Prepay

Prepay

POST https://mapi.yuansfer.com/app-instore/v3/prepay

Request Body

NameTypeDescription

merchantNo*

string

Merchant ID

storeNo*

string

Store ID

storeAdminNo

string

Store Admin ID

transactionNo

string

The Invoice Number of the transaction in Yuansfer's system. Either transactionNo or reference is required.

reference

string

The Invoice Number of the transaction in the merchant's system. Either transactionNo or reference is required.

paymentBarcode*

string

The payment method. The payment barcode from the customer.

verifySign*

string

The parameter signature.

{
    "result": {
        "amount": "13.00",
        "createTime": "2020-10-12 21:38:16",
        "currency": "USD",
        "merchantNo": "200043",
        "originalTransactionNo": null,
        "paymentTime": "2020-10-12 22:38:16",
        "reference": "test20200101206",
        "refundAmount": "0.00",
        "settleCurrency": "USD",
        "storeAdminNo": null,
        "storeNo": "300014",
        "transactionNo": "297553638241892410",
        "transactionStatus": "success",
        "transactionType": "payment",
        "voidAmount": "0.00"
    },
    "ret_code": "000100",
    "ret_msg": "add 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.

createTime

string

The date and time when the transaction was created.

Format : "yyyy-MM-dd HH:mm:ss".

currency

string

The three-character currency code that identifies the 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

This is the currency that a payment will be made to the merchant.

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 transaction type.

The possible values are: "payment","refund","void".

voidAmount

number

The void or cancel amount.

curl -XPOST -H "Content-type: application/json" -d '{
    "merchantNo": "200043",
    "storeNo": "300014",
    "verifySign": "f38965887c5676e2fb19d951251eb613",
    "transactionNo": "297553636764407286",
    "paymentBarcode": "286498530672949108",
    "vendor": "alipay"
}' 'https://mapi.yuansfer.com/app-instore/v3/pay'

Last updated