Payment instructions
Payment instructions carry the details needed to deliver the funds to the
beneficiary. You provide them in destination.payment_instructions when you
create an order.
Send exactly one of the two groups below:
| Group | For | Payout type |
|---|---|---|
bank_account | A deposit into the beneficiary's bank account | BANK_TRANSFER |
bank_phone_account | A phone-linked P2P transfer | P2P_PHONE_TRANSFER |
Sending neither, or both, is rejected with 422
B2B_BENEFICIARY_INVALID.
You never send the payout method itself. It is inferred from which group you send, and it has to match the payout type of the quotation the order executes.
bank_accountβ
{
"destination": {
"payment_instructions": {
"bank_account": {
"bank_name": "BANCO_BANESCO_VE",
"number": "01340055351055017659",
"type": "CHECKING"
}
}
}
}
| Field | Type | Required | Description |
|---|---|---|---|
bank_name | enum | yes | The bank's API name, from the closed catalog β "BANCO_BANESCO_VE", not "Banesco". See bank entities. |
number | string | yes | Beneficiary account number. |
type | enum | yes | CHECKING, SAVINGS, CORRIENTE or AHORRO. |
bank_display_name | string | β | Read-only. Reads return the bank's commercial name here. Do not send it: the API rejects unknown fields with 400. |
bank_phone_accountβ
{
"destination": {
"payment_instructions": {
"bank_phone_account": {
"bank_name": "BANCO_BANESCO_VE",
"phone_number": "+584121234567",
"document_id": "87654321"
}
}
}
}
| Field | Type | Required | Description |
|---|---|---|---|
bank_name | enum | yes | Same catalog as above β the API name, never the display name. |
phone_number | string | yes | Beneficiary phone in E.164 (+584121234567). |
document_id | string | no | Beneficiary document. Omit it and destination.receiver.document.id is used β the P2P beneficiary is the same person, so there is no point sending it twice. |
bank_display_name | string | β | Read-only, same as above β never sent. |
note
bank_name is a closed catalog in both groups: a value outside it is rejected
with 400. The catalog is per country β see bank entities.