Initiate payment

curl --request POST \ --url https://api.example.com/v1/payments \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: <idempotency-key>' \ --data ' { "source": "CLIENT", "paymentScheme": "SCT", "debtor": { "accountId": "019bdb2a-960f-789d-8955-21720e6cdeef" }, "creditor": { "name": "Jane Smith", "account": { "iban": "DE89370400440532013000" }, "agent": "DEUTDEFFXXX" }, "instructedAmount": { "amount": 10000, "currency": "EUR" }, "endToEndId": "E2E-123456", "remittanceInformation": "Invoice payment #12345" } '

Headers

Idempotency-Key

string

required

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

Maximum string length: 255

Pattern: \S

Body

application/json

Payment creation request

Request to create a payment transaction

remittanceInformation

string

required

Payment description/reference

Pattern: \S

Example:

"Invoice payment #12345"

paymentScheme

enum<string>

Payment scheme

Available options:

SCT,

SCT_INST,

INTERNAL,

SWIFT

Example:

"SCT"

debtor

object

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

Show child attributes

creditor

object

Creditor (payee) information

Show child attributes

instructedAmount

object

Payment amount

Show child attributes

endToEndId

string | null

End-to-end identifier

Example:

"E2E-123456"

source

enum<string>

default:CLIENT

Business source that initiated the payment

Available options:

CLIENT,

PLAIS

Example:

"CLIENT"

priority

enum<string> | null

Payment priority. SWIFT-only. Defaults to NORM.

Available options:

NORM,

HIGH

Example:

"NORM"

settlement

object | null

Settlement details. Required for SWIFT.

Show child attributes

paymentSource

enum<string>

default:CURRENT

Customer ledger account source for payment funds

Available options:

CURRENT,

HOLDING

Example:

"CURRENT"

Response

Payment initiation accepted

Response for accepted asynchronous requests

correlationId

string

Correlation identifier for tracking the request through events

Example:

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

Getting Started

Parties

Accounts

Account Statements

Payments

Transactions

Transaction Postings

Oversight

Webhooks

Headers

Body

Response