Introdução

Bem-vindo à API Brasil Cash. Com ela você gera cobranças Pix (cash-in), envia Pix (cash-out), consulta saldo e extrato da conta e recebe notificações em tempo real por webhooks.

Todas as rotas usam JSON (UTF-8) e valores em reais com duas casas decimais (ex.: 100.50). Datas e horários são retornados em ISO 8601 (UTC).

URL base

text

1https://api.brasilcash.app.br/api/v1

Fluxo básico

1. Gere o Client ID e o Client Secret no painel, em Configurações › Chaves de API.

2. Troque as credenciais por um token em POST /pix/auth/token.

3. Envie o token no header Authorization: Bearer {token} em todas as outras rotas.

4. Cadastre um webhook para receber os eventos de pagamento e saque.

Ambientes

Ambiente	URL base	Observação
`Produção`	https://api.brasilcash.app.br/api/v1	Movimenta dinheiro real.
`Sandbox`	https://sandbox-api.brasilcash.app.br/api/v1	Credenciais de sandbox são emitidas pelo suporte.

Códigos de status

Código	Significado
`200`	Sucesso
`201`	Recurso criado
`400`	Dados inválidos ou faltando
`401`	Token inválido ou expirado
`403`	Sem permissão / IP não autorizado
`404`	Recurso não encontrado
`409`	Conflito (recurso já existe)
`429`	Limite de requisições excedido
`503`	Instituição liquidante indisponível, tente novamente (Retry-After)

Esta seção foi útil?

Autenticação

Toda chamada é autenticada com um Bearer token obtido a partir do par client_id / client_secret da sua chave de API (Painel › Configurações › Integrações). O token vale por 1 hora; gere outro antes de expirar.

As chaves de API passam pela lista de IPs autorizados da conta: chamadas de IPs fora da lista recebem 403.

Base URL

Produção:

https://api.brasilcash.app.br/api/v1

Retrieve access token

Troca o Client ID e o Client Secret por um token de acesso (JWT) válido por 30 minutos.

Use o token no header Authorization: Bearer {token}. Reaproveite o mesmo token até expirar: gerar um token por requisição é desnecessário e está sujeito a limite de taxa.

As credenciais são criadas no painel em Configurações › Chaves de API. Se a chave tiver IPs autorizados, somente requisições desses IPs são aceitas.

Expiração

expires_in é informado em segundos (1800 = 30 minutos). Gere um novo token apenas quando o anterior expirar.

Header Parameters

Content-TypestringREQUIRED

application/json

Body Parameters

clientIdstringREQUIRED

Client ID da chave de API. · Ex.: client_abc123def456

clientSecretstringREQUIRED

Client Secret da chave de API (mostrado uma única vez na criação). · Ex.: secret_xyz789abc456

Response

200Object

Response Attributes

tokenstring

token_typestring

expires_ininteger

merchant_idstring

merchant_namestring

environmentstring

400 Bad Request
401 Unauthorized
429 Too Many Requests

Esta seção foi útil?

POST/pix/auth/token

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/auth/token" \2  -H "Content-Type: application/json" \3  -d '{4  "clientId": "client_abc123def456",5  "clientSecret": "secret_xyz789abc456"6}'

Response

{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 1800,
    "merchant_id": "uuid",
    "merchant_name": "Minha Empresa LTDA",
    "environment": "production"
  }
}

Conta

Saldo disponível e bloqueado, extrato de transações (entradas, saídas, taxas e devoluções) e comprovante em PDF de cada Pix enviado.

Current balance

Retorna o saldo disponível, pendente e total da conta.

Campos

available: pode ser sacado agora · pending: aguardando liquidação · total: soma dos dois.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Response

200Object

Response Attributes

availablenumber

pendinginteger

totalnumber

currencystring

401 Unauthorized

Esta seção foi útil?

GET/balance

1curl -X GET "https://api.brasilcash.app.br/api/v1/balance" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "available": 1500.5,
    "pending": 250,
    "total": 1750.5,
    "currency": "BRL"
  }
}

Listing transactions

Lista as transações da conta (entradas e saídas Pix) com paginação e filtros.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Query Parameters

statusstring

pending, processing, completed, failed, cancelled, refunded

typestring

pix_in (recebimentos) ou pix_out (envios)

start_datestring

Data inicial (ISO 8601)

end_datestring

Data final (ISO 8601)

searchstring

Busca por external_id, txid ou end_to_end_id

pagenumber

Página (padrão 1)

limitnumber

Itens por página (padrão 50, máximo 100)

Response

200Array

Response Attributes

idstring

merchant_idstring

amountinteger

fee_amountnumber

net_amountnumber

payment_methodstring

statusstring

external_idstring

descriptionstring

debtorAccountobject

creditorAccountobject

metadataobject

created_atstring

updated_atstring

Esta seção foi útil?

GET/pix/transactions

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/transactions" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "merchant_id": "uuid",
      "amount": 100,
      "fee_amount": 1.5,
      "net_amount": 98.5,
      "payment_method": "pix",
      "status": "completed",
      "external_id": "pedido_123",
      "description": "Pagamento do pedido 123",
      "debtorAccount": {
        "document": "12345678901",
        "name": "João Silva"
      },
      "creditorAccount": {
        "document": "12345678000190",
        "name": "Minha Empresa LTDA"
      },
      "metadata": {
        "qrCode": "00020126580014br.gov.bcb.pix...",
        "endToEndId": "E3038525920250120103000abc123"
      },
      "created_at": "2026-01-10T10:00:00Z",
      "updated_at": "2026-01-10T10:05:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Retrieving transaction

Detalhes completos de uma transação, com pagador, recebedor, MEDs e reembolsos relacionados.

O identificador aceita o ID interno (UUID), o external_id informado na criação, o txid da cobrança ou o End-to-End ID (E2E) do Pix.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

identifierstringREQUIRED

UUID, external_id, txid ou End-to-End ID · Ex.: E3038525920250120103000abc123

Response

200Object

Response Attributes

idstring

merchant_idstring

amountinteger

fee_amountnumber

net_amountnumber

payment_methodstring

statusstring

external_idstring

descriptionstring

debtorAccountobject

creditorAccountobject

metadataobject

created_atstring

updated_atstring

medsarray

refundsarray

404 Not Found

Esta seção foi útil?

GET/pix/transactions/{identifier}

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/transactions/{identifier}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_id": "uuid",
    "amount": 100,
    "fee_amount": 1.5,
    "net_amount": 98.5,
    "payment_method": "pix",
    "status": "completed",
    "external_id": "pedido_123",
    "description": "Pagamento do pedido 123",
    "debtorAccount": {
      "document": "12345678901",
      "name": "João Silva",
      "email": "[email protected]"
    },
    "creditorAccount": {
      "document": "12345678000190",
      "name": "Minha Empresa LTDA"
    },
    "metadata": {
      "qrCode": "00020126580014br.gov.bcb.pix...",
      "endToEndId": "E3038525920250120103000abc123"
    },
    "created_at": "2026-01-10T10:00:00Z",
    "updated_at": "2026-01-10T10:05:00Z",
    "meds": [],
    "refunds": []
  }
}

Generating receipt PDF

Comprovante de um Pix enviado (dados do pagamento para emissão do recibo).

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

transactionIdstringREQUIRED

ID (UUID) da transação de saída

Response

200Object

Response Attributes

idstring

end_to_end_idstring

amountinteger

fee_amountinteger

statusstring

receiverobject

payerobject

completed_atstring

Esta seção foi útil?

GET/pix/transfers/{transactionId}/receipt

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/transfers/{transactionId}/receipt" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "end_to_end_id": "E3038525920250120140500def456",
    "amount": 500,
    "fee_amount": 2,
    "status": "completed",
    "receiver": {
      "name": "João Silva",
      "document": "***.456.789-**",
      "bank_name": "NU PAGAMENTOS S.A.",
      "pix_key": "[email protected]"
    },
    "payer": {
      "name": "Minha Empresa LTDA",
      "document": "12345678000190"
    },
    "completed_at": "2026-01-10T14:00:12Z"
  }
}

Pix · Cash-in

Receba por Pix gerando QR Codes dinâmicos (com valor e validade) ou estáticos. A confirmação do pagamento chega pelo webhook transaction.completed; o valor líquido (descontada a taxa) entra no saldo disponível. Devoluções totais ou parciais saem pelo refund.

Creating QR code

Cria uma cobrança Pix dinâmica e devolve o QR Code (imagem) e o código copia e cola.

A cobrança expira em expiresIn segundos (padrão 3600). Ao ser paga, a transação muda para completed e o evento transaction.completed é enviado aos webhooks cadastrados (e à webhook_url desta cobrança, se informada).

Renderizar o QR

qr_code já vem como imagem PNG em base64; qr_code_text é o payload EMV para o botão "copia e cola".

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

amountnumberREQUIRED

Valor em reais (ex.: 100.50) · Ex.: 100.50

externalIdstring

Seu identificador (pedido, fatura). Único por conta. · Ex.: pedido_12345

descriptionstring

Descrição exibida ao pagador

expiresInnumber

Validade em segundos (padrão 3600)

customerobject

Pagador: name (obrigatório), document (CPF/CNPJ), email, phone. Quando informado, só esse documento consegue pagar.

itemsarray

Itens do pedido: name, quantity, unit_price, total

metadataobject

Dados livres devolvidos nos webhooks

webhook_urlstring

URL extra para notificar apenas esta cobrança (sem assinatura HMAC)

Response

201Object

Response Attributes

transaction_idstring

external_idstring

amountnumber

qr_codestring

qr_code_textstring

expires_atstring

400 Bad Request
503 Service Unavailable

Esta seção foi útil?

POST/pix/qrcode/generate

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/qrcode/generate" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "amount": 100.5,6  "externalId": "pedido_12345",7  "description": "Pagamento do pedido 12345",8  "expiresIn": 3600,9  "customer": {10    "name": "João Silva",11    "document": "12345678900",12    "email": "[email protected]"13  },14  "metadata": {15    "order_id": "12345"16  }17}'

Response

{
  "success": true,
  "data": {
    "transaction_id": "uuid",
    "external_id": "pedido_12345",
    "amount": 100.5,
    "qr_code": "data:image/png;base64,iVBORw0KGgo...",
    "qr_code_text": "00020126580014br.gov.bcb.pix0136...6304A1B2",
    "expires_at": "2026-01-10T11:00:00Z"
  }
}

Creating static QR code

Cria um QR Code estático reutilizável (valor fixo ou livre) para ponto de venda.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

descriptionstringREQUIRED

Identificação do QR (ex.: Balcão 1)

amountnumber

Valor fixo. Omita para o pagador digitar o valor.

Response

201Object

Response Attributes

idstring

descriptionstring

amountinteger

pix_copy_pastestring

statusstring

created_atstring

Esta seção foi útil?

POST/pix/static-qrcode/generate

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/static-qrcode/generate" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "description": "Balcão 1",6  "amount": 257}'

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "description": "Balcão 1",
    "amount": 25,
    "pix_copy_paste": "00020126580014br.gov.bcb.pix0136...",
    "status": "active",
    "created_at": "2026-01-10T10:00:00Z"
  }
}

Refunding pix

Devolve, total ou parcialmente, um Pix recebido.

Acompanhe

O status final chega pelos eventos refund.completed / refund.failed ou em GET /pix/refunds/{refundId}/status.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

transactionIdstringREQUIRED

ID da transação recebida

amountnumber

Valor a devolver. Omita para devolução total.

reasonstring

Motivo da devolução

Response

201Object

Response Attributes

idstring

statusstring

amountstring

original_transaction_idstring

endToEndIdstring

reasonstring

created_atstring

400 Bad Request

Esta seção foi útil?

POST/pix/refunds/create

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/refunds/create" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "transactionId": "550e8400-e29b-41d4-a716-446655440000",6  "amount": 50,7  "reason": "Cliente solicitou cancelamento parcial"8}'

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "status": "PENDING",
    "amount": "50.00",
    "original_transaction_id": "550e8400-e29b-41d4-a716-446655440000",
    "endToEndId": "E3038525920250120103000xyz789",
    "reason": "Cliente solicitou cancelamento parcial",
    "created_at": "2026-01-10T10:30:00Z"
  }
}

Refund status

Status de uma devolução.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

refundIdstringREQUIRED

ID da devolução

Response

200Object

Response Attributes

idstring

statusstring

amountinteger

original_transaction_idstring

endToEndIdstring

completed_atstring

Esta seção foi útil?

GET/pix/refunds/{refundId}/status

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/refunds/{refundId}/status" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "status": "completed",
    "amount": 50,
    "original_transaction_id": "uuid",
    "endToEndId": "E3038525920250120103000xyz789",
    "completed_at": "2026-01-10T10:31:00Z"
  }
}

Pix · Cash-out

Envie Pix para uma chave ou pague um QR Code (copia e cola) debitando o saldo disponível. Há dois jeitos de enviar:

• Uma etapa — Sending pix by key / by QR code: uma chamada cria e envia o Pix.

• Duas etapas (contas habilitadas) — Initiating pix consulta o recebedor (chave no DICT ou QR Code na instituição liquidante) e devolve nome, documento mascarado e banco; Confirming initiated pix envia. Nada é debitado até a confirmação e a intenção vale por 10 minutos.

O resultado final de qualquer envio chega em withdrawal.completed ou withdrawal.failed.

Preview receiver (DICT)

Consulta a chave Pix no DICT e devolve nome, documento mascarado e banco do recebedor, sem movimentar dinheiro.

Disponível quando a adquirente de saque da conta consulta chaves sem iniciar pagamento. Quando não há consulta (enabled = false), use o fluxo em duas etapas (Initiating pix), que resolve o recebedor na própria iniciação.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

pix_keystringREQUIRED

Chave Pix do recebedor

pix_key_typestring

cpf, cnpj, email, phone ou random (detectado se omitido)

Response

200Object

Response Attributes

enabledboolean

receiverobject

422 Unprocessable
429 Too Many Requests

Esta seção foi útil?

POST/pix/withdrawals/preview

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/withdrawals/preview" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "pix_key": "[email protected]",6  "pix_key_type": "email"7}'

Response

{
  "success": true,
  "data": {
    "enabled": true,
    "receiver": {
      "name": "João Silva",
      "document_masked": "***.456.789-**",
      "person_type": "PF",
      "bank_name": "NU PAGAMENTOS S.A.",
      "ispb": "18236120"
    }
  }
}

Sending pix by key

Envia um Pix para uma chave, debitando o saldo disponível.

O valor é validado contra o limite diário da conta e o saldo disponível. Com token de chave de API o 2FA não é exigido (a chave já passa pela lista de IPs autorizados).

A resposta vem com status processing; o resultado final chega em withdrawal.completed ou withdrawal.failed (ou consulte o status).

Idempotência

Envie sempre um externalId único por saque e reaproveite-o ao repetir a chamada após timeout: um saque com o mesmo externalId não é criado duas vezes.

Prefere conferir o recebedor antes?

Contas com o saque em duas etapas habilitado usam Initiating pix (consulta e devolve nome/banco) e Confirming initiated pix.

Pix copia e cola

Para pagar um QR Code envie o código EMV completo em pixKey (veja Sending pix by QR code).

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

amountnumberREQUIRED

Valor em reais

pixKeystringREQUIRED

Chave Pix do recebedor (CPF/CNPJ só dígitos, telefone +55DDDNÚMERO, e-mail ou chave aleatória)

pix_key_typestring

cpf, cnpj, email, phone ou random

externalIdstring

Seu identificador único do saque (idempotência)

descriptionstring

Descrição que acompanha o Pix

Response

201Object

Response Attributes

idstring

typestring

statusstring

amountinteger

fee_amountinteger

net_amountinteger

pix_keystring

pix_key_typestring

external_idstring

descriptionstring

end_to_end_idnull

created_atstring

updated_atstring

400 Bad Request
400 Insufficient balance
403 Forbidden

Esta seção foi útil?

POST/pix/withdrawals/create

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/withdrawals/create" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "amount": 500,6  "pixKey": "13870676647",7  "pix_key_type": "cpf",8  "externalId": "saque_001",9  "description": "Saque mensal"10}'

Response

{
  "success": true,
  "data": {
    "id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
    "type": "pix_out",
    "status": "processing",
    "amount": 500,
    "fee_amount": 2,
    "net_amount": 502,
    "pix_key": "13870676647",
    "pix_key_type": "cpf",
    "external_id": "saque_001",
    "description": "Saque mensal",
    "end_to_end_id": null,
    "created_at": "2026-01-10T14:00:00Z",
    "updated_at": "2026-01-10T14:00:00Z"
  }
}

Initiating pix (two steps)

Passo 1 do envio em duas etapas: consulta o recebedor (chave Pix ou QR Code) e devolve uma intenção para conferência, sem enviar dinheiro.

Recurso habilitado por conta (fale com o suporte). A consulta é feita no DICT ou iniciando o Pix na instituição liquidante: o recebedor volta com nome, documento mascarado e banco, e nada é debitado até a confirmação. Contas sem o recurso recebem 403 com code TWO_STEP_DISABLED e usam Sending pix by key em uma etapa.

pixKey aceita uma chave Pix ou um Pix copia e cola (código EMV). Com QR Code, amount é opcional: QR com valor fixo devolve o valor na intenção; QR sem valor devolve amount 0 e o valor é informado na confirmação.

A intenção vale por 10 minutos. Confirme com PUT /pix/withdrawals/intents/{intentId}/confirm ou cancele com DELETE /pix/withdrawals/intents/{intentId}. Cada iniciação consome cota de consulta no Banco Central (liberada na confirmação): inicie só quando houver intenção de pagar.

Quando usar

Iniciar + confirmar: conferir o recebedor (nome, documento, banco) antes de enviar — por chave ou QR Code. Sending pix by key / by QR code: envio direto em uma chamada, para todas as contas.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

amountnumberREQUIRED

Valor em reais. Opcional apenas quando pixKey é um QR Code (copia e cola).

pixKeystringREQUIRED

Chave Pix do recebedor ou código Pix copia e cola (EMV, começa com 000201)

pix_key_typestring

cpf, cnpj, email, phone ou random (detectado se omitido; ignorado para QR Code)

externalIdstring

Seu identificador único (reaproveitado na transação ao confirmar)

descriptionstring

Descrição que acompanha o Pix

Response

201Object

Response Attributes

idstring

statusstring

amountinteger

pix_keystring

pix_key_typestring

descriptionstring

external_idstring

receiverobject

acquirerstring

expires_atstring

transaction_idnull

created_atstring

201 Created (QR Code)
403 Two-step disabled
400 Preview unavailable
400 QR Code fixed amount
422 Key not found
409 Conflict
429 Too Many Requests

Esta seção foi útil?

POST/pix/withdrawals/initiate

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/withdrawals/initiate" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "amount": 500,6  "pixKey": "[email protected]",7  "pix_key_type": "email",8  "externalId": "saque_001",9  "description": "Saque mensal"10}'

Response

{
  "success": true,
  "data": {
    "id": "7c1c7d2e-1b0a-4c3f-9a1e-2d3f4a5b6c7d",
    "status": "initiated",
    "amount": 500,
    "pix_key": "[email protected]",
    "pix_key_type": "email",
    "description": "Saque mensal",
    "external_id": "saque_001",
    "receiver": {
      "name": "João Silva",
      "document_masked": "***.456.789-**",
      "person_type": "PF",
      "bank_name": "NU PAGAMENTOS S.A.",
      "ispb": "18236120",
      "branch": "0001",
      "account_masked": "*****123",
      "account_type": "payment",
      "key": "[email protected]",
      "key_type": "email"
    },
    "acquirer": "brasilcash",
    "expires_at": "2026-01-10T14:10:00Z",
    "transaction_id": null,
    "created_at": "2026-01-10T14:00:00Z"
  }
}

Confirming initiated pix

Passo 2: confirma a intenção e envia o Pix. Debita o saldo e aplica as mesmas regras do envio em uma etapa.

Com token de chave de API o 2FA não é exigido. O resultado final chega em withdrawal.completed / withdrawal.failed (ou consulte o status pelo transaction_id devolvido). Uma intenção confirmada não pode ser confirmada de novo (409); expirada responde 410.

amount só é aceito quando a intenção veio de um QR Code sem valor (amount 0 na intenção) — e aí é obrigatório. Para intenções com valor definido, um amount diferente responde 400 AMOUNT_MISMATCH: inicie um novo saque.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

intentIdstringREQUIRED

id devolvido em Initiating pix

Body Parameters

amountnumber

Valor em reais — apenas para QR Code sem valor definido (intenção com amount 0)

Response

201Object

Response Attributes

idstring

typestring

statusstring

amountinteger

fee_amountinteger

net_amountinteger

pix_keystring

pix_key_typestring

external_idstring

descriptionstring

end_to_end_idnull

created_atstring

updated_atstring

400 Amount required
400 Amount mismatch
409 Already confirmed
410 Expired
400 Insufficient balance

Esta seção foi útil?

PUT/pix/withdrawals/intents/{intentId}/confirm

1curl -X PUT "https://api.brasilcash.app.br/api/v1/pix/withdrawals/intents/{intentId}/confirm" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{}'

Response

{
  "success": true,
  "data": {
    "id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
    "type": "pix_out",
    "status": "processing",
    "amount": 500,
    "fee_amount": 2,
    "net_amount": 502,
    "pix_key": "13870676647",
    "pix_key_type": "cpf",
    "external_id": "saque_001",
    "description": "Saque mensal",
    "end_to_end_id": null,
    "created_at": "2026-01-10T14:00:00Z",
    "updated_at": "2026-01-10T14:00:00Z"
  },
  "intent": {
    "id": "7c1c7d2e-1b0a-4c3f-9a1e-2d3f4a5b6c7d",
    "status": "confirmed",
    "amount": 500,
    "receiver": {
      "name": "João Silva",
      "document_masked": "***.456.789-**",
      "bank_name": "NU PAGAMENTOS S.A."
    }
  }
}

Cancelling initiated pix

Cancela uma intenção ainda não confirmada. Nada foi debitado.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

intentIdstringREQUIRED

id devolvido em Initiating pix

Response

200Object

Response Attributes

idstring

statusstring

Esta seção foi útil?

DELETE/pix/withdrawals/intents/{intentId}

1curl -X DELETE "https://api.brasilcash.app.br/api/v1/pix/withdrawals/intents/{intentId}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "7c1c7d2e-1b0a-4c3f-9a1e-2d3f4a5b6c7d",
    "status": "cancelled"
  }
}

Retrieving initiated pix

Situação de uma intenção (initiated, confirmed, cancelled ou expired) e, se confirmada, o transaction_id.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

intentIdstringREQUIRED

id devolvido em Initiating pix

Response

200Object

Response Attributes

idstring

statusstring

amountinteger

pix_keystring

receiverobject

transaction_idstring

expires_atstring

Esta seção foi útil?

GET/pix/withdrawals/intents/{intentId}

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/withdrawals/intents/{intentId}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "7c1c7d2e-1b0a-4c3f-9a1e-2d3f4a5b6c7d",
    "status": "confirmed",
    "amount": 500,
    "pix_key": "[email protected]",
    "receiver": {
      "name": "João Silva"
    },
    "transaction_id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
    "expires_at": "2026-01-10T14:10:00Z"
  }
}

Decoding QR code

Lê um Pix copia e cola (EMV) e devolve tipo, valor, chave e recebedor, para exibir antes de pagar. Não movimenta dinheiro.

amount vem null quando o QR Code não tem valor definido (o pagador informa). type é STATIC ou DYNAMIC.

A leitura usa a instituição liquidante da conta e consome cota de consulta: para o fluxo completo prefira Initiating pix com o código EMV, que já devolve o recebedor e segura o pagamento para confirmação.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

emvstringREQUIRED

Código Pix copia e cola (começa com 000201). Aliases: pix_copy_and_paste, pixCopyPaste.

Response

200Object

Response Attributes

typestring

amountinteger

keystring

key_typestring

receiver_namestring

receiver_documentstring

receiver_document_typestring

ispbstring

txidstring

descriptionstring

200 OK (sem valor)
400 Bad Request
422 Unprocessable

Esta seção foi útil?

POST/pix/qrcode/decode

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/qrcode/decode" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "emv": "00020126580014br.gov.bcb.pix0136...6304A1B2"6}'

Response

{
  "success": true,
  "data": {
    "type": "DYNAMIC",
    "amount": 150,
    "key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "key_type": "EVP",
    "receiver_name": "Loja Exemplo LTDA",
    "receiver_document": "12345678000190",
    "receiver_document_type": "CNPJ",
    "ispb": "30507541",
    "txid": "PEDIDO123",
    "description": "Pedido 123"
  }
}

Sending pix by QR code

Paga um Pix copia e cola em uma chamada: o código EMV vai no campo pixKey.

Mesma rota e regras de Sending pix by key (limite diário, saldo, 2FA para usuários do painel). Envie o código EMV completo em pixKey com pix_key_type = random e amount igual ao valor do QR Code (ou o valor desejado quando o QR não tem valor; um valor diferente do fixo é recusado).

Para conferir o recebedor antes de pagar use Decoding QR code ou, nas contas com saque em duas etapas, Initiating pix com o código EMV e Confirming initiated pix.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

amountnumberREQUIRED

Valor em reais (igual ao do QR Code quando ele tem valor fixo)

pixKeystringREQUIRED

Código Pix copia e cola completo (EMV, começa com 000201)

pix_key_typestringREQUIRED

random

externalIdstring

Seu identificador único do pagamento (idempotência)

descriptionstring

Descrição interna

Response

201Object

Response Attributes

idstring

typestring

statusstring

amountinteger

fee_amountinteger

net_amountinteger

pix_keystring

pix_key_typestring

external_idstring

descriptionnull

end_to_end_idnull

created_atstring

updated_atstring

400 Fixed amount
400 Insufficient balance

Esta seção foi útil?

POST/pix/withdrawals/create

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/withdrawals/create" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "amount": 150,6  "pixKey": "00020126580014br.gov.bcb.pix0136...6304A1B2",7  "pix_key_type": "random",8  "externalId": "pagamento_001"9}'

Response

{
  "success": true,
  "data": {
    "id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
    "type": "pix_out",
    "status": "processing",
    "amount": 150,
    "fee_amount": 2,
    "net_amount": 502,
    "pix_key": "00020126580014br.gov.bcb.pix0136...6304A1B2",
    "pix_key_type": "random",
    "external_id": "pagamento_001",
    "description": null,
    "end_to_end_id": null,
    "created_at": "2026-01-10T14:00:00Z",
    "updated_at": "2026-01-10T14:00:00Z"
  }
}

Listing withdrawals

Lista os Pix enviados pela conta.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Query Parameters

statusstring

pending, processing, completed, failed

pagenumber

Página (padrão 1)

limitnumber

Itens por página (padrão 50)

Response

200Array

Response Attributes

idstring

typestring

statusstring

amountinteger

fee_amountinteger

net_amountinteger

pix_keystring

pix_key_typestring

external_idstring

descriptionstring

end_to_end_idstring

created_atstring

updated_atstring

Esta seção foi útil?

GET/pix/withdrawals

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/withdrawals" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
      "type": "pix_out",
      "status": "completed",
      "amount": 500,
      "fee_amount": 2,
      "net_amount": 502,
      "pix_key": "13870676647",
      "pix_key_type": "cpf",
      "external_id": "saque_001",
      "description": "Saque mensal",
      "end_to_end_id": "E3038525920250120140500def456",
      "created_at": "2026-01-10T14:00:00Z",
      "updated_at": "2026-01-10T14:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1
  }
}

Retrieving withdrawal status

Status atual de um Pix enviado.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

withdrawalIdstringREQUIRED

ID (UUID) do saque

Response

200Object

Response Attributes

idstring

typestring

statusstring

amountinteger

fee_amountinteger

net_amountinteger

pix_keystring

pix_key_typestring

external_idstring

descriptionstring

end_to_end_idstring

created_atstring

updated_atstring

completed_atstring

200 Failed

Esta seção foi útil?

GET/pix/withdrawals/{withdrawalId}/status

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/withdrawals/{withdrawalId}/status" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "id": "f0b6c1b2-5d8e-4a1b-9c3d-2e4f5a6b7c8d",
    "type": "pix_out",
    "status": "completed",
    "amount": 500,
    "fee_amount": 2,
    "net_amount": 502,
    "pix_key": "13870676647",
    "pix_key_type": "cpf",
    "external_id": "saque_001",
    "description": "Saque mensal",
    "end_to_end_id": "E3038525920250120140500def456",
    "created_at": "2026-01-10T14:00:00Z",
    "updated_at": "2026-01-10T14:00:00Z",
    "completed_at": "2026-01-10T14:00:12Z"
  }
}

Pix Keys

Chaves Pix (DICT) da conta na instituição liquidante. Recurso liberado por conta (fale com o suporte): contas sem ele recebem enabled = false na listagem e 403 ao cadastrar. Cada conta pode ter até 5 chaves; a exclusão é imediata no DICT.

Retrieving pix keys

Lista as chaves Pix da conta na instituição liquidante.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Response

200Object

Response Attributes

enabledboolean

supportedboolean

acquirerstring

maxinteger

keysarray

200 Not enabled

Esta seção foi útil?

GET/pix/keys

1curl -X GET "https://api.brasilcash.app.br/api/v1/pix/keys" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "enabled": true,
    "supported": true,
    "acquirer": "brasilcash",
    "max": 5,
    "keys": [
      {
        "key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "type": "random",
        "status": "active",
        "created_at": "2026-01-10T10:00:00Z"
      },
      {
        "key": "12345678000190",
        "type": "cnpj",
        "status": "active",
        "created_at": "2026-01-05T09:30:00Z"
      }
    ]
  }
}

Creating pix key

Cadastra uma chave Pix no DICT pela instituição liquidante. Para random a chave é gerada pelo Banco Central.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

typestringREQUIRED

cpf, cnpj, email, phone ou random

keystring

Valor da chave (obrigatório exceto para random). CPF/CNPJ só dígitos, telefone +55DDDNÚMERO.

Response

201Object

Response Attributes

keystring

typestring

statusstring

created_atstring

400 Limit reached
403 Not enabled
409 Conflict

Esta seção foi útil?

POST/pix/keys

1curl -X POST "https://api.brasilcash.app.br/api/v1/pix/keys" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "type": "email",6  "key": "[email protected]"7}'

Response

{
  "success": true,
  "data": {
    "key": "[email protected]",
    "type": "email",
    "status": "active",
    "created_at": "2026-01-10T10:00:00Z"
  }
}

Delete pix key

Exclui uma chave Pix do DICT. QR Codes estáticos emitidos com ela deixam de receber.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

keystringREQUIRED

A chave (URL-encoded; e-mail e telefone com + codificados)

Response

200Object

Response Attributes

successboolean

404 Not found

Esta seção foi útil?

DELETE/pix/keys/{key}

1curl -X DELETE "https://api.brasilcash.app.br/api/v1/pix/keys/{key}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true
}

Webhooks

Cadastre uma URL HTTPS para receber os eventos da conta (recebimentos, envios, devoluções). Cada entrega é assinada com HMAC-SHA256 no header X-Webhook-Signature; responda 2xx em até 10 segundos — entregas sem 2xx são reenviadas com intervalo crescente.

Eventos e assinatura

Webhooks são requisições POST em JSON enviadas à URL cadastrada sempre que um evento acontece. Responda 2xx em até 10 segundos; sem resposta, reenviamos com intervalo crescente (até 5 tentativas).

Formato do payload

json

{
  "event": "transaction.completed",
  "timestamp": "2026-01-10T10:00:00Z",
  "data": {
    "id": "uuid",
    "txid": "uuid",
    "endToEndId": "E3038525920250120103000abc123",
    "merchant_id": "uuid",
    "amount": 100,
    "fee_amount": 1.5,
    "net_amount": 98.5,
    "payment_method": "pix",
    "status": "completed",
    "external_id": "pedido_123",
    "description": "Pagamento do pedido 123",
    "debtorAccount": {
      "document": "12345678901",
      "name": "João Silva",
      "ispb": "11275560",
      "bankName": "RECARGAPAY IP LTDA."
    },
    "creditorAccount": {
      "document": "12345678000190",
      "name": "Minha Empresa LTDA",
      "pixKey": "d8e8d3bd-9476-4088-81b8-6188a0565f23",
      "pixKeyType": "RANDOM"
    },
    "created_at": "2026-01-10T09:50:00Z",
    "completed_at": "2026-01-10T10:00:00Z"
  }
}

Assinatura

Cada entrega traz o header X-Webhook-Signature: HMAC-SHA256 do corpo (JSON exatamente como recebido) usando o secret devolvido na criação do webhook, em hexadecimal. Compare com tempo constante.

javascript

1const crypto = require('crypto');23function isValid(rawBody, signature, secret) {4  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');5  return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature || ''));6}

Eventos disponíveis

Evento	Quando
`transaction.created`	Cobrança Pix criada (QR Code gerado)
`transaction.completed`	Pix recebido e creditado no saldo
`transaction.failed`	Cobrança expirou ou falhou
`withdrawal.created`	Pix de saída criado
`withdrawal.awaiting_approval`	Saque aguardando aprovação manual
`withdrawal.processing`	Saque enviado à instituição liquidante
`withdrawal.completed`	Pix enviado com sucesso (traz endToEndId)
`withdrawal.failed`	Pix de saída falhou; o valor volta ao saldo (failure_reason)
`refund.created`	Devolução solicitada
`refund.completed`	Devolução concluída
`refund.failed`	Devolução falhou
`med.created`	MED aberto contra uma transação recebida; saldo bloqueado cautelarmente
`med.accepted`	MED aceito: valor debitado para devolução ao pagador
`med.rejected`	MED rejeitado (defesa aceita): saldo liberado

Exemplo: withdrawal.completed

json

{
  "event": "withdrawal.completed",
  "timestamp": "2026-01-10T14:00:12Z",
  "data": {
    "id": "uuid",
    "txid": "uuid",
    "endToEndId": "E3038525920250120140500def456",
    "merchant_id": "uuid",
    "amount": 500,
    "fee_amount": 2,
    "total_amount": 502,
    "payment_method": "pix",
    "status": "completed",
    "external_id": "saque_001",
    "description": "Saque mensal",
    "pix_key": "13870676647",
    "pix_key_type": "CPF",
    "creditorAccount": {
      "document": "13870676647",
      "name": "João Silva",
      "bankName": "NU PAGAMENTOS S.A."
    },
    "completed_at": "2026-01-10T14:00:12Z"
  }
}

Esta seção foi útil?

Create webhook

Cadastra uma URL para receber eventos. O secret de assinatura é devolvido apenas nesta resposta.

Guarde o secret

Ele não é mostrado de novo. Para trocar, apague o webhook e cadastre outro.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Body Parameters

urlstringREQUIRED

URL HTTPS pública que receberá os POSTs

eventsarrayREQUIRED

Lista de eventos (ver Eventos e assinatura)

is_activeboolean

Padrão true

retry_attemptsnumber

Tentativas de reenvio (padrão 5)

timeout_secondsnumber

Timeout por entrega (padrão 10)

Response

201Object

Response Attributes

idstring

urlstring

eventsarray

secretstring

is_activeboolean

created_atstring

400 Bad Request

Esta seção foi útil?

POST/webhooks

1curl -X POST "https://api.brasilcash.app.br/api/v1/webhooks" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "url": "https://seu-servidor.com/webhooks/brasilcash",6  "events": [7    "transaction.created",8    "transaction.completed",9    "withdrawal.completed",10    "withdrawal.failed",11    "refund.completed",12    "med.created"13  ],14  "is_active": true15}'

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "url": "https://seu-servidor.com/webhooks/brasilcash",
    "events": [
      "transaction.created",
      "transaction.completed",
      "withdrawal.completed"
    ],
    "secret": "whsec_abc123def456...",
    "is_active": true,
    "created_at": "2026-01-10T10:00:00Z"
  }
}

List webhooks

Lista os webhooks da conta com contadores de entrega.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Response

200Array

Response Attributes

idstring

urlstring

eventsarray

is_activeboolean

created_atstring

last_triggered_atstring

success_countinteger

failure_countinteger

Esta seção foi útil?

GET/webhooks

1curl -X GET "https://api.brasilcash.app.br/api/v1/webhooks" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "url": "https://seu-servidor.com/webhooks/brasilcash",
      "events": [
        "transaction.completed",
        "withdrawal.completed"
      ],
      "is_active": true,
      "created_at": "2026-01-10T10:00:00Z",
      "last_triggered_at": "2026-01-10T15:30:00Z",
      "success_count": 142,
      "failure_count": 3
    }
  ]
}

Update webhook

Altera URL, eventos ou ativa/desativa um webhook.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

idstringREQUIRED

ID do webhook

Body Parameters

urlstring

Nova URL

eventsarray

Nova lista de eventos

is_activeboolean

Ativa ou pausa as entregas

Response

200Object

Response Attributes

idstring

urlstring

eventsarray

is_activeboolean

Esta seção foi útil?

PUT/webhooks/{id}

1curl -X PUT "https://api.brasilcash.app.br/api/v1/webhooks/{id}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5  "events": [6    "transaction.completed"7  ],8  "is_active": false9}'

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "url": "https://seu-servidor.com/webhooks/brasilcash",
    "events": [
      "transaction.completed"
    ],
    "is_active": false
  }
}

Delete webhook

Remove um webhook.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

idstringREQUIRED

ID do webhook

Response

200Object

Response Attributes

successboolean

messagestring

Esta seção foi útil?

DELETE/webhooks/{id}

1curl -X DELETE "https://api.brasilcash.app.br/api/v1/webhooks/{id}" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "message": "Webhook deleted"
}

Delivery logs

Histórico de entregas, com status HTTP e tentativas.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Query Parameters

statusstring

success, failed, pending

eventstring

Filtra por evento

pagenumber

Página

limitnumber

Itens por página (padrão 50)

Response

200Array

Response Attributes

idstring

webhook_idstring

eventstring

statusstring

http_statusinteger

attemptsinteger

responsestring

created_atstring

delivered_atstring

Esta seção foi útil?

GET/webhooks/logs/list

1curl -X GET "https://api.brasilcash.app.br/api/v1/webhooks/logs/list" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "webhook_id": "uuid",
      "event": "transaction.completed",
      "status": "success",
      "http_status": 200,
      "attempts": 1,
      "response": "OK",
      "created_at": "2026-01-10T15:30:00Z",
      "delivered_at": "2026-01-10T15:30:01Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 145
  }
}

Retry delivery

Reenvia uma entrega que falhou.

Header Parameters

AuthorizationstringREQUIRED

Bearer {token} obtido em Retrieve access token. · Ex.: Bearer eyJhbGciOi...

Content-TypestringREQUIRED

application/json · Ex.: application/json

Path Parameters

log_idstringREQUIRED

ID do log de entrega

Response

200Object

Response Attributes

successboolean

messagestring

Esta seção foi útil?

POST/webhooks/logs/{log_id}/retry

1curl -X POST "https://api.brasilcash.app.br/api/v1/webhooks/logs/{log_id}/retry" \2  -H "Authorization: Bearer $TOKEN" \3  -H "Content-Type: application/json"

Response

{
  "success": true,
  "message": "Webhook queued for retry"
}