Capture a payment
Request a payment capture during a workflow execution.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Headers
Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.
Path Parameters
Path parameter to specify the workflow code. Machine-friendly code of Workflow.
^[a-z][-A-Za-z0-9]*$Identifier of the resource in Payrails.
Body
The amount to capture, including currency. Full amount will be captured if not specified.
Reason for invoking the operation or action.
BetterPrice, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, NoReason, ProductMismatchDescription, WrongProduct, WrongProductSpecification An optional field to include any necessary information for the capture action.
"Customer's automatic subscription."
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. See Meta for every field.
The final parameter indicates if multiple partial captures are expected, if the value is false and the captured amount is less than the authorized amount then multiple partial captures can be applied until reaching the original authorized amount, if the value is true or the parameter is not sent the capture will be treated as a final capture and no further capture request will be accepted for it.
Response
The payment capture was requested.
Triggers the selected payments on PSP.
capture Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same actionId.
Date and time when execution of the Action was started.
Links to the next possible actions that can be taken.
Unique identifier of a workspace in Payrails.
Reason for invoking the operation or action.
BetterPrice, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, NoReason, ProductMismatchDescription, WrongProduct, WrongProductSpecification An optional field to include any necessary information for the capture action.
"Monthly subscription."