API REFERENCE
Consulter une répartition de paiement
Paramètres
| Parameter | Type | Description | Obligatoire |
|---|---|---|---|
| data.command | string | querySplitPayment | ✓ |
| data.nonce_string | string | 随机字符串，不长于32位 | ✓ |
| data.reference_id | string | 商户方的分账id，不长于32位 | ✓ |
| data.split_id | string | 创建分账后的分账单号 | ✓ |
| data.split_type | string | 分账类型, 0 ：Split 分账 , 1 ： Return 分账回退，只提供这2种类型。如果没有传，则查询 split_id 所有分账单和回退信息 | — |
| data.split_detail_id | string | 创建分账后的分账单号的分账单的明细，可配合 split_type 查询对应分账单的明细的信息 | — |
| data.refund_split_detail_id | string | 只有 split_type 类型为分账回退时才有效，查询对应分账回退单的明细的信息 | — |
Cette API consulte les ordres de répartition de paiement et les ordres de retour de répartition YabandPay existants.
| Paramètre | Type | Description | Obligatoire |
|---|---|---|---|
| user | String | UID du compte super administrateur | Obligatoire |
| sign | String | Signature | Obligatoire |
| method | String | v3.SplitPayment | Obligatoire |
| time | Long | Timestamp | Obligatoire |
- Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | command | String | querySplitPayment | Obligatoire | | nonce_string | String | Chaîne aléatoire de 32 caractères maximum | Obligatoire | | reference_id | String | ID de répartition de paiement du marchand, limité à 32 caractères | Obligatoire | | split_id | String | Numéro d’ordre de répartition du paiement généré lors de sa création | Obligatoire | | split_type | String | Type de répartition : 0 : Split (répartition du paiement), 1 : Return (retour de répartition). Seuls ces 2 types sont pris en charge. Si ce paramètre est omis, toutes les répartitions et tous les retours liés à split_id sont consultés. | Facultatif | | split_detail_id | String | Détail de l’ordre de répartition généré lors de sa création ; peut être utilisé avec split_type pour consulter les détails de l’ordre de répartition correspondant | Facultatif | | refund_split_detail_id | String | Pris en compte uniquement lorsque split_type indique un retour de répartition ; consulte les détails de l’ordre de retour correspondant | Facultatif |
Exemple de signature :
Paramètres triés et concaténés dans une chaîne de requête au format URL
"command=querySplitPayment&method=v3.SplitPayment&nonce_string=7vccb9qkplvtxl22km&reference_id=123456&split_id=20231229110618372777&time=1703836221&trade_id=67943b0b-ca6b-aa96-5fb1-e354975f1ec4&user=9212776037"
Signer stringA avec secret_key
La signature obtenue est :
"YOUR_SIGNATURE"
Exemple de requête :
{
"user": "9212776037",
"sign": "YOUR_SIGNATURE",
"method": "v3.SplitPayment",
"time": 1703836221,
"data": {
"command": "querySplitPayment",
"nonce_string": "7vccb9qkplvtxl22km",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
Exemple de réponse :
{
"status": true,
"code": "200",
"data": {
"split_id": "20231229110618372777",
"state": "Success",
"merchant_mid": "123",
"merchant_name": "123",
"reference_id": "123456",
"reference": "5464654561",
"split_solution_id": "104",
"created_at": "1703819178",
"notify_url": null,
"currency": "EUR",
"receivers": [
{
"merchant_mid": "222",
"merchant_name": "222",
"detail_reference_id": "123456-1",
"split_detail_id": "20231229110618372777-2",
"refund_split_detail_id": "20231229110618372777-2-1",
"split_type": "Return",
"split_amount": "1.00",
"role": "1",
"result": "Success",
"description": "分账回退描述2",
"error_msg": null
},
{
"merchant_mid": "111",
"merchant_name": "111",
"detail_reference_id": "123456-1",
"split_detail_id": "20231229110618372777-1",
"refund_split_detail_id": "20231229110618372777-1-1",
"split_type": "Return",
"split_amount": "2.00",
"role": "2",
"result": "Success",
"description": "分账回退描述1",
"error_msg": null
},
{
"merchant_mid": "222",
"merchant_name": "222",
"detail_reference_id": "123456-2",
"split_detail_id": "20231229110618372777-2",
"refund_split_detail_id": "",
"split_type": "Split",
"split_amount": "5.00",
"role": "1",
"result": "Success",
"description": "分账描述2",
"error_msg": null
},
{
"merchant_mid": "111",
"merchant_name": "111",
"detail_reference_id": "123456-1",
"split_detail_id": "20231229110618372777-1",
"refund_split_detail_id": "",
"split_type": "Split",
"split_amount": "10.00",
"role": "2",
"result": "Success",
"description": "分账描述1",
"error_msg": null
}
],
"split_completed": 1
},
"message": ""
}
- Response Parameters
| Paramètre | Type | Description |
|---|---|---|
| user | String | UID du compte caissier |
| split_id | String | Numéro d’ordre de répartition du paiement généré lors de sa création |
| trade_id | String | trade_id de la commande YabandPay |
| split_solution_id | String | ID de la règle de répartition du paiement |
| state | String | Status: Processing, Success, Failed, Cancelled |
| merchant_mid | String | MID du marchand qui répartit le paiement |
| merchant_name | String | Nom du marchand qui répartit le paiement |
| created_at | String | Horodatage de création |
| currency | String | Devise de règlement de la commande, Settlement Currency |
| notify_url | String | URL de notification asynchrone |
| split_completed | String | Indique si la répartition du paiement est terminée : 0 : Non, 1 : Oui |
| reference_id | String | ID de répartition de paiement du marchand, limité à 32 caractères |
| reference | String | Description, limitée à 128 caractères |
| receivers | String | Informations du bénéficiaire de la répartition au format JSON |
| receivers.merchant_mid | String | MID du bénéficiaire de la répartition |
| receivers.merchant_name | String | Nom du marchand bénéficiaire de la répartition |
| receivers.split_detail_id | String | Numéro de détail de la répartition généré lors de sa création |
| receivers.detail_reference_id | String | Numéro de détail de la répartition du marchand |
| receivers.split_type | String | Type de détail de la répartition : Split ou Return |
| receivers.split_amount | String | Montant réparti |
| receivers.role | String | Rôle du bénéficiaire de la répartition |
| receivers.result | String | Status: Processing, Success, Failed, Cancelled |
| receivers.description | String | Description du détail de la répartition |
| receivers.error_msg | String | Message d’erreur du détail de la répartition, renseigné en cas d’échec |