Documentación/Referencia de API

API REFERENCE

Reembolsar una divesión de pago

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

Reembolsar una divesión de pago

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.

Parámetros

ParameterTypeDescripciónObligatorio
data.commandstringreturnSplitPayment✓
data.currencystring订单结算货币,Settlement Currency✓
data.notify_urlstring异步通知地址✓
data.nonce_stringstring随机字符串,不长于32位✓
data.split_idstring创建分账后返回的分账订单id✓
data.reference_idstring商户方的分账回退id,不长于32位,不能重复✓
data.referencestring描述信息,不长于128位—
data.receiversstring分账接收方信息,json格式✓

Esta API devuelve una divesión de pago de YabandPay completada correctamente.

Consejo

Nota: Cada divesión de pago se puede devolver como máximo 10 veces.

ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.SplitPaymentObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringreturnSplitPaymentObligatorio
currencyStringMoneda de liquidación del pedido, Settlement CurrencyObligatorio
notify_urlStringURL de notificación asíncronaObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio
split_idStringID del pedido de divesión de pago devuelto al crearlaObligatorio
reference_idStringID único de devolución de divesión de pago del comercio, de un máximo de 32 caracteresObligatorio
referenceStringDescripción, de un máximo de 128 caracteresOpcional
receiversStringInformación del destinatario de la divesión de pago en formato JSON formatObligatorio
receivers.midStringMID del destinatario de la divesión de pagoObligatorio
receivers.split_detail_idStringID del detalle de divesión de pago devuelto al crearlaObligatorio
receivers.detail_reference_idStringNúmero de detalle de devolución de divesión para el destinatarioObligatorio
receivers.split_amountStringImporte de la divesión de pagoObligatorio
receivers.descriptionStringDescripción del detalle de divesión de pagoObligatorio

Ejemplo de firma:

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

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

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

Ejemplo de respuesta:

{
    "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": ""
}
  • 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
split_solution_idStringID de configuración de divesión de pago
stateStringStatus: Success or Failed
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
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.resultStringStatus: Success or Failed
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