Retrieve Payee
You can retrieve payee's account detail by sending a POST request to Yuansfer Retrieve Payee Account API.
RetrievePayee
POST
https://mapi.yuansfer.com/v2/customers/account/retrieve
Request Body
Name | Type | Description |
---|---|---|
accountType | string | Payee account type, possible values: "PAYPAL", "VENMO", "CARD", "BANK_ACCOUNT", "PREPAID_CARD", "PAPER_CHECK", "ALIPAY", "WIRE_ACCOUNT" |
customerNo | string | The auto-generated payee's id in Yuansfer's system when register customer account |
timestamp | string | Current UTC time. Correct format should be: "yyyy-MM-ddTHH:mm:ssZ" |
accountTag | string | The payee's account id in merchant's system Either accountTag or accontToken is required |
accountToken | string | The unique, auto-generated account identifier. Either accountTag or accountToken is required |
merchantNo | string | Merchant ID |
storeNo | string | Store ID |
verifySign | string | The parameter signature |
Response
Parameter | Type | Description |
result | object | The result object. |
ret_msg | string | The response return message. |
ret_code | string | The response return code. For more details, see here. |
Result Object
Parameter | Type | Description |
amountTag | string | The payee's account id in merchant's system |
country | string | The payee account country code |
createdAt | string | The date and time when the account was created Format : "yyyy-MM-ddTHH:mm:ssZ". |
firstName | string | The first name of the payee |
lastName | string | The last name of the payee |
accountToken | string | The unique, auto-generated account identifier ID in Yuansfer's system. |
customerNo | string | The auto-generated user's id in Yuansfer's system. |
status | string | The status of the payee account. |
string | The payee account email address |
Last updated