API REFERENCE
Een betaalverdeling opvragen
Deze API vraagt bestaande betaalverdeelorders en retourorders voor betaalverdelingen van YabandPay op.
API-URL：https://mapi.yabandpay.com/Payments
Methode：POST
POST gegevenstype：Json
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| user | String | UID van het superbeheerderaccount | Verplicht |
| sign | String | Signature | Verplicht |
| method | String | v3.SplitPayment | Verplicht |
| time | Long | Timestamp | Verplicht |
- Parameters
| Parameter | Type | Beschrijving | Verplicht |
|---|---|---|---|
| command | String | querySplitPayment | Verplicht |
| nonce_string | String | Willekeurige tekenreeks van maximaal 32 tekens | Verplicht |
| reference_id | String | ID van de betaalverdeling van de merchant, maximaal 32 tekens | Verplicht |
| split_id | String | Nummer van de betaalverdeelorder dat bij het aanmaken van de betaalverdeling is gegenereerd | Verplicht |
| split_type | String | Type betaalverdeling: 0: Split (betaalverdeling), 1: Return (terugstorting van een betaalverdeling). Alleen deze 2 typen worden ondersteund. Als dit veld ontbreekt, worden alle betaalverdelingen en retourgegevens voor split_id opgevraagd. | Optioneel |
| split_detail_id | String | Detail van de betaalverdeelorder dat bij het aanmaken is gegenereerd; kan samen met split_type worden gebruikt om de bijbehorende details van de betaalverdeelorder op te vragen | Optioneel |
| refund_split_detail_id | String | Alleen van toepassing wanneer split_type een terugstorting van een betaalverdeling aangeeft; vraagt de bijbehorende retourorderdetails op | Optioneel |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"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"
Onderteken stringA met secret_key
De gegenereerde handtekening is:
"YOUR_SIGNATURE"
Voorbeeld van een aanvraag:
{
"user": "9212776037",
"sign": "YOUR_SIGNATURE",
"method": "v3.SplitPayment",
"time": 1703836221,
"data": {
"command": "querySplitPayment",
"nonce_string": "7vccb9qkplvtxl22km",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
Voorbeeld van een antwoord:
{
"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": ""
}
- Antwoordparameters
| Parameter | Type | Beschrijving |
|---|---|---|
| user | String | UID van het kassieraccount |
| split_id | String | Nummer van de betaalverdeelorder dat bij het aanmaken van de betaalverdeling is gegenereerd |
| trade_id | String | trade_id van de YabandPay-order |
| split_solution_id | String | ID van de betaalverdelingsregeling |
| state | String | Status: Processing, Success, Failed, Cancelled |
| merchant_mid | String | MID van de merchant die de betaling verdeelt |
| merchant_name | String | Naam van de merchant die de betaling verdeelt |
| created_at | String | Aanmaaktijdstempel |
| currency | String | Afwikkelingsvaluta van de order, Settlement Currency |
| notify_url | String | URL voor asynchrone melding |
| split_completed | String | Of de betaalverdeling is voltooid: 0: Nee, 1: Ja |
| reference_id | String | ID van de betaalverdeling van de merchant, maximaal 32 tekens |
| reference | String | Beschrijving, maximaal 128 tekens |
| receivers | String | Informatie over de ontvanger van de betaalverdeling in JSON-indeling |
| receivers.merchant_mid | String | MID van de ontvanger van de betaalverdeling |
| receivers.merchant_name | String | Merchantnaam van de ontvanger van de betaalverdeling |
| receivers.split_detail_id | String | Nummer van het detail van de betaalverdeling dat bij het aanmaken is gegenereerd |
| receivers.detail_reference_id | String | Nummer van het detail van de betaalverdeling van de merchant |
| receivers.split_type | String | Type betaalverdeling: Split of Return |
| receivers.split_amount | String | Bedrag van de betaalverdeling |
| receivers.role | String | Rol van de ontvanger van de betaalverdeling |
| receivers.result | String | Status: Processing, Success, Failed, Cancelled |
| receivers.description | String | Beschrijving van het detail van de betaalverdeling |
| receivers.error_msg | String | Foutmelding voor het detail van de betaalverdeling; ingevuld wanneer het resultaat Failed is |