Usando a Affiliate API#

O que é a Affiliate API?#

A Affiliate API permite que você crie recipients afiliados ao seu cadastro no EBANX, para que sejam refenciados em pagamentos com Split. Os pagamentos com Split permitem que você divida o valor de um pagamento, da maneira que você quiser, entre os participantes daquele pagamento.

Por que devo usar?#

Se o seu Negócio permite que parceiros utilizem sua solução como meio de pagamento e o valor dos pagamentos realizados pelos parceiros devam ser transferidos diretamente à eles, então é necessário utilizar nossa Affiliate API.

Como eu uso isso?#

Adquira um token de autenticação
Para utilizar a Affiliate API, você precisará de um token de autenticação que deverá ser informado no header Authorization das requisições. Se você não possui este token, por favor entre em contato com seu representante comercial para solicitá-lo.
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:
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"
}'
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:
- Cartão de Crédito
- Cartão de Débito
- Boleto
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.

Para mais detalhes sobre a Affiliate API, consulte a API Reference aqui

Usando a Affiliate API#

O que é a Affiliate API?#

Por que devo usar?#

Como eu uso isso?#

Adquira um token de autenticação

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

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

note