PaymentInstructions
Use of Quote in Requests
This section provides a detailed table showing the required fields that must be included in paymentInstructions
for each payoutType
. These fields are crucial to ensure that an order is processed correctly and that funds are transferred to the designated beneficiary according to the selected payout method.
During the order creation process, it is essential to include the required information in paymentInstructions
for each payout method type. This ensures that the payment instructions are accurate and that the transaction is executed smoothly. Compliance with these specific requirements is critical to validate and authorize the transfer of funds through the platform.
Table of Required Fields
payoutTypePlatformName | beneficiaryDocumentId | beneficiaryDocumentType | beneficiaryLastNames | beneficiaryNames | senderNames | senderLastNames | senderDocumentId | senderDocumentType | senderCountry | externalId | paymentPurpose | paymentInstructions.bankName | paymentInstructions.accountNumber | paymentInstructions.accountType | paymentInstructions.phoneNumber | paymentInstructions.branchId |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BANK_TRANSFER | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No |
INTERBANK_TRANSFER_CO | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No |
CASH_PICKUP_CO | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | No |
BANK_TRANSFER_EU | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | No | No | No |
P2P_PHONE_TRANSFER | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | No |
BANK_TRANSFER_USD | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | No | Yes |
CASH_PICKUP_AR | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No |
BANK_TRANSFER_AR | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | No | No | No |
CASH_PICKUP_USD_VE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No |
BANK_TRANSFER_USD_PE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No |
CASH_PICKUP_USD_PE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No |
WALLET_PEN_PE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No |
CASH_PICKUP_PEN_PE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No | No |
BANK_TRANSFER_PEN_PE | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | No |
Important:
- Yes: Required field.
- No: Optional field.