Get Pix key or QR Code details

Receives a Pix key or a QR Code (static or dynamic) and returns the available details, including the receiver's banking data resolved via DICT. Use this to show the payee, amount, and account to the payer before calling Create payment consent.

Send exactly one of pixKey or qrCode — never both.

POST/api/v1/pix/details

Get Pix key or QR Code details

Resolves a Pix key or QR Code (Copia e Cola) to the receiver's banking data.

Auth: Bearer Token

Headers

1 campo

subTenantId

headerstring

Sub-tenant ID when required by the authenticated user context.

Request body

2 campos

pixKey

bodystring

Receiver's Pix key. Either pixKey or qrCode must be provided, never both.

qrCode

bodystring

Pix QR Code (Copia e Cola), static or dynamic. Either pixKey or qrCode must be provided, never both.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/pix/details' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --data '{
  "pixKey": "12447403739",
  "qrCode": "00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/efafb771be4f41bb8e56e156cb1d6ec05204000053039865802BR5903Pix6008BRASILIA62070503***6304B131"
}'

Response

200Pix details resolved successfully.

Response body

object

dataobjectrequired
PixDetailsResponseDto.
- typestringrequired
  Lookup source. PIX_KEY | STATIC | DYNAMIC
- pixKeystringrequired
  Receiver's Pix key.
- valuestring
  Transaction value, when available in the QR Code.
- txIdstring
  Transaction identifier, when available in the QR Code.
- accountobjectrequired
  Receiver's banking data, resolved via DICT.
messagestring
Response message.
typestring
Envelope type.
statusCodeinteger· nullable
HTTP status in envelope.

200 · Pix details resolved successfully.

{
  "data": {
    "type": "DYNAMIC",
    "pixKey": "4004901d-bd85-4769-8e52-cb4c42c506dc",
    "value": "100.00",
    "txId": "MOCKEDTXID001",
    "account": {
      "name": "EMPRESA TESTE LTDA",
      "personType": "PESSOA_JURIDICA",
      "cpfCnpj": "11111111000191",
      "accountIspb": "99999008",
      "accountIssuer": "0001",
      "accountNumber": "12345678",
      "accountType": "CACC"
    }
  },
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps

Create payment consent — send the resolved qrCode (or the payer's chosen pixKey flow) on the payment payload.