Jump to Content
Home
Guides
API Reference
Go to payrails.com
API Reference
Go to payrails.com
Home
Guides
API Reference
Records
Search
All
Pages
Start typing to search…
JUMP TO
Payrails API Reference
Authentication
Request an access token
post
Workflows
Search & list workflow configurations
get
Create a workflow configuration
post
Get a workflow configuration
get
Get the default workflow configuration
get
Update the default workflow configuration
put
Updates a workflow configuration version
patch
Rulesets
Create a new Ruleset
post
List Rulesets
get
Update a Ruleset
put
Get a Ruleset
get
Executions
Search & list executions
get
Create an execution
post
Get an execution by ID
get
Actions
Lookup payment options
post
Start a payment session
post
Authorize a payment
post
Confirm a payment
post
Cancel a payment
post
Capture a payment
post
Refund a payment
post
Create a payout
post
Search & list events
get
List actions of an execution
get
Search & list actions
get
Get an action by ID
get
Update fraud order status
post
Client
Initialize a client SDK
post
Workspaces
Create a workspace
post
Fetch a list of workspaces
get
Get a workspace by ID
get
Payments
Search & list payments
get
Get payment by ID
get
Get Payment Operations by Payment ID
get
Get Payment Operation Logs by Payment Operation ID
get
Instruments
Search & list instruments
get
Create an instrument
post
Get an instrument by ID
get
Delete an instrument
delete
Update an instrument
patch
Provision a Network Token
post
InstrumentTokens
Search & list tokens
get
Create a token
post
Get a token by ID
get
Delete a token by ID
delete
Get a token by reference
get
Delete a token by reference
delete
BinLookup
Get issuer info by BIN
get
Providers
Search & list providers
get
Get provider by ID
get
ProviderConfigs
List active provider configs
get
Create a provider config
post
List Provider Configs by Provider
get
Update a provider config
put
Provider config by ID
get
Update a provider config status
patch
Vault
Execute a proxy request for vault
post
Get public encryption key for tokenization
get
Get field details by alias
get
Get field details by alias list
get
Get record and its fields by ID
get
Delete record by ID
delete
Get record and its fields by alias
get
Delete a record by the alias of one of its fields
delete
Get connection version details
get
Create a connection
post
Filter & list connections
get
Get connection details
get
Update connection details
patch
Create a new version of a connection
post
List connection versions for connection
get
Set live version of a connection
put
Initialize a Vault Client SDK
post
Search & list API Logs
get
Get an API Log event by ID
get
Search & list API Logs
get
FraudChecks
Search & list Fraud checks
get
Get Fraud check by ID
get
Get Fraud Operations by Fraud ID
get
Get Fraud Operation Logs by Fraud Operation ID
get
ThreeDS
Search & list ThreeDS entities
get
Get ThreeDS authentication by ID
get
Get ThreeDS Operations by ThreeDS ID
get
Get ThreeDS Operation Logs by ThreeDS Operation ID
get
PayoutInstruments
Create a payout instrument
post
Holders
Search & list holders
get
Create a holder
post
Get a holder by ID
get
Accounts
Create an account
post
Transfers
Create a transfer
post
Get a transfer by ID
get
Reports
Search & list reports
get
Get a report by ID
get
ReportRuns
Search & list report runs
get
Create a report run
post
Get a report run by ID
get
Records
Records
