English

API de Transações de Terceiros

Esta documentação descreve o endpoint para registro de transações realizadas por terceiros, essenciais para o monitoramento de compliance PLD.

Registrar Transação de Terceiro

[POST] /third-party-payment-transactions

Registra uma nova transação realizada por um terceiro no sistema.

Parâmetros do corpo

Nome do campo	Tipo de dado	Obrigatório	Descrição
`tax_id`	string	Sim	CPF do titular da transação. Exemplo: `"012.345.678-90"`.
`amount`	number	Sim	Valor da transação em centavos. Exemplo: `15000` para R$ 150,00.
`date`	datetime	Sim	Data e hora da transação. Exemplo: `"2024-01-15T10:30:00Z"`.
`psp`	string	Sim	Payment Service Provider. Exemplo: `"Paag2"`.
`type`	string	Sim	Tipo da transação. Opções: `"cash_in"`, `"cash_out"`.
`merchant`	string	Sim	Identificação do estabelecimento. Exemplo: `"BetXX"`.
`account_number`	string	Não	Número da conta corrente. Exemplo: `"12345-6"`.
`branch`	string	Não	Número da agência bancária. Exemplo: `"1234"`.
`account_type`	string	Não	Tipo da conta. Opções: `"checking"`, `"savings"`.
`ispb`	string	Não	Código ISPB da instituição financeira. Exemplo: `"60746948"`.
`e2e`	string	Não	Identificador end-to-end da transação PIX. Exemplo: `"E12345678202401151030"`.

Exemplo de Requisição

Registrar Transação de Terceiro

cURL

curl --location 'https://aml.paag.io/third-party-payment-transactions' \
--header 'accept: application/json' \
--header 'x-api-key: {{ token }}' \
--header 'Content-Type: application/json' \
--header 'Origin: *' \
--data '{
  "tax_id": "012.345.678-90",
  "amount": 15000,
  "date": "2024-01-15T10:30:00Z",
  "psp": "Paag2",
  "type": "cash_in",
  "merchant": "BetXX",
  "account_number": "12345-6",
  "branch": "1234",
  "account_type": "checking",
  "ispb": "60746948",
  "e2e": "E12345678202401151030"
}'

Respostas

200 - Criado com sucesso

{
  "id": "txn_abc123def456"
}

400 - Dados inválidos

{
  "error": {
    "message": "Dados de entrada inválidos",
    "details": {
      "tax_id": ["CPF deve estar no formato válido"],
      "amount": ["Valor deve ser maior que zero"]
    },
    "status": 400
  }
}

Notas Adicionais

tax_id: CPF (Cadastro de Pessoas Físicas), documento de identificação brasileiro.
PSP: Payment Service Provider (Provedor de Serviços de Pagamento).
ISPB: Identificador do Sistema de Pagamentos Brasileiro.
E2E: Identificador end-to-end usado em transações PIX.
Cash In/Cash Out: Entrada e saída de dinheiro, respectivamente.
Account Type: "checking" para conta corrente, "savings" para poupança.

Os dados coletados são utilizados para análises de compliance e detecção de padrões suspeitos conforme regulamentações PLD.