Saltar al contenido principal

Crear un Pago

POST 
/v2/payments

Endpoint genérico para la creación de pagos de cualquier tipo. El tipo debe especificarse en el campo kind.

Requisitos previos​

Para emitir un pago, es necesario tener una Cuenta Financiera, informada en financial_account_uid. La cuenta de pago que registra la operación se define en payment_account_uid; si se omite, se usa la más antigua vinculada a la cuenta financiera; si se especifica, debe pertenecer a financial_account_uid.

Tipos Soportados​

PIX​

Utilizar kind: "pix" y proporcionar la clave pix:

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

Boleto Bancario​

Utilizar kind: "bank_billet" y proporcionar la clave bank_billet:

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

DARF​

Utilizar kind: "darf" y proporcionar la clave darf:

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

Tributos (Impuesto)​

Utilizar kind: "tax" y proporcionar la clave tax con código de barras:

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

Cuentas de Consumo (Servicio)​

Utilizar kind: "utility" y proporcionar la clave utility:

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

Eventos de Webhook​

El evento payment.db.created se dispara en esta operación.

Endpoint Unificado: Este endpoint unifica la creación de todos los tipos de pago. Para crear pagos de un tipo específico, también puede usar los endpoints dedicados en /api/v2/payment/{type}.

Request​

Responses​

Pago de Cuenta de Consumo creado