v1

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

Get All Authorizations

The merchant uses this endpoint to fetch refund transaction history. The data output can be filtered using a date range and/or status..

get/card/auth_capture/authorize?status=AUTHORIZED&page={page}&size={size}&from_date={from_date}&to_date={to_date}

Path parameters

statusstring

Authorization status to filter results (e.g. AUTHORIZED, PENDING, FAILED).

from_datestring

Start date for filtering records, in yyyy-MM-dd HH:mm:ss format.

to_datestring

End date for filtering records, in yyyy-MM-dd HH:mm:ss format.

pagenumber

Page number for paginated results.

sizenumber

The number of records to return per page.

Response

Get All Authorizations Response

statusstring nullable

Error status (present in error responses).

messagestring nullable

Error message details (present in error responses).

pageinteger

Current page index (0-based).

sizeinteger

Number of items per page.

total_elementsinteger

Total number of authorization records found.

total_pagesinteger

Total number of pages available.

has_nextboolean

Indicates if there is a next page.

has_previousboolean

Indicates if there is a previous page.

Example response

{
  "status": "ERROR",
  "message": "Invalid date format. Use ISO 8601 format (e.g., 2024-01-01T00:00:00)",
  "authorizations": [
    {
      "authorization_reference": "AUTH-1234567890",
      "status": "AUTHORIZED",
      "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"
    }
  ],
  "size": 20,
  "total_elements": 1,
  "total_pages": 1
}