API REFERENCE
Rapports de compensation
Paramètres
| Parameter | Type | Description | Obligatoire |
|---|---|---|---|
| data.command | string | getTradebill | ✓ |
| data.bill_date | string | 账单日期 格式dd-MM-yyyy 仅支持三个月内的账单下载申请。 | ✓ |
| data.nonce_string | string | 随机字符串,不长于32位 | ✓ |
Cette API récupère les rapports de compensation YabandPay.
Conseil
- 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.
- 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.
- 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ètre | Type | Description | Obligatoire |
|---|---|---|---|
| user | String | UID du compte super administrateur | Obligatoire |
| sign | String | Signature | Obligatoire |
| method | String | v3.GetTradebill | Obligatoire |
| time | Long | Timestamp | Obligatoire |
- 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ètre | Type | Description |
|---|---|---|
| time_zone | String | Fuseau horaire de compensation, généralement celui du pays d’enregistrement du marchand |
| MID | String | MID du marchand |
| merchant_name | String | Nom du marchand |
| store_name | String | Nom du magasin du marchand |
| sub_pay_method | String | Moyen de paiement |
| settlement_currency | String | Devise de règlement, norme ISO 4217 |
| number_of_payment | String | Nombre de transactions de paiement |
| amount_of_payment | String | Montant total des transactions de paiement |
| number_of_refund | String | Nombre de transactions de remboursement |
| amount_of_refund | String | Montant total des transactions de remboursement |
| fee | String | Frais de transaction |
| net_value | String | Montant net des transactions avant déduction de la TVA |
| vat | String | TVA sur l’ensemble des frais de transaction |
| Status | Code | Message |
| state | String | Statut de règlement : processing ou settled |
| transaction_date | String | Date de la transaction |
| due_date | String | Date de règlement prévue |
| settlement_date | String | Date réelle de règlement |
| clearing_id | String | ID de compensation |
| count | String | Nombre d’enregistrements renvoyés |
