Skip to main content
Rate this article:

Capturing an authorisation

A capture on an authorisation places a hold on a payment. Usually the full authorisation amount is captured; however, it's also possible to capture a smaller amount - the remaining part of the authorisation will then need to be cancelled. This step triggers the process to capture the funds to the Merchant resulting in clearing and settlement.

You can perform a capture through the API or through the portal. Captures can only be completed on transactions with the status AUTHORIZED.

Payment methods, which automatically capture as part of authorisation (or where capture==true), don't need to be captured. If immediate or delayed auto-capture is enabled, calling the capture method is not necessary. 

Note the required parameters:

  • id - Example: 76944d4b-89e6-48d2-ac04-675383c3eedf

Original transaction id to capture authorization.

  • amount - string (Amount Simple Type) <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?.+))$

The value, which can be anything from:

For the required number of decimal places for a currency code, see ISO 4217.

  • An integer. For currencies that are not typically fractional, such as JPY.
  • A three-place decimal fraction. For currencies that are subdivided into thousandths, such as TND.
  • An eight-place decimal fraction. For currencies such as Bitcoin.

Capturing an authorisation via the API

Send a POST/transactions/{id}/capture

{
"amount": "20.50",
"id": "1234",
"initiatorTraceId": "000001",
"referenceId": "200211654321",
"createdDateTime": "2019-02-24T05:19:12Z",
"online": true
}

Example response

{
  "id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
  "status": "AUTHORIZED",
  "createdAt": "2020-07-19T19:35:36Z",
  "reversalStatus": "NONE",
  "response": "SUCCESS",
  "responseCode": "0000",
  "responseMessage": "string",
  "acquirerResponseCode": "stri",
  "poiUid": "0e0357d7-8c7f-49ac-b07f-3db112be3126",
  "poiId": "652314",
  "merchantId": "765231"
}

 

Capturing an authorisation via the portal

  1. Log into the portal and go to the "Transaction" page.
  2. Select the Transaction ID from the drop-down menu and type in the Transaction ID in the search bar.
  3. Click on the transaction and navigate to "Actions" tab.
  4. Enter the amount you want to capture and click "Capture".

Cancelling a capture overview

A cancellation or void authorisation puts a hold on a payment. If no amount is specified then the full amount will cancelled. Cancellations can only be completed on transactions with the status SETTLEMENT_REQUESTED. Multiple cancellations cannot be completed on a single payment. Only a cancellation for the full transaction amount is allowed.

You can perform a cancellation through the API or the portal

Cancelling a capture via the API

Send POST/transactions/{id}/void

Example request

{
"amount": "20.50",
"id": 1234,
"initiatorTraceId": "000001",
"referenceId": "200211654321",
"createdDateTime": "2019-02-24T05:19:12Z"
}

Note the parameters:

  • id (required) - Original transaction id to void authorization.
  • amount - The value, which can be anything from:
    • An integer. For currencies that are not typically fractional, such as JPY.
    • A three-place decimal fraction. For currencies that are subdivided into thousandths, such as TND.
    • An eight-place decimal fraction. For currencies such as Bitcoin. 
    • For the required number of decimal places for a currency code, see ISO 4217.

Example response

{
"id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
"status": "AUTHORIZED",
"createdAt": "2020-07-21T19:35:29Z",
"reversalStatus": "NONE",
"response": "SUCCESS",
"responseCode": "0000",
"responseMessage": "string",
"acquirerResponseCode": "stri",
"merchantId": "765231"
}

Cancelling a capture via the portal

  1. Log into the portal and go to the "Transaction" page.
  2. Select the Transaction ID from the drop-down menu and type the Transaction ID in the search bar.
  3. Click on the transaction and navigate to "Actions" tab.
  4. Enter the amount you want to cancel and click "Cancel".

Refunds

Refund a payment that has previously been captured. A status of SETTLEMENT_COMPLETED is needed before a payment can be refunded. Multiple refunds can be done on a single transaction until the original authorised amount has been refunded completely. You can perform a capture through the API or the portal.

Refunds can be matched or unmatched. Matched refunds are processed based on providing the identifiers to the original message. These would include the elements within the related transaction section of the transaction object. Unmatched refunds requires a new transaction message with a payment instrument.

Refunding a transaction via the API

Send POST/transactions/{id}/refund

Note the parameters

  • id (required)- Original transaction id to refund.
  • amount (required)- string (Amount Simple Type) <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?.+))$ 

The value, which can be anything from:

  • An integer. For currencies that are not typically fractional, such as JPY.
    • A three-place decimal fraction. For currencies that are subdivided into thousandths, such as TND.
    • An eight-place decimal fraction. For currencies such as Bitcoin.
    • For the required number of decimal places for a currency code, see ISO 4217.
  • reason - The reason for the refund.

Example request

{
"amount": "20.50",
"reason": "string",
"id": "1234",
"initiatorTraceId": "000001",
"referenceId": "200211654321",
"createdDateTime": "2019-02-24T05:19:12Z"
}

Example response:

{
"id": "76944d4b-89e6-48d2-ac04-675383c3eedf",
"status": "AUTHORIZED",
"createdAt": "2020-07-21T19:35:29Z",
"reversalStatus": "NONE",
"response": "SUCCESS",
"responseCode": "0000",
"responseMessage": "string",
"acquirerResponseCode": "stri",
"merchantId": "765231"
}

Refunding a transaction via the portal

  1. Log into the portal and go to the "Transaction" page.
  2. Select the Transaction ID from the drop-down menu and type the Transaction ID in the search bar.
  3. Click on the transaction and navigate to "Actions" tab.
  4. Enter the amount you want to refund and optionally a reason and click "Refund".
Rate this article:
Logo of Verifone