Authorize a payment

Request a payment authorization during a workflow execution.

Path Params
string
required

Path parameter to specify the workflow code.

uuid
required

Identifier of the resource in Payrails.

Body Params
amount
object
required

The amount to authorize.

meta
object

Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide.

returnInfo
object
required

URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for cancel or error are needed, we will redirect to the value in the success URL. The 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time.

paymentComposition
array of objects
required

Selected composition of payments methods and instruments to execute the action. We support one payment for each Workflow for now. Split payments and multiple payments in a Workflow will be supported very soon.

paymentComposition*
Headers
uuid
required

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

Responses

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/json