Get Started

Sections

Theme switcher

Authorization Callback

Header Parameters

MidenAuthorizationstring
Referencestring
Signaturestring
UniqueKeystring
Authorizationstring

Body Parameters

requestTypestring Required

Type of card transaction request being sent for processing. Example: Authorization.

accountNumberstring Required

Card account number associated with the transaction, where applicable.

cardIdstring Required

Unique identifier of the card involved in the transaction.

transactionAmountnumber Required

Transaction amount expressed in USD.

authorizationAmountnumber Required

Amount presented for authorization in the transaction currency.

chargenumber Required

Charge associated with the transaction, where applicable.

chargeTypestring Required

Identifies the type of charge represented by charge. Supported charge types include ContactlessCharge and CrossBorderCharge.

transactionCurrencyCodestring Required

Currency of the authorization amount in ISO 4217 format.

merchantCategoryCodestring

Merchant Category Code (MCC) associated with the transaction.

merchantNamestring

Name of the merchant where the transaction occurred.

merchantCitystring

City in which the merchant is located, where available.

merchantCountrystring

Country code associated with the merchant location.

referencestring Required

Transaction reference.

eventIdstring Required

Unique identifier of the transaction event.

eventTimestring Required

Date and time the event occurred.

merchantAcceptorIdstring

Identifier assigned to the merchant/card acceptor.

merchantNameLocationstring

Combined merchant name and location information, where available.

retrievalReferenceNumberstring

Retrieval Reference Number (RRN) associated with the transaction.

requestTimestring Required

Date and time the authorization request was created.

switchReferencestring Required

Reference assigned by the card switch or network.

settlementCurrencyCodestring

Currency in which settlement will occur, where applicable.

settlementAmountnumber

Amount expected to be settled, where applicable.

cardTransactionAuthorizationIdstring

Unique identifier of the related card authorization record.

cardTransactionSettlementIdstring

Unique identifier of the related settlement record, where available.

responseCodestring

Existing transaction response code associated with the event, where applicable.

responseReasonCodestring

Existing response reason associated with the event, where applicable.

responseMessagestring

Human-readable response message associated with the event, where applicable.

eventTypestring

Classification of the card transaction event. Example: auth.approved.

isContactlessPaymentboolean

Indicates whether the transaction was performed as a contactless payment.

riskAssessmentobject

Advisory transaction risk assessment generated from available transaction and authentication signals, where available.

precedingRelatedTokenstring

Token that links the event to a preceding related transaction, where applicable.

Response

Approval
Object

After evaluating the callback, return your authorization decision using a supported responseCode, responseReasonCode, and responseMessage. The response code should correspond to the actual reason for the decision. A decline does not always use the same response code.

Response Attributes

responseCodestring

Code that determines the authorization outcome. 000 means approve; a supported non-000 code means decline.

responseReasonCodestring

Machine-readable reason for the decision.

responseMessagestring

Human-readable description of the decision.

Decline
Object

After evaluating the callback, return your authorization decision using a supported responseCode, responseReasonCode, and responseMessage. The response code should correspond to the actual reason for the decision. A decline does not always use the same response code.

Response Attributes

responseCodestring

Code that determines the authorization outcome. 000 means approve; a supported non-000 code means decline.

responseReasonCodestring

Machine-readable reason for the decision.

responseMessagestring

Human-readable description of the decision.

Was this section helpful?

POST

/

Select
1

Response

Status Codes

200

OK

The authorization decision was returned successfully.

400

Bad request

The request payload is invalid or cannot be processed. A valid decision may not be applied.

401

Unauthorized

Request authentication failed.

402

Request Failed

The parameters were valid but the request failed.

403

Forbidden

The request is authenticated but not permitted.

404

Not Found

The configured authorization route does not exist.

405

Method Not Allowed

The endpoint does not accept HTTP POST.

429

Too Many Requests

The endpoint rejected the request because of rate limiting.

500

Internal Server Error

The merchant’s authorization service encountered an error.

503

Service Unavailable

The merchant’s authorization service is unavailable.

Was this section helpful?