List Events

List infrastructure events for your partner account.

Endpoint

GET /partner/v1/events

Request

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key

Query parameters

Name	Type	Required	Description
delivered	string	No	Filter by delivery status: true or false

Response

Success (200 OK)

{
  "events": [
    {
      "id": "evt_abc123",
      "kind": "pix_key",
      "created_at": 1704067200,
      "is_delivered": false,
      "log": {
        "id": "log_xyz789",
        "kind": "registered",
        "created_at": 1704067200,
        "key": "abc123-def456-ghi789",
        "tax_id": "12345678900",
        "timestamp": 1704067200
      }
    }
  ]
}

Event kinds

Kind	Description
pix_key	Pix key lifecycle events
pix_inflow	Incoming Pix payment events
user	User account events
usdt_withdrawal	USDT withdrawal events

Pix Key event log

{
  "id": "log_xyz789",
  "kind": "registered",
  "created_at": 1704067200,
  "key": "abc123-def456-ghi789",
  "tax_id": "12345678900",
  "timestamp": 1704067200
}

Log kind	Description
created	Pix key creation requested
registered	Pix key successfully registered
failed	Pix key registration failed
canceled	Pix key was deleted

Pix Inflow event log

{
  "id": "log_xyz789",
  "kind": "credited",
  "created_at": 1704067200,
  "amount_cents": 10000,
  "description": "Payment",
  "end_to_end_id": "E12345678...",
  "method": "dict",
  "receiver_tax_id": "12345678900",
  "sender_name": "João Silva",
  "sender_tax_id": "98765432100",
  "timestamp": 1704067200
}

Log kind	Description
created	Pix inflow received
credited	Funds credited to user
failed	Inflow processing failed

User event log

{
  "id": "log_xyz789",
  "kind": "opened",
  "created_at": 1704067200,
  "tax_id": "12345678900",
  "account_branch_code": "0001",
  "account_full_number": 123456,
  "account_digit": 7,
  "timestamp": 1704067200
}

Log kind	Description
opened	User account opened
closed	User account closed

USDT Withdrawal event log

{
  "id": "log_xyz789",
  "kind": "settled",
  "created_at": 1704067200,
  "tax_id": "12345678900",
  "amount_usdtmicros": 100000000,
  "blockchain_address": "0x1234...",
  "network": "polygon",
  "tx_hash": "0xabcd...",
  "timestamp": 1704067200
}

Log kind	Description
created	Withdrawal request created
sent	Transaction sent to blockchain
settled	Transaction confirmed on-chain
failed	Withdrawal failed

Example

# List all events
curl https://api.bipa.tech/partner/v1/events \
  -H "X-API-Key: your_partner_api_key"

# List only pending events
curl "https://api.bipa.tech/partner/v1/events?delivered=false" \
  -H "X-API-Key: your_partner_api_key"