1. Intenção de Pagamento
Brasil Cash API
v3
  • main
  • v3
  • Gateway
    • Autenticação
      • Recebendo um token de acesso
    • Conta
      • Dados da conta
      • Listar transactions
      • Visualizar saldo na conta
    • Intenção de Pagamento
      • API de Pagamentos — Intenção de Pagamento (Payment Intent)
      • Iniciando TEF
        POST
      • Iniciando TED
        POST
      • Iniciando PIX Chave
        POST
      • Iniciando PIX QRCode
        POST
      • Iniciando PIX Manual
        POST
      • Confirmando Intenção de Pagamento
        PUT
      • Lendo dados QRCode
        POST
      • Listando Intenção de Pagamentos
        GET
      • Detalhe de uma Intenção de Pagamento
        GET
    • QRCode
      • Criando um QRCode PIX
      • Static QRCODE
      • Detalhe de um QRCode
      • Inativando um QRCode
    • PIX Dict
      • Listando Chaves PIX
      • Criando Chave PIX
      • Cancelamento de Chave PIX
    • MED
    • Webhooks
  • BaaS
    • BrasilCash BaaS — API do Parceiro (v1)
    • Onboardings
      • Listar Onboardings
      • Criar link de onboarding
    • Contas
      • Listar Contas
      • Detalhar Conta
      • Criar credencial para uma conta
  • Esquemas
    • PIX
      • ReceiverPayer
      • Pix Initiate
      • Pix Consulta
      • Paginação
    • Pagador/Recebedor
    • ApplicationError
  1. Intenção de Pagamento

Iniciando PIX Chave

BaaS API
https://api.brasilcash.com.br/baas
BaaS API
https://api.brasilcash.com.br/baas
POST
/v2/pix/payments/key
Cria uma intenção de pagamento PIX utilizando uma chave PIX como identificador da conta recebedora.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Bodyapplication/json

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.brasilcash.com.br/baas/v2/pix/payments/key' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 110,
    "key_type": "document",
    "key": "356792336842",
    "external_id": "74078baa-3748-4119-a67c-2212cc9aa216"
}'
Response Response Example
200 - 200 OK
{
    "pix_id": "11112222-ce91-4654-8f97-f4955d5e0b6a",
    "endToEndId": "E7102786620220713142814756293322",
    "amount": 101,
    "tax_amount": 0,
    "status": "processing",
    "created_at": "2022-07-13T11:28:15.221904-03:00",
    "external_id": "22228b26-4c53-44e4-b945-6b5fa8727f0b",
    "receiver": {
        "ipsb": "18236120",
        "bank_name": "NU PAGAMENTOS - IP",
        "branch": "0001",
        "account_number": "0123455",
        "account_type": "ContaPagamento",
        "document": "01234567890",
        "document_type": "CPF",
        "name": "string",
        "trade_name": "string"
    }
}
Modificado em 2026-10-16 20:53:35
Página anterior
Iniciando TED
Próxima página
Iniciando PIX QRCode
Built with