GET
/
v1
/
entries
/
{entryId}
/
details
Retrieve key details
curl --request GET \
  --url http://localhost:4011/v1/entries/{entryId}/details \
  --header 'Authorization: Bearer <token>'
{
  "key": "12345678901",
  "endToEndId": "E1234567820250926120000001",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "0",
    "key": "12345678901",
    "bankName": "Banco Example"
  }
}

Authorizations

Authorization
string
header
required

JWT token obtained from the authentication endpoint

Path Parameters

entryId
string
required

Pix key to get details for

Query Parameters

account_id
string<uuid>
required

Account ID requesting the details

Response

Pix key details retrieved successfully

key
string

Pix key

Example:

"12345678901"

endToEndId
string

End-to-end transaction identifier

Example:

"E1234567820250926120000001"

payee
object