API REFERENCE
Détails des transactions
Paramètres
| Parameter | Type | Description | Obligatoire |
|---|---|---|---|
| data.command | string | getTradebillinfo | ✓ |
| data.clearing_id | string | 清算报表ID | — |
| data.start_time | string | 交易开始时间 | — |
| data.end_time | string | 交易结束时间 | — |
| data.nonce_string | string | 随机字符串，不长于32位 | ✓ |
Cette API consulte les détails des transactions figurant dans les rapports de compensation YabandPay, ou les détails des transactions sur une plage de dates.
Conseil
- Les détails ne concernent que les transactions impliquant une compensation de fonds, par exemple les paiements ou remboursements réussis. Les annulations et les autorisations, entre autres, ne sont pas incluses.
- La plage de dates interrogée ne doit pas dépasser un an.
- Les transactions datant de plus de 7 ans ne peuvent pas être consultées.
- 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 | getTradebillinfo | Obligatoire | | clearing_id | String | ID du rapport de compensation | Facultatif | | start_time | String | Heure de début de la transaction | Facultatif | | end_time | String | Heure de fin de la transaction | Facultatif | | 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
"clearing_id=M20240302001503350733&command=getTradebillinfo&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 : rapport de compensation
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"clearing_id": "M20240220001503109569",
"nonce_string": "tw5be5b7sry5prm96s"
}
}
Exemple de requête : plage de dates
{
"user": "036870",
"sign": "YOUR_SIGNATURE",
"method": "v3.GetTradebill",
"time": 1708422208,
"data": {
"command": "getTradebillInfo",
"start_time": "1716393600",
"end_time" : "1716566340",
"nonce_string": "g46a5g156rt4784ghb1b"
}
}
Exemple de réponse :
{
"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
}
}
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 |
| store_name | String | Nom du magasin du marchand |
| date | String | Date de finalisation de la transaction |
| settlement_currency | String | Devise de règlement, norme ISO 4217 |
| amount | String | Montant du règlement |
| fee | String | Frais de transaction |
| net_value | String | Montant net avant déduction de la TVA |
| vat | String | TVA sur les frais |
| type | String | Type de transaction : Payment ou Refund |
| sub_pay_method | String | Moyen de paiement |
| order_id | String | ID de transaction du marchand |
| trade_id | String | ID de transaction YabandPay |
| description | String | Description de la transaction |
| demo | String | Champ défini par le marchand |
| state | String | Statut de la transaction : Paid ou Refunded |
| fund_flow_status | String | Code du statut des fonds |
| fund_flow_description | String | Description du statut des fonds |
| count | String | Nombre d’enregistrements renvoyés |
Codes et descriptions des statuts des fonds :
| fund_flow_status | fund_flow_description |
|---|---|
| 0 | Non compensé |
| 1 | Compensé |
| 2 | Réglé |