Portal Data APIs

GET /v1/portal

Returns the current user's scoped portal snapshot.

What it pulls:

• principal and account profile data
• organization branding and DNS state
• access flags
• visible users
• visible terminals
• visible groups and connectors
• recent transactions, commands, and forms
• the available report catalog

curl -sS \
  -H 'X-API-Key: $PINRAIL_API_KEY' \
  https://api.pinrail.xyz/v1/portal

GET /v1/transactions

Returns normalized, scoped transaction rows for visible terminals.

What it pulls:

• terminal date and time
• transaction type
• sequence number
• account type
• EMV indicator when available
• response
• amount requested and completed
• surcharge requested and completed
• total surcharge and total withdrawn in the response summary

Supports query params such as:

• limit
• terminal_id
• group_id
• sort_by
• sort_dir

curl -sS \
  -H 'X-API-Key: $PINRAIL_API_KEY' \
  'https://api.pinrail.xyz/v1/transactions?group_id=grp_pilot_lab&sort_by=amt_comp&sort_dir=desc&limit=10'

GET /v1/settlements

Returns scoped ACH settlement batches visible to the current account.

What it pulls:

• batch status
• entry counts
• credit and debit totals
• net payout
• batch timing fields

curl -sS \
  -H 'X-API-Key: $PINRAIL_API_KEY' \
  https://api.pinrail.xyz/v1/settlements

GET /v1/disputes

Returns scoped dispute cases visible to the current account.

What it pulls:

• dispute status and reason code
• related transaction and terminal IDs
• amount, due date, assignment, and resolution fields
• reviewer metadata when the case has been resolved

curl -sS \
  -H 'X-API-Key: $PINRAIL_API_KEY' \
  https://api.pinrail.xyz/v1/disputes