Skip to main content
POST
Push payees
Each payee carries your own clientPayeeId, echoed back in the result. It is the only key you use to attach payments and to update or delete the payee later, and it must be unique within the submission. 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
clientPayeeId
string
required

Your own id for this payee. Required and echoed back in the result to correlate it.

Maximum string length: 100
names
object[]
required
Required array length: 1 - 2147483647 elements
countryCode
string
required
Minimum string length: 1
Example:

"DE"

addresses
object[]
required
emails
string[]
required
webPages
string[]
required
taxes
object[]
required
accounts
object[]
required
representative
object

Payee representative (optional)

Response

All payees created

status
enum<string>
required
Available options:
SUCCESS,
FAILED
errors
object[]
required
clientPayeeId
string

Your clientPayeeId echoed back, to correlate this result with your record

Last modified on July 22, 2026