Payout type
The payout type specifies the mechanism used to disburse funds to a beneficiary.
It is set through payout_method.type when requesting a Quote, and it
determines which payment instructions the resulting
Order must provide.
{
"destination": {
"country": "VE",
"currency": "VES",
"payout_method": { "type": "P2P_PHONE_TRANSFER" }
}
}
Available types​
payout_method.type is a closed enum with exactly two values:
| Type | What it is | Payment instructions group |
|---|---|---|
BANK_TRANSFER | A deposit into the beneficiary's bank account. | payment_instructions.bank_account (bank_name, number, type) |
P2P_PHONE_TRANSFER | A phone-linked P2P transfer to the beneficiary. | payment_instructions.bank_phone_account (bank_name, phone_number, optional document_id) |
Any other value is rejected with a 400 at validation, before the request reaches
the quotation engine.
Technical importance​
- Quote ↔ Order correspondence — the payout type used to create the order must match the one used for the quote, since it determines the required payment instructions.
- Required fields — each payout type determines which payment instructions the order must provide.
- Fees and limits — the payout type is part of the corridor that determines applicable fees and operational limits.