Consultar uma chave Pix de uma conta

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API para consultar os dados associados a uma Chave de Endereçamento, incluindo o Nome do Titular, CPF/CNPJ do Titular, ISPB do PSP, Número da Agência, Tipo de Conta e Número da Conta.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Consultar uma chave Pix de uma conta

post

Authorizations

Body

objectOptionalExample: {"payerId":"11165756000107","key":"25335905000143"}

Responses

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/dict HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "payerId": "11165756000107",
  "key": "25335905000143"
}

No content

JSON Retorno Sucesso

{
    "endToEndId": "E1116575620240216005420625882974",
    "name": "PAULO SERGIO CONSULIN",
    "cpfCnpj": 25335905000143,
    "peopleType": "JURIDICA",
    "key": "25335905000143",
    "keyType": "CNPJ",
    "ispb": 11165756,
    "agency": "1",
    "account": "62",
    "accountType": "CORRENTE",
    "dateCreateKey": "2023-12-07T12:47:55.885Z",
    "dateInitKey": "2023-12-07T12:47:55.879Z",
    "dateOpenAccount": "2023-12-07T12:47:54.417Z"
}