Payout Field Query
Overview
When you create an API payment order interface, you can use the query interaction to obtain and encapsulate the fields with senderInfo or receiverInfo request parameters. You can also request API encapsulation.
Instructions
Merchants can obtain field information in Query Interaction. They need to fill in the test account and API_KEY, select the opened business currency, country, region and type, obtain the list of connected channels, and then select the channel and transaction mode and click Query.
For example: After performing a query operation in Query Interaction > Query Required Fields, the result will be the following list of fields.
At this time, the content of the senderInfo field corresponding to the payer needs to be encapsulated into the following JSON format:
{
"surName": "yourname",// Last name
"givName": "epayers",// First name
"address": "youraddress", // Address
"purposeOfRemittance": "6" // The purpose of remittance can be obtained by querying other information.
}
The information of purposeOfRemittance can be obtained through Query Interaction > Query Other Information.
receiverInfo The content of the field needs to be encapsulated into the following JSON format for the payee:
{
"surName": "yourname",// Last name
"givName": "epayers",// First name
"country": "youraddress", // Address
"accountNo": "**8944556", // Account number
"sortCode": "600**6", // Sort Code
"locationId": "17*4", // Bank ID is obtained by querying the bank branch
"bankName": "yourbankName" // Bank name Obtained by querying bank branches
}
Among them, locationId and bankName information can be obtained through Query Interaction > Query Bank Branch.
API List
Merchants can also obtain these field information through API list requests.
| Name | Desc | Operation |
|---|---|---|
| channelList | Get channel list | View documentation |
| getRequiredField | Query required fields | View documentation |
| getBankList | Query bank list | View documentation |
| getDataSource | Get data source | View documentation |
Query Interaction
| Payer/Payee | Field name | Required | Max length | Describe |
|---|
No data
No data
No data