Reference
Every operation, generated from the contract.
These pages render from a committed snapshot of the gateway's openapi.json, with a hand-authored overlay for the why. A drift gate fails the build when the snapshot and the gateway disagree.
TransfersQuote, create, track.
- Quote a transferPOST/v1/transfers/quote
- Create a transferPOST/v1/transfers
- Read transfer statusGET/v1/transfers/{transferRef}/status
EndpointsReceiving and programmable endpoints.
- Create a receiving endpointPOST/v1/receiving-endpoints
- Read the current receiving endpointGET/v1/receiving-endpoints/current
- Create a programmable endpointPOST/v1/programmable-endpoints
- List programmable endpointsGET/v1/programmable-endpoints
- Read a programmable endpointGET/v1/programmable-endpoints/{endpointRef}
- Read effective operation readinessGET/v1/programmable-endpoints/{endpointRef}/effective-operation-readiness
- Manage endpoint lifecyclePOST/v1/programmable-endpoints/{endpointRef}/lifecycle
BalancesCurrent balances and the committed postings behind them.
- Read a balance snapshotGET/v1/balances/current
- Read balance activityGET/v1/balances/activity
EnvironmentWhat your key opens.
- Read environment statusGET/v1/environment
SandboxThe rail stand-in, sandbox only.
- Simulate an inbound creditPOST/v1/sandbox/inbound-credits
Management sandboxesProvision, inspect, credential, and retire Test sandboxes.
- List Test sandboxesGET/management/v1/sandboxes
- Provision a Test sandboxPOST/management/v1/sandboxes
- Read a Test sandboxGET/management/v1/sandboxes/{sandboxRef}
- Read sandbox request recordsGET/management/v1/sandboxes/{sandboxRef}/request-log
- List sandbox Application keysGET/management/v1/sandboxes/{sandboxRef}/api-keys
- Mint a sandbox Application keyPOST/management/v1/sandboxes/{sandboxRef}/api-keys
- Revoke a sandbox Application keyPOST/management/v1/sandboxes/{sandboxRef}/api-keys/{apiKeyRef}/revoke
- Retire a Test sandboxPOST/management/v1/sandboxes/{sandboxRef}/retire
- List customer event typesGET/management/v1/sandboxes/{sandboxRef}/customer-events/catalog
- List customer eventsGET/management/v1/sandboxes/{sandboxRef}/customer-events
- Read a customer eventGET/management/v1/sandboxes/{sandboxRef}/customer-events/{eventRef}
- List event webhook deliveriesGET/management/v1/sandboxes/{sandboxRef}/customer-events/{eventRef}/webhook-deliveries
- List webhook endpointsGET/management/v1/sandboxes/{sandboxRef}/webhook-endpoints
- Read a webhook endpointGET/management/v1/sandboxes/{sandboxRef}/webhook-endpoints/{endpointRef}
- List webhook deliveriesGET/management/v1/sandboxes/{sandboxRef}/webhook-deliveries
- Read a webhook deliveryGET/management/v1/sandboxes/{sandboxRef}/webhook-deliveries/{deliveryRef}
generated from openapi.json · gateway 0.1.0 · sandbox