Pular para o conteúdo principal

Criar um Pagamento

POST 
/v2/payments

Endpoint genérico para criação de pagamentos de qualquer tipo. O tipo deve ser especificado no campo kind.

Pré-requisitos​

Para emitir um pagamento é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de pagamento que registra a operação é definida em payment_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Tipos Suportados​

PIX​

Usar kind: "pix" e fornecer a chave pix:

{
  "kind": "pix",
  "financial_account_uid": "...",
  "amount": 100.0,
  "pix": {
    "qrcode": "00020126330014br.gov.bcb.pix..."
  }
}

Boleto Bancário​

Usar kind: "bank_billet" e fornecer a chave bank_billet:

{
  "kind": "bank_billet",
  "financial_account_uid": "...",
  "amount": 200.0,
  "bank_billet": {
    "code": "81770000001-8 00005659970-7 41131079703-9 0014334-8"
  }
}

DARF​

Usar kind: "darf" e fornecer a chave darf:

{
  "kind": "darf",
  "financial_account_uid": "...",
  "amount": 300.0,
  "darf": {
    "tax_code": "0107",
    "calculation_date": "2024-12-31",
    "expire_at": "2025-01-10"
  }
}

Tributos (Tax)​

Usar kind: "tax" e fornecer a chave tax com código de barras:

{
  "kind": "tax",
  "financial_account_uid": "...",
  "amount": 400.0,
  "tax": {
    "kind": "iptu",
    "code": "81770000001-8 00005659970-7..."
  }
}

Contas de Consumo (Utility)​

Usar kind: "utility" e fornecer a chave utility:

{
  "kind": "utility",
  "financial_account_uid": "...",
  "amount": 500.0,
  "utility": {
    "code": "81770000001-8 00005659970-7..."
  }
}

Eventos de Webhook​

O evento payment.db.created é disparado nesta operação.

Endpoint Unificado: Este endpoint unifica a criação de todos os tipos de pagamento. Para criar pagamentos de um tipo específico, você também pode usar os endpoints dedicados em /api/v2/payment/{type}.

Request​

Responses​

Pagamento Conta de Consumo criado