Documentação/Referência da API

API REFERENCE

Criar uma divisão de pagamentos

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

Criar uma divisão de pagamentos

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

Request parameters10

Required fields first

创建分账

commandRequiredstringdata.commandcreateSplitPayment
trade_idRequiredstringdata.trade_id已支付订单YabandPay订单的trade_id
split_solution_idRequiredstringdata.split_solution_id后台配置的分账方案id
currencyRequiredstringdata.currency原始订单的结算货币,Settlement Currency
notify_urlRequiredstringdata.notify_url分账异步通知地址
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
split_completedRequiredintegerdata.split_completed是否完成分账,0 : 否,1 : 是
reference_idRequiredstringdata.reference_id商户方自定义的分账id,不长于32位,不能重复
receiversRequiredstringdata.receivers分账接收方信息,由二维数组通过json_encode转换的json字符串,json格式
Optional parameters 1
referenceOptionalstringdata.reference描述信息,不长于128位

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

Dica

A YabandPay envia notificações assíncronas a partir dos endereços IP abaixo. Recomendamos adicioná-los à lista de permissões do firewall.

8.211.41.31 8.211.10.244 8.211.8.123

Esta API cria uma divisão de pagamentos para um pedido YabandPay pago com sucesso.

Dica

Observação:

  1. É possível criar no máximo 10 divisões de pagamento para cada pedido de pagamento;
  1. Antes de chamar esta API, é necessário configurar uma solução de divisão de pagamentos e obter aprovação;
  1. Quando split_completed for 1, a divisão de pagamentos estará concluída e não será possível iniciar outras divisões.
ParâmetroTipoDescriçãoObrigatório
userStringUID da conta de superadministradorObrigatório
signStringSignatureObrigatório
methodStringv3.SplitPaymentObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
commandStringcreateSplitPaymentObrigatório
trade_idStringtrade_id do pedido pago da YabandPayObrigatório
split_solution_idStringID da solução de divisão de pagamentos configurada no portal de gestãoObrigatório
currencyStringMoeda de liquidação do pedido original, Settlement CurrencyObrigatório
notify_urlStringURL de notificação assíncrona de divisão de pagamentosObrigatório
nonce_stringStringCadeia aleatória com no máximo 32 caracteresObrigatório
split_completedStringIndica se a divisão do pagamento foi concluída: 0: No, 1: YesObrigatório
reference_idStringID exclusivo de divisão de pagamentos definido pelo estabelecimento, no máximo 32 caracteresObrigatório
referenceStringDescrição, no máximo 128 caracteresOpcional
receiversStringInformações do destinatário da divisão de pagamentos: cadeia JSON gerada a partir de uma matriz bidimensional usando json_encodeObrigatório ao dividir um pagamento. Omita este parâmetro se quiser apenas marcar o pedido como totalmente dividido sem fornecer informações do destinatário.
receivers.midStringmid do destinatário da divisão de pagamentosObrigatório ao dividir um pagamento
receivers.detail_reference_idStringNúmero personalizado do detalhe da divisão para o destinatárioObrigatório ao dividir um pagamento
receivers.split_amountStringValor da divisão de pagamentos; por exemplo, 24.99 deve ser escrito como 24.99Obrigatório ao dividir um pagamento
receivers.roleStringFunção do destinatário da divisão de pagamentosObrigatório ao dividir um pagamento
receivers.descriptionStringDescrição do detalhe da divisão de pagamentosOpcional ao dividir um pagamento

Recipient roles

receivers.role parameterDescrição
1Sub-merchant
2Supplier
3Distributor
4Tax withholding and remittance service
5Technical services
6Influencer
7Other

Exemplo de assinatura:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

"command=createSplitPayment&currency=EUR&method=v3.SplitPayment&nonce_string=1704693939376&notify_url=https://www.yabandpay.com/notify&receivers=[{"mid":104006,"split_amount":0.01,"role":7,"detail_reference_id":"123456-2","description":"分账描述2"}]&reference=1704693939376&reference_id=1704693939376&split_completed=0&split_solution_id=102&time=1704693939&trade_id=23a199b8-b82b-81b0-a4cd-8485ca4feb3c&user=9212776037"

Assine a stringA usando secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Exemplo de solicitação:

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1704693939,
    "data": {
        "command": "createSplitPayment",
        "trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
        "split_solution_id": "102",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "nonce_string": "1704693939376",
        "split_completed": 0,
        "reference_id": "1704693939376",
        "reference": "1704693939376",
        "receivers": "[{\"mid\":104006,\"split_amount\":0.01,\"role\":7,\"detail_reference_id\":\"123456-2\",\"description\":\"分账描述2\"}]"
    }
}

Exemplo de resposta:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "9212776037",
        "split_id": "20240108162134979318",
        "trade_id": "23a199b8-b82b-81b0-a4cd-8485ca4feb3c",
        "split_solution_id": "102",
        "state": "Processing",
        "merchant_mid": "102300",
        "merchant_name": "Yaband Telecom B.V.",
        "created_at": "1704702094",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "split_completed": 0,
        "reference_id": "1704693939376",
        "reference": "1704693939376",
        "receivers": [
            {
                "merchant_mid": "104006",
                "merchant_name": "ybtest",
                "split_detail_id": "20240108162134979318-1",
                "detail_reference_id": "123456-2",
                "split_type": "Split",
                "split_amount": "0.01",
                "role": "7",
                "result": "Processing",
                "description": "分账描述2",
                "error_msg": null
            }
        ],
        "type": "splitPayment"
    },
    "message": ""
}
  • Parâmetros de resposta
ParâmetroTipoDescrição
userStringUID da conta de caixa
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
currencyStringOrder settlement currency, Settlement Currency
notify_urlStringURL de notificação assíncrona
split_completedStringWhether the payment split is complete: 0: No, 1: Yes
reference_idStringID de divisão de pagamentos do estabelecimento, no máximo 32 caracteres
referenceStringDescription, no longer than 128 characters
typeStringTipo: splitPayment ou splitRefund
receiversStringInformações do destinatário da divisão 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