Payrails API Reference

Authentication
- Request an access tokenpost
Workflows
Rulesets
Executions
Actions
Client
- Initialize a client SDKpost
Workspaces
Payments
Instruments
InstrumentTokens
BinLookup
- Get issuer info by BINget
Providers
- Search & list providersget
- Get provider by IDget
ProviderConfigs
Vault
Search & list API Logsget
- Get an API Log event by IDget
- Search & list API Logsget
FraudChecks
ThreeDS
PayoutInstruments
- Create a payout instrumentpost
Holders
Accounts
- Create an accountpost
Transfers
- Create a transferpost
- Get a transfer by IDget
Reports
- Search & list reportsget
- Get a report by IDget
ReportRuns
Records

Payrails API Reference

Authentication
- Request an access tokenpost
Workflows
Rulesets
Executions
Actions
Client
- Initialize a client SDKpost
Workspaces
Payments
Instruments
InstrumentTokens
BinLookup
- Get issuer info by BINget
Providers
- Search & list providersget
- Get provider by IDget
ProviderConfigs
Vault
Search & list API Logsget
- Get an API Log event by IDget
- Search & list API Logsget
FraudChecks
ThreeDS
PayoutInstruments
- Create a payout instrumentpost
Holders
Accounts
- Create an accountpost
Transfers
- Create a transferpost
- Get a transfer by IDget
Reports
- Search & list reportsget
- Get a report by IDget
ReportRuns
Records

Cancel a payment

post https://payrails-api.staging.payrails.io/merchant/workflows/{workflowCode}/executions/{executionId}/cancel

Request a payment cancelation during a workflow execution.

Path Params

workflowCode

string

required

Path parameter to specify the workflow code.

executionId

uuid

required

Identifier of the resource in Payrails.

Body Params

reason

string

Reason for invoking the operation or action.

reasonDescription

string

An optional field to include any necessary information for the capture action.

Headers

x-idempotency-key

uuid

required

Idempotency key to be used.
Sending again the same key would return the same result without re-executing the update.

Responses

Response body

object

name

string

required

Performed action name.

cancel

actionId

uuid

required

Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same actionId.

executedAt

date-time

required

Date and time when execution of the Action was started.

links

object

required

Links to the next possible actions that can be taken.

execution

required

URL to fetch the current execution state.

reason

string

Reason for invoking the operation or action.

BetterPrice CustomerDontNeed DamagedProduct Duplicate FraudulentProduct LateDelivery NoReason ProductMismatchDescription WrongProduct WrongProductSpecification

reasonDescription

string

An optional field to include any necessary information for the cancel action.

Response body

object

errors

array of objects

required

errors*

object

uuid

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

detail

string

required

Human-readable description about the error, its cause, and resolution.

docUrl

string

Link to the specific documentation about this particular code.

reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

uuid

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

detail

string

required

Human-readable description about the error, its cause, and resolution.

docUrl

string

Link to the specific documentation about this particular code.

reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

uuid

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

detail

string

required

Human-readable description about the error, its cause, and resolution.

docUrl

string

Link to the specific documentation about this particular code.

reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

uuid

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

detail

string

required

Human-readable description about the error, its cause, and resolution.

docUrl

string

Link to the specific documentation about this particular code.

reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

Has additional fields

Response body

object

errors

array of objects

required

errors*

object

uuid

required

Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.

code

string

required

Machine-friendly error code assigned to the error. Check the full list of possible values here.

detail

string

required

Human-readable description about the error, its cause, and resolution.

docUrl

string

Link to the specific documentation about this particular code.

reason

object

Metadata providing more details about the reason of the error. The structure of this object varies according to the code.

Has additional fields

Updated about 13 hours ago

Confirm a payment

Capture a payment

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://payrails-api.staging.payrails.io/merchant/workflows/workflowCode/executions/executionId/cancel \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
10
 
1
{
2
  "name": "cancel",
3
  "actionId": "1aa0ef20-36cb-4485-b60e-0526c3699014",
4
  "executedAt": "2022-04-22T17:53:36.814Z",
5
  "reason": "FraudulentProduct",
6
  "reasonDescription": "An optional field to include any necessary information for the cancel action.",
7
  "links": {
8
    "execution": "https://payrails-api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016"
9
  }
10
}

Updated about 13 hours ago

Confirm a payment

Capture a payment

Did this page help you?

Payrails API Reference
Authentication
Request an access tokenpost
Workflows
Updates a workflow configuration versionpatch
Update the default workflow configurationput
Get the default workflow configurationget
Get a workflow configurationget
Create a workflow configurationpost
Search & list workflow configurationsget
Rulesets
Get a Rulesetget
Update a Rulesetput
List Rulesetsget
Create a new Rulesetpost
Executions
Get an execution by IDget
Create an executionpost
Search & list executionsget
Actions
Get an action by IDget
Search & list actionsget
List actions of an executionget
Search & list eventsget
Create a payoutpost
Refund a paymentpost
Capture a paymentpost
Cancel a paymentpost
Confirm a paymentpost
Authorize a paymentpost
Start a payment sessionpost
Lookup payment optionspost
Client
Initialize a client SDKpost
Workspaces
Get a workspace by IDget
Fetch a list of workspacesget
Create a workspacepost
Payments
Get Payment Operation Logs by Payment Operation IDget
Get Payment Operations by Payment IDget
Get payment by IDget
Search & list paymentsget
Instruments
Update an instrumentpatch
Delete an instrumentdelete
Get an instrument by IDget
Create an instrumentpost
Search & list instrumentsget
InstrumentTokens
Delete a token by referencedelete
Get a token by referenceget
Delete a token by IDdelete
Get a token by IDget
Create a tokenpost
Search & list tokensget
BinLookup
Get issuer info by BINget
Providers
Get provider by IDget
Search & list providersget
ProviderConfigs
Update a provider config statuspatch
Provider config by IDget
Update a provider configput
List Provider Configs by Providerget
Create a provider configpost
List active provider configsget
Vault
Get connection version by connectionID and versionID.get
Delete a record by the alias of one of its fields.delete
Get record and its fields by alias.get
Delete record by IDdelete
Get record and its fields by IDget
Get field details by alias listget
Get field details by aliasget
Get public encryption key for tokenizationget
Execute a proxy request for vaultpost
Search & list API Logsget
Search & list API Logsget
Get an API Log event by IDget
FraudChecks
Get Fraud Operation Logs by Fraud Operation IDget
Get Fraud Operations by Fraud IDget
Get Fraud check by IDget
Search & list Fraud checksget
ThreeDS
Get ThreeDS Operation Logs by ThreeDS Operation IDget
Get ThreeDS Operations by ThreeDS IDget
Get ThreeDS authentication by IDget
Search & list ThreeDS entitiesget
PayoutInstruments
Create a payout instrumentpost
Holders
Get a holder by IDget
Create a holderpost
Search & list holdersget
Accounts
Create an accountpost
Transfers
Get a transfer by IDget
Create a transferpost
Reports
Get a report by IDget
Search & list reportsget
ReportRuns
Get a report run by IDget
Create a report runpost
Search & list report runsget
Records

Payrails API Reference
Authentication
Request an access tokenpost
Workflows
Updates a workflow configuration versionpatch
Update the default workflow configurationput
Get the default workflow configurationget
Get a workflow configurationget
Create a workflow configurationpost
Search & list workflow configurationsget
Rulesets
Get a Rulesetget
Update a Rulesetput
List Rulesetsget
Create a new Rulesetpost
Executions
Get an execution by IDget
Create an executionpost
Search & list executionsget
Actions
Get an action by IDget
Search & list actionsget
List actions of an executionget
Search & list eventsget
Create a payoutpost
Refund a paymentpost
Capture a paymentpost
Cancel a paymentpost
Confirm a paymentpost
Authorize a paymentpost
Start a payment sessionpost
Lookup payment optionspost
Client
Initialize a client SDKpost
Workspaces
Get a workspace by IDget
Fetch a list of workspacesget
Create a workspacepost
Payments
Get Payment Operation Logs by Payment Operation IDget
Get Payment Operations by Payment IDget
Get payment by IDget
Search & list paymentsget
Instruments
Update an instrumentpatch
Delete an instrumentdelete
Get an instrument by IDget
Create an instrumentpost
Search & list instrumentsget
InstrumentTokens
Delete a token by referencedelete
Get a token by referenceget
Delete a token by IDdelete
Get a token by IDget
Create a tokenpost
Search & list tokensget
BinLookup
Get issuer info by BINget
Providers
Get provider by IDget
Search & list providersget
ProviderConfigs
Update a provider config statuspatch
Provider config by IDget
Update a provider configput
List Provider Configs by Providerget
Create a provider configpost
List active provider configsget
Vault
Get connection version by connectionID and versionID.get
Delete a record by the alias of one of its fields.delete
Get record and its fields by alias.get
Delete record by IDdelete
Get record and its fields by IDget
Get field details by alias listget
Get field details by aliasget
Get public encryption key for tokenizationget
Execute a proxy request for vaultpost
Search & list API Logsget
Search & list API Logsget
Get an API Log event by IDget
FraudChecks
Get Fraud Operation Logs by Fraud Operation IDget
Get Fraud Operations by Fraud IDget
Get Fraud check by IDget
Search & list Fraud checksget
ThreeDS
Get ThreeDS Operation Logs by ThreeDS Operation IDget
Get ThreeDS Operations by ThreeDS IDget
Get ThreeDS authentication by IDget
Search & list ThreeDS entitiesget
PayoutInstruments
Create a payout instrumentpost
Holders
Get a holder by IDget
Create a holderpost
Search & list holdersget
Accounts
Create an accountpost
Transfers
Get a transfer by IDget
Create a transferpost
Reports
Get a report by IDget
Search & list reportsget
ReportRuns
Get a report run by IDget
Create a report runpost
Search & list report runsget
Records

202The payment cancelation was requested.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.