Nesse artigo você irá 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 mestres.

Por exemplo, em uma transação, para o produto A deve ser separado 10% do valor total da compra a ser enviado para uma subconta, mas 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:

Untitled__36_.png

Criar Cliente:

Essa request é usada para realizar o cadastro do cliente. Indicamos que caso exista a necessidade de utilizar o método de pagamento boleto, deve ser preenchido os dados de endereço.

Endpoint: /v1/customers

Modelo de request:

mceclip0.png

Modelo de response:

mceclip1.png

Para realizar uma transação com cartão de crédito se faz necessário realizar a “Tokenização do cartão de crédito”.

Se sua empresa não for PCI Dss, indicamos que utilize o iugu.js, ao inserir esse trecho de código javascript em sua webpage, 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 irá te 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 realizando um POST na api “Criar Token”, onde será gerado um token id e retornado no response da api.

Endpoint: /v1/payment_token

Modelo de request:

mceclip1.png

 

Modelo de response da api:

mceclip3.png

 

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 “Tokenização”, é preciso criar uma forma de pagamento através de um POST na api “Criar Forma de Pagamento”, que irá retornar um id (identificador) desse novo cartão crédito.

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

Modelo de request:

mceclip2.png

 

Modelo de response:

mceclip5.png

É 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 funciona o Proxy_payments_from_customer_id”.

 

2. Configuração do split por faturas:

Para realizar a configuração do split se faz necessário criar uma invoice, para isso é necessário realizar um POST na api “Criar Fatura”, nela é possível configurar como será 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 Comissions.

Se você precisa realizar um split para todos os métodos de pagamento com um valor, ou porcentagem fixa, indicamos que você preencha as propriedades cents e percents do objeto Comissions, desta forma a iugu irá 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 ele por porcentagem, ou valor fixo, deve ser preenchido no array comissions, configurando o cartão de crédito (credit_card), boleto bancário (bank_split), 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:

mceclip1.png

Modelo de response:

mceclip0.png

  • Múltiplo 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 realizar a configuração do seu múltiplo split é necessário preencher o array splits, onde cada novo objeto será um conta.

mceclip1.png

A propriedade recipient_account_id, representa o id da conta iugu, para mais informações de como consultar esse id, basta ler o artigo ID da conta e tokens de API de teste e de produção

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

Modelo de request:

mceclip3.png

Modelo de response:

mceclip4.png

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 você 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

mceclip5.png

 

 

Tem mais dúvidas? Envie uma solicitação

0 Comentários

Artigo fechado para comentários.
Fale Conosco