PATCH
/
v1
/
close
curl --request PATCH \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/instalment/v1/close \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "instalmentId": "<string>"
}'
{
  "id": "<string>",
  "accountId": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "firstPayment": "2023-12-25",
  "lastPayment": "2023-12-25",
  "currency": "<string>",
  "effectiveRate": "<string>",
  "totalAmount": 123,
  "principalAmount": 123,
  "feeAmount": 123,
  "paidAmount": 123,
  "principalPaidAmount": 123,
  "dueAmount": 123,
  "overdueAmount": 123,
  "writtenOffAmount": 123,
  "fullRepaymentAmount": 123,
  "status": "WAITING",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "transactionId": "<string>",
  "description": "<string>",
  "planOptions": {
    "shift": 2,
    "type": "BUY_NOW_PAY_LATER"
  }
}

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

Response

200
application/json

Closed instalment

The response is of type object.