API REFERENCE
Detalhes da transação
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| 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 os detalhes de transações nos relatórios de liquidação YabandPay ou consulta detalhes das transações por intervalo de datas.
Dica
- Os detalhes incluem apenas transações que envolvem liquidação de fundos, como pagamentos ou reembolsos bem-sucedidos. Não incluem transações como cancelamentos e autorizações.
- Ao consultar por intervalo de datas, o intervalo não pode exceder um ano.
- Não é possível consultar transações com mais de 7 anos.
- Somente contas de superadministrador do estabelecimento podem chamar esta API. Contas de operador e caixa não têm autorização para chamá-la.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | UID da conta de superadministrador | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.GetTradebill | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| command | String | getTradebillinfo | Obrigatório |
| clearing_id | String | ID do relatório de liquidação | Opcional |
| start_time | String | Hora de início da transação | Opcional |
| end_time | String | Hora de término da transação | Opcional |
| nonce_string | String | Cadeia aleatória com no máximo 32 caracteres | Obrigatório |
Signature example:
Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL
"clearing_id=M20240302001503350733&command=getTradebillinfo&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Sign stringA using secret_key
A assinatura resultante é:
"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"
}
}
Response example:
{
"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
}
}
Additional information:
Response parameter descriptions:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| time_zone | String | Fuso horário da liquidação, geralmente o fuso horário do país de registro do estabelecimento |
| store_name | String | Nome da loja do estabelecimento |
| date | String | Data de conclusão da transação |
| settlement_currency | String | Moeda de liquidação, ISO 4217 |
| amount | String | Valor da liquidação |
| fee | String | Taxas da transação |
| net_value | String | Valor líquido antes da dedução do IVA |
| vat | String | IVA sobre as taxas |
| type | String | Tipo de transação: Payment ou Refund |
| sub_pay_method | String | Método de pagamento |
| order_id | String | ID da transação do estabelecimento |
| trade_id | String | ID da transação Yabandpay |
| description | String | Descrição da transação |
| demo | String | Campo definido pelo estabelecimento |
| state | String | Status da transação: Paid ou Refunded |
| fund_flow_status | String | Código do status dos fundos |
| fund_flow_description | String | Descrição do status dos fundos |
| count | String | Número de registros retornados |
Funds status codes and descriptions:
| fund_flow_status | fund_flow_description |
|---|---|
| 0 | uncleared |
| 1 | cleared |
| 2 | settled |