API REFERENCE
Zahlungsaufteilung erstellen
Tipp
YabandPay sendet asynchrone Benachrichtigungen von den unten aufgeführten IP-Adressen. Wir empfehlen, diese in die Firewall-Zulassungsliste aufzunehmen.
8.211.41.31 8.211.10.244 8.211.8.123
Diese API erstellt eine Zahlungsaufteilung für eine erfolgreich bezahlte YabandPay-Bestellung.
Tipp
Hinweis:
- Für jede Zahlungsbestellung können höchstens 10 Zahlungsaufteilungen erstellt werden.
- Bevor Sie diese API aufrufen, müssen Sie im Voraus einen Zahlungsaufteilungsplan konfigurieren und genehmigen lassen.
- Wenn split_completed den Wert 1 hat, ist die Zahlungsaufteilung abgeschlossen und es können keine weiteren Aufteilungen eingeleitet werden.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| user | String | UID des Superadmin-Kontos | Erforderlich |
| sign | String | Signature | Erforderlich |
| method | String | v3.SplitPayment | Erforderlich |
| time | Long | Timestamp | Erforderlich |
- Parameter
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| command | String | createSplitPayment | Erforderlich |
| trade_id | String | trade_id der bezahlten YabandPay-Bestellung | Erforderlich |
| split_solution_id | String | ID des im Verwaltungsportal konfigurierten Zahlungsaufteilungsplans | Erforderlich |
| currency | String | Abrechnungswährung der ursprünglichen Bestellung | Erforderlich |
| notify_url | String | URL für asynchrone Benachrichtigungen zur Zahlungsaufteilung | Erforderlich |
| nonce_string | String | Zufällige Zeichenfolge mit höchstens 32 Zeichen | Erforderlich |
| split_completed | String | Gibt an, ob die Zahlungsaufteilung abgeschlossen ist: 0: Nein, 1: Ja | Erforderlich |
| reference_id | String | Eindeutige, vom Händler festgelegte ID der Zahlungsaufteilung, höchstens 32 Zeichen | Erforderlich |
| reference | String | Beschreibung, höchstens 128 Zeichen | Optional |
| receivers | String | Angaben zum Empfänger der Zahlungsaufteilung: eine JSON-Zeichenfolge, die mit json_encode aus einem zweidimensionalen Array erzeugt wird | Für eine Zahlungsaufteilung erforderlich. Lassen Sie diesen Parameter aus, wenn Sie die Bestellung nur als vollständig aufgeteilt markieren möchten, ohne Empfängerangaben zu übermitteln. |
| receivers.mid | String | MID des Empfängers der Zahlungsaufteilung | Bei einer Zahlungsaufteilung erforderlich |
| receivers.detail_reference_id | String | Benutzerdefinierte Detailnummer der Zahlungsaufteilung für den Empfänger | Bei einer Zahlungsaufteilung erforderlich |
| receivers.split_amount | String | Betrag der Zahlungsaufteilung; zum Beispiel muss 24.99 als 24.99 angegeben werden | Bei einer Zahlungsaufteilung erforderlich |
| receivers.role | String | Rolle des Empfängers der Zahlungsaufteilung | Bei einer Zahlungsaufteilung erforderlich |
| receivers.description | String | Beschreibung des Details der Zahlungsaufteilung | Bei einer Zahlungsaufteilung optional |
Empfängerrollen
| Parameter receivers.role | Beschreibung |
|---|---|
| 1 | Unterhändler |
| 2 | Lieferant |
| 3 | Vertriebspartner |
| 4 | Steuerabzugs- und Überweisungsdienst |
| 5 | Technische Dienstleistungen |
| 6 | Influencer |
| 7 | Sonstiges |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"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"
Signieren Sie stringA mit secret_key.
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel:
{
"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\"}]"
}
}
Antwortbeispiel:
{
"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": ""
}
- Antwortparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| user | String | UID des Kassiererkontos |
| split_id | String | Bei der Zahlungsaufteilung erzeugte Auftragsnummer |
| trade_id | String | trade_id der YabandPay-Bestellung |
| split_solution_id | String | ID des Zahlungsaufteilungsplans |
| state | String | Status: Processing, Success, Failed, Cancelled |
| merchant_mid | String | MID des Händlers, der die Zahlung aufteilt |
| merchant_name | String | Name des Händlers, der die Zahlung aufteilt |
| created_at | String | Erstellungszeitstempel |
| currency | String | Abrechnungswährung der Bestellung |
| notify_url | String | URL für asynchrone Benachrichtigungen |
| split_completed | String | Gibt an, ob die Zahlungsaufteilung abgeschlossen ist: 0: Nein, 1: Ja |
| reference_id | String | Händler-ID der Zahlungsaufteilung, höchstens 32 Zeichen |
| reference | String | Beschreibung, höchstens 128 Zeichen |
| type | String | Typ: splitPayment oder splitRefund |
| receivers | String | Angaben zum Empfänger der Zahlungsaufteilung im Format JSON |
| receivers.merchant_mid | String | MID des Empfängers der Zahlungsaufteilung |
| receivers.merchant_name | String | Händlername des Empfängers der Zahlungsaufteilung |
| receivers.split_detail_id | String | Bei der Zahlungsaufteilung erzeugte Detailnummer |
| receivers.detail_reference_id | String | Händlerseitige Detailnummer der Zahlungsaufteilung |
| receivers.split_type | String | Art der Zahlungsaufteilung: Split oder Return |
| receivers.split_amount | String | Betrag der Zahlungsaufteilung |
| receivers.role | String | Rolle des Empfängers der Zahlungsaufteilung |
| receivers.result | String | Status: Processing, Success, Failed, Cancelled |
| receivers.description | String | Beschreibung des Details der Zahlungsaufteilung |
| receivers.error_msg | String | Fehlermeldung zum Detail der Zahlungsaufteilung; wird ausgefüllt, wenn das Ergebnis Failed lautet |
