API REFERENCE
Relatórios de liquidação
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.command | string | getTradebill | ✓ |
| data.bill_date | string | 账单日期 格式dd-MM-yyyy 仅支持三个月内的账单下载申请。 | ✓ |
| data.nonce_string | string | 随机字符串,不长于32位 | ✓ |
Esta API recupera relatórios de liquidação YabandPay.
Dica
- A YabandPay liquida diariamente às 4 a.m. (horário dos Países Baixos) todas as transações do dia anterior e gera relatórios. Recomendamos consultar após 7 a.m., horário dos Países Baixos.
- Um relatório de liquidação é gerado diariamente para cada loja e método de pagamento. Por exemplo, uma loja com dois métodos de pagamento recebe 2 relatórios por dia.
- 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 | getTradebill | Obrigatório |
| bill_date | String | Data do extrato no formato dd-MM-yyyy. Só há suporte para solicitações de download de extratos dos últimos três meses. | Obrigatório |
| 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
"bill_date=2024-02-19&command=getTradebill&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"
Sign stringA using secret_key
A assinatura resultante é:
"YOUR_SIGNATURE"
Request example:
{
"user": "040268",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebill",
"bill_date": "19-02-2024",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Response example:
{
"status": true,
"code": 200,
"message": "",
"data": {
"tradebill": [
{
"time_zone": "GMT+1",
"MID": 102300,
"merchant_name": "Yaband Telecom B.V.",
"store_name": "YabandPay",
"sub_pay_method": "WeChat Pay",
"settlement_currency": "EUR",
"number_of_payment": 8,
"amount_of_payment": "53.25",
"number_of_refund": 0,
"amount_of_refund": "0.00",
"fee": "0.9",
"net_value": "52.35",
"vat": "0.19",
"state": "settled",
"transaction_date": "2024-02-19",
"due_date": "2024-02-21",
"settlement_date": "2024-02-21",
"clearing_id": "M20240220001503109569"
},
{
"time_zone": "GMT+1",
"MID": 102300,
"merchant_name": "Yaband Telecom B.V.",
"store_name": "YabandPay",
"sub_pay_method": "Alipay",
"settlement_currency": "EUR",
"number_of_payment": 9,
"amount_of_payment": "67.85",
"number_of_refund": 0,
"amount_of_refund": "0.00",
"fee": "1.23",
"net_value": "66.62",
"vat": "0.20",
"state": "settled",
"transaction_date": "2024-02-19",
"due_date": "2024-02-21",
"settlement_date": "2024-02-21",
"clearing_id": "M20240220001503109614"
}
],
"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 |
| MID | String | MID do estabelecimento |
| merchant_name | String | Nome do estabelecimento |
| store_name | String | Nome da loja do estabelecimento |
| sub_pay_method | String | Método de pagamento |
| settlement_currency | String | Moeda de liquidação, ISO 4217 |
| number_of_payment | String | Número de transações de pagamento |
| amount_of_payment | String | Valor total das transações de pagamento |
| number_of_refund | String | Número de transações de reembolso |
| amount_of_refund | String | Valor total das transações de reembolso |
| fee | String | Taxas de transação |
| net_value | String | Valor líquido da transação antes da dedução do IVA |
| vat | String | IVA sobre todas as taxas de transação |
| state | String | Status da liquidação: processing ou settled |
| transaction_date | String | Data em que a transação ocorreu |
| due_date | String | Data de liquidação prevista |
| settlement_date | String | Data real de liquidação |
| clearing_id | String | ID de liquidação |
| count | String | Número de registros retornados |
