Faturas - 3run01/marketplace GitHub Wiki

Serviço que disponibiliza gestão de faturas de cobrança, através da emissão de faturas com pagamento através de cartão de crédito, boleto e wallet. A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente. Uma fatura pode conter vários itens: "Assinatura mensal", "Suporte técnico adicional", "Mensagens enviadas", etc.

Cada linha da fatura está obrigatoriamente associada a um produto do parceiro. Faturas podem existir independente de assinaturas e neste caso elas são chamadas de "faturas avulsas" e são ligadas diretamente ao cliente.

  • Suportamos pagamentos através de Boletes e cartões de crédito das bandeiras Visa, Master, Amex, ELO, Diners, Discover, Aura, JCB, Hipercard;
  • Suportamos pagamentos através de cartões de voucher refeição da bandeira Ticket;
  • Suporte a realizar de transações de pré-autorização de venda com captura total ou parcial do valor;
  • Geração de recebíveis e liquidação direta para o vendedor;
  • Suporte a cobrança em conta digital com cartões tokenizados no marketplace ou usando saldo de conta;
  • Serviço de listagem e gestão dos dados de transações;
  • Notificação através de webhooks de eventos de estorno, captura, confirmação, falha, disputa e chargeback de transações

O objeto fatura

due_date (date) - Data de vencimento da fatura.
payment_type (string) - (debit, credit, boleto, bank_account) - Métodos de pagamento aceitos. Os métodos de pagamento disponíveis podem variar de acordo com a localização.
customer_id (integer) - Indentificador ID do cliente já cadastrado em sua conta.
invoiceItems (array) - Itens da fatura (description = string - Descrição do item), (amount = integer - Quantidade do item), (price = integer - valor unitário de venda do item. Ex: R$ 2,50 = 2.50 ou R$ 2,00 = 2).
invoiceItems (array) - Itens da fatura (description = string - Descrição do item), (amount = integer - Quantidade do item), (price = integer - valor unitário de venda do item. Ex: R$ 2,50 = 2.50 ou R$ 2,00 = 2).
holder_name (string) - Nome impresso do dono no cartão de crédito.
expiration_month (string) - Mês de vencimento do cartão.
expiration_year (string) - Ano de vencimento do cartão.
security_code (string) - Código de segurança do cartão.
card_number (string) - Número do cartão.
number_installments (string) - Quantidade de parcelamento da fatura.
notification_url (string) - URL de notificação da fatura para retorno automático.

Criar fatura tipo cartão de crédito

Cria uma fatura para um cliente com método de pagamento cartão de crédito.

Curl --request POST\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url /api/v1/invoices/ \

--data'{
        "due_date":"2018-07-20",
	"payment_type":"credit_card",
	"customer_id":"1",
	"invoiceItems": [
		{
			"description":"item 1",
			"amount": 2,
			"price": 2
		},
		
		{
			"description":"item 2",
			"amount": 1,
			"price": 2
		}
	],
	
	"holder_name": "Bruno Santos",
	"expiration_month": "03",
	"expiration_year": "2019",
	"security_code": "857",
	"card_number": "5569117530337546",
	"number_installments": "2",
	"notification_url": "http://www.seusite.com.br/retorno-fatura"
}'

Criar fatura tipo boleto

Cria uma fatura para um cliente com método de pagamento Boleto.

Curl --request POST\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url /api/v1/invoices/ \

--data'{
	"due_date":"2018-01-01",
	"payment_type":"boleto",
	"customer_id":"5",
	"invoiceItems": [
		{
			"description":"item 1",
			"amount": 2,
			"price": 1000
		},
		
		{
			"description":"item 2",
			"amount": 1,
			"price": 1000
		}
	]
}'

Atualizar fatura

Atualiza dados da fatura como vencimento.

Curl --request PUT\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url /api/v1/invoices/ \
--data'{
	"due_date":"2018-07-22"
}'

Listar faturas

Retorna todas as as faturas geradas em sua conta.

Curl --request GET\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url /api/v1/invoices/ \

Buscar fatura

Retorna os dados de uma Fatura.

Curl --request GET\
--header "Content-Type: application/json" \
--Authorization Bearer SEU TOKEN \
--url /api/v1/invoices/{invoice_id} \
⚠️ **GitHub.com Fallback** ⚠️