Skip to main content

​
Visão Geral

As Faturas são os pedidos (orders) gerados automaticamente a cada ciclo de cobrança de uma assinatura. Quando uma fatura não é paga, ela pode ser quitada manualmente via a rota de pagamento em atraso.

​
Status de uma Fatura

As faturas utilizam o mesmo enum StatusOrder dos pedidos:
StatusDescrição
PendingAguardando pagamento
PaidFatura paga com sucesso
FailFalha na tentativa de cobrança
ChallengedAguardando confirmação do cliente
CanceledFatura cancelada
ChargeBackEstorno
ReversedRevertida
PartialReversedParcialmente revertida
ReprovedReprovada
NewNova (recém-criada)
UnprocessedNão processada

​
Pagamento de fatura em atraso

Faturas com status Pending ou Fail podem ser pagas via POST /v1/invoices/{invoice_code}/pay-overdue. A assinatura precisa estar ativa para permitir o pagamento.

​
Métodos aceitos

MétodoObjeto card
CreditCardObrigatório
DebitCardNão necessário
PIXNão necessário
BoletoNão necessário
PayPalNão necessário
Pagar fatura em atraso com cartão
{
  "method": "CreditCard",
  "card": {
    "name": "CARLOS FERREIRA",
    "number": "4111111111111111",
    "month": "12",
    "year": "28",
    "security_code": "321"
  }
}
Pagar fatura em atraso com PIX
{
  "method": "PIX"
}
O código da fatura (invoice_code) pode ser obtido via GET /v1/subscriptions/{code}/invoices. Este código corresponde ao campo code do pedido (order) da assinatura.
A resposta de sucesso retorna diretamente os dados da cobrança criada, sem o envelope padrão APIReturnUtil. Todos os valores monetários (amount) são retornados em centavos.