Sign in

v1

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

Authorize Transaction

This endpoint authorizes a transaction and holds funds for a specified period. This endpoint handles payout requests.

Record Creation:

Authorization record is created with PENDING status before MPGS call, then updated to AUTHORIZED on success or FAILED on error.

post/card/auth_capture/authorize

Request body

{"stackTrail":"paths:/card/auth_capture/authorize:post:requestBody:content:application/json:schema:oneOf","oasType":"schema","type":"unknown"}

Response

Authorize Transaction

statusstring

Status of the authorization (AUTHORIZED, PENDING, DECLINED).

messagestring

Descriptive message about the status.

authorization_referencestring nullable

Unique reference for the authorization.

authorization_codestring nullable

Code provided by the issuer if authorized.

authorized_amountnumber nullable

The amount successfully held.

currencystring nullable

Currency code.

expires_atstring date-time nullable

Timestamp when the hold expires.

do3dsAuthboolean

Indicates if 3D Secure authentication is required.

threeDsUrlstring uri nullable

URL to redirect for 3DS authentication.

threeDsHtmlstring nullable

HTML content for 3DS page rendering.

formDatastring nullable

Form data (cReq/PaReq) for 3DS.

error_codestring nullable

Error code if declined.

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",
  "threeDsUrl": "https://acs.example.com/3ds",
  "threeDsHtml": "<html>...</html>",
  "formData": "cReq_or_PaReq_data_here",
  "error_code": "INVALID_CARD",
  "error_message": "Card number is invalid"
}