Pinrail Docs
DevelopmentAPI

Live Testing

Test the currently published production APIs on api.pinrail.xyz from the docs site.

Overview

Use this page structure as the reference for live production testing against api.pinrail.xyz.

The current live testing flow is intended for:

  • validating a newly created API key
  • confirming your account scope
  • testing request and response structure before writing code

Current Endpoints

The primary production endpoints currently documented for live use are:

  • GET /v1/portal
  • GET /v1/transactions
  • GET /v1/settlements

Notes

  • the request is still made against production api.pinrail.xyz
  • the key is forwarded from docs.pinrail.xyz to api.pinrail.xyz for the live request
  • the response will reflect the exact scope of the authenticated user

Start with:

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

Then validate a filtered transaction example:

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

Portal Data APIs

Tenant-facing portal data APIs with examples, filters, and live production request guidance.

Webhooks

Current Pinrail webhook subscription model, signature format, and live event categories derived from pinrail-platform.

On this page

OverviewCurrent EndpointsNotesRecommended Smoke Test