Documentatie/API-referentie

API REFERENCE

Een betaalverdeling terugstorten

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

Een betaalverdeling terugstorten

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.

Deze API stort een geslaagde betaalverdeling van YabandPay terug.

Tip

Opmerking: Elke betaalverdeling kan maximaal 10 keer worden teruggestort.

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.SplitPaymentVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
commandStringreturnSplitPaymentVerplicht
currencyStringAfwikkelingsvaluta van de order, Settlement CurrencyVerplicht
notify_urlStringURL voor asynchrone meldingVerplicht
nonce_stringStringWillekeurige tekenreeks van maximaal 32 tekensVerplicht
split_idStringID van de betaalverdeelorder dat bij het aanmaken is geretourneerdVerplicht
reference_idStringUnieke ID van de terugstorting van de betaalverdeling van de merchant, maximaal 32 tekensVerplicht
referenceStringBeschrijving, maximaal 128 tekensOptioneel
receiversStringInformatie over de ontvanger van de betaalverdeling in JSON-indelingVerplicht
receivers.midStringMID van de ontvanger van de betaalverdelingVerplicht
receivers.split_detail_idStringID van het detail van de betaalverdeling dat bij het aanmaken is geretourneerdVerplicht
receivers.detail_reference_idStringNummer van het detail van de terugstorting voor de ontvangerVerplicht
receivers.split_amountStringBedrag van de betaalverdelingVerplicht
receivers.descriptionStringBeschrijving van het detail van de betaalverdelingVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

"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"

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

{
    "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\"}]"
    }
}

Voorbeeld van een antwoord:

{
    "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": ""
}
  • Antwoordparameters
ParameterTypeBeschrijving
userStringUID van het kassieraccount
split_idStringNummer van de betaalverdeelorder dat bij het aanmaken van de betaalverdeling is gegenereerd
split_solution_idStringID van de betaalverdelingsregeling
stateStringStatus: Success of Failed
merchant_midStringMID van de merchant die de betaling verdeelt
merchant_nameStringNaam van de merchant die de betaling verdeelt
created_atStringAanmaaktijdstempel
currencyStringAfwikkelingsvaluta van de order, Settlement Currency
notify_urlStringURL voor asynchrone melding
reference_idStringID van de betaalverdeling van de merchant, maximaal 32 tekens
referenceStringBeschrijving, maximaal 128 tekens
typeStringType: splitPayment of splitRefund
receiversStringInformatie over de ontvanger van de betaalverdeling in JSON-indeling
receivers.merchant_midStringMID van de ontvanger van de betaalverdeling
receivers.merchant_nameStringMerchantnaam van de ontvanger van de betaalverdeling
receivers.split_detail_idStringNummer van het detail van de betaalverdeling dat bij het aanmaken is gegenereerd
receivers.detail_reference_idStringNummer van het detail van de betaalverdeling van de merchant
receivers.split_typeStringType betaalverdeling: Split of Return
receivers.split_amountStringBedrag van de betaalverdeling
receivers.resultStringStatus: Success of Failed
receivers.descriptionStringBeschrijving van het detail van de betaalverdeling
receivers.error_msgStringFoutmelding voor het detail van de betaalverdeling; ingevuld wanneer het resultaat Failed is