Referência
Crie um link de cobrança e deixe seu cliente pagar
O termo “cobrança” é genérico. Ele representa um portal de um fluxo de pagamento onde você pode cobrar seu cliente e ele fazer todo o processo de pagamento sem nenhuma interrupção.
Atualmente uma cobrança pode ser de duas formas:
ONE_TIME
para cobranças que serão pagas uma única vez. preciso enviar os dados do seu cliente. Para cobrançarONE_TIME
é obrigatório informar o cliente ao criar a cobrança por meio dos camposcustomerId
oucustomer
.- Só é necessário fornecer uma das opções de identificador do cliente:
customerId
OUcustomer
.
- Só é necessário fornecer uma das opções de identificador do cliente:
MULTIPLE_PAYMENTS
é uma cobrança que pode ser paga multiplas vezes e por múltiplas pessoas diferentes. Ex: utilização de um único link de pagamento para vender um produto para múltiplas pessoas.- Para cobranças
MULTIPLE_PAYMENTS
o usuário informará informações como CPF, nome e email na página do checkout.
- Para cobranças
Estrutura
Uma cobrança é representada em nossa API pela seguinte estrutura:
Atributos:
id:
id:
id
: string.
Id único da cobrança na AbacatePay
frequency:
frequency:
frequency
: string.
Frequência da cobrança. Pode ser ONE_TIME
ou MULTIPLE_PAYMENTS
.
ONE_TIME | Cobrança que aceita um único pagamento. É necessário enviar os dados do cliente |
MULTIPLE_PAYMENTS | Cobrança em modo checkout, aceita vários pagamentos. Não é necessário enviar os dados do cliente. |
url:
url:
url
: string.
URL para seu cliente executar o pagamento da cobrança
Amount:
amount
: number.
Valor da cobrança em centavos
amount:
amount:
amount
: number.
Valor da cobrança em centavos
status:
status:
status
: string.
Status da cobrança. Pode ser PENDING
, EXPIRED
, CANCELLED
, PAID
, REFUNDED
PENDING | A cobrança está com o pagamento pendente |
EXPIRED | O tempo limite de pagamento foi excedido |
CANCELLED | A cobrança foi cancelada por você |
PAID | A cobrança foi paga com sucesso pelo cliente |
REFUNDED | O valor foi devolvido ao cliente |
methods:
methods:
methods
: array
Tipos de pagamento. Suportamos somente PIX
no momento.
products:
products:
products
: array
Lista de produtos inclusos na cobrança
customer:
customer:
customer
: object
Cliente que você está cobrando. Veja referência da estrutura aqui
metadata:
metadata:
metadata
: object
Objeto com metadados sobre a cobrança
fee
number Taxa aplicada pela AbacatePayreturnUrl
string URL que o cliente será redirecionado ao clicar no botão “voltar”completionUrl
string URL que o cliente será redirecionado ao realizar o pagamento
nextBilling:
nextBilling:
nextBilling
: date-time | null.
Data e hora da próxima cobrança, ou null para cobranças únicas
allowCoupons:
allowCoupons:
allowCoupons
: bool | null.
Permite ou não cupons para a cobrança
coupons:
coupons:
coupons
: array
Cupons permitidos na cobrança. Só são considerados os cupons se allowCoupons
é verdadeiro.