/payments/payout
Header Parameters
idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring
Body Parameters
paymentReasonstring Required
The reason defined for the payment. Valid values for this field are any reasonCode property from the GET /payment/reasonCodes endpoint.
referencestring
The reference which will show on the recipients bank records.
Min length
1
Max length
18
currencystring Required
The currency the payment is being made in.
Min length
3
Max length
3
amountnumber Required
The amount of the payment.
fromWalletIdstring Required
The ID of the wallet where the payment is being sent from.
Min length
38
Max length
100
Pattern
wallet_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
recipientIdstring Required
The recipient of the payment.
Min length
38
Max length
100
Pattern
recipient_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
paymentAddressIdstring Required
The ID of the payment address.
Min length
38
Max length
100
Pattern
paymentAddress_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
externalReferencestring
An optional value that can be passed in to later reference a related resource in the partner system.
Response
201
Object
Successful response.
Response Attributes
itemobject
Show child attributes
400
Object
Bad Request
Response Attributes
messagestring Required
errorsarray Required
Show child attributes
401
Object
Unauthorized
Response Attributes
messagestring
errorsarray Required
Show child attributes
409
Object
Conflict
Response Attributes
messagestring
errorsarray Required
Show child attributes
500
Object
Unknown Error
Response Attributes
messagestring
errorsarray Required
Show child attributes
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?