API docs by Redocly

Issuer Bank Integration APIs - Issuer Transaction Search API (2025.4.0)

Download OpenAPI specification:Download

Operations exposed by the Issuer Bank for amiko to query transactions in the issuer realm.

Search Transactions

Get transaction details by ID

Retrieves detailed information about a specific transaction using its transaction ID

path Parameters
transactionId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "123456789987654321",
  • "transactionTimestamp": 1670935380000,
  • "scheme": "mastercard",
  • "status": "authorization",
  • "originalAmount": "100.35",
  • "originalCurrency": "AED",
  • "merchantId": "string",
  • "merchantName": "Merchant name",
  • "transactionType": "credit",
  • "arn": "22223600332062290049858",
  • "billingAmount": "100.35",
  • "billingCurrency": "AED",
  • "merchantLocation": "string",
  • "mcc": "5812",
  • "channel": "card_not_present",
  • "strongCardholderAuthentication": true,
  • "posEntryMode": "barcode",
  • "cardholderVerificationMethod": "none",
  • "strongCardholderAuthenticationFlow": "challenge",
  • "strongCardholderAuthenticationMethod": "app",
  • "tokenRequestorName": "string",
  • "tokenRequestorId": "string",
  • "cardNotPresentEnvironment": "ecom",
  • "recurring": true,
  • "transactionGCOType": "intra_processing",
  • "jurisdictionCode": "domestic",
  • "isAvailableOnSchemeApi": true,
  • "cardId": "b8ba25f3-c945-4ed0-9d4d-e3153a0dd048",
  • "authorizationCode": "string",
  • "authorizationDecision": "string",
  • "authorizationDateTime": 1670935380000,
  • "cardholderAuthenticationCode": "string",
  • "merchantStateProvinceCode": "string",
  • "retrievalReferenceNumber": "string",
  • "settlementDate": 1670889600000,
  • "cardProductCode": "string",
  • "merchantCountryCode": "string",
  • "merchantPostalCode": "string",
  • "terminalAttendanceIndicator": "string",
  • "terminalId": "string",
  • "terminalOperatingEnvironment": "0",
  • "cardholderPresenceIndicator": "string",
  • "catLevelIndicator": "string",
  • "terminalCapabilityIndicator": "string",
  • "electronicCommerceIndicator": "string",
  • "cvcInvalidIndicator": "string",
  • "avsResponseCode": "string",
  • "secureCode": "string",
  • "linkIdentifier": "string",
  • "traceId": "string",
  • "originalTransactionARN": "22223600332062290049858",
  • "passengerName": "string",
  • "ticketNumber": "string",
  • "departureDate": 1670889600000,
  • "originCity": "string",
  • "destination": "string",
  • "travelAgencyName": "string"
}

Search for transactions

Search for transactions using various criteria such as ARN/PAN, date range, and optional filters

header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Request Body schema: application/json
required
arn
string <\d{23}>

The ARN/ARD of the transaction

pan
string
issuerAuthorizationId
string
authorizationBNR
string
startDate
integer <int64>

Local date & time in UTC timezone, timestamped in milliseconds since epoch

endDate
integer <int64>

Local date & time in UTC timezone, timestamped in milliseconds since epoch

merchantName
string
originalAmount
number
transactionType
string
Enum: "credit" "debit_cash" "debit_purchase"
limit
integer <int32>
Default: 100
offset
integer <int32>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "arn": "22223600332062290049858",
  • "pan": "string",
  • "issuerAuthorizationId": "string",
  • "authorizationBNR": "string",
  • "startDate": 1670935380000,
  • "endDate": 1670935380000,
  • "merchantName": "Merchant name",
  • "originalAmount": 0,
  • "transactionType": "credit",
  • "limit": 100,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "pagination": {
    }
}

Utility

Returns the health status for this API

The specification is based on the IETF draft linked below. Its content consists of a single mandatory root field (“status”) and several optional fields. Health Check Response Format for HTTP APIs: https://inadarei.github.io/rfc-healthcheck/

Responses

Response samples

Content type
application/json
{
  • "status": "fail"
}