Documentação/Referência da API

API REFERENCE

Relatórios de liquidação

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Relatórios de liquidação

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters3

Required fields first

清算报表

commandRequiredstringdata.commandgetTradebill
bill_dateRequiredstringdata.bill_date账单日期 格式dd-MM-yyyy 仅支持三个月内的账单下载申请。
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Parâmetros

ParameterTypeDescriçãoObrigatório
data.commandstringgetTradebill✓
data.bill_datestring账单日期 格式dd-MM-yyyy 仅支持三个月内的账单下载申请。✓
data.nonce_stringstring随机字符串,不长于32位✓

Esta API recupera relatórios de liquidação YabandPay.

Dica

  1. 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.
  1. 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.
  1. 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âmetroTipoDescriçãoObrigatório
userStringUID da conta de superadministradorObrigatório
signStringSignatureObrigatório
methodStringv3.GetTradebillObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
commandStringgetTradebillObrigatório
bill_dateStringData 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_stringStringCadeia aleatória com no máximo 32 caracteresObrigató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âmetroTipoDescrição
time_zoneStringFuso horário da liquidação, geralmente o fuso horário do país de registro do estabelecimento
MIDStringMID do estabelecimento
merchant_nameStringNome do estabelecimento
store_nameStringNome da loja do estabelecimento
sub_pay_methodStringMétodo de pagamento
settlement_currencyStringMoeda de liquidação, ISO 4217
number_of_paymentStringNúmero de transações de pagamento
amount_of_paymentStringValor total das transações de pagamento
number_of_refundStringNúmero de transações de reembolso
amount_of_refundStringValor total das transações de reembolso
feeStringTaxas de transação
net_valueStringValor líquido da transação antes da dedução do IVA
vatStringIVA sobre todas as taxas de transação
stateStringStatus da liquidação: processing ou settled
transaction_dateStringData em que a transação ocorreu
due_dateStringData de liquidação prevista
settlement_dateStringData real de liquidação
clearing_idStringID de liquidação
countStringNúmero de registros retornados