Pular para o conteúdo

Criar cobrança

Utilize nossa API para criar uma cobrança (link de pagamento) avulsa e enviar para o seu cliente. Para isso, basta enviar uma requisição conforme o exemplo abaixo:

POST /api/v1/payment-link

A resposta retorna a URL pública da cobrança no campo url. Basta enviar esse endereço para o seu cliente pelo canal que preferir (e-mail, SMS, WhatsApp ou QR Code).

Exemplo de requisição

curl --request POST \
  --url https://sandbox.azpag.dev/api/v1/payment-link \
  --header 'Authorization: Bearer {token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Cobrança Maio/2025",
    "description": "Mensalidade do plano Premium",
    "amount": 99.90,
    "installments": 3,
    "enable_pix": true,
    "enable_credit": true,
    "enable_bank_slip": false,
    "fee_mode": "customer_pay_fee",
    "expired_at": "2025-06-30",
    "expire_after_payment": true,
    "reference": "INV-2025-05-001",
    "customer_name": "Maria Souza",
    "customer_email": "maria@exemplo.com",
    "customer_phone": "51999990000",
    "customer_document": "12345678901"
  }'

Todos os atributos

Atributo	Tipo	Obrigatório	Descrição
`title`	Texto	Sim	Título exibido na página de cobrança. Limite de 150 caracteres.
`description`	Texto	Não	Texto auxiliar exibido para o cliente. Limite de 1000 caracteres.
`amount`	Decimal	Sim	Valor da cobrança. Não utilize vírgula para casa decimal. Ex: 99.90
`additional_amount`	Decimal	Não	Valor adicional opcional, somado ao `amount`.
`bg_color`	Texto	Não	Cor de fundo da página em formato hexadecimal. Ex: #0d6efd
`show_company_logo`	Boolean	Não	Exibe o logo da sua empresa na página de cobrança.
`expired_at`	Data	Não	Data de expiração da cobrança no formato `YYYY-MM-DD`. Após essa data, a cobrança não aceita mais pagamentos.
`expire_after_payment`	Boolean	Não	Se `true`, a cobrança é invalidada automaticamente após o primeiro pagamento confirmado.
`reference`	Texto	Não	Referência externa para identificar a cobrança na sua aplicação. Limite de 100 caracteres. Recomendamos preencher.
`enable_pix`	Boolean	Não	Habilita o pagamento via Pix.
`enable_credit`	Boolean	Não	Habilita o pagamento via cartão de crédito.
`enable_bank_slip`	Boolean	Não	Habilita o pagamento via boleto bancário.
`installments`	Inteiro	Não	Número máximo de parcelas permitidas no cartão. Aceita valores de 1 a 12.
`fee_mode`	Texto	Não	Define o modo de juros aplicado à cobrança: `none`, `interest` ou `customer_pay_fee`.
`hide_customer_fields`	Boolean	Não	Oculta os campos de dados do cliente na página de cobrança. Use quando enviar os campos `customer_*` preenchidos.
`customer_name`	Texto	Não	Pré-preenche o nome do cliente.
`customer_email`	Texto	Não	Pré-preenche o e-mail do cliente.
`customer_phone`	Texto	Não	Pré-preenche o telefone do cliente.
`customer_document`	Texto	Não	Pré-preenche o CPF ou CNPJ do cliente.
`customer_cep`	Texto	Não	Pré-preenche o CEP do cliente. O sistema carrega automaticamente o endereço com base nos dados atualizados dos Correios. Se o CEP informado for inválido ou incorreto, o cliente deverá preencher o campo manualmente no momento do pagamento.
`customer_number`	Texto	Não	Pré-preenche o número do endereço. Caso não informado, o cliente deverá preencher o campo no momento do pagamento.
`payment_link_rule_token`	Texto	Não	Token da régua de cobrança a ser aplicada (lembretes automáticos antes e após o vencimento).

Modo de juros (`fee_mode`)

Campo único na API. Use fee_mode para definir como as taxas serão aplicadas na cobrança.

`fee_mode`	`enable_fee`	`customer_pay_fee`	`cash_discount`	Significado
`none`	`false`	`false`	`false`	Empresa absorve todas as taxas
`interest`	`true`	`false`	`true`	Juros incidem na parcela; à vista com desconto
`customer_pay_fee`	`true`	`true`	`true`	Repasse das taxas ao comprador

Respostas

{
  "data": {
    "slug": "pl_3kd0192",
    "url": "https://sandbox.azpag.dev/link/pl_3kd0192",
    "title": "Cobrança Maio/2025",
    "description": "Mensalidade do plano Premium",
    "amount": 99.90,
    "additional_amount": 0.00,
    "expired_at": "2025-06-30",
    "expire_after_payment": true,
    "reference": "INV-2025-05-001",
    "enable_pix": true,
    "enable_credit": true,
    "enable_bank_slip": false,
    "fee_mode": "customer_pay_fee",
    "installments": 3,
    "customer_name": "Maria Souza",
    "customer_email": "maria@exemplo.com",
    "customer_phone": "51999990000",
    "customer_document": "12345678901",
    "hide_customer_fields": false,
    "paid_at": null,
    "created_at": "2025-05-30 10:00:00"
  }
}

{
  "hasError": true,
  "response": {
    "title": [
      "O título é obrigatório."
    ],
    "amount": [
      "O valor de cobrança é obrigatório."
    ]
  }
}

{
  "hasError": true,
  "response": "Too many requests."
}

{
  "hasError": true,
  "response": "Error on server, try again."
}