Consultar dados do destinatário antes de criar transferência P2P
Este endpoint permite consultar previamente os dados do destinatário a partir do documento (CPF ou CNPJ), garantindo maior segurança antes da criação de uma transferência P2P.
Validação destinatárioEssa validação é recomendada para evitar inconsistências e reduzir riscos operacionais antes de iniciar um fluxo de transferência.
POST urlServidor/v1/marketplace/transfers/check-p2p
Obs: A palavra urlServidor deve ser substituída pela url do servidor.
Parâmetros da Requisição
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
integration-key | string | Sim | Chave de integração. |
x-token | string | Sim | Token utilizado para autenticação. Pode ser encontrado no portal da API. |
Authorization | Auth Type Bearer Token | Sim | Inserir o Bearer Token, gerado na rota Auth |
Exemplo de header da requisição
curl--request POST \
--location 'urlServidor/v1/marketplace/transfers/check-p2p' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \Variáveis
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| document | string | Sim | Documento do destinatário (CPF ou CNPJ) |
📥 Modelo Body
{
"document": "11299221000129"
}Response
{
"first_name": "Teste Sandbox",
"last_name": "Solucoes",
"document": "11299221000129",
"phone_number": "27992830001",
"type": "BUSINESS",
"account": {
"document": null,
"bank_id": 165,
"routing_number": "0001",
"routing_check_digit": null,
"account_number": "416947",
"account_check_digit": "0",
"bank": {
"name": "CELCOIN IP S.A.",
"code": "509",
"ispb": "13935893"
}
}
}📥 Detalhe response
Dados do destinatário
| Campo | Tipo | Descrição |
|---|---|---|
| first_name | string | Primeiro nome ou razão social |
| last_name | string | Sobrenome ou nome fantasia |
| document | string | Documento do recebedor |
| phone_number | string | Telefone do recebedor |
| type | string | Tipo do estabelecimento (ex: pessoa física ou jurídica) |
Dados da conta
| Campo | Tipo | Descrição |
|---|---|---|
| account.document | string | Documento do titular da conta |
| account.bank_id | number | ID interno do banco |
| account.routing_number | string | Número da agência |
| account.routing_check_digit | string | Dígito verificador da agência |
| account.account_number | string | Número da conta |
| account.account_check_digit | string | Dígito verificador da conta |
| account.type | string | Tipo da conta (corrente, poupança, etc) |
Dados do banco
| Campo | Tipo | Descrição |
|---|---|---|
| account.bank.name | string | Nome do banco |
| account.bank.code | string | Código do banco |
| account.bank.ispb | string | ISPB do banco |
🔁 Fluxo recomendado de uso
- O parceiro envia o documento do destinatário
- A API retorna os dados cadastrados vinculados à conta bancária
- O parceiro valida:
- Nome do recebedor
- Documento
- Dados bancários
- Após validação, prosseguir com a criação da transferência P2P
Códigos de resposta
Consulte a página com os status: Status de respostas
Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.
Updated 3 months ago
Did this page help you?