Skip to content

Third Party Payment Transactions API

This documentation describes the endpoint for registering transactions performed by third parties, essential for AML compliance monitoring.

Register Third Party Transaction

[POST] /third-party-payment-transactions

Registers a new transaction performed by a third party in the system.

Body Parameters

Field Name Data Type Required Description
tax_id string Yes Player's tax ID (CPF). Example: "012.345.678-90".
amount number Yes Transaction amount in cents. Example: 15000 for R$ 150.00.
date datetime Yes Transaction date and time. Example: "2024-01-15T10:30:00Z".
psp string Yes Payment Service Provider. Example: "Paag2".
type string Yes Transaction type. Options: "cash_in", "cash_out".
merchant string Yes Merchant identification. Example: "BetXX".
account_number string No Account number. Example: "12345-6".
branch string No Bank branch number. Example: "1234".
account_type string No Account type. Options: "checking", "savings".
ispb string No ISPB code of financial institution. Example: "60746948".
e2e string No End-to-end identifier for PIX transaction. Example: "E12345678202401151030".

Request Example

Register Third Party Transaction

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"
}'

Responses

200 - Successfully Created 
{
  "id": "txn_abc123def456"
}
400 - Invalid Data 
{
  "error": {
    "message": "Invalid input data",
    "details": {
      "tax_id": ["Tax ID must be in valid format"],
      "amount": ["Amount must be greater than zero"]
    },
    "status": 400
  }
}

Additional Notes

  • tax_id: Brazilian Individual Taxpayer Registry (CPF), Brazilian identification document.
  • PSP: Payment Service Provider.
  • ISPB: Brazilian Payment System Identifier.
  • E2E: End-to-end identifier used in PIX transactions.
  • Cash In/Cash Out: Money inflow and outflow, respectively.
  • Account Type: "checking" for current account, "savings" for savings account.

The collected data is used for compliance analysis and detection of suspicious patterns according to AML regulations.