Transaction Query

TranQuery

POST https://mapi.yuansfer.com/app-data-search/v3/tran-query

This API gets the transaction details by ID of a transaction in the merchant's system.

Request Body

NameTypeDescription

merchantNo*

string

Merchant ID

storeNo*

string

Store ID

transactionNo

string

The Transaction ID in the Yuansfer system.

reference

string

The Invoice Number of the transaction in the merchant's system.

verifySign*

string

The parameter signature.

{
    "result": {
        "amount": "10.00",
        "currency": "CNY",
        "reference": "test202001011305",
        "settleCurrency": "USD",
        "status": "success",
        "transactionNo": "297553638300708562",
        "transactionType": "payment"
    },
    "ret_code": "000100",
    "ret_msg": "query 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

transactionNo

string

The Transaction ID in the Yuansfer system.

reference

string

The Invoice Number of the transaction in the merchant’s system.

amount

number

The transaction amount.

status

string

The status of the transaction.

currency

string

The supported transaction currency is "USD", "CNY".

settleCurrency

string

The supported settlement currency is "USD", "CNY".

transactionType

string

The type will be either "payment" or "refund".

RefundInfo Object

Parameter

Type

Description

refundTransactionId

string

The ID of the refund transaction in the Yuansfer system.

refundReference

string

The ID of the refund transaction in the merchant’s system.

refundAmount

string

The transaction refund amount. This parameter will be returned only when the payment order contains a 'Amount'.

refundRmbAmount

string

The transaction refund amount of CNY. This parameter will be returned only when the payment order contains a 'rmbAmount'.

currency

string

The supported transaction currency is "USD", "CNY".

settleCurrency

string

The supported settlement currency is "USD", "CNY".

curl -XPOST -H "Content-type: application/json" -d '{
    "merchantNo": "200043",
    "storeNo": "300014",
    "transactionNo": "297553638300708562",
    "verifySign": "0df745088d7202a6d186596acdc82c6a"
}' 'https://mapi.yuansfer.com/app-data-search/v3/tran-query'

Last updated