External API Endpoints

Authentication

• GET /api/authorize

• POST /api/token

One-time Password (OTP)

• POST /api/request-otp

Payments

• POST /api/payments/create

• GET /api/payments/{payment_id}

• GET /api/merchant-payments (requires X-piaxis-Client-ID)

Escrows

• POST /api/escrows/ (requires X-piaxis-Client-ID)

• GET /api/escrows/{escrow_id}

• GET /api/escrows/{escrow_id}/status

• POST /api/escrows/{escrow_id}/release

• POST /api/escrows/{escrow_id}/reverse

• POST /api/escrows/{escrow_id}/disputes

• POST /api/escrows/{escrow_id}/terms/{term_id}/fulfill

Disbursements

• POST /api/disbursements/quote (requires X-piaxis-Client-ID)

• POST /api/disbursements (requires X-piaxis-Client-ID)

• GET /api/disbursements (requires X-piaxis-Client-ID)

• GET /api/disbursements/{disbursement_id} (requires X-piaxis-Client-ID)

• POST /api/disbursements/{disbursement_id}/cancel (requires X-piaxis-Client-ID)

Escrow Disbursements

• POST /api/escrow-disbursements (requires X-piaxis-Client-ID)

• GET /api/escrow-disbursements (requires X-piaxis-Client-ID)

• GET /api/escrow-disbursements/{disbursement_id} (requires X-piaxis-Client-ID)

• POST /api/escrow-disbursements/{disbursement_id}/release (requires X-piaxis-Client-ID)

• POST /api/escrow-disbursements/{disbursement_id}/cancel (requires X-piaxis-Client-ID)

Documentation (HTML)

These pages are served by the API, but are not part of the OpenAPI schema:

• GET /api/docs/login

• GET /api/docs

• GET /api/docs/piaxis-api-integration-guide.md

• GET /api/docs/index.md

• GET /api/docs/api-reference.md

• GET /api/docs/llms.txt

• GET /api/docs/{page:path}

• GET /api/docs/static/{filepath}

• GET /api/_static/{filepath}

The live HTML documentation is protected by a separate docs login/session and is served from https://api.gopiaxis.com/api/docs/.