Create a bank transfer
POST/api/v1/payout/transfer
Creates a new bank transfer by deducting the amount from the user's available balance.
The bank transfer can use an existing payout destination or create a new one.
- If
destination.idis provided, the existing payout destination is used. - If
destination.idis not provided, a new payout destination is created (or reused, if one already matches the given rail/account identifier) fromdestination.rail,destination.country,destination.accountIdentifierValue, anddestination.beneficiary.
Attachments
- Optional PDF files can be attached to the bank transfer.
- Required for USD/EUR bank transfers.
- Maximum 10 files per transfer.
- Maximum size per file: 1MB.
Request
Responses
- 201
- 400
- 403
- 404
- 413
- 422
- 500
Transfer created successfully
Invalid request data
Insufficient permissions to create transfers
Beneficiary not found or does not belong to the user
File too large
The destination cannot be mapped to a payout rail
File type is not supported