# Query Transfer
Merchants query transfer orders through this API, and the payment gateway will return the latest order data.
# Query Transfer API
API
Request API: /api/transfer/query
Request method: POST
Request type: application/json or application/x-www-form-urlencoded
# Request parameters
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Merchant No | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Transfer Order No | transferId | Yes | String(30) | T20160427210604000490 | The payment order number generated by the payment center can be passed along with mchOrderNo |
| Merchant Transfer Order No | mchOrderNo | Yes | String(30) | 20160427210604000490 | The payment order number generated by the merchant can be passed along with the transferId |
| Request Time | reqTime | Yes | long | 1622016572190 | Request API time, 13-digit timestamp |
| API Version | version | Yes | String(3) | 1.0 | API version number, fixed: 1.0 |
| Signature | sign | Yes | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | Signature value, see signature algorithm for details |
| Signature Type | signType | Yes | String(32) | MD5 | Signature type, currently only supports MD5 mode |
# Request Example Data
{
"appId":"60cc3ba74ee0e6685f57eb1e",
"sign":"D3C0CC231F3FC3D033650699BA099B39",
"signType":"MD5",
"reqTime":"1629106457",
"transferId":"T202108121543441860003",
"mchNo":"M1623997351",
"version":"1.0"
}
# Return parameters
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Return State | code | Yes | int | 0 | 0 - processing successful, others - processing error, see error code for details |
| Return Message | msg | No | String(128) | Signature failure | Specific error reasons, such as: signature failure, parameter format verification error |
| Signature | sign | No | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | Sign the data in data, if data is empty, it will not be returned |
| Return Data | data | No | String(512) | {} | Return order data, json format data |
# Parameter Data Format
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Transfer Order No | transferId | Yes | String(30) | T20160427210604000490 | Payment order number generated by the payment center |
| Merchant No | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Merchant Order No | mchOrderNo | Yes | String(30) | 20160427210604000490 | Payment order number generated by the merchant |
| Transfer Amount | amount | Yes | String(long) | 100 | Payment amount, in cents |
| Arrival Amount | arrivalAmount | Yes | String(long) | 100 | Arrival amount, in cents |
| Fee Bearer | feeBear | Yes | String(32) | merchant | Fee bearer merchant-merchant bear beneficiary-payee bear |
| Currency Code | currency | Yes | String(3) | USD | Three-digit currency code |
| Entry Type | entryType | Yes | String(20) | PIX | Payment channel |
| Transfer State | state | Yes | int | 2 | Payment status 0-Order generated 1-Payment in progress 2-Payment successful 3-Payment failed 4-Payment closed |
| Recipient Account No | accountNo | Yes | String(64) | o6BcIwvTvIqf1zZZohc61biryWik | Payee account Id |
| Beneficiary Account Type | accountType | No | String(32) | account | beneficiary account type |
| Payee Name | accountFullName | No | String(64) | Sky Wong | Payee Name |
| Transfer Remark | transferDesc | No | String(128) | Test payment | Payment remark information |
| Channel Error Code | errCode | No | String | 1002 | Channel order return error code |
| Channel Error Message | errMsg | No | String | Business exception error | Channel order return error description |
| Extended Parameters | extParam | No | String(512) | 134586944573118714 | Merchant extended parameters, which will be returned unchanged during callback |
| Creation Time | createdAt | Yes | String(long) | 1622016572190 | Order creation time, 13-digit timestamp |
| Success Time | successTime | No | String(long) | 1622016572190 | Order payment success time, 13-digit timestamp |
# Return Example Data
{
"code": 0,
"data": {
"accountNo": "o6BcIwvTvIqf1zZZohc61biryWik",
"amount": "1",
"appId": "6113805e42020495c62bd4cb",
"createdAt": "1628818820011",
"currency": "USD",
"entryType": "PIX",
"errCode": "ACCOUNT_NOT_ALLOW",
"errMsg": "ACCOUNT NOT ALLOW",
"mchNo": "M1623997351",
"mchOrderNo": "1628818820",
"state": 3,
"transferDesc": "Test",
"transferId": "T202108130940200100001"
},
"msg": "SUCCESS",
"sign": "A262DBD3D6182E8A0AEC90EF820F2A5A"
}