API Reference
Go to payrails.com

Start a payment session

post
https://api.staging.payrails.io/merchant/workflows//executions//startPaymentSession

Request the start of a payment session during a workflow execution. This action synchronously returns the necessary data to handle the session on the client-side.

Path Params
string
required

Path parameter to specify the workflow code.

uuid
required

Identifier of the resource in Payrails.

Body Params
string
enum
required

Code of the integration type for using the payment method in the provider.

Allowed:
string
enum

Code of the payment method selected to start a payment session.

Allowed:
amount
object
required
returnInfo
object

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.

meta

Any merchant-specific data that should be used and carried for context in the action execution.

Headers
uuid
required

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

Responses

Updated 11 months ago

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

Updated 11 months ago