v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar uma chave Pix (DICT)

Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-chaves-pix-externa-dict

get/pix/dict/entry/external/{account}

Path parameters

accountstring required

Query parameters

keystring required

Chave Pix

ownerTaxIdstring

includeStatisticsboolean

Inclui estatísticas da chave Pix

Response

200

versionstring

statusstring

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "keyType": "string",
    "key": "string",
    "account": {
      "participant": "30306294",
      "branch": "0001",
      "account": "10545584",
      "accountType": "TRAN",
      "createDate": "2020-11-03T06:30:00-03:00"
    },
    "owner": {
      "type": "NATURAL_PERSON",
      "documentNumber": "34335125070",
      "name": "Carlos Henrique da Silva"
    },
    "endtoEndId": "string"
  }
}