Documentação/Referência da API

API REFERENCE

Notificações assíncronas de divisão de pagamentos

  • Response parameters:
{
    "sign": "YOUR_SIGNATURE",
    "data": {
        "user": "9212776037",
        "split_id": "20231229110618372777",
        "trade_id": "67943b0b-ca6b-aa96-5fb1-e354975f1ec4",
        "state": "Processing",
        "merchant_mid": "123",
        "merchant_name": "123",
        "reference_id": "123456",
        "split_solution_id": "104",
        "split_completed": 1,
        "created_at": "1703819178",
        "notify_url": "https://www.yabandpay.com/notify",
        "currency": "EUR",
        "receivers": [
            {
                "merchant_mid": "222",
                "merchant_name": "222",
                "detail_reference_id": "123456-2",
                "split_detail_id": "20231229110618372777-2",
                "split_type": "Split",
                "split_amount": "5.00",
                "role": "1",
                "result": "Processing",
                "description": "分账描述2",
                "error_msg": null
            },
            {
                "merchant_mid": "111",
                "merchant_name": "111",
                "detail_reference_id": "123456-1",
                "split_detail_id": "20231229110618372777-1",
                "split_type": "Split",
                "split_amount": "10.00",
                "role": "2",
                "result": "Processing",
                "description": "分账描述1",
                "error_msg": null
            }
        ],
        "type": "splitPayment"
    }
}
  • Response parameters
ParâmetroTipoDescrição
userStringUID da conta de superadministrador
split_idStringNúmero do pedido de divisão de pagamentos gerado quando a divisão é criada
trade_idStringtrade_id do pedido YabandPay
split_solution_idStringID da solução de divisão de pagamentos
stateStringStatus: Processing, Success, Failed, Cancelled
merchant_midStringmid do estabelecimento que divide o pagamento
merchant_nameStringNome do estabelecimento que divide o pagamento
created_atStringCarimbo de data/hora de criação
currencyStringMoeda de liquidação do pedido, Settlement Currency
notify_urlStringURL de notificação assíncrona
split_completedStringIndica se a divisão do pagamento foi concluída: 0: No, 1: Yes
reference_idStringID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres
referenceStringDescrição, no máximo 128 caracteres
typeStringTipo: splitPayment ou splitRefund
receiversStringInformações do destinatário da divisão de pagamentos no formato JSON
receivers.merchant_midStringmid do destinatário da divisão de pagamentos
receivers.merchant_nameStringNome do estabelecimento destinatário da divisão de pagamentos
receivers.split_detail_idStringNúmero do detalhe da divisão gerado quando a divisão de pagamentos é criada
receivers.detail_reference_idStringNúmero do detalhe da divisão de pagamentos do estabelecimento
receivers.split_typeStringTipo de divisão de pagamentos: Split ou Return
receivers.split_amountStringValor da divisão de pagamentos
receivers.roleStringFunção do destinatário da divisão de pagamentos
receivers.resultStringStatus: Processing, Success, Failed, Cancelled
receivers.descriptionStringDescrição do detalhe da divisão de pagamentos
receivers.error_msgStringMensagem de erro do detalhe da divisão de pagamentos; preenchida quando o resultado é Failed