Pular para o conteúdo
Central de Ajuda

Como realizar o Split por fatura com cartão de crédito?

Split por fatura com cartão de crédito

Neste artigo você vai aprender:

• Como cobrar com cartão de crédito via API.
• Como configurar o split por fatura.

Caso de uso

O marketplace não tem um padrão de split, ou seja, um padrão no repasse de valores para subcontas e/ou contas mestre.

Exemplo

Em uma transação, para o produto A deve ser separado 10% do valor total da compra a ser enviado para uma subconta. Na transação de um produto B, o percentual muda para 5% e deve ser enviado para a mesma subconta.

Neste cenário não é possível manter uma única configuração para a subconta: será necessário enviar a configuração do split por fatura.

Modelo de diagrama de sequência

Diagrama de sequência do modelo de integração com cartão de crédito entre Cliente, E-commerce/Sistema e iugu: cadastro do cliente, tokenização, forma de pagamento, criação da fatura, cobrança e retorno de rejeição ou aprovação

Criar cliente

Essa request é usada para realizar o cadastro do cliente. Caso exista a necessidade de utilizar o método de pagamento boleto, indicamos que sejam preenchidos os dados de endereço.

Documentação: Criar Cliente

Endpoint: /v1/customers

Modelo de request

Exemplo de request POST para /v1/customers com os dados do cliente

Modelo de response

Exemplo de response da criação de cliente, com o id do cliente

Tokenização do cartão de crédito

Para realizar uma transação com cartão de crédito, é necessário realizar a tokenização do cartão de crédito.

Sua empresa não é certificada PCI DSS?

Indicamos que utilize o iugu.js. Ao inserir esse trecho de código JavaScript em sua página, você garante que os dados de cartão de crédito serão transacionados apenas pelo front-end da sua aplicação, trazendo segurança para o seu negócio.

O iugu.js vai retornar um token que deve ser usado para criar uma forma de pagamento ou realizar uma cobrança direta.

Caso sua empresa seja certificada PCI DSS, deve ser realizado um POST na API Criar Token, onde será gerado um token id, retornado no response da API.

Endpoint: /v1/payment_token

Modelo de request

Exemplo de request POST para /v1/payment_token com os dados do cartão

Modelo de response da API

Exemplo de response da criação de token, com o id do token

Criar forma de pagamento

Caso exista a necessidade de armazenar os dados do cartão de crédito para utilizar em outras cobranças, será necessário criar uma forma de pagamento.

Com o token gerado na chamada de tokenização, é preciso criar uma forma de pagamento através de um POST na API Criar Forma de Pagamento, que vai retornar um id (identificador) desse novo cartão de crédito.

Endpoint: /v1/customers/{customer_id}/payment_methods

Modelo de request

Exemplo de request POST para /v1/customers/{customer_id}/payment_methods com o token do cartão

Modelo de response

Exemplo de response da criação da forma de pagamento, com o id da forma de pagamento

É importante armazenar o id da forma de pagamento caso exista a necessidade de realizar o processo de aquisição para outras subcontas ou produtos.

Caso exista a necessidade de replicar o cartão de crédito para uso em outras subcontas, indicamos que leia o artigo:

Como vincular um cliente de subconta a um cliente da conta master via API

Configuração do split por faturas

Para realizar a configuração do split, é necessário criar uma invoice. Para isso, realize um POST na API Criar Fatura. Nela é possível configurar como será o seu split.

Na iugu é possível realizar esse procedimento por porcentagem, valor fixo (centavos) e pelo método de pagamento.

Via API, é possível realizar esse processo entre subcontas, contas mestre ou ambos os tipos de conta.

Endpoint: /v1/invoices

Split subconta para conta mestre

Caso você queira apenas realizar o split da subconta para a conta mestre, deve ser preenchido o objeto commissions.

Se você precisa realizar um split para todos os métodos de pagamento com um valor ou porcentagem fixa, indicamos que preencha as propriedades cents e percent do objeto commissions. Dessa forma, a iugu vai sempre splitar para essa conta mestre o valor definido em cada propriedade.

Caso exista a necessidade de cada método de pagamento ter um valor diferente a ser separado, seja por porcentagem ou valor fixo, deve ser preenchido no objeto commissions, configurando o cartão de crédito (credit_card), o boleto bancário (bank_slip) ou o Pix.

A plataforma também possibilita realizar o split por porcentagem e valor fixo. Nesse caso, é necessário preencher os dois campos (exemplo: 'cents': 200 e 'credit_card_percent': 1) e manter como true a propriedade permit_aggregated.

Modelo de request

Exemplo de request POST para /v1/invoices com o objeto commissions preenchido

Modelo de response

Exemplo de response da criação de fatura com split para a conta mestre

Múltiplos splits

Na iugu é possível realizar múltiplos splits, ou seja, o valor da compra pode ser dividido entre uma ou mais subcontas ou contas mestre.

Para configurar o seu múltiplo split, é necessário preencher o array splits, em que cada novo objeto será uma conta.

Lista de propriedades de cada objeto de split: recipient_account_id, cents, percent, bank_slip_cents, bank_slip_percent, credit_card_cents, credit_card_percent, pix_cents, pix_percent e permit_aggregated

A propriedade recipient_account_id representa o id da conta iugu. Para saber como consultar esse id, leia o artigo ID da conta e tokens de API de teste e de produção.

Assim como no objeto commissions, nos objetos do array splits é possível configurar o split por porcentagem, centavos e método de pagamento, e também ter um split em que é cobrado um valor fixo mais um determinado percentual.

Modelo de request

Exemplo de request POST para /v1/invoices com o array splits preenchido

Modelo de response

Exemplo de response da criação de fatura com múltiplos splits

Efetuar cobrança com cartão de crédito

Para realizar a cobrança com cartão de crédito, é necessário realizar um POST na API Cobrança Direta.

Nessa requisição deve ser preenchido o id da forma de pagamento (customer_payment_method_id) ou o token do cartão de crédito (token_id).

Endpoint: /v1/charge

Exemplo de request POST para /v1/charge com o token do cartão e o id da fatura

Vídeo

Para saber mais e assistir a todo o passo a passo que produzimos sobre o conteúdo, assista ao vídeo a seguir:

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 2
Ainda precisa de ajuda? Nosso time responde pela sua conta iugu.
Abrir solicitação

0 Comentários

Artigo fechado para comentários.