Dokumentation/API-Referenz

API REFERENCE

Zahlungsaufteilung zurückgeben

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

Zahlungsaufteilung zurückgeben

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

Request parameters8

Required fields first

回退分账

commandRequiredstringdata.commandreturnSplitPayment
currencyRequiredstringdata.currency订单结算货币,Settlement Currency
notify_urlRequiredstringdata.notify_url异步通知地址
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
split_idRequiredstringdata.split_id创建分账后返回的分账订单id
reference_idRequiredstringdata.reference_id商户方的分账回退id,不长于32位,不能重复
receiversRequiredstringdata.receivers分账接收方信息,json格式
Optional parameters 1
referenceOptionalstringdata.reference描述信息,不长于128位

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

Diese API gibt eine erfolgreich abgeschlossene Zahlungsaufteilung von YabandPay zurück.

Tipp

Hinweis: Jede Zahlungsaufteilung kann höchstens 10-mal zurückgegeben werden.

ParameterTypBeschreibungErforderlich
userStringUID des Superadmin-KontosErforderlich
signStringSignatureErforderlich
methodStringv3.SplitPaymentErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
commandStringreturnSplitPaymentErforderlich
currencyStringAbrechnungswährung der BestellungErforderlich
notify_urlStringURL für asynchrone BenachrichtigungenErforderlich
nonce_stringStringZufällige Zeichenfolge mit höchstens 32 ZeichenErforderlich
split_idStringID des bei der Erstellung zurückgegebenen ZahlungsaufteilungsauftragsErforderlich
reference_idStringEindeutige Händler-ID für die Rückgabe der Zahlungsaufteilung, höchstens 32 ZeichenErforderlich
referenceStringBeschreibung, höchstens 128 ZeichenOptional
receiversStringAngaben zum Empfänger der Zahlungsaufteilung im Format JSONErforderlich
receivers.midStringMID des Empfängers der ZahlungsaufteilungErforderlich
receivers.split_detail_idStringBei der Erstellung zurückgegebene Detail-ID der ZahlungsaufteilungErforderlich
receivers.detail_reference_idStringDetailnummer der Rückgabe der Zahlungsaufteilung für den EmpfängerErforderlich
receivers.split_amountStringBetrag der ZahlungsaufteilungErforderlich
receivers.descriptionStringBeschreibung des Details der ZahlungsaufteilungErforderlich

Signaturbeispiel:

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

"command=returnSplitPayment&currency=EUR&method=v3.SplitPayment&nonce_string=qxg9mzdxxh4pyi9fhb&notify_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
ParameterTypBeschreibung
userStringUID des Kassiererkontos
split_idStringBei der Zahlungsaufteilung erzeugte Auftragsnummer
split_solution_idStringID des Zahlungsaufteilungsplans
stateStringStatus: Success oder Failed
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
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.resultStringStatus: Success oder Failed
receivers.descriptionStringBeschreibung des Details der Zahlungsaufteilung
receivers.error_msgStringFehlermeldung zum Detail der Zahlungsaufteilung; wird ausgefüllt, wenn das Ergebnis Failed lautet