Dokumentation/API-Referenz

API REFERENCE

Zahlungsaufteilung erstellen

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Zahlungsaufteilung erstellen

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters10

Required fields first

创建分账

commandRequiredstringdata.commandcreateSplitPayment
trade_idRequiredstringdata.trade_id已支付订单YabandPay订单的trade_id
split_solution_idRequiredstringdata.split_solution_id后台配置的分账方案id
currencyRequiredstringdata.currency原始订单的结算货币,Settlement Currency
notify_urlRequiredstringdata.notify_url分账异步通知地址
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
split_completedRequiredintegerdata.split_completed是否完成分账,0 : 否,1 : 是
reference_idRequiredstringdata.reference_id商户方自定义的分账id,不长于32位,不能重复
receiversRequiredstringdata.receivers分账接收方信息,由二维数组通过json_encode转换的json字符串,json格式
Optional parameters 1
referenceOptionalstringdata.reference描述信息,不长于128位

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

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:

  1. Für jede Zahlungsbestellung können höchstens 10 Zahlungsaufteilungen erstellt werden.
  1. Bevor Sie diese API aufrufen, müssen Sie im Voraus einen Zahlungsaufteilungsplan konfigurieren und genehmigen lassen.
  1. Wenn split_completed den Wert 1 hat, ist die Zahlungsaufteilung abgeschlossen und es können keine weiteren Aufteilungen eingeleitet werden.
ParameterTypBeschreibungErforderlich
userStringUID des Superadmin-KontosErforderlich
signStringSignatureErforderlich
methodStringv3.SplitPaymentErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
commandStringcreateSplitPaymentErforderlich
trade_idStringtrade_id der bezahlten YabandPay-BestellungErforderlich
split_solution_idStringID des im Verwaltungsportal konfigurierten ZahlungsaufteilungsplansErforderlich
currencyStringAbrechnungswährung der ursprünglichen BestellungErforderlich
notify_urlStringURL für asynchrone Benachrichtigungen zur ZahlungsaufteilungErforderlich
nonce_stringStringZufällige Zeichenfolge mit höchstens 32 ZeichenErforderlich
split_completedStringGibt an, ob die Zahlungsaufteilung abgeschlossen ist: 0: Nein, 1: JaErforderlich
reference_idStringEindeutige, vom Händler festgelegte ID der Zahlungsaufteilung, höchstens 32 ZeichenErforderlich
referenceStringBeschreibung, höchstens 128 ZeichenOptional
receiversStringAngaben zum Empfänger der Zahlungsaufteilung: eine JSON-Zeichenfolge, die mit json_encode aus einem zweidimensionalen Array erzeugt wirdFü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.midStringMID des Empfängers der ZahlungsaufteilungBei einer Zahlungsaufteilung erforderlich
receivers.detail_reference_idStringBenutzerdefinierte Detailnummer der Zahlungsaufteilung für den EmpfängerBei einer Zahlungsaufteilung erforderlich
receivers.split_amountStringBetrag der Zahlungsaufteilung; zum Beispiel muss 24.99 als 24.99 angegeben werdenBei einer Zahlungsaufteilung erforderlich
receivers.roleStringRolle des Empfängers der ZahlungsaufteilungBei einer Zahlungsaufteilung erforderlich
receivers.descriptionStringBeschreibung des Details der ZahlungsaufteilungBei einer Zahlungsaufteilung optional

Empfängerrollen

Parameter receivers.roleBeschreibung
1Unterhändler
2Lieferant
3Vertriebspartner
4Steuerabzugs- und Überweisungsdienst
5Technische Dienstleistungen
6Influencer
7Sonstiges

Signaturbeispiel:

Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.

"command=createSplitPayment&currency=EUR&method=v3.SplitPayment&nonce_string=1704693939376&notify_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
ParameterTypBeschreibung
userStringUID des Kassiererkontos
split_idStringBei der Zahlungsaufteilung erzeugte Auftragsnummer
trade_idStringtrade_id der YabandPay-Bestellung
split_solution_idStringID des Zahlungsaufteilungsplans
stateStringStatus: Processing, Success, Failed, Cancelled
merchant_midStringMID des Händlers, der die Zahlung aufteilt
merchant_nameStringName des Händlers, der die Zahlung aufteilt
created_atStringErstellungszeitstempel
currencyStringAbrechnungswährung der Bestellung
notify_urlStringURL für asynchrone Benachrichtigungen
split_completedStringGibt an, ob die Zahlungsaufteilung abgeschlossen ist: 0: Nein, 1: Ja
reference_idStringHändler-ID der Zahlungsaufteilung, höchstens 32 Zeichen
referenceStringBeschreibung, höchstens 128 Zeichen
typeStringTyp: splitPayment oder splitRefund
receiversStringAngaben zum Empfänger der Zahlungsaufteilung im Format JSON
receivers.merchant_midStringMID des Empfängers der Zahlungsaufteilung
receivers.merchant_nameStringHändlername des Empfängers der Zahlungsaufteilung
receivers.split_detail_idStringBei der Zahlungsaufteilung erzeugte Detailnummer
receivers.detail_reference_idStringHändlerseitige Detailnummer der Zahlungsaufteilung
receivers.split_typeStringArt der Zahlungsaufteilung: Split oder Return
receivers.split_amountStringBetrag der Zahlungsaufteilung
receivers.roleStringRolle des Empfängers der Zahlungsaufteilung
receivers.resultStringStatus: Processing, Success, Failed, Cancelled
receivers.descriptionStringBeschreibung des Details der Zahlungsaufteilung
receivers.error_msgStringFehlermeldung zum Detail der Zahlungsaufteilung; wird ausgefüllt, wenn das Ergebnis Failed lautet