Send Money

To make a payment, send a POST request to the payments endpoint and include the payment details in a JSON format in the request body. Then, send the amount to the receiver to complete the payment.

Pay

POST https://mapi.yuansfer.com/v3/payouts/pay

Request Body

Name	Type	Description
customerNo	string	The auto-generated ID in Yuansfer's system when create payee account
accountToken	string	The unique, auto-generated account identifier in Yuansfer's system
invoiceId	string	The Invoice Number of the transaction in the merchant's system.
subject	string	The subject line for the email the gets sent out when a payment is completed.
currency	string	The supported transaction currency is "USD".
merchantNo	string	Merchant ID
storeNo	string	Store ID
amount	string	The transaction amount.
verifySign	string	The parameter signature.
ipnUrl	string	The asynchronous callback address. The IPN URL must be secure.
description	string	The description of the transaction that will be displayed on the invoice.
note	string	A sender-specified note of a payment.

200

{
    "result":
    {
        "amount": "7.77",
        "transactionNo": "305681586651421444",
        "createdTime": "2021-04-09T12:20:43Z",
        "currency": "USD",
        "accountToken": "2010301345144831354780",
        "customerNo": "2000302213444831354691",
        "status": "scheduled"
    },
    "ret_msg": "succeeded",
    "ret_code": "000100"
}
        

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
amount	number	The transaction amount.
transactionNo	string	The Transaction ID in the Yuansfer system.
createdTime	string	The date and time when the transaction was created. Format : "yyyy-MM-ddTHH:mm:ssZ".
currency	string	The three-character currency code that identifies the currency.
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 transaction.

Payout Item Status

Status	Description
success / completed	Funds have been credited to the receiver’s account.
pending	Your payout request was received and will be processed.
failed	This payout request has failed, so funds were not deducted from the payor’s account.
returned	The receiver has not claimed this payout, so the funds have been returned to payor's account.
refunded	This payout request was refunded.
reversed	This payout request was reversed.
unclaimed	The recipient for this payout does not have a account. A link to sign up for a account was sent to the recipient.
onhold	This payout request is being reviewed and is on hold.
blocked	This payout request has been blocked.