Comment on page

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.

post
https://mapi.yuansfer.com
/v3/payouts/pay
Pay
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.

Balance

Search Payments

Last modified 2yr ago

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.

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.