DEVELOPERS

Build on a canonical payment model

PayMatrixAI developer payment API infrastructure

Design integrations around stable internal payment records, explicit state transitions, idempotency and a universal ledger rather than coupling application logic to one provider.

SANDBOX

Safe test environment

No real-money movement

AUTHENTICATION

Scoped API keys

Bearer + organization isolation

IDEMPOTENCY

Durable request keys

Replay-safe writes

WEBHOOKS

Signed event delivery

Retries + observability

QUICKSTART

Make your first authenticated request

First register the website or app you are building in the authenticated Developer Console. Then select that application to create its sandbox API keys and webhooks. Keep secrets on your server, not in browser JavaScript or a public repository. Every write must include a unique Idempotency-Key.

curl -X GET "https://paymatrixai.com/_api/developer_api_status" \
  -H "Authorization: Bearer pmx_sandbox_YOUR_SECRET"

GET/_api/developer_api_status

Verify sandbox authentication and see capability gates.

GET/_api/developer_api_capabilities

Read API version and supported permission scopes.

GET/_api/developer_api_payments?limit=25

List sandbox payment records.

POST/_api/developer_api_payments

Create a sandbox payment; requires payments:write and Idempotency-Key.

POST/_api/developer_api_customers

Create a sandbox customer; requires customers:write and Idempotency-Key.

POST/_api/developer_api_transfers

Create a sandbox transfer quote; requires transfers:write and Idempotency-Key.

All endpoints above are sandbox-only. The API does not move real money or enable production credentials.

SANDBOX API SURFACE

Core resources

PAYMENTSPOSTCreate a sandbox paymentpayments:write

PAYMENTSGETList / retrieve sandbox paymentspayments:read

PAYMENTSPOSTAdvance payment lifecycle or issue refundpayments:write

CUSTOMERSPOSTCreate a sandbox customercustomers:write

CUSTOMERSGETList / retrieve sandbox customerscustomers:read

TRANSFERSPOSTCreate a sandbox FX transfertransfers:write

TRANSFERSGETList / retrieve sandbox transferstransfers:read

TRANSFERSPOSTAdvance transfer lifecycletransfers:write

WEBHOOKSPOSTCreate/test/replay signed sandbox eventswebhooks:write

WEBHOOKSGETRead webhook configuration and delivery historywebhooks:read

REQUEST CONTRACT

Every write is explicit

Write requests use an Idempotency-Key. PayMatrixAI fingerprints the method, route and request body. Reusing a key with a different request is rejected; a completed request can be safely replayed.

Authorization: Bearer pmx_sandbox_…\nIdempotency-Key: order_2026_0001\nContent-Type: application/json

RESPONSE CONTRACT

Traceable API responses

Responses include a request ID and sandbox marker. Errors use structured codes. Payment and transfer state changes are validated server-side before persistence.

{
  "object": "payment",
  "sandbox": true,
  "requestId": "…",
  "status": "pending"
}

INTEGRATION CHECKLIST

01Authenticate

Use a scoped sandbox key and organization context.

02Protect writes

Attach a unique idempotency key to each mutation.

03Observe events

Inspect request IDs, webhook delivery and state history.

ARCHITECTURE

Canonical records, provider-neutral integration

PMX records remain the application-facing contract. Provider transaction identifiers are stored separately. State transitions are server-enforced, financial integrity is reconciled against provider events, and live provider activation remains gated behind production readiness controls.

PMX record → state machine → ledger → provider event → reconciliation
developer key → scope → idempotency → audit trail

Developer environment status

Sandbox endpoints and contracts are presented for inspection. No live API credential, production payment rail or real-money execution is implied by this public page.

The public developer surface describes the current sandbox architecture. Live credentials and real-money execution require separate production authorization, regulated provider connectivity, compliance approval, security verification and operational readiness.

Open sandbox Talk to us