API REFERENCE
Zahlungsaufteilung abfragen
Diese API fragt vorhandene Zahlungsaufteilungen und Rückgaben von Zahlungsaufteilungen bei YabandPay ab.
| 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 | querySplitPayment | Erforderlich |
| nonce_string | String | Zufällige Zeichenfolge mit höchstens 32 Zeichen | Erforderlich |
| reference_id | String | Händler-ID der Zahlungsaufteilung, höchstens 32 Zeichen | Erforderlich |
| split_id | String | Bei der Zahlungsaufteilung erzeugte Auftragsnummer | Erforderlich |
| split_type | String | Typ der Zahlungsaufteilung: 0: Split (Zahlungsaufteilung), 1: Return (Rückgabe der Zahlungsaufteilung). Es werden nur diese 2 Typen unterstützt. Wird der Parameter ausgelassen, werden alle Zahlungsaufteilungen und Rückgabeinformationen für split_id abgefragt. | Optional |
| split_detail_id | String | Bei der Zahlungsaufteilung erzeugtes Detail; kann zusammen mit split_type verwendet werden, um die entsprechenden Details der Zahlungsaufteilung abzufragen | Optional |
| refund_split_detail_id | String | Nur wirksam, wenn split_type eine Rückgabe der Zahlungsaufteilung angibt; fragt die zugehörigen Details der Rückgabe ab | Optional |
Signaturbeispiel:
Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.
"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"
Signieren Sie stringA mit secret_key.
Die resultierende Signatur lautet:
"YOUR_SIGNATURE"
Anfragebeispiel:
{
"user": "9212776037",
"sign": "YOUR_SIGNATURE",
"method": "v3.SplitPayment",
"time": 1703836221,
"data": {
"command": "querySplitPayment",
"nonce_string": "7vccb9qkplvtxl22km",
"split_id": "20231229110618372777",
"reference_id": "123456"
}
}
Antwortbeispiel:
{
"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": ""
}
- 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 |
| 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 |