TEteya
Captures

Capture a pre-authorised transaction

API to capture a previously pre-authorised transaction. <br><br><strong>Usage notes:</strong>

<ul> <li>The capture amount must be less than or equal to the original authorisation amount.</li> <li>Only one capture is allowed per pre-authorised transaction. Once captured (fully or partially), the transaction cannot be captured again.</li> </ul> <br><strong>Access Token Required scope:</strong> captures/create
post/v1/transactions/{id}/capture

Request

Path parameters

idstring required

The transaction ID of the pre-authorisation to capture

Example:tr_5f7b1a3a-3b7a-4b1a-9b1a-3a3b7a4b1a9b

Headers

Idempotency-Keystring

A unique key to identify the request. If the request is repeated with the same key, the same response will be returned. If the request is repeated with a different key or without a key, a new capture will be created.

User-Agentstring required
Example:YourCompany-Integration/1.0

Identifies your integration, for example YourCompany-Integration/1.0. Requests without a User-Agent can be blocked by our firewall before they reach the API.

Request body

amountinteger required

A positive integer representing the amount to capture in the smallest currency unit (e.g., 100 cents to charge $1). Must be less than or equal to the original authorisation amount.

Example request

{
  "amount": 1000
}

Response

Capture processed

transaction_idstring required

Unique identifier of the capture created

card_acceptor_idstring required

mid or card_acceptor_id (ISO 8583 field standard). Used to uniquely identify the merchant in the transaction.

status'SUCCESS' | 'FAILURE' | 'PENDING' required

The status of the capture

status_reason'ACCOUNT_INVALID' | 'CANNOT_VALIDATE_AUTHENTICATION' | 'CARD_COUNT_EXCEEDED' | 'CARD_DECLINED' | 'CARD_EXPIRED' | 'CARD_LIMIT_EXCEEDED' | 'CARD_NOT_ACTIVE' | 'DISABLED_ACCOUNT' | 'DO_NOT_HONOR' | 'ECOM_NEGATIVE_CARD_AUTHENTICATION_VERIFICATION' | 'EXCEEDS_AMOUNT_LIMIT' | 'FORMAT_ERROR' | 'INCORRECT_CARD_AUTHENTICATION' | 'INSUFFICIENT_FUNDS' | 'INVALID_CARD_NUMBER' | 'INVALID_TRANSACTION' | 'ISSUER_DECLINED' | 'LOST_OR_STOLEN' | 'MERCHANT_CONFIGURATION' | 'PIN_LIMIT_EXCEEDED' | 'PROCESSOR_UNAVAILABLE' | 'RESTRICTED_CARD' | 'SCA_PIN_REQUIRED' | 'SCA_REQUIRED' | 'SUSPECTED_FRAUD' | 'TEMPORARY_ISSUE_RETRY' | 'TIMEOUT' | 'TRANSACTION_NOT_ALLOWED' | 'UNABLE_TO_ROUTE_TRANSACTION' | 'UNSUPPORTED_ISSUER' | 'NEGATIVE_BALANCE_LIMIT' | 'OTHER'

Reason for FAILURE status

processed_atstring date-time

The date and time the capture was processed (in ISO 8601 with time-zone).

Example response

{
  "transaction_id": "tr_5f7b1a3a-3b7a-4b1a-9b1a-3a3b7a4b1a9b",
  "card_acceptor_id": "50001325",
  "status": "SUCCESS",
  "issuer_result": {
    "approval_code": "123456",
    "response_code": "00"
  },
  "processed_at": "2021-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.