Add
Add
POST
https://mapi.yuansfer.com/app-instore/v3/add
This API initiates a Barcode/QR Code Payment request and creates a transaction order.
Request Body
Name | Type | Description |
---|---|---|
merchantNo* | string | Merchant ID |
storeNo* | string | Store ID |
storeAdminNo* | string | Store Admin 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. |
verifySign* | string | The parameter signature. |
timeout | integer | The timeout in minutes. Default values is 120. |
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. |
createTime | string | The date and time when the transaction was created. Format : "yyyy-MM-dd HH:mm:ss". |
currency | string | The supported transaction currency is "USD". |
merchantNo | string | Merchant ID |
originalTransactionNo | string | The ID of the original transaction in the Yuansfer system. |
paymentTime | string | The date and time when the payment was processed. Format : "yyyy-MM-dd HH:mm:ss". |
reference | string | The Invoice Number of the transaction in the merchant’s system. |
refundAmount | number | The refund amount. |
settleCurrency | string | The supported settlement currency "USD". |
storeAdminNo | string | Store Admin ID |
storeNo | string | Store ID |
transactionNo | string | The Transaction ID in the Yuansfer system. |
transactionStatus | string | The status of the transaction. |
transactionType | string | The possible transaction type values are "payment", "refund", "void". |
voidAmount | number | The void or cancel amount. |
Last updated