API REFERENCE

Consultar uma divisão de pagamentos

YabandPay documentation·Atualizado em 26 de out. de 2026

Parâmetros

Parameter	Type	Descrição	Obrigatório
data.command	string	querySplitPayment	✓
data.nonce_string	string	随机字符串，不长于32位	✓
data.reference_id	string	商户方的分账id，不长于32位	✓
data.split_id	string	创建分账后的分账单号	✓
data.split_type	string	分账类型, 0 ：Split 分账 , 1 ： Return 分账回退，只提供这2种类型。如果没有传，则查询 split_id 所有分账单和回退信息	—
data.split_detail_id	string	创建分账后的分账单号的分账单的明细，可配合 split_type 查询对应分账单的明细的信息	—
data.refund_split_detail_id	string	只有 split_type 类型为分账回退时才有效，查询对应分账回退单的明细的信息	—

Esta API consulta pedidos existentes de divisão de pagamentos e pedidos de devolução de divisão de pagamentos da YabandPay.

Parâmetro	Tipo	Descrição	Obrigatório
user	String	UID da conta de superadministrador	Obrigatório
sign	String	Signature	Obrigatório
method	String	v3.SplitPayment	Obrigatório
time	Long	Timestamp	Obrigatório

Parameters

Parâmetro	Tipo	Descrição	Obrigatório
command	String	querySplitPayment	Obrigatório
nonce_string	String	Cadeia aleatória com no máximo 32 caracteres	Obrigatório
reference_id	String	ID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres	Obrigatório
split_id	String	Número do pedido de divisão de pagamentos gerado quando a divisão é criada	Obrigatório
split_type	String	Tipo de divisão de pagamentos: 0: Split (divisão de pagamento), 1: Return (devolução da divisão de pagamento). Há suporte apenas para esses 2 tipos. Se omitido, são consultadas todas as divisões e devoluções de split_id.	Opcional
split_detail_id	String	Detalhes do pedido de divisão gerados quando a divisão é criada; podem ser usados com split_type para consultar os detalhes correspondentes do pedido de divisão	Opcional
refund_split_detail_id	String	Só é efetivo quando split_type indica uma devolução de divisão de pagamentos; consulta os detalhes correspondentes do pedido de devolução	Opcional

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no 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"

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1703836221,
    "data": {
        "command": "querySplitPayment",
        "nonce_string": "7vccb9qkplvtxl22km",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Response example:

{
    "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": ""
}

Response parameters

Parâmetro	Tipo	Descrição
user	String	UID da conta de caixa
split_id	String	Número do pedido de divisão gerado quando a divisão é criada
trade_id	String	trade_id do pedido YabandPay
split_solution_id	String	ID da solução de divisão de pagamentos
state	String	Status: Processing, Success, Failed, Cancelled
merchant_mid	String	mid do estabelecimento que divide o pagamento
merchant_name	String	Nome do estabelecimento que divide o pagamento
created_at	String	Carimbo de data/hora de criação
currency	String	Moeda de liquidação do pedido, Settlement Currency
notify_url	String	URL de notificação assíncrona
split_completed	String	Indica se a divisão do pagamento foi concluída: 0: No, 1: Yes
reference_id	String	ID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres
reference	String	Descrição, no máximo 128 caracteres
receivers	String	Informações do destinatário da divisão de pagamentos no formato JSON
receivers.merchant_mid	String	mid do destinatário da divisão de pagamentos
receivers.merchant_name	String	Nome do estabelecimento destinatário da divisão de pagamentos
receivers.split_detail_id	String	Número do detalhe da divisão gerado quando a divisão de pagamentos é criada
receivers.detail_reference_id	String	Número do detalhe da divisão de pagamentos do estabelecimento
receivers.split_type	String	Tipo de divisão de pagamentos: Split ou Return
receivers.split_amount	String	Valor da divisão de pagamentos
receivers.role	String	Função do destinatário da divisão de pagamentos
receivers.result	String	Status: Processing, Success, Failed, Cancelled
receivers.description	String	Descrição do detalhe da divisão de pagamentos
receivers.error_msg	String	Mensagem de erro do detalhe da divisão de pagamentos; preenchida quando o resultado é Failed

Consultar uma divisão de pagamentos

Consultar uma divisão de pagamentos

Request parameters7

查询分账

Parâmetros

Signature example:

Request example:

Response example: