Get Single Authorization - Payaza Documentation

{ "authorization_reference": "AUTH-1234567890", "status": "AUTHORIZED", "authorization_amount": 100, "captured_amount": 0, "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", "captured_at": null, "voided_at": null, "card_last_4": "2346", "card_brand": "MASTERCARD", "order_reference": "ORD-001", "merchant_reference": "MR-001", "customer_email": "customer@example.com", "customer_name": "John Doe", "error_reason": null, "void_reason": null }

Authorizations

Authorization

string

header

required

Payaza {{Public API Key in Base 64}}

Path Parameters

authorization_reference

string

required

The authorization reference from the Authorize response

Response

Payment successful

status

string

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

Example:

"AUTHORIZED"

message

string

Descriptive message about the status.

Example:

"Authorization successful"

authorization_reference

string | null

Unique reference for the authorization.

Example:

"AUTH-1234567890"

authorization_amount

number | null

Total amount originally authorized.

Example:

100

captured_amount

number | null

Amount that has been captured so far.

Example:

0

remaining_amount

number | null

Amount remaining available to capture.

Example:

100

currency

string | null

Currency code.

Example:

"NGN"

authorization_code

string | null

Issuer's authorization code.

Example:

"123456"

expires_at

string<date-time> | null

Timestamp when the authorization expires.

Example:

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

created_at

string<date-time> | null

Timestamp when the authorization was created.

Example:

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

updated_at

string<date-time> | null

Timestamp of the last update.

Example:

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

captured_at

string<date-time> | null

Timestamp when the capture occurred.

Example:

null

voided_at

string<date-time> | null

Timestamp when the void occurred.

Example:

null

card_last_4

string | null

Last 4 digits of the card used.

Example:

"2346"

card_brand

string | null

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

Example:

"MASTERCARD"

order_reference

string | null

Order ID associated with the transaction.

Example:

"ORD-001"

merchant_reference

string | null

Merchant's internal reference.

Example:

"MR-001"

customer_email

string<email> | null

Customer's email.

Example:

"customer@example.com"

customer_name

string | null

Customer's full name.

Example:

"John Doe"

error_reason

string | null

Reason for error if applicable.

Example:

null

void_reason

string | null

Reason for void if applicable.

Example:

null