Capture a payment

post https://payrails-api.staging.payrails.io/merchant/workflows/{workflowCode}/executions/{executionId}/capture

Request a payment capture during a workflow execution.

Path Params

workflowCode

string

required

Path parameter to specify the workflow code.

executionId

uuid

required

Identifier of the resource in Payrails.

Body Params

amount

object

The amount to capture, including currency. Full amount will be captured if not specified.

reason

string

Reason for invoking the operation or action.

reasonDescription

string

An optional field to include any necessary information for the capture action.

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.

final

boolean

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.

Headers

x-idempotency-key

uuid

required

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

Responses

Response body

object

name

string

required

Triggers the selected payments on PSP and book the movements on the ledger.

capture

actionId

uuid

required

Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same actionId.

executedAt

date-time

required

Date and time when execution of the Action was started.

links

object

required

Links to the next possible actions that can be taken.

execution

required

URL to fetch the current execution state.

refund

required

URL to refund the current execution.

reason

string

Reason for invoking the operation or action.

BetterPrice CustomerDontNeed DamagedProduct Duplicate FraudulentProduct LateDelivery NoReason ProductMismatchDescription WrongProduct WrongProductSpecification

reasonDescription

string

An optional field to include any necessary information for the capture action.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://payrails-api.staging.payrails.io/merchant/workflows/workflowCode/executions/executionId/capture \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
14
 
1
{
2
  "name": "capture",
3
  "actionId": "1aa0ef20-36cb-4485-b60e-0526c3699014",
4
  "executedAt": "2022-04-22T17:53:36.814Z",
5
  "reason": "NoReason",
6
  "reasonDescription": "Customer's automatic subscription.",
7
  "links": {
8
    "execution": "https://payrails-api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016",
9
    "refund": {
10
      "method": "POST",
11
      "href": "https://payrails-api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/refund"
12
    }
13
  }
14
}

202The payment capture was requested.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.