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

Consulta de chave PIX para realizar pagamentos.

Dados para os clientes diretos serão enviados mascarados.

Com esses dados, o cliente utiliza o endToEndId para realizar o pagamento, caso os dados correspondam à pessoa que deseja fazer o pagamento.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

payerIdstringRequired

CPF/CNPJ de quem esta realizando a consulta e ira realizar o pagamento.

Example: 11165756000107

keystringRequiredExample: 25335905000143

Responses

200

Consulta realizada com sucesso

application/json

endToEndIdstringOptionalExample: E1116575620241104181133791593625

namestringOptionalExample: PORSCHE BRASIL IMPORTADORA DE VEICULOS LTDA

cpfCnpjintegerOptionalExample: 1306024000136

peopleTypestring · enumOptionalExample: JURIDICAPossible values:

keystringOptionalExample: 01306024000136

keyTypestring · enumOptionalExample: CNPJPossible values:

ispbintegerOptionalExample: 11165756

agencystringOptionalExample: 11

accountstringOptionalExample: 11

accountTypestring · enumOptionalExample: CORRENTEPossible values:

dateCreateKeystring · date-timeOptionalExample: 2024-01-03T12:30:21.499Z

dateInitKeystring · date-timeOptionalExample: 2024-01-03T12:30:21.485Z

dateOpenAccountstring · date-timeOptionalExample: 2023-12-13T03:01:12.000Z

401

Falha de autorização

422

Falha de validação

500

Erro desconhecido no servidor

post

/internal/api/v1/keys/dict

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/dict HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

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

{
  "endToEndId": "E1116575620241104181133791593625",
  "name": "PORSCHE BRASIL IMPORTADORA DE VEICULOS LTDA",
  "cpfCnpj": 1306024000136,
  "peopleType": "JURIDICA",
  "key": "01306024000136",
  "keyType": "CNPJ",
  "ispb": 11165756,
  "agency": "11",
  "account": "11",
  "accountType": "CORRENTE",
  "dateCreateKey": "2024-01-03T12:30:21.499Z",
  "dateInitKey": "2024-01-03T12:30:21.485Z",
  "dateOpenAccount": "2023-12-13T03:01:12.000Z"
}

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"
}