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ário

Essa 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

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken utilizado para autenticação. Pode ser encontrado no portal da API.
AuthorizationAuth Type Bearer TokenSimInserir 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

CampoTipoObrigatórioDescrição
documentstringSimDocumento 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

CampoTipoDescrição
first_namestringPrimeiro nome ou razão social
last_namestringSobrenome ou nome fantasia
documentstringDocumento do recebedor
phone_numberstringTelefone do recebedor
typestringTipo do estabelecimento (ex: pessoa física ou jurídica)

Dados da conta

CampoTipoDescrição
account.documentstringDocumento do titular da conta
account.bank_idnumberID interno do banco
account.routing_numberstringNúmero da agência
account.routing_check_digitstringDígito verificador da agência
account.account_numberstringNúmero da conta
account.account_check_digitstringDígito verificador da conta
account.typestringTipo da conta (corrente, poupança, etc)

Dados do banco

CampoTipoDescrição
account.bank.namestringNome do banco
account.bank.codestringCódigo do banco
account.bank.ispbstringISPB do banco

🔁 Fluxo recomendado de uso

  1. O parceiro envia o documento do destinatário
  2. A API retorna os dados cadastrados vinculados à conta bancária
  3. O parceiro valida:
    1. Nome do recebedor
    2. Documento
    3. Dados bancários
  4. 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.


Did this page help you?