Consultar Chaves Pix de uma Conta
Consultar uma chave Pix para uma conta
Essa funcionalidade permite que os clientes da Celcoin consigam consultar as chaves Pix que foram criadas na conta de seus clientes.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Consultar Chaves PIX - [API Reference]
Consultar chaves Pix
cURL da chamada
curl --location -g --request GET 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/entry/{{Numero_da_Conta}}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"listKeys": [
{
"keyType": "EMAIL",
"key": "[email protected]",
"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"
}
}
]
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE177",
"message": "Operação não permitida. Conta esta bloqueada"
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE091 | É necessário informar pelo menos um dos campos: id, clientCode, ou endtoendId. |
| CBE039 | Account invalido. |
| CBE175 | Cadastro de chave não permitido. Verifique o formato da chave informada |
| CBE041 | Account possui tamanho maximo de 20 caracteres |
| CBE174 | O Campo key não pode ultrapassar 77 caracteres |
| CBE176 | Operação não permitida. Conta esta encerrada |
| CBE177 | Operação não permitida. Conta esta bloqueada |
| CBE190 | Operação Não permitida. Chave não esta vinculada a essa conta. |
Updated 4 months ago