API REFERENCE
Een betaalverdeling terugstorten
Deze API stort een geslaagde betaalverdeling van YabandPay terug.
Tip
Opmerking: Elke betaalverdeling kan maximaal 10 keer worden teruggestort.
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 | returnSplitPayment | Verplicht |
| currency | String | Afwikkelingsvaluta van de order, Settlement Currency | Verplicht |
| notify_url | String | URL voor asynchrone melding | Verplicht |
| nonce_string | String | Willekeurige tekenreeks van maximaal 32 tekens | Verplicht |
| split_id | String | ID van de betaalverdeelorder dat bij het aanmaken is geretourneerd | Verplicht |
| reference_id | String | Unieke ID van de terugstorting van de betaalverdeling van de merchant, maximaal 32 tekens | Verplicht |
| reference | String | Beschrijving, maximaal 128 tekens | Optioneel |
| receivers | String | Informatie over de ontvanger van de betaalverdeling in JSON-indeling | Verplicht |
| receivers.mid | String | MID van de ontvanger van de betaalverdeling | Verplicht |
| receivers.split_detail_id | String | ID van het detail van de betaalverdeling dat bij het aanmaken is geretourneerd | Verplicht |
| receivers.detail_reference_id | String | Nummer van het detail van de terugstorting voor de ontvanger | Verplicht |
| receivers.split_amount | String | Bedrag van de betaalverdeling | Verplicht |
| receivers.description | String | Beschrijving van het detail van de betaalverdeling | Verplicht |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"command=returnSplitPayment¤cy=EUR&method=v3.SplitPayment&nonce_string=qxg9mzdxxh4pyi9fhb¬ify_url=https://www.yabandpay.com/notify&receivers=[{"mid":111,"split_amount":2,"split_detail_id":"20231229110618372777-1","detail_reference_id":"123456-1","description":"分账回退描述1"},{"mid":222,"split_amount":1,"split_detail_id":"20231229110618372777-2","detail_reference_id":"123456-1","description":"分账回退描述2"}]&reference=19398394598568&reference_id=123456&split_id=20231229110618372777&time=1703829894&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": 1703829894,
"data": {
"command": "returnSplitPayment",
"trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
"notify_url": "https://www.yabandpay.com/notify",
"reference_id": "123456",
"reference": "564635235",
"currency": "EUR",
"split_id": "20231229110618372777",
"nonce_string": "qxg9mzdxxh4pyi9fhb",
"receivers": "[{\"mid\":111,\"split_amount\":2,
\"split_detail_id\":\"20231229110618372777-1\",\"detail_reference_id\":\"123456-1\",\"description\":\"分账回退描述1\"},{\"mid\":222,\"split_amount\":1,
\"split_detail_id\":\"20231229110618372777-2\",\"detail_reference_id\":\"123456-1\",\"description\":\"分账回退描述2\"}]"
}
}
Voorbeeld van een antwoord:
{
"status": true,
"code": "200",
"data": {
"user": "9212776037",
"split_id": "20231229110618372777",
"trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
"state": "Success",
"merchant_mid": "123",
"merchant_name": "123",
"reference_id": "123456",
"reference": "564635235",
"split_solution_id": "104",
"notify_url": "https://www.yabandpay.com/notify",
"currency": "EUR",
"created_at": 1703831332,
"receivers": [
{
"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",
"result": "Success",
"description": "分账回退描述1",
"error_msg": null
},
{
"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",
"result": "Success",
"description": "分账回退描述2",
"error_msg": null
}
],
"type": "splitRefund"
},
"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 |
| split_solution_id | String | ID van de betaalverdelingsregeling |
| state | String | Status: Success of Failed |
| 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 |
| reference_id | String | ID van de betaalverdeling van de merchant, maximaal 32 tekens |
| reference | String | Beschrijving, maximaal 128 tekens |
| type | String | Type: splitPayment of splitRefund |
| 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.result | String | Status: Success of Failed |
| 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 |
