API REFERENCE
Detalles de la transacción
Parámetros
| Parameter | Type | Descripción | Obligatorio |
|---|---|---|---|
| data.command | string | getTradebillinfo | ✓ |
| data.clearing_id | string | 清算报表ID | — |
| data.start_time | string | 交易开始时间 | — |
| data.end_time | string | 交易结束时间 | — |
| data.nonce_string | string | 随机字符串，不长于32位 | ✓ |
Esta API consulta los detalles de las transacciones en los informes de liquidación de YabandPay o busca transacciones dentro de un intervalo de fechas.
Consejo
- Los detalles incluyen únicamente transacciones que implican liquidación de fondos, como pagos o reembolsos completados. Se excluyen operaciones como cancelaciones y autorizaciones.
- Al consultar por intervalo de fechas, el intervalo no puede superar un año.
- No se pueden consultar transacciones con más de 7 años de antigüedad.
- Solo las cuentas de superadminestrador del comercio pueden llamar a esta API. Las cuentas de operador y cajero no tienen autorización para hacerlo.
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| user | String | UID de la cuenta de superadminestrador | Obligatorio |
| sign | String | Signature | Obligatorio |
| method | String | v3.GetTradebill | Obligatorio |
| time | Long | Timestamp | Obligatorio |
- Parámetros
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| command | String | getTradebillinfo | Obligatorio |
| clearing_id | String | ID del informe de liquidación | Opcional |
| start_time | String | Hora de inicio de la transacción | Opcional |
| end_time | String | Hora de finalización de la transacción | Opcional |
| nonce_string | String | Cadena aleatoria de un máximo de 32 caracteres | Obligatorio |
Ejemplo de firma:
Parámetros ordenados y concatenados en una cadena de consulta con formato de URL
"clearing_id=M20240302001503350733&command=getTradebillinfo&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Firme la cadena A con secret_key
La firma resultante es:
"YOUR_SIGNATURE"
Request example - clearing report:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"clearing_id": "M20240220001503109569",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Request example - date range:
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"start_time": "1716393600",
"end_time" : "1716566340",
"nonce_string": "g46a5g156rt4784ghb1b"
}
}
Ejemplo de respuesta:
{
"status": true,
"code": 200,
"message": "",
"data": {
"tradebill": [
{
"time_zone": "GMT+1",
"store_name": "Test Store",
"date": "21-02-2024 19:03:21",
"settlement_currency": "EUR",
"amount": "2.00",
"fee": "0.02",
"net_value": "1.98",
"vat": "0.01",
"type": "payment",
"sub_pay_method": "WeChat Pay",
"order_id": "YOUR_ORDER_ID",
"trade_id": "ed71a5db-8e1c-a883-d062-ccbb4005b914",
"description": "test order",
"demo": "",
"state": "paid",
"fund_flow_status": "2",
"fund_flow_description": "settled"},
{
"time_zone": "GMT+1",
"store_name": "Test Store"
"date": "21-02-2024 20:25:43",
"settlement_currency": "EUR",
"amount": "2.00",
"fee": "0.02",
"net_value": "1.98",
"vat": "0.01",
"type": "Payment",
"sub_pay_method": "WeChat Pay",
"order_id": "YOUR_ORDER_ID",
"trade_id": "ed71a5db-8e1c-a883-d062-ccbb4005b914",
"description": "test order",
"demo": "",
"state": "paid",
"fund_flow_status": "2",
"fund_flow_description": "settled"}
],
"count": 2
}
}
Información adicional:
Descripción de los parámetros de respuesta:
| Parámetro | Tipo | Descripción |
|---|---|---|
| time_zone | String | Zona horaria de liquidación, usually the time zone of the merchant's country of regestration |
| store_name | String | Nombre de la tienda del comercio |
| date | String | Fecha de finalización de la transacción |
| settlement_currency | String | Moneda de liquidación, ISO 4217 |
| amount | String | Settlement amount |
| fee | String | Transaction fees |
| net_value | String | Net value before VAT deduction |
| vat | String | VAT on fees |
| type | String | Transaction type: Payment or Refund |
| sub_pay_method | String | Método de pago |
| order_id | String | Merchant transaction ID |
| trade_id | String | Yabandpay transaction ID |
| description | String | Transaction description |
| demo | String | Merchant-defined field |
| state | String | Transaction status: Paid or Refunded |
| fund_flow_status | String | Funds status code |
| fund_flow_description | String | Funds status description |
| count | String | Number of records returned |
Funds status codes and descriptions:
| fund_flow_status | fund_flow_description |
|---|---|
| 0 | uncleared |
| 1 | cleared |
| 2 | settled |