Authorizations
Paxos APIs use OAuth 2 with the client credentials grant flow.
Token URLs:
- Production: https://oauth.paxos.com/oauth2/token
- Sandbox: https://oauth.sandbox.paxos.com/oauth2/token
Learn more in the API credentials guide →
Path Parameters
Response
A successful response.
Orchestrations can be created directly via the CreateOrchestration endpoint, or indirectly by an incoming deposit which matches an OrchestrationRule previously defined with the CreateOrchestrationRule endpoint.
A client or system-specified unique identifier for the orchestration - used for idempotency protection. Retries of a request should use the same ref_id to avoid duplicate transactions. For system-initiated orchestrations generated by invocation of an orchestration rule, the ref_id is generated the system.
TransferDetails refers to a specific Transfer and encodes its current status.
TransferDetails refers to a specific Transfer and encodes its current status.
Status represents the current state of an orchestration.
PROCESSING, COMPLETED, FAILED The ID of the orchestration rule which triggered this orchestration. Can be empty for ad-hoc orchestrations.