Capture Transaction - Payaza Documentation

curl --request POST \ --url https://api.payaza.africa/live/card/auth_capture/capture \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "authorization_reference": "AUTH-ABCD1234EFGH5678IJKL", "capture_reference": "CAP-001" } '

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

Authorizations

Authorization

string

header

required

Payaza {{Public API Key in Base 64}}

Body

application/json

authorization_reference

string

required

The authorization reference from authorize response..

Example:

"AUTH-ABCD1234EFGH5678IJKL"

capture_reference

string

required

the Unique reference for this capture operation.

Example:

"CAP-001"

Response

Capture Transaction

status

string

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

Example:

"AUTHORIZED"

message

string

Descriptive message about the operation status.

Example:

"Authorization successful"

authorization_reference

string | null

The reference of the authorization being captured.

Example:

"AUTH-1234567890"

authorization_code

string | null

Authorization code for the captured transaction.

Example:

"123456"

authorized_amount

number | null

The amount successfully captured.

Example:

100

currency

string | null

Currency code.

Example:

"NGN"

expires_at

string<date-time> | null

Timestamp related to authorization expiration (if relevant).

Example:

"2025-01-19T10:30:00"

error_code

string | null

Error code if the capture failed.

Example:

"AUTH_EXPIRED"

error_message

string | null

Detailed error description.

Example:

"Authorization has expired"