Início Referência

Introdução

Autenticação
- Introdução
- Segurança e Controle de Acesso
- Formatos de Autenticação
  - API Key

Webhooks
- Introdução
- Endpoints
  - [POST] /business/webhook

Minha conta
- Introdução
- Endpoints
  - [GET] /account/balance

PIX
- Introdução
- Cobrança Imediata (Cash In)
- Envio e Pagamento (Cash Out)
- Reembolso de transação (Pix)
- Consultar transação
- Split
- Endpoints
  - v1
    [POST] /payment
    [POST] /payment/withdraw
    [POST]/payment/withdraw/qrcode
    [POST] /payment/refund/:id
    [GET] /transactions/:id
    [GET] /transactions
  - v2
    [POST] /payment
    [POST] /payment/withdraw
    [GET] /payment/:id
    [POST] /payment/refund/:id
- Webhooks
  - Introdução
  - Cash In - Payload
  - Cash Out - Payload
  - Error - Payload
- Integração
  - Criação de Cobrança PIX
  - Criação de Saque PIX
  - Link de Pagamentos

Boleto
- Introdução
- Fluxo de integração
- Endpoints
  - [POST] /payment
  - [GET] /payment/:id
  - [PATCH] /payment/:id/cancel
  - [POST] /payment/:id/generate-pdf
- Webhooks
  - Introdução
  - Boleto confirmado
  - Boleto cancelado
  - Boleto pago

Cartão de crédito
- Introdução
- Endpoints
  - payment
    [POST] /payment
    [GET] /payment
    [GET] /payment/:id
    [POST] /payment/:id/capture
    [POST] /payment/:id/refund
    [POST] /payment/:id/cancel-capture
  - account
    [GET] /account/balance
- Webhooks
  - Campos do payload

Formatos de Autenticação

On This Page

Formatos de Autenticação

This documentation playground was created by Scalar. For help, questions or feedback don't hesitate to email our support.

You can fully customize or delete this footer by simply navigating to the footer section of the "customize" button within our header.

Features About Pricing
Privacy Policy Terms of Service Pricing

© 2025 Scalar