API REFERENCE
Een betaalverdeling aanmaken
Tip
YabandPay verstuurt asynchrone meldingen vanaf de onderstaande IP-adressen. We raden aan deze toe te voegen aan de allowlist van uw firewall.
8.211.41.31 8.211.10.244 8.211.8.123
Deze API maakt een betaalverdeling aan voor een geslaagde YabandPay-bestelling.
Tip
Opmerking:
- Per betaalorder kunnen maximaal 10 betaalverdelingen worden aangemaakt;
- Voordat u deze API aanroept, moet u een betaalverdelingsregeling configureren en goedkeuring verkrijgen;
- Wanneer split_completed gelijk is aan 1, is de betaalverdeling voltooid en kunnen geen verdere betaalverdelingen meer worden gestart.
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 | createSplitPayment | Verplicht |
| trade_id | String | trade_id van de betaalde YabandPay-order | Verplicht |
| split_solution_id | String | ID van de betaalverdelingsregeling die in het beheerportaal is geconfigureerd | Verplicht |
| currency | String | Afwikkelingsvaluta van de oorspronkelijke order, Settlement Currency | Verplicht |
| notify_url | String | URL voor asynchrone melding over de betaalverdeling | Verplicht |
| nonce_string | String | Willekeurige tekenreeks van maximaal 32 tekens | Verplicht |
| split_completed | String | Of de betaalverdeling is voltooid: 0: Nee, 1: Ja | Verplicht |
| reference_id | String | Unieke, door de merchant gedefinieerde ID van de betaalverdeling, maximaal 32 tekens | Verplicht |
| reference | String | Beschrijving, maximaal 128 tekens | Optioneel |
| receivers | String | Informatie over de ontvanger van de betaalverdeling; een JSON-tekenreeks die met json_encode wordt gegenereerd op basis van een tweedimensionale array | Vereist voor een betaalverdeling. Laat deze parameter weg als u de order alleen als volledig verdeeld wilt markeren zonder ontvangersgegevens op te geven. |
| receivers.mid | String | MID van de ontvanger van de betaalverdeling | Vereist voor een betaalverdeling |
| receivers.detail_reference_id | String | Aangepast detailnummer voor de ontvanger van de betaalverdeling | Vereist voor een betaalverdeling |
| receivers.split_amount | String | Bedrag van de betaalverdeling; bijvoorbeeld, 24.99 moet worden geschreven als 24.99 | Vereist voor een betaalverdeling |
| receivers.role | String | Rol van de ontvanger van de betaalverdeling | Vereist voor een betaalverdeling |
| receivers.description | String | Beschrijving van het detail van de betaalverdeling | Optioneel voor een betaalverdeling |
Rollen van ontvangers
| parameter receivers.role | Beschrijving |
|---|---|
| 1 | Submerchant |
| 2 | Leverancier |
| 3 | Distributeur |
| 4 | Dienst voor inhouding en afdracht van belastingen |
| 5 | Technische diensten |
| 6 | Influencer |
| 7 | Overige |
Voorbeeld van een handtekening:
Parameters op volgorde samengevoegd tot een querystring in URL-stijl
"command=createSplitPayment¤cy=EUR&method=v3.SplitPayment&nonce_string=1704693939376¬ify_url=https://www.yabandpay.com/notify&receivers=[{"mid":104006,"split_amount":0.01,"role":7,"detail_reference_id":"123456-2","description":"分账描述2"}]&reference=1704693939376&reference_id=1704693939376&split_completed=0&split_solution_id=102&time=1704693939&trade_id=23a199b8-b82b-81b0-a4cd-8485ca4feb3c&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": 1704693939,
"data": {
"command": "createSplitPayment",
"trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
"split_solution_id": "102",
"currency": "EUR",
"notify_url": "https://www.yabandpay.com/notify",
"nonce_string": "1704693939376",
"split_completed": 0,
"reference_id": "1704693939376",
"reference": "1704693939376",
"receivers": "[{\"mid\":104006,\"split_amount\":0.01,\"role\":7,\"detail_reference_id\":\"123456-2\",\"description\":\"分账描述2\"}]"
}
}
Voorbeeld van een antwoord:
{
"status": true,
"code": "200",
"data": {
"user": "9212776037",
"split_id": "20240108162134979318",
"trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
"split_solution_id": "102",
"state": "Processing",
"merchant_mid": "102300",
"merchant_name": "Yaband Telecom B.V.",
"created_at": "1704702094",
"currency": "EUR",
"notify_url": "https://www.yabandpay.com/notify",
"split_completed": 0,
"reference_id": "1704693939376",
"reference": "1704693939376",
"receivers": [
{
"merchant_mid": "104006",
"merchant_name": "ybtest",
"split_detail_id": "20240108162134979318-1",
"detail_reference_id": "123456-2",
"split_type": "Split",
"split_amount": "0.01",
"role": "7",
"result": "Processing",
"description": "分账描述2",
"error_msg": null
}
],
"type": "splitPayment"
},
"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 |
| 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.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 |
