Skip to main content
POST
/
v1
curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/instalment/v1' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "TRANSACTION",
  "transactionId": "12345678",
  "description": "Buy now, pay in 2 months",
  "planOptions": {
    "type": "BUY_NOW_PAY_LATER",
    "shift": 2
  }
}
'
{
  "description": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication is used to authenticate towards Enfuce API. It is described in more detail in RFC 7617.

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json
​
from
enum<string>
required

The source type for the instalment.

Available options:
TRANSACTION
Example:

"TRANSACTION"

​
transactionId
string<biginteger>
required

Transaction that will be converted into instalments

Example:

"8767653"

​
planOptions
BUY_NOW_PAY_LATER · object
required

The paymentPlan.type field should be BUY_NOW_PAY_LATER.

​
description
string

Optional text describing the instalment request

Maximum string length: 255
Example:

"Instalment for product #4567"

Response

Successful creation of an instalment

​
description
string

Short description of the result of the action

​
id
string

Will contain the ID of the resource that has been created or updated