Skip to main content
GET
/
v1
/
entries
/
{entryId}
/
details
Retrieve key
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/entries/{entryId}/details \
  --header 'Authorization: Bearer <token>'
{
  "key": "+5511987654321",
  "endToEndId": "E1234567820230615123456789012345",
  "payee": {
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "key": "+5511987654321",
    "keyType": 3
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Path Parameters

​
entryId
string
required

Pix key value.

Query Parameters

​
account_id
string<uuid>

Account identifier.

Response

Pix key details retrieved successfully

​
key
string
required

Pix key value.

Example:

"+5511987654321"

​
endToEndId
string
required

End-to-end transaction identifier.

Example:

"E1234567820230615123456789012345"

​
payee
object
required

Bank account information.