Criar uma nova cobrança

post https://api.abacatepay.com/v1/billing/create

Permite que você crie um link de cobrança pro seu cliente pagar você.

Body Params

frequency

string

required

Defaults to ONE_TIME

Define o tipo de frequência da cobrança. Atualmente, somente cobranças únicas são suportadas.

methods

array of strings

required

length between 1 and 1

Defaults to PIX

Métodos de pagamento que serão utilizados. Atualmente, apenas PIX é suportado.

products

array of objects

required

length ≥ 1

Lista de produtos que seu cliente está pagando.

products*

externalId

string

required

O id do produto em seu sistema. Utilizamos esse id para criar seu produto na AbacatePay de forma automática, então certifique-se de que seu id é único.

name

string

required

Nome do produto.

description

string

Descrição detalhada do produto.

quantity

integer

required

≥ 1

Quantidade do produto sendo adquirida.

price

integer

required

≥ 100

Preço por unidade do produto em centavos. O mínimo é 100 (1 BRL).

returnUrl

uri

required

URL para redirecionar o cliente caso o mesmo clique na opção "Voltar".

completionUrl

uri

required

URL para redirecionar o cliente quando o pagamento for concluído.

customerId

string

O id de um cliente já cadastrado em sua loja.

customer

object

Os dados do seu cliente para criá-lo

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.abacatepay.com/v1/billing/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "frequency": "ONE_TIME",
8
  "methods": [
9
    "PIX"
10
  ]
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Cobrança criada com sucesso.

401Não autorizado. Falha na autenticação.