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"
}
'{
"correlationId": "550e8400-e29b-41d4-a716-446655440000"
}{
"status": 400,
"title": "<string>",
"instance": "<string>",
"violations": [
{
"field": "<string>",
"in": "query",
"message": "<string>"
}
]
}{
"status": 500,
"title": "<string>",
"instance": "<string>",
"detail": "<string>"
}Initiate payment
Initiates a new SEPA payment (SCT or SCT_INST). Returns 202 Accepted when the request is queued for processing.
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"
}
'{
"correlationId": "550e8400-e29b-41d4-a716-446655440000"
}{
"status": 400,
"title": "<string>",
"instance": "<string>",
"violations": [
{
"field": "<string>",
"in": "query",
"message": "<string>"
}
]
}{
"status": 500,
"title": "<string>",
"instance": "<string>",
"detail": "<string>"
}Headers
Client-provided idempotency key. UUID v4 suggested, max 255 characters.
255\SBody
Payment creation request
Request to create a payment transaction
Payment description/reference
\S"Invoice payment #12345"
Payment scheme
SCT, SCT_INST, INTERNAL, SWIFT "SCT"
Debtor (payer) details. Exactly one of accountId or iban must be provided.
Show child attributes
Show child attributes
Creditor (payee) information
Show child attributes
Show child attributes
Payment amount
Show child attributes
Show child attributes
End-to-end identifier
"E2E-123456"
Business source that initiated the payment
CLIENT, PLAIS "CLIENT"
Payment priority. SWIFT-only. Defaults to NORM.
NORM, HIGH "NORM"
Settlement details. Required for SWIFT.
Show child attributes
Show child attributes
Customer ledger account source for payment funds
CURRENT, HOLDING "CURRENT"
Response
Payment initiation accepted
Response for accepted asynchronous requests
Correlation identifier for tracking the request through events
"550e8400-e29b-41d4-a716-446655440000"