v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Auth-Capture-Void

Capture Transaction

This endpoint captures a previously authorized transaction.

post/card/auth_capture/capture

Request body

authorization_referencestring required

The authorization reference from authorize response..

capture_referencestring required

the Unique reference for this capture operation.

Example request

{
  "authorization_reference": "AUTH-ABCD1234EFGH5678IJKL",
  "capture_reference": "CAP-001"
}

Response

Capture Transaction

statusstring

Status of the capture operation (e.g., AUTHORIZED, ERROR).

messagestring

Descriptive message about the operation status.

authorization_referencestring nullable

The reference of the authorization being captured.

authorization_codestring nullable

Authorization code for the captured transaction.

authorized_amountnumber nullable

The amount successfully captured.

currencystring nullable

Currency code.

expires_atstring date-time nullable

Timestamp related to authorization expiration (if relevant).

error_codestring nullable

Error code if the capture failed.

error_messagestring nullable

Detailed error description.

Example response

{
  "status": "AUTHORIZED",
  "message": "Authorization successful",
  "authorization_reference": "AUTH-1234567890",
  "authorization_code": "123456",
  "authorized_amount": 100,
  "currency": "NGN",
  "expires_at": "2025-01-19T10:30:00",
  "error_code": "AUTH_EXPIRED",
  "error_message": "Authorization has expired"
}