Documentación/Referencia de API

API REFERENCE

Consultar una divesión de pago

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

Consultar una divesión de pago

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

Request parameters7

Required fields first

查询分账

commandRequiredstringdata.commandquerySplitPayment
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
reference_idRequiredstringdata.reference_id商户方的分账id,不长于32位
split_idRequiredstringdata.split_id创建分账后的分账单号
Optional parameters 3
split_typeOptionalstringdata.split_type分账类型, 0 :Split 分账 , 1 : Return 分账回退,只提供这2种类型。如果没有传,则查询 split_id 所有分账单和回退信息
split_detail_idOptionalstringdata.split_detail_id创建分账后的分账单号的分账单的明细,可配合 split_type 查询对应分账单的明细的信息
refund_split_detail_idOptionalstringdata.refund_split_detail_id只有 split_type 类型为分账回退时才有效,查询对应分账回退单的明细的信息

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

Parámetros

ParameterTypeDescripciónObligatorio
data.commandstringquerySplitPayment✓
data.nonce_stringstring随机字符串,不长于32位✓
data.reference_idstring商户方的分账id,不长于32位✓
data.split_idstring创建分账后的分账单号✓
data.split_typestring分账类型, 0 :Split 分账 , 1 : Return 分账回退,只提供这2种类型。如果没有传,则查询 split_id 所有分账单和回退信息—
data.split_detail_idstring创建分账后的分账单号的分账单的明细,可配合 split_type 查询对应分账单的明细的信息—
data.refund_split_detail_idstring只有 split_type 类型为分账回退时才有效,查询对应分账回退单的明细的信息—

Esta API consulta los pedidos de divesión de pago y los pedidos de devolución de divesión de pago exestentes de YabandPay.

ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.SplitPaymentObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringquerySplitPaymentObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio
reference_idStringID de divesión de pago del comercio, de un máximo de 32 caracteresObligatorio
split_idStringNúmero de orden de divesión de pago generado al crear la divesiónObligatorio
split_typeStringPayment split type: 0: Split (payment split), 1: Return (payment split return). Only these 2 types are supported. If omitted, all payment splits and return information for split_id are queried.Opcional
split_detail_idStringDetalle del pedido de divesión de pago generado al crear la divesión; puede utilizarse con split_type para consultar los detalles del pedido de divesión correspondienteOpcional
refund_split_detail_idStringSolo tiene efecto cuando split_type indica una devolución de divesión de pago; consulta los detalles del pedido de devolución correspondienteOpcional

Ejemplo de firma:

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

"command=querySplitPayment&method=v3.SplitPayment&nonce_string=7vccb9qkplvtxl22km&reference_id=123456&split_id=20231229110618372777&time=1703836221&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": 1703836221,
    "data": {
        "command": "querySplitPayment",
        "nonce_string": "7vccb9qkplvtxl22km",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Ejemplo de respuesta:

{
    "status": true,
    "code": "200",
    "data": {
        "split_id": "20231229110618372777",
        "state": "Success",
        "merchant_mid": "123",
        "merchant_name": "123",
        "reference_id": "123456",
        "reference": "5464654561",
        "split_solution_id": "104",
        "created_at": "1703819178",
        "notify_url": null,
        "currency": "EUR",
        "receivers": [
            {
                "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.00",
                "role": "1",
                "result": "Success",
                "description": "分账回退描述2",
                "error_msg": null
            },
            {
                "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.00",
                 "role": "2",
                "result": "Success",
                "description": "分账回退描述1",
                "error_msg": null
            },
            {
                "merchant_mid": "222",
                "merchant_name": "222",
                "detail_reference_id": "123456-2",
                "split_detail_id": "20231229110618372777-2",
                "refund_split_detail_id": "",
                "split_type": "Split",
                "split_amount": "5.00",
                "role": "1",
                "result": "Success",
                "description": "分账描述2",
                "error_msg": null
            },
            {
                "merchant_mid": "111",
                "merchant_name": "111",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-1",
                "refund_split_detail_id": "",
                "split_type": "Split",
                "split_amount": "10.00",
                "role": "2",
                "result": "Success",
                "description": "分账描述1",
                "error_msg": null
            }
        ],
        "split_completed": 1
    },
    "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
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