# Consultar destinatário (/docs/conta-digital/endpoints/pix/post_pix_destination)

## POST /transactions/pix/destination

`POST https://api.hub.payzu.com.br/api/v1/transactions/pix/destination`

Escopo: `PIX_DICT_READ`. Mostra o titular e a instituição de uma chave Pix ou de um Pix copia e cola, para conferir antes de pagar. Limite de requisições: 30 consultas por minuto por conta.

### Body params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `pixKey` | string | no | Chave Pix a consultar. Envie `pixKey` ou `brCode`, nunca os dois. — minLength: 1; maxLength: 140 |
| `pixKeyType` | string | no | Tipo da chave. Só com `pixKey`. — `EVP`, `CNPJ`, `CPF`, `EMAIL`, `PHONE` |
| `brCode` | string | no | Pix copia e cola a consultar. — minLength: 8; maxLength: 1024 |

### Responses

**200** Destinatário.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `source` | string | yes | O que foi consultado: `PIX_KEY` ou `BR_CODE`. — `PIX_KEY`, `BR_CODE` |
| `pixKey` | string | yes | Chave de destino. CPF, e-mail e telefone saem mascarados; CNPJ e chave aleatória, legíveis. |
| `pixKeyType` | string | null | yes | Tipo da chave, deduzido do formato. `null` quando o formato não é reconhecido. — `EVP`, `CNPJ`, `CPF`, `EMAIL`, `PHONE` |
| `holder` | object | null | yes | Titular da chave. `null` quando não há nome nem documento. |
| `holder.name` | string | null | yes | Nome do titular, por extenso. |
| `holder.document` | string | null | yes | CPF mascarado ou CNPJ formatado. |
| `bank` | object | null | yes | Instituição do destino. `null` quando a consulta não aconteceu. |
| `bank.name` | string | null | yes | Nome da instituição. |
| `bank.ispb` | string | null | yes | ISPB da instituição. |
| `bank.branch` | string | null | yes | Agência. |
| `bank.accountNumber` | string | null | yes | Conta mascarada, com os quatro últimos dígitos visíveis. |
| `amount` | integer | null | yes | Valor fixado no Pix copia e cola. Sempre `null` para chave. Em centavos. |
| `isAmountFixed` | boolean | yes | `true` quando `amount` não é `null`. |
| `isVerified` | boolean | yes | `true` quando o nome veio do DICT; `false` quando veio do próprio Pix copia e cola. |

**400** Requisição inválida.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**401** Credencial ausente, inválida ou expirada.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**403** Sem permissão: escopo, IP ou operação desabilitada.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**404** Não encontrado, ou de outra conta.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**412** Falta um passo antes desta operação.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**422** Recusa de regra de negócio.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**429** Limite de requisições excedido.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**502** O banco não respondeu ou recusou.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |

**503** Serviço de consulta ou limitador indisponível; nada foi feito.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `message` | string | yes | Descrição em português, pronta para exibir. Pode mudar a qualquer momento. |
| `code` | string | yes | Código estável do erro. É por ele que o seu sistema decide o que fazer. |
| `details` | object | no | Contexto estruturado do erro, quando existe. |