Cobranças
Post
Para fazer uma cobrança avulsa (sem vínculo a uma assinatura)você deve usar a rota /invoice. Ela poderá ser feita por cartão de crédito, boleto bancário ou pix.
Em caso de cobrança por cartão de crédito é possível utilizar um card_id ou enviar todos os dados do cartão. Da mesma forma, pode ser informado o customer_id ou então todos os dados do customer(cliente).
| Campo | Validação | Descrição | Exemplo |
|---|---|---|---|
| customer_id (integer) | ID do cliente (Não-obrigatório caso customer esteja preenchido) | ||
| customer | Customer | Objeto cliente (Não-obrigatório caso customer_id esteja preenchido) | |
| link (boolean) | Se cobrança deverá gerar um link de pagamento ou não | true | |
| gateway_id (integer) | ID do gateway | 2 | |
| payment_method (string) | "boleto"/"credit_card" (choice) | Nome do método de pagamento | |
| card_id (integer) | ID do cartão (Não-obrigatório caso card_cvv, card_number, card_expiration_date e card_holder_name estejam preenchidos ou payment_method ≠ "credit_card") | ||
| card_cvv (string) | Verifica de acordo com número | CVV (Não-obrigatório caso card_id esteja preenchido ou payment_method ≠ "credit_card") | |
| card_number (string) | Valida se é válido, mas não se existe | Número do cartão (Não-obrigatório caso card_id esteja preenchido ou payment_method ≠ "credit_card") | |
| card_expiration_date (string) | "MMYY", verifica se já está vencido | Validade do cartão (Não-obrigatório caso card_id esteja preenchido ou payment_method ≠ "credit_card") | |
| card_holder_name (string) | Nome do portador (Não-obrigatório caso card_id esteja preenchido ou payment_method ≠ "credit_card") | ||
| amount (integer) | De acordo com o mínimo do gateway | Valor da cobrança, em centavos | |
| postback_url (string) | Endpoint informado pelo cliente para recebimento de notificações referentes ao status da assinatura | ||
| soft_descriptor (string) | Informações extras que podem ser passados ao método de pagamento (Não-obrigatório) | ||
| expirate_at | "YYYY-MM-DD" | Informar a data de vencimento quando método de pagamento for boleto ou pix. Caso não seja informado, a data será a de hoje | |
| Splits(array) | |||
| splits.*.partner_id(int) | Parceiro deve possuir cadastro no gateway passado na cobrança (gateway_id). | Id do parceiro | 1 |
| splits.*.fixed_value(int) | Fixed_value e percentual_value não podem ser informados ao mesmo tempo | Valor em centavos que parceiro receberá | 50 |
| splits.*.percentual_value(int) | Fixed_value e percentual_value não podem ser informados ao mesmo tempo | Valor em percentual que parceiro receberá sobre a cobrança | 10 |
| splits.*.percentual_value(int) | Fixed_value e percentual_value não podem ser informados ao mesmo tempo | Valor em percentual que parceiro receberá sobre a cobrança | 10 |
| tags(array) | |||
| tags.[i].name(string) | Informação para identificação da assinatura | Tipo A | |
| static_gateway(boolean) | Cobrança deverá ou não ter tentativas de pagamento em diferentes gateways. Atenção: caso seja informado como false, sistema não levará em conta prioridade numérica, nem prioridade por taxas. | true | |
| emit_nfse(boolean) | Cobrança deve ou não emitir nota fiscal. | Tipo A | |
| when_emit_nfse(boolean) | "emissao"/"pagamento" (escolha) | Escolha de quando a nota fiscal deverá ser emitida: na emissão da cobrança ou no pagamento da cobrança | Pagamento |
| note_id | Identificador do emissor das notas fiscais | Nibo | |
| "service_uuid (string)" | Identificador do serviço emissor de notas | e2a4ffa13ec3 |
Rotas adicionais
Alterar vencimento
Usa a rota de alterDate para alterar a data de vencimento de uma invoice e em troca, o boleto da invoice terá a sua data de vencimento alterada.
-> Regras:
- Funciona somente para boletos do GerenciaNet e do Safe2Pay;
- Não aparece quando a invoice está com o status "a confirmar";
- Não se altera vencimento de uma invoice paga.
-> Funcionamento: Usa a rota de alterDate da invoice, mandando como o novo billing_expirate_at e precisa receber, dando sucesso, o novo a invoice com a nova da de expiração e dando falha 422, o motivo.
Alterar método de pagamento
Usa a rota de alterPayment para alterar o método de pagamento de uma invoice.
->Regras
- Funciona para todos os métodos de pagamento e gateways;
- Não aparece quando a invoice está com o status "a confirmar";
- Não se altera de uma invoice paga.
-> Funcionamento: Usa a rota de alterPayment da invoice, mandando como parâmetro payment_method e as informações atreladas a ele e precisa receber, dando sucesso, a invoice com o novo método de pagamento, e dando falha 422, o motivo.
Alterar Gateway
Usa a rota de alterGateway para alterar o gateway de uma invoice.
-> Regras:
- Funciona para todos os métodos de pagamento e gateways;
- Não aparece quando a invoice está com o status "a confirmar";
- Não se altera de uma invoice paga.
-> Funcionamento: Usa a rota de alterGateway da invoice, mandando como parâmetro gateway_id e precisa receber, dando sucesso, a invoice no novo gateway, e dando falha 422, o motivo.
Cancelar
Usa a rota de cancel para cancelar a invoice.
-> Regras
- Funciona somente em: GerenciaNet: Boleto, Safe2Pay: Boleto, Pagarme: Nenhum método de pagamento
- Não se cancela uma invoice paga.
-> Funcionamento: Usando a rota de cancel da invoice, ele precisa ir até o gateway, efetuar o cancelamento e trazer de volta alguma mensagem, sendo ela sucesso ou erro.
Estorno
Usa a rota de refund para estornar a invoice.
->Regras
- Funciona somente em: GerenciaNet: Pix, Safe2Pay: Pix e Cartão, Pagarme: Boleto, Pix e Cartão
- Só funciona em uma invoice paga.
-> Funcionamento: Usando a rota de refund da invoice, ele precisa ir até o gateway, efetuar o estorno e trazer de volta alguma mensagem, sendo ela sucesso ou erro.
Marcar como pago
Usa a rota manualPay para dizer que aquela invoice foi paga.
->Regras
- Funciona para todos os métodos de pagamento;
- Não aparece quando a invoice está com o status "a confirmar";
- Não se marca como paga uma invoice que já recebeu pagamento.
Split
Definição
Split é definido como uma parcela de uma cobrança paga que será repassada a um parceiro. Esse valor poderá ser fixo (em centavos) ou em porcentagem.
Parceiros: é a pessoa física ou jurídica que receberá um valor ou percentual sobre a cobrança. Esse cadastro será incluído no sistema com o CNPJ (ou CPF), Razão Social e o valor ou percentual que será destinado ao parceiro como padrão. Além disso, será informado o código identificador do parceiro no gateway, dessa forma o parceiro terá um código específico para cada gateway. É importante lembrar que o gateway no qual o parceiro possui cadastro deverá ser o mesmo gateway da cobrança.
Na Invoice, caso seja informado o parceiro, o Gateway Paco tem duas formas de proceder:
- Informando apenas o CNPJ do parceiro, o Gateway Paco irá buscar o valor ou percentual definido no cadastro do parceiro.
- Informando o CPNJ e o valor ou percentual direto na invoice, o Gateway Paco irá enviar esta informação para o gateway terceiro, assim cada invoice pode ter um valor ou percentual para o parceiro diferente do valor definido como padrão.