Capture a paymentAsk AIpost https://api.staging.payrails.io/merchant/workflows/{workflowCode}/executions/{executionId}/captureRequest a payment capture during a workflow execution.Path ParamsworkflowCodestringrequiredPath parameter to specify the workflow code.executionIduuidrequiredIdentifier of the resource in Payrails.Body ParamsamountobjectThe amount to capture, including currency. Full amount will be captured if not specified.amount objectreasonstringenumReason for invoking the operation or action.NoReasonBetterPriceCustomerDontNeedDamagedProductDuplicateFraudulentProductLateDeliveryNoReasonProductMismatchDescriptionWrongProductWrongProductSpecificationShow 10 enum valuesreasonDescriptionstringAn optional field to include any necessary information for the capture action.metaobjectMetadata 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.meta objectfinalbooleanThe 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.truefalseHeadersx-idempotency-keyuuidrequiredIdempotency key to be used. Sending again the same key would return the same result without re-executing the update.Responses 202The payment capture was requested. 400Bad Request. 401Unauthorized. 403Insufficient Scope. 404Not Found. 429Too Many Requests.Updated 11 months ago
