Documentatie/API-referentie

API REFERENCE

Een betaalverdeling aanmaken

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

Een betaalverdeling aanmaken

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.

Tip

YabandPay verstuurt asynchrone meldingen vanaf de onderstaande IP-adressen. We raden aan deze toe te voegen aan de allowlist van uw firewall.

8.211.41.31 8.211.10.244 8.211.8.123

Deze API maakt een betaalverdeling aan voor een geslaagde YabandPay-bestelling.

Tip

Opmerking:

  1. Per betaalorder kunnen maximaal 10 betaalverdelingen worden aangemaakt;
  1. Voordat u deze API aanroept, moet u een betaalverdelingsregeling configureren en goedkeuring verkrijgen;
  1. Wanneer split_completed gelijk is aan 1, is de betaalverdeling voltooid en kunnen geen verdere betaalverdelingen meer worden gestart.

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

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.SplitPaymentVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
commandStringcreateSplitPaymentVerplicht
trade_idStringtrade_id van de betaalde YabandPay-orderVerplicht
split_solution_idStringID van de betaalverdelingsregeling die in het beheerportaal is geconfigureerdVerplicht
currencyStringAfwikkelingsvaluta van de oorspronkelijke order, Settlement CurrencyVerplicht
notify_urlStringURL voor asynchrone melding over de betaalverdelingVerplicht
nonce_stringStringWillekeurige tekenreeks van maximaal 32 tekensVerplicht
split_completedStringOf de betaalverdeling is voltooid: 0: Nee, 1: JaVerplicht
reference_idStringUnieke, door de merchant gedefinieerde ID van de betaalverdeling, maximaal 32 tekensVerplicht
referenceStringBeschrijving, maximaal 128 tekensOptioneel
receiversStringInformatie over de ontvanger van de betaalverdeling; een JSON-tekenreeks die met json_encode wordt gegenereerd op basis van een tweedimensionale arrayVereist voor een betaalverdeling. Laat deze parameter weg als u de order alleen als volledig verdeeld wilt markeren zonder ontvangersgegevens op te geven.
receivers.midStringMID van de ontvanger van de betaalverdelingVereist voor een betaalverdeling
receivers.detail_reference_idStringAangepast detailnummer voor de ontvanger van de betaalverdelingVereist voor een betaalverdeling
receivers.split_amountStringBedrag van de betaalverdeling; bijvoorbeeld, 24.99 moet worden geschreven als 24.99Vereist voor een betaalverdeling
receivers.roleStringRol van de ontvanger van de betaalverdelingVereist voor een betaalverdeling
receivers.descriptionStringBeschrijving van het detail van de betaalverdelingOptioneel voor een betaalverdeling

Rollen van ontvangers

parameter receivers.roleBeschrijving
1Submerchant
2Leverancier
3Distributeur
4Dienst voor inhouding en afdracht van belastingen
5Technische diensten
6Influencer
7Overige

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

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

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

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

Voorbeeld van een antwoord:

{
    "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": ""
}
  • Antwoordparameters
ParameterTypeBeschrijving
userStringUID van het kassieraccount
split_idStringNummer van de betaalverdeelorder dat bij het aanmaken van de betaalverdeling is gegenereerd
trade_idStringtrade_id van de YabandPay-order
split_solution_idStringID van de betaalverdelingsregeling
stateStringStatus: Processing, Success, Failed, Cancelled
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
split_completedStringOf de betaalverdeling is voltooid: 0: Nee, 1: Ja
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.roleStringRol van de ontvanger van de betaalverdeling
receivers.resultStringStatus: Processing, Success, Failed, Cancelled
receivers.descriptionStringBeschrijving van het detail van de betaalverdeling
receivers.error_msgStringFoutmelding voor het detail van de betaalverdeling; ingevuld wanneer het resultaat Failed is