Capture a payment
Capture an authorized payment in a workflow execution in full by omitting the amount, or set final to false to allow multiple partial captures.
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
Path Parameters
Body
Reason for invoking the operation or action. Omit it if there is no reason. CustomerDontNeed is deprecated, use CustomerDoesNotNeed instead. With Other, reasonDescription is required for refunds: at least 3 characters after trimming. On refunds, reasonDescription is at most 255 characters for any reason.
BetterPrice, CustomerDoesNotNeed, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, Other, ProductMismatchDescription, WrongProduct, WrongProductSpecification 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.
Reason for invoking the operation or action. Omit it if there is no reason. CustomerDontNeed is deprecated, use CustomerDoesNotNeed instead. With Other, reasonDescription is required for refunds: at least 3 characters after trimming. On refunds, reasonDescription is at most 255 characters for any reason.
BetterPrice, CustomerDoesNotNeed, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, Other, ProductMismatchDescription, WrongProduct, WrongProductSpecification