Saltar al contenido principal
GET
/
v1
/
dict
/
keys
/
{key}
Recuperar una clave
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/keys/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{ "key": "john.doe@example.com", "keyType": "EMAIL", "account": { "branch": "0001", "number": "123456789", "participant": "12345678", "type": "TRAN" }, "owner": { "name": "John Doe", "taxIdNumber": "12345678901", "type": "NATURAL_PERSON" } }

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

​
X-EndToEnd-Id
string

Identificador de extremo a extremo del SPI, opcional, utilizado para propuestas de pago.

Parámetros de ruta

​
key
string
requerido

Valor de la clave Pix (CPF, CNPJ, correo electrónico, teléfono o EVP).

Respuesta

Detalles de la clave Pix recuperados correctamente.

​
key
string

Valor de la clave Pix.

Ejemplo:

"john.doe@example.com"

​
keyType
string

Tipo de clave Pix.

Ejemplo:

"EMAIL"

​
account
object
​
owner
object