> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Getting started

> Overview of the Payrails API reference: every API area, grouped by domain as in the sidebar, with a link to its main endpoint.

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](https://docs.payrails.com/reference/getoauthtoken.md)**
>
> Request an OAuth 2.0 access token for server-side requests.

> **[Client](https://docs.payrails.com/reference/clientinit.md)**
>
> Start a client-side SDK session for a workflow and holder.

> **[SSO Connections](https://docs.payrails.com/reference/listssoconnections.md)**
>
> Manage SSO identity provider connections.

## Workflow

> **[Workflows](https://docs.payrails.com/reference/listworkflowconfigurations.md)**
>
> List and manage the workflow configurations that define each use case.

> **[Executions](https://docs.payrails.com/reference/listexecutions.md)**
>
> Create and track workflow executions.

> **[Actions](https://docs.payrails.com/reference/lookupaction.md)**
>
> Trigger actions that change an execution's state, such as authorize or refund.

## Payment

> **[Payments](https://docs.payrails.com/reference/listpayments.md)**
>
> Search and retrieve payments and their operations.

> **[Instruments](https://docs.payrails.com/reference/listinstruments.md)**
>
> Store and manage payment instruments that belong to a holder.

> **[Instrument Tokens](https://docs.payrails.com/reference/listtokens.md)**
>
> Manage the provider tokens mapped to each payment instrument.

> **[BIN Lookup](https://docs.payrails.com/reference/getbinlookup.md)**
>
> Get issuer information for a card by its BIN.

> **[API Logs](https://docs.payrails.com/reference/apilogs.md)**
>
> Search and list API request logs.

> **[Fraud Checks](https://docs.payrails.com/reference/listfraudchecks.md)**
>
> Search and retrieve fraud checks created by workflow executions.

> **[3D Secure](https://docs.payrails.com/reference/listthreeds.md)**
>
> Search and retrieve 3D Secure authentications created by workflow executions.

## Provider

> **[Providers](https://docs.payrails.com/reference/listproviders.md)**
>
> List payment providers and get one by ID.

> **[Provider Configs](https://docs.payrails.com/reference/listactiveproviderconfigs.md)**
>
> Manage the configurations for each provider.

## Merchant

> **[Rulesets](https://docs.payrails.com/reference/listrulesets.md)**
>
> Create and manage routing rulesets.

> **[Holders](https://docs.payrails.com/reference/listholders.md)**
>
> Manage holders, which group a customer's accounts, payment instruments, and identities.

> **[Workspaces](https://docs.payrails.com/reference/getallworkspaces.md)**
>
> Create and manage workspaces.

> **[Drop-in Links](https://docs.payrails.com/reference/listdropinlinks.md)**
>
> Create shareable payment links with full or partial payments.

> **[Apple Pay](https://docs.payrails.com/reference/listapplepaywebdomains.md)**
>
> Register and list the web domains where you offer Apple Pay.

## Vault

> **[Vault Instant Proxy](https://docs.payrails.com/reference/vaultproxy.md)**
>
> Send a one-off request to a provider through the vault proxy.

> **[Vault Proxy Connections](https://docs.payrails.com/reference/createvaultconnections.md)**
>
> Manage the connections the vault proxy uses.

> **[Vault Records and Aliases](https://docs.payrails.com/reference/tokenizerecords.md)**
>
> Tokenize and detokenize records and manage their aliases.

> **[Vault Display SDK](https://docs.payrails.com/reference/vaultclientinit.md)**
>
> Initialize the Vault Display SDK.

> **[Vault Public Encryption](https://docs.payrails.com/reference/vaultpublicinfo.md)**
>
> Get the public key used to encrypt data before tokenization.

## Analytics

> **[Files](https://docs.payrails.com/reference/fileupload.md)**
>
> Get an upload URL for a file and retrieve files by ID.

## Reporting

> **[Reports](https://docs.payrails.com/reference/getreports.md)**
>
> List available reports and get one by ID.

> **[Report Runs](https://docs.payrails.com/reference/listreportruns.md)**
>
> Generate and retrieve report runs.

## Reconciliation

> **[Reconciliation Records](https://docs.payrails.com/reference/bulkmanualreconcilerecords.md)**
>
> Manually reconcile records in bulk.

## Dispute

> **[Disputes](https://docs.payrails.com/reference/listdisputes.md)**
>
> Manage disputes and chargebacks.


## Related topics

- [Getting started](https://docs.payrails.com/docs/analytics-and-reporting/getting-started.md)
- [Getting Started](https://docs.payrails.com/docs/token-vault/getting-started.md)
- [How to Integrate](https://docs.payrails.com/docs/orchestration/checkout-sdks/react-native/how-to-integrate.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.