Create an instalment

POST

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": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

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.

BUY_NOW_PAY_LATER
INTEREST_FREE
FIXED_INTEREST

Show child attributes

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

When a payment is declined, a response description is returned, if available, providing more context on why the transaction failed. This includes a return code and a brief explanation. If multiple issues cause the decline, only one response description is sent; the most recent reason for decline is returned. If the payment is successful, the resourceResponse attribute is returned with null value.

Example:

"061-Usage Limit '24H_RETAIL' Amount Exceeded"

string

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

⌘I

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": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}