Capture payment | Payroc

using RestSharp;
var client = new RestClient("https://api.payroc.com/v1/payments/M2MJOG6O2Y/capture");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"processingTerminalId\": \"1234001\",\n  \"operator\": \"Jane\",\n  \"amount\": 4999,\n  \"breakdown\": {\n    \"subtotal\": 4999,\n    \"dutyAmount\": 499,\n    \"freightAmount\": 500,\n    \"items\": [\n      {\n        \"unitPrice\": 4000,\n        \"quantity\": 1\n      }\n    ]\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

{
  "paymentId": "M2MJOG6O2Y",
  "processingTerminalId": "1234001",
  "order": {
    "orderId": "OrderRef6543",
    "amount": 4999,
    "currency": "USD",
    "dateTime": "2024-07-02T15:30:00Z",
    "description": "Large Pepperoni Pizza"
  },
  "card": {
    "type": "MasterCard",
    "entryMethod": "keyed",
    "cardNumber": "453985******7062",
    "expiryDate": "1230",
    "securityChecks": {
      "cvvResult": "M",
      "avsResult": "Y"
    }
  },
  "transactionResult": {
    "status": "ready",
    "responseCode": "A",
    "type": "sale",
    "approvalCode": "OK3",
    "authorizedAmount": 4999,
    "currency": "USD",
    "responseMessage": "OK3"
  },
  "operator": "Jane",
  "customer": {
    "firstName": "Sarah",
    "lastName": "Hopper",
    "billingAddress": {
      "address1": "1 Example Ave.",
      "address2": "Example Address Line 2",
      "address3": "Example Address Line 3",
      "city": "Chicago",
      "state": "Illinois",
      "country": "US",
      "postalCode": "60056"
    },
    "shippingAddress": {
      "recipientName": "Sarah Hopper",
      "address": {
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "60056"
      }
    }
  },
  "supportedOperations": [
    "capture",
    "fullyReverse",
    "partiallyReverse",
    "incrementAuthorization",
    "adjustTip",
    "setAsPending"
  ],
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}

Use this method to capture a pre-authorization.

To capture a pre-authorization, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.

Note: If you don’t have the paymentId, use our List Payments method to search for the payment.

Depending on the amount you want to capture, complete the following:

Capture the full amount of the pre-authorization - Don’t send a value for the amount parameter in your request.
Capture less than the amount of the pre-authorization - Send a value for the amount parameter in your request.
Capture more than the amount of the pre-authorization - Adjust the pre-authorization before you capture it. For more information about adjusting a pre-authorization, go to Adjust Payment.

If your request is successful, our gateway takes the amount from the payment card.

Note: For more information about pre-authorizations and captures, go to Run a pre-authorization.

Use this method to capture a pre-authorization. To capture a pre-authorization, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/card-payments/payments/create) method. **Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/card-payments/payments/list) method to search for the payment. Depending on the amount you want to capture, complete the following: - **Capture the full amount of the pre-authorization** - Don't send a value for the amount parameter in your request. - **Capture less than the amount of the pre-authorization** - Send a value for the amount parameter in your request. - **Capture more than the amount of the pre-authorization** - Adjust the pre-authorization before you capture it. For more information about adjusting a pre-authorization, go to [Adjust Payment](https://docs.payroc.com/api/schema/card-payments/payments/adjust). If your request is successful, our gateway takes the amount from the payment card. **Note:** For more information about pre-authorizations and captures, go to [Run a pre-authorization](https://docs.payroc.com/guides/integrate/run-a-pre-authorization).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentIdstringRequired=10 characters

Unique identifier of the payment that the merchant wants to retrieve.

Request

This endpoint expects an object.

processingTerminalIdstringOptional4-50 characters

Unique identifier that our gateway assigned to the terminal.

operatorstringOptional0-50 characters

Operator who captured the payment.

amountlongOptional

Amount that the merchant wants to capture. The value is in the currency’s lowest denomination, for example, cents.
Note: If the merchant does not send an amount, we capture the total amount of the transaction.

breakdownobjectOptional

Object that contains information about the breakdown of the transaction.

Contains parameters required for Level 2, Level 3, and CEDP transactions.

Response

Successful request. We captured the payment.

paymentIdstring=10 characters

Unique identifier that our gateway assigned to the transaction.

processingTerminalIdstring4-50 characters

Unique identifier of the terminal that initiated the transaction.

orderobject

Object that contains information about the payment.

cardobject

Object that contains the details of the payment card.

transactionResultobject

Object that contains information about the transaction response details.

operatorstringOptional0-50 characters

Operator who initiated the request.

customerobjectOptional

Object that contains the customer's contact details and address information.

refundslist of objectsOptional

Array of refundSummary objects. Each object contains information about refunds linked to the transaction.

supportedOperationslist of enumsOptional

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

capture - Capture the payment.
refund - Refund the payment.
fullyReverse - Fully reverse the transaction.
partiallyReverse - Partially reverse the payment.
incrementAuthorization - Increase the amount of the authorization.
adjustTip - Adjust the tip post-payment.
addSignature - Add a signature to the payment.
setAsReady - Set the transaction’s status to ready.
setAsPending - Set the transaction’s status to pending.

customFieldslist of objectsOptional

Array of customField objects.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error