Pay

Pay

POST https://mapi.yuansfer.com/auto-debit/v3/pay

Use this interface to initiate a payment and process payment results according to the status and operation instruction returned by Yuansfer. AccessToken will be used when deductions are made.

Request Body

Name	Type	Description
merchantNo*	string	Merchant ID
storeNo*	string	Store ID
autoDebitNo*	string	The auto-debit record ID.
amount*	string	The transaction amount.
currency*	string	The supported transaction currency is "USD".
settleCurrency*	string	The supported settlement currency is "USD".
reference*	string	The Invoice Number of the transaction in the merchant's system.
ipnUrl*	string	Asynchronous callback address.
verifySign*	string	The parameter signature.

200 Correct return value

{
    "result": {
        "amount": 100,
        "autoDebitNo": "298222562856331071",
        "currency": "PHP",
        "reference": "test2021010801",
        "transactionNo": "297553645779430418"
    },
    "ret_code": "000100",
    "ret_msg": "pay success"
}

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	string	The transaction amount.
autoDebitNo	string	Unique ID of auto debit record in Yuansfer's system.
currency	string	The supported transaction currency is "USD".
settleCurrency	string	The supported settlement currency is "USD".
reference	string	The invoice number of the transaction in the merchant's system.
transactionNo	string	The unique ID of a transaction.

Parameter format

{
    "merchantNo": "200043",
    "storeNo": "300014",
    "verifySign": "cec6cc1dc16c399f68b66d74f8e363f5",
    "autoDebitNo": "298222562856331071",
    "amount": "100",
    "currency": "PHP",
    "settleCurrency": "USD",
    "reference": "test2021010801",
    "ipnUrl": "http://zk-tys.yunkeguan.com/ttest/test"
}

Correct return value

{
    "result": {
        "amount": 100,
        "autoDebitNo": "298222562856331071",
        "currency": "PHP",
        "settleCurrency": "USD",
        "reference": "test2021010801",
        "transactionNo": "297553645779430418"
    },
    "ret_code": "000100",
    "ret_msg": "pay success"
}

Error return value

{
   "ret_code": "000000",
   "ret_msg": "data error : verifySign",
}