Listar chaves
Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
GET
https://horizon-api-sb.app.rpe.tech
Chaves
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/chaves?bankAccountNumber&date&description&from&to&idAccount&key&keyStatus&keyType&limit&page&sort&transactionUUID' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Content-Type: application/json'Response Response Example
200 - Example 1
{
"previousPage": 1,
"currentPage": 2,
"nextPage": 3,
"last": true,
"totalPages": 3,
"totalItems": 20,
"maxItemsPerPage": 25,
"totalItemsPage": 25,
"items": [
{
"key": "Telefone",
"keyType": "nationalRegistration",
"dateKeyCreated": "2025-01-12T17:08:20.123Z",
"dateKeyOwnership": "2025-01-12T17:08:20.123Z",
"description": "Email",
"keyStatus": "OPEN",
"keyAccount": {
"idAccount": 2001,
"bankAccountNumber": "000009876",
"bankBranchNumber": "0012",
"bankAccountType": "CC",
"dateAccountCreated": "2024-02-12T17:08:20.123Z",
"ispb": "12345678",
"beneficiaryType": "F",
"nationalRegistration": "03967703675",
"name": "Maria Silva",
"tradeName": "M Sousa LTDA"
},
"claim": {
"claimType": "KEY_TRANSFER",
"playerType": "CLAIMANT",
"claimStatus": "WAITING_GRANTOR",
"dateKeyClaimed": "2023-02-12T17:08:20.123Z",
"grantorDeadline": "2025-02-02T17:08:20.123Z",
"claimDeadline": "2024-02-12T17:08:20.123Z",
"claimUUID": "f23f9809-199a-494f-b5bf-9d57c0530f23",
"key": "teste@teste.com",
"keyType": "nationalRegistration",
"dateKeyCreated": "2025-01-12T17:08:20.123Z",
"dateKeyOwnership": "2025-02-12T17:08:20.123Z",
"description": "Email",
"keyStatus": "OPEN",
"claimantAccount": {
"claimName": "Maria Sousa",
"bankAccountNumber": "0067890",
"bankAccountType": "CC",
"bankBranchNumber": "009"
}
}
}
]
}Requisição
Parâmetros Query
bankAccountNumber
string
opcional
Exemplo:
00009123
date
string <date>
opcional
dateKeyOwnership) para consulta de chave.Exemplo:
2023-02-12
description
string
opcional
Exemplo:
Email
from
string
opcional
dateKeyOwnership.Exemplo:
2021-04-25T22:09:40.690Z
to
string
opcional
dateKeyOwnership..Exemplo:
2021-04-26T22:09:40.690Z
idAccount
string
opcional
>= 1 Caracteres<= 14 Caracteres
Exemplo:
2001
key
string
opcional
Exemplo:
teste@teste.com
keyStatus
enum<string>
opcional
Valores permitidos:
OPENWAITING_RESOLUTION
Exemplo:
OPEN
keyType
enum<string>
opcional
Valores permitidos:
emailevpphoneNumbernationalRegistration
Exemplo:
email
limit
string
opcional
>= 1 Caracteres<= 100 Caracteres
Padrão:
20
Exemplo:
3
page
string
opcional
Padrão:
1
Exemplo:
2
sort
enum<string>
opcional
Valores permitidos:
ASCDESC
Exemplo:
DESC
transactionUUID
string
opcional
Exemplo:
f09f6609-199a-494f-b5bf-9d57c0530f23
Parâmetros Header
Accept
string
requerido
Exemplo:
*/*
Content-Type
string
opcional
Exemplo:
application/json
Authorization
string
opcional
BearerExemplo:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ