Theme switcher

Pix

Endpoints para realizar cobranças via PIX.

  • POST /pix/cashIn → Gera uma cobrança PIX, retornando um código de pagamento e um QR Code para que o cliente possa efetuar o pagamento.
  • GET /transaction/{id}→ Utilizado para consultar o STATUS de uma transação PIX.
  • GET /cashOut→ Realiza saque via API.

Exemplo da resposta do Webhook:

A resposta será enviada apenas se o campo webhook_url estiver configurado nos endpoints informados.

JSON
{ "id" = string, "value" = number, "status" = "created" | "paid" | "canceled", "end_to_end_id" = string, }
On this page
  • Pix

Pix Recorrente

Endpoints para realizar cobranças de PIX com recorrência.

  • POST /pix/cashIn/subscription → Gera uma cobrança PIX com recorrência, retornando um código de pagamento e um QR Code para que o cliente possa efetuar o pagamento.
  • DELETE /pix/cashIn/subscription/{id}/cancel→ Utilizado para desativar determinada cobrança de PIX recorrente.
  • GET /pix/cashIn/subscription→ Utilizado para buscar cobranças PIX com recorrência.
On this page
  • Pix Recorrente

Boleto

Endpoints necessários para integração do boleto.

Exemplo da resposta do Webhook:

A resposta será enviada apenas se o campo webhook_url estiver configurado nos endpoints informados.

JSON
{ "id" = string, "value" = number, "status" = "created" | "paid" | "canceled", "end_to_end_id" = string, "payer_name" = string, "payer_national_registration" = string, "qr_code" = string, "digitable_line" = string, "our_number" = number, }
On this page
  • Boleto

Conta

Endpoints necessários para obter dados de determinada conta.

On this page
  • Conta

Reembolso

Endpoints necessários para realizar reembolso.

On this page
  • Reembolso