Skip to main content
The Payrails API reference lists every endpoint of the payment orchestration platform, with its request and response formats, authentication, and errors. Start by requesting an access token. The cards below group the API by domain, in the same order as the sidebar.

Get started

Authentication

Request an OAuth 2.0 access token for server-side requests.

Client

Start a client-side SDK session for a workflow and holder.

SSO Connections

Manage SSO identity provider connections.

Workflow

Workflows

List and manage the workflow configurations that define each use case.

Executions

Create and track workflow executions.

Actions

Trigger actions that change an execution’s state, such as authorize or refund.

Payment

Payments

Search and retrieve payments and their operations.

Instruments

Store and manage payment instruments that belong to a holder.

Instrument Tokens

Manage the provider tokens mapped to each payment instrument.

BIN Lookup

Get issuer information for a card by its BIN.

API Logs

Search and list API request logs.

Fraud Checks

Search and retrieve fraud checks created by workflow executions.

3D Secure

Search and retrieve 3D Secure authentications created by workflow executions.

Provider

Providers

List payment providers and get one by ID.

Provider Configs

Manage the configurations for each provider.

Merchant

Rulesets

Create and manage routing rulesets.

Holders

Manage holders, which group a customer’s accounts, payment instruments, and identities.

Workspaces

Create and manage workspaces.

Drop-in Links

Create shareable payment links with full or partial payments.

Vault

Vault Instant Proxy

Send a one-off request to a provider through the vault proxy.

Vault Proxy Connections

Manage the connections the vault proxy uses.

Vault Records and Aliases

Tokenize and detokenize records and manage their aliases.

Vault Display SDK

Initialize the Vault Display SDK.

Vault Public Encryption

Get the public key used to encrypt data before tokenization.

Analytics

Files

Get an upload URL for a file and retrieve files by ID.

Reporting

Reports

List available reports and get one by ID.

Report Runs

Generate and retrieve report runs.

Reconciliation

Reconciliation Records

Manually reconcile records in bulk.

Dispute

Disputes

Manage disputes and chargebacks.
Last modified on October 6, 2026