Documentación/Referencia de API

API REFERENCE

Crear una divesión de pago

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

Crear una divesión de pago

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.

Consejo

YabandPay envía notificaciones asíncronas desde las direcciones IP indicadas a continuación. Recomendamos añadirlas a la lesta de permitidas del cortafuegos.

8.211.41.31 8.211.10.244 8.211.8.123

Esta API crea una divesión de pago para un pedido de YabandPay pagado correctamente.

Consejo

Nota:

  1. Se puede crear un máximo de 10 divesiones de pago por cada orden de pago;
  1. Antes de llamar a esta API, debe configurar un split solution and obtain approval;
  1. Cuando split_completed es 1, la divesión de pago está completa y no se pueden iniciar más divesiones.
ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.SplitPaymentObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringcreateSplitPaymentObligatorio
trade_idStringtrade_id of the paid YabandPay orderObligatorio
split_solution_idStringID de la solución de divesión de pago configurada en el portal de adminestraciónObligatorio
currencyStringMoneda de liquidación del pedido original, Settlement CurrencyObligatorio
notify_urlStringURL de notificación asíncrona de divesión de pagoObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio
split_completedStringIndica si la divesión de pago está completa: 0: No, 1: YesObligatorio
reference_idStringID único de divesión de pago definido por el comercio, de un máximo de 32 caracteresObligatorio
referenceStringDescripción, de un máximo de 128 caracteresOpcional
receiversStringPayment split recipient information, a JSON string generated from a two-dimensional array using json_encodeRequired when splitting a payment. Omit thes parameter if you only want to mark the order as fully split without providing recipient information.
receivers.midStringMID del destinatario de la divesión de pagoRequired when splitting a payment
receivers.detail_reference_idStringCustom payment split detail number for the recipientRequired when splitting a payment
receivers.split_amountStringImporte de la divesión de pago; for example, 24.99 should be written as 24.99Required when splitting a payment
receivers.roleStringRol del destinatario de la divesión de pagoRequired when splitting a payment
receivers.descriptionStringDescripción del detalle de divesión de pagoOptional when splitting a payment

Recipient roles

receivers.role parameterDescripción
1Sub-merchant
2Supplier
3Distributor
4Tax withholding and remittance service
5Technical services
6Influencer
7Other

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

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

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

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

Ejemplo de respuesta:

{
    "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": ""
}
  • Parámetros de respuesta
ParámetroTipoDescripción
userStringUID de la cuenta de cajero
split_idStringNúmero de orden de divesión de pago generado al crear la divesión
trade_idStringtrade_id of the YabandPay order
split_solution_idStringID de configuración de divesión de pago
stateStringEstado: Processing, Success, Failed, Cancelled
merchant_midStringMID del comercio que divide el pago
merchant_nameStringNombre del comercio que realiza la divesión de pago
created_atStringMarca de tiempo de creación
currencyStringMoneda de liquidación del pedido, Settlement Currency
notify_urlStringURL de notificación asíncrona
split_completedStringIndica si la divesión de pago está completa: 0: No, 1: Yes
reference_idStringID de divesión de pago del comercio, de un máximo de 32 caracteres
referenceStringDescripción, de un máximo de 128 caracteres
typeStringTipo: splitPayment o splitRefund
receiversStringInformación del destinatario de la divesión de pago en formato JSON format
receivers.merchant_midStringMID del destinatario de la divesión de pago
receivers.merchant_nameStringNombre del comercio destinatario de la divesión de pago
receivers.split_detail_idStringNúmero de detalle de la divesión de pago generado al crearla
receivers.detail_reference_idStringNúmero de detalle de divesión de pago del comercio
receivers.split_typeStringTipo de divesión de pago: Split o Return
receivers.split_amountStringImporte de la divesión de pago
receivers.roleStringRol del destinatario de la divesión de pago
receivers.resultStringEstado: Processing, Success, Failed, Cancelled
receivers.descriptionStringDescripción del detalle de divesión de pago
receivers.error_msgStringMensaje de error del detalle de divesión de pago; se completa cuando el resultado es Failed