Skip to main content
POST
/
payments
Initiate payment
curl --request POST \
  --url https://api.example.com/payments \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "paymentScheme": "SCT",
  "debtor": {
    "accountId": "019bdb2a-960f-789d-8955-21720e6cdeef",
    "iban": "LT647044001231465456"
  },
  "creditor": {
    "name": "Jane Smith",
    "account": {
      "iban": "DE89370400440532013000"
    },
    "agent": "REVOLT21"
  },
  "instructedAmount": {
    "amount": 10000,
    "currency": "EUR"
  },
  "remittanceInformation": "Invoice payment #12345",
  "endToEndId": "E2E-123456"
}
'
{
  "correlationId": "550e8400-e29b-41d4-a716-446655440000"
}

Headers

Idempotency-Key
string
required

Client-provided idempotency key. UUID v4 suggested, max 255 characters.

Maximum string length: 255
Pattern: \S

Body

application/json

Request to create a payment transaction

paymentScheme
enum<string>
required

Payment scheme

Available options:
SCT,
SCT_INST
Example:

"SCT"

debtor
object
required

Debtor (payer) details. Exactly one of accountId or iban must be provided.

creditor
object
required

Creditor (payee) information

instructedAmount
object
required

Payment amount

remittanceInformation
string
required

Payment description/reference

Pattern: \S
Example:

"Invoice payment #12345"

endToEndId
string | null

End-to-end identifier

Example:

"E2E-123456"

Response

Payment initiation accepted

Response for accepted asynchronous requests

correlationId
string
required

Correlation identifier for tracking the request through events

Example:

"550e8400-e29b-41d4-a716-446655440000"

Last modified on February 10, 2026