API REFERENCE

Devolver 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	returnSplitPayment	✓
data.currency	string	订单结算货币，Settlement Currency	✓
data.notify_url	string	异步通知地址	✓
data.nonce_string	string	随机字符串，不长于32位	✓
data.split_id	string	创建分账后返回的分账订单id	✓
data.reference_id	string	商户方的分账回退id，不长于32位，不能重复	✓
data.reference	string	描述信息，不长于128位	—
data.receivers	string	分账接收方信息，json格式	✓

Esta API devolve uma divisão de pagamentos da YabandPay concluída com sucesso.

Dica

Observação: Cada divisão de pagamentos pode ser devolvida no máximo 10 vezes.

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	returnSplitPayment	Obrigatório
currency	String	Moeda de liquidação do pedido, Settlement Currency	Obrigatório
notify_url	String	URL de notificação assíncrona	Obrigatório
nonce_string	String	Cadeia aleatória com no máximo 32 caracteres	Obrigatório
split_id	String	ID do pedido de divisão de pagamentos retornado quando a divisão é criada	Obrigatório
reference_id	String	ID exclusivo de devolução de divisão de pagamentos definido pelo estabelecimento, no máximo 32 caracteres	Obrigatório
reference	String	Descrição, no máximo 128 caracteres	Opcional
receivers	String	Informações do destinatário da divisão no formato JSON	Obrigatório
receivers.mid	String	mid do destinatário da divisão de pagamentos	Obrigatório
receivers.split_detail_id	String	ID do detalhe da divisão retornado quando a divisão é criada	Obrigatório
receivers.detail_reference_id	String	Número do detalhe de devolução da divisão de pagamentos do destinatário	Obrigatório
receivers.split_amount	String	Valor da divisão de pagamentos	Obrigatório
receivers.description	String	Descrição do detalhe da divisão de pagamentos	Obrigatório

Signature example:

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

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Response example:

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

Response parameters

Parâmetro	Tipo	Descrição
user	String	UID da conta de caixa
split_id	String	Número do pedido de divisão de pagamentos gerado quando a divisão é criada
split_solution_id	String	ID da solução de divisão de pagamentos
state	String	Status: Success ou Failed
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
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
type	String	Tipo: splitPayment ou splitRefund
receivers	String	Informações do destinatário da divisão 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 de pagamentos gerado quando a divisão é 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.result	String	Status: Success ou Failed
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

Devolver uma divisão de pagamentos

Devolver uma divisão de pagamentos

Request parameters8

回退分账

Parâmetros

Signature example:

Request example:

Response example: