Skip to main content

Pagamentos com Split#

Sobre este guia#

Esta página explica como adicionar a funcionalidade de Split nos pagamentos realizados através de nossa Direct API. A funcionalidade de split permite que um pagamento seja dividido entre 2 ou mais recipients, que são os parceiros afiliados de seu negócio.

Se você ainda não está integrado com EBANX Direct API, dê uma olhada neste guia básico. Não tem certeza se EBANX Direct API é a melhor opção para seu e-commerce? Por favor, fale com um de nossos especialistas.

O que você vai precisar#

Antes de iniciar sua integração, certifique-se de ter:

  1. Uma conta em nosso ambiente de testes. Ainda não possui sua conta? Fale com nossa equipe comercial;
  2. Um token de autorização para a Affiliate API;
  3. Cadastrar seus parceiros através da Affiliate API;
  4. Incluir o objeto split em suas requisições de pagamento.

Como funciona#

Basicamente, para utilizar esta funcionalidade você precisa adicionar um objeto split em sua Direct API request, indicando quem são os recipients que farão parte daquela transação.

Meios de pagamento suportados

A funcionalidade de split de pagamentos é suportada para pagamentos com cartão de crédito, débito e boleto.

  1. Faça o cadastro de um recipient através da Affiliate API

    Para cadastrar um recipient, você precisará informar na requisição seu número de documento, dados de contato, dados bancários para liquidação e um customer_ref/recipient_code, que é a identificação que você utilizará para referenciar este recipient nos pagamentos. Abaixo um exemplo de request para cadastrar um recipient:

    Autenticação da API

    Para utilizar a Affiliate API, você precisará incluir no header Authorization o seu token de autenticação. Se você ainda não possui um token, entre em contato com seu representante comercial.

    curl -X POST 'https://affiliate-api-stg.ebanxpay.com/api/affiliate/recipient' \
    -d 'request_body={
    "type": "individual",
    "country": "BRA",
    "document": {
    "country": "BRA",
    "number": "23168241024",
    "type": "cpf"
    },
    "name": "EBANX Split Test",
    "contacts": [
    {
    "contact_name": "EBANX Split Test",
    "email": "email-de-contato@seu-recipient.com.br",
    "mobile_phone_number": "11988887777"
    }
    ],
    "bank_accounts": [
    {
    "account_number": "123456",
    "account_verification_code": "1",
    "bank_branch_code": "0001",
    "bank_identifier": "123",
    "bank_account_type": "corrente"
    }
    ],
    "customer_ref": "EBANX-split-recipient-1"
    }'

  2. Inclua o objeto split em sua requisição de pagamento

    Agora que você possui um recipient cadastrado, é hora de realizar um pagamento referenciando este parceiro. Para isso, é necessário incluir o objeto split em sua Direct API request:

    curl -X POST 'https://staging.ebanx.com.br/ws/direct' \
    -d '{
    "integration_key": "your_test_integration_key_here",
    "operation": "request",
    "payment": {
    "name": "EBANX Test",
    "email": "test123@ebanx.com.br",
    "document": "11158875053",
    "address": "Rua Antônio Achê",
    "street_number": "1800",
    "city": "Ribeirão Preto",
    "state": "SP",
    "zipcode": "14020-600",
    "country": "br",
    "phone_number": "(11) 1111-1111",
    "payment_type_code": "creditcard",
    "merchant_payment_code": "ebanx-split-payment-1",
    "currency_code": "BRL",
    "instalments": 1,
    "amount_total": 150,
    "creditcard": {
    "token": "your_creditcard_token"
    },
    "split": [
    {
    "recipient_code": "me",
    "percentage": 2,
    "liable": true,
    "charge_fee": true
    },
    {
    "recipient_code": "EBANX-split-recipient-1",
    "percentage": 98,
    "liable": true,
    "charge_fee": false
    }
    ]
    }
    }'
    note

    Para referenciar o próprio merchant em uma venda com split, utilize orecipient_codeme. Este código sempre referencia o merchant, portanto não é necessário cadastrá-lo.

    Nos exemplos acima, temos um pagamento de R$150,00, dividido entre dois recipients: O próprio merchant (me), recebendo 2% do valor, e o parceiro cadastrado anteriormente EBANX-split-recipient-1, recebendo 98%.

    Sobre o objeto Split#

    CampoDescrição
    recipient_codeO código do recipient .
    percentageA porcentagem do valor total que este recipient receberá.
    amountSe não for especificado uma porcentagem, o split poderá ser realizado por valores absolutos
    liableSe este recipient será responsável por eventuais chargebacks. A regra que se aplica é que 1 recipient ou todos sejam responsáveis
    charge_feeSe este recipient será cobrado pelas taxas de processamento.

    Observações adicionais#

    • O split só pode ser realizado por porcentagem ou valor absoluto, não é possível utilizar os dois em uma mesma requisição:
      • Se for utilizado porcentagem, a somatória de todos as porcentagens deverá ser igual a 100;
      • Se for utilizado valor absoluto, a somatória dee todos os valores deverá ser igual ao parâmetro payment.amount_total.
    • Ao menos 1 recipient deverá ser responsável por chargebacks;
    • Ao menos 1 recipient deverá ser responsável pelas taxas de processamento (fees).

Realizando um reembolso de pagamento com Split#

Para um reembolso de pagamento com split, é necessário informar como será a divisão de valores deste reembolso. Para isso, é necessário incluir um objeto split na requisição de reembolso, contendo os parametros recipient_code, junto com percentage ou amount:

curl -X POST 'https://staging.ebanx.com.br/ws/refund \
-d '{
"integration_key": "your_test_integration_key_her",
"operation": "request",
"amount": 150,
"merchant_refund_code": "ebanx-refund-with-split",
"hash": "payment-hash-here",
"description": "Test refund with split",
"split": [
{
"recipient_code": "me",
"percentage": 2
},
{
"recipient_code": "EBANX-split-recipient-1",
"percentage": 98
}
]
}'
Recipients no reembolso

Somente podem participar de um reembolso com split recipients que fizeram parte daquele pagamento.

Reembolso parcial

Você também pode realizar reembolsos parciais para um pagamento com split, inclusive indicando apenas um recipient responsável por aquele reembolso. Para isto, basta enviar o objeto split com apenas um recipient.

Obtendo Ajuda#

Nós esperamos que este artigo tenha sido esclarecedor, mas caso não tenhamos tirado suas dúvidas você tem as seguintes opções para continuar buscando respostas:

  • Se você ainda não é nosso parceiro e deseja saber mais sobre nossos preços e condições, entre em contato com nossa equipe comercial.
  • Caso você já seja nosso parceiro, entre em contato com nossa equipe de suporte em faleconosco@ebanxpay.com.
Edit this page
Last updated on by Samuell Oliveira