API REFERENCE
Zahlungsaufteilung zurückgeben
Diese API gibt eine erfolgreich abgeschlossene Zahlungsaufteilung von YabandPay zurück.
Tipp
Hinweis: Jede Zahlungsaufteilung kann höchstens 10-mal zurückgegeben 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 | returnSplitPayment | Erforderlich |
| currency | String | Abrechnungswährung der Bestellung | Erforderlich |
| notify_url | String | URL für asynchrone Benachrichtigungen | Erforderlich |
| nonce_string | String | Zufällige Zeichenfolge mit höchstens 32 Zeichen | Erforderlich |
| split_id | String | ID des bei der Erstellung zurückgegebenen Zahlungsaufteilungsauftrags | Erforderlich |
| reference_id | String | Eindeutige Händler-ID für die Rückgabe der Zahlungsaufteilung, höchstens 32 Zeichen | Erforderlich |
| reference | String | Beschreibung, höchstens 128 Zeichen | Optional |
| receivers | String | Angaben zum Empfänger der Zahlungsaufteilung im Format JSON | Erforderlich |
| receivers.mid | String | MID des Empfängers der Zahlungsaufteilung | Erforderlich |
| receivers.split_detail_id | String | Bei der Erstellung zurückgegebene Detail-ID der Zahlungsaufteilung | Erforderlich |
| receivers.detail_reference_id | String | Detailnummer der Rückgabe der Zahlungsaufteilung für den Empfänger | Erforderlich |
| receivers.split_amount | String | Betrag der Zahlungsaufteilung | Erforderlich |
| receivers.description | String | Beschreibung des Details der Zahlungsaufteilung | Erforderlich |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"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"
Signieren Sie stringA mit secret_key.
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel:
{
"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\"}]"
}
}
Antwortbeispiel:
{
"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": ""
}
- Antwortparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| user | String | UID des Kassiererkontos |
| split_id | String | Bei der Zahlungsaufteilung erzeugte Auftragsnummer |
| split_solution_id | String | ID des Zahlungsaufteilungsplans |
| state | String | Status: Success oder Failed |
| 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 |
| 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.result | String | Status: Success oder Failed |
| 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 |
