Sign in

v1

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

Get Single Authorization

This endpoint retrieves details of a single authorization by its authorization_reference.

Notes:

  1. authorization_reference:: Must exist and belong to the requesting merchant.
  2. Merchant Ownership: Strictly enforced - only the business that created the authorization can retrieve it. Attempting to access another business’s authorization returns 403 Forbidden.
  3. Authentication: Valid Authorization header required (same format as authorize endpoint).
  4. Security: The system verifies business ownership by comparing the authenticated business.
get/card/auth_capture/authorize/{authorization_reference}

Path parameters

authorization_referencestring required

The authorization reference from the Authorize response

Response

Payment successful

statusstring

Current status of the authorization (e.g., AUTHORIZED, ERROR).

messagestring

Descriptive message about the status.

authorization_referencestring nullable

Unique reference for the authorization.

authorization_amountnumber nullable

Total amount originally authorized.

captured_amountnumber nullable

Amount that has been captured so far.

remaining_amountnumber nullable

Amount remaining available to capture.

currencystring nullable

Currency code.

authorization_codestring nullable

Issuer's authorization code.

expires_atstring date-time nullable

Timestamp when the authorization expires.

created_atstring date-time nullable

Timestamp when the authorization was created.

updated_atstring date-time nullable

Timestamp of the last update.

captured_atstring date-time nullable

Timestamp when the capture occurred.

voided_atstring date-time nullable

Timestamp when the void occurred.

card_last_4string nullable

Last 4 digits of the card used.

card_brandstring nullable

Brand of the card (e.g., MASTERCARD).

order_referencestring nullable

Order ID associated with the transaction.

merchant_referencestring nullable

Merchant's internal reference.

customer_emailstring email nullable

Customer's email.

customer_namestring nullable

Customer's full name.

error_reasonstring nullable

Reason for error if applicable.

void_reasonstring nullable

Reason for void if applicable.

Example response

{
  "status": "AUTHORIZED",
  "message": "Authorization successful",
  "authorization_reference": "AUTH-1234567890",
  "authorization_amount": 100,
  "remaining_amount": 100,
  "currency": "NGN",
  "authorization_code": "123456",
  "expires_at": "2025-01-19T10:30:00",
  "created_at": "2025-01-12T10:30:00",
  "updated_at": "2025-01-12T10:30:00",
  "card_last_4": "2346",
  "card_brand": "MASTERCARD",
  "order_reference": "ORD-001",
  "merchant_reference": "MR-001",
  "customer_email": "customer@example.com",
  "customer_name": "John Doe"
}