Create Payee
To send a payment to payees, first register a account with Yuansfer by sending a POST request to the Register Customer endpoint and use the customerNo you receive to create a payout account for payee.
CreatePayee
POST
https://mapi.yuansfer.com/v2/customers/account/create
Request Body
Name | Type | Description |
---|---|---|
timestamp | string | Current UTC time. Correct format should be "yyyy-MM-ddTHH:mm:ssZ" |
accountCountry | string | The payee account country. Two characters country code. |
accountCurrency | string | The currency which payee account wish to receive. Three characters currency code. |
customerNo | string | The auto-generated payee's id in Yuansfer's system when registered customer account |
accountTag | string | The payee's account id in Merchant's system |
ipnUrl | string | The asynchronous notification address. The IPN url must be secure. |
callbackUrl | string | The synchronous callback HTTP address to receive notification messages for events. The callback url follows macro substitution rules like
|
accountType | string | Payee account type, possible value: "CARD", "PAYPAL", "VENMO" ,"BANK_ACCOUNT", "PAPER_CHECK", "PREPAID_CARD", "ALIPAY" |
merchantNo | string | Merchant ID |
storeNo | string | Store ID |
verifySign | string | The parameter signature |
clientIp | string | The client ip address of the device who is making the request, correct format: xxx,xxx,xxx,xxx |
Response
Parameter | Type | Description |
customer | object | The customer object. |
ret_msg | string | The response return message. |
ret_code | string | The response return code. For more details, see here. |
Customer Object
Parameter | Type | Description |
firstName | string | The payee's first name. |
lastName | string | The payee's last name. |
link | string | Send this link to payees so they can register a account to receive payments |
customerCode | string | The user-defined payee's ID in Yuansfer's system |
timestamp | string | The time when customer registered account |
customerNo | string | The auto-generated payee's ID in Yuansfer's system |
string | The payee's email address | |
accountToken | string | The unique, auto-generated account identifier |
timestamp | string | The UTC time retrieved from Register Customer Api |
profileType | string | Payee account profile type |
accountCountry | string | The payee account country |
accountCurrency | string | The currency which payee account wish to receive. |
Asynchronous Notification Object
Parameter | Type | Description |
accountStatus | string | The payee account status |
accountTag | string | The payee account id in Merchant's system |
accountToken | string | The unique, auto-generated account identifier |
accountType | string | The payee account's account type |
country | string | The payee account's country |
customerNo | string | The auto-generated payee's ID in Yuansfer's system |
currency | string | The payee account's currency |
payeeAccount | string | The payee account's email address |
verifySign | string | The parameter signature |
Last updated