Hosted Payment PageExtend your integrationRun a pre-authorization

Capture the pre-authorization

View as Markdown

An AI skill is available for this guide, get it on the Skills Marketplace (GitHub).

If your merchant doesn’t capture a pre-authorization, it expires and the issuing bank releases the hold on the customer’s card.

To capture the pre-authorization, you must use our API.

Before you begin

Authenticate your requests before making API calls. If your request fails, see Errors.

Send a POST request to capture the pre-authorization

To capture the pre-authorization, you need the UNIQUEREF that we returned to the merchant’s receipt page. Send the UNIQUEREF in the paymentId path parameter in a POST request to our Payments endpoint.

Depending on the amount you want to capture:

  • 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.

Request parameters

To create the body of your request, use the following parameters:

Request

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](https://docs.payroc.com/knowledge/card-payments/enhanced-data).

Example request

POST
/v1/payments/:paymentId/capture
1curl -X POST https://api.payroc.com/v1/payments/M2MJOG6O2Y/capture \
2     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
3     -H "Authorization: Bearer <token>" \
4     -H "Content-Type: application/json" \
5     -d '{
6  "processingTerminalId": "1234001",
7  "operator": "Jane",
8  "amount": 4999,
9  "breakdown": {
10    "subtotal": 4999,
11    "dutyAmount": 499,
12    "freightAmount": 500,
13    "items": [
14      {
15        "unitPrice": 4000,
16        "quantity": 1
17      }
18    ]
19  }
20}'
Try it

Response fields

If your request is successful, we capture the pre-authorization and return a response. The response contains the following fields:

Response

paymentIdstringRequired=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstringRequired4-50 characters
Unique identifier of the terminal that initiated the transaction.
orderobjectRequired
Object that contains information about the payment.
cardobjectRequired
Object that contains the details of the payment card.
transactionResultobjectRequired
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. - `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.

Example response

Response
1{
2  "paymentId": "M2MJOG6O2Y",
3  "processingTerminalId": "1234001",
4  "order": {
5    "orderId": "OrderRef6543",
6    "amount": 4999,
7    "currency": "USD",
8    "dateTime": "2024-07-02T15:30:00Z",
9    "description": "Large Pepperoni Pizza"
10  },
11  "card": {
12    "type": "MasterCard",
13    "entryMethod": "keyed",
14    "cardNumber": "453985******7062",
15    "expiryDate": "1230",
16    "securityChecks": {
17      "cvvResult": "M",
18      "avsResult": "Y"
19    }
20  },
21  "transactionResult": {
22    "status": "ready",
23    "responseCode": "A",
24    "type": "sale",
25    "approvalCode": "OK3",
26    "authorizedAmount": 4999,
27    "currency": "USD",
28    "responseMessage": "OK3"
29  },
30  "operator": "Jane",
31  "customer": {
32    "firstName": "Sarah",
33    "lastName": "Hopper",
34    "billingAddress": {
35      "address1": "1 Example Ave.",
36      "address2": "Example Address Line 2",
37      "address3": "Example Address Line 3",
38      "city": "Chicago",
39      "state": "Illinois",
40      "country": "US",
41      "postalCode": "60056"
42    },
43    "shippingAddress": {
44      "recipientName": "Sarah Hopper",
45      "address": {
46        "address1": "1 Example Ave.",
47        "address2": "Example Address Line 2",
48        "address3": "Example Address Line 3",
49        "city": "Chicago",
50        "state": "Illinois",
51        "country": "US",
52        "postalCode": "60056"
53      }
54    }
55  },
56  "supportedOperations": [
57    "capture",
58    "fullyReverse",
59    "partiallyReverse",
60    "incrementAuthorization",
61    "adjustTip",
62    "setAsPending"
63  ],
64  "customFields": [
65    {
66      "name": "yourCustomField",
67      "value": "abc123"
68    }
69  ]
70}