Skip to main content
POST
Push payments
Each payment links to a previously pushed payee via payeeClientId (that payee’s clientPayeeId). This is the high-volume stream and may be called repeatedly. Send the optional Idempotency-Key header to make a retried batch safe.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Client-provided idempotency key.

Maximum string length: 255

Path Parameters

submissionId
string
required

Body

application/json
payeeClientId
string
required

Your clientPayeeId for the payee this payment belongs to

Maximum string length: 100
transactionId
string
required
Maximum string length: 100
refund
boolean
required
amount
number
required

Positive for a payment, negative for a refund; zero is not allowed

Example:

100.21

currency
string
required
Minimum string length: 1
Example:

"EUR"

paymentDates
object[]
required
Required array length: 1 - 2147483647 elements
initiatedOnPremises
boolean
required
payerCountryCode
string
required

Payer location: an EU Member State, given as an ISO 3166-1 alpha-2 code

Minimum string length: 1
Example:

"DE"

payerAccountType
enum<string>
required
Available options:
IBAN,
OBAN,
BIC,
OTHER
refundedTransactionId
string
Maximum string length: 100
paymentMethodType
enum<string>
Available options:
CARD,
BANK_TRANSFER,
DIRECT_DEBIT,
E_MONEY,
REMITTANCE,
MARKETPLACE,
INTERMEDIARY,
OTHER
paymentMethodSpecification
string
Maximum string length: 200
pspRoleType
enum<string>
Available options:
THREE_PARTY,
FOUR_PARTY,
E_MONEY,
ACQUIRER,
E_WALLET,
MONEY_TRANSFER,
ISSUER,
PAYMENT_PROCESSOR,
E_PAYMENT,
PAYMENT_COLLECTOR,
OTHER
pspRoleSpecification
string
Maximum string length: 200

Response

All payments created

status
enum<string>
required
Available options:
SUCCESS,
FAILED
transactionId
string
required

Client transaction id echoed back

errors
object[]
required
Last modified on July 22, 2026