Documentation/Référence API

API REFERENCE

Rapports de compensation

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

Rapports de compensation

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.

Paramètres

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

Cette API récupère les rapports de compensation YabandPay.

Conseil

  1. Chaque jour à 4 (heure des Pays-Bas), YabandPay compense toutes les transactions de la veille et génère les rapports. Nous recommandons d’effectuer la consultation après 7, heure des Pays-Bas.
  1. Un rapport de compensation est généré chaque jour pour chaque magasin et chaque moyen de paiement. Par exemple, un magasin utilisant deux moyens de paiement reçoit 2 rapports par jour.
  1. Seuls les comptes super administrateurs du marchand peuvent appeler cette API. Les comptes opérateur et caissier ne sont pas autorisés à l’appeler.
ParamètreTypeDescriptionObligatoire
userStringUID du compte super administrateurObligatoire
signStringSignatureObligatoire
methodStringv3.GetTradebillObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | command | String | getTradebill | Obligatoire | | bill_date | String | Date de facturation au format dd-MM-yyyy. Les demandes de téléchargement ne sont prises en charge que pour les factures des trois derniers mois. | Obligatoire | | nonce_string | String | Chaîne aléatoire de 32 caractères maximum | Obligatoire |

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"bill_date=2024-02-19&command=getTradebill&method=v3.GetTradebill&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
  "user": "040268",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.GetTradebill",
  "time": 1708422208,
  "data": {
    "command": "getTradebill",
    "bill_date": "19-02-2024",
    "nonce_string": "tw5be5b7sry5prm96s"

  }
}

Exemple de réponse :

{
	"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
    }
}

Informations complémentaires :

Description des paramètres de réponse :
ParamètreTypeDescription
time_zoneStringFuseau horaire de compensation, généralement celui du pays d’enregistrement du marchand
MIDStringMID du marchand
merchant_nameStringNom du marchand
store_nameStringNom du magasin du marchand
sub_pay_methodStringMoyen de paiement
settlement_currencyStringDevise de règlement, norme ISO 4217
number_of_paymentStringNombre de transactions de paiement
amount_of_paymentStringMontant total des transactions de paiement
number_of_refundStringNombre de transactions de remboursement
amount_of_refundStringMontant total des transactions de remboursement
feeStringFrais de transaction
net_valueStringMontant net des transactions avant déduction de la TVA
vatStringTVA sur l’ensemble des frais de transaction
StatusCodeMessage
stateStringStatut de règlement : processing ou settled
transaction_dateStringDate de la transaction
due_dateStringDate de règlement prévue
settlement_dateStringDate réelle de règlement
clearing_idStringID de compensation
countStringNombre d’enregistrements renvoyés