Download OpenAPI specification:Download
Operations exposed by the Issuer Bank for amiko to query transactions in the issuer realm.
Retrieves detailed information about a specific transaction using its transaction ID
| transactionId required | string |
| tracing-id required | string Internal Tracing ID that can be used to track interactions. |
| auth_header | string The given http header "auth_header" should be considered only a placeholder in this OpenAPI spec. The actual header name and header value must match the configured authentication strategy e.g. API Key or JWT. |
| external-tracing-id | string External tracing ID that can be used to track interactions with issuers. Supplied by the Issuer, only available when this Issuer API call originates from an Amiko external API operation with header 'tracing-id'. |
{- "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": "00",
- "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 using various criteria such as ARN/PAN, date range, and optional filters
| tracing-id required | string Internal Tracing ID that can be used to track interactions. |
| auth_header | string The given http header "auth_header" should be considered only a placeholder in this OpenAPI spec. The actual header name and header value must match the configured authentication strategy e.g. API Key or JWT. |
| external-tracing-id | string External tracing ID that can be used to track interactions with issuers. Supplied by the Issuer, only available when this Issuer API call originates from an Amiko external API operation with header 'tracing-id'. |
| arn | string <\d{23}> The ARN/ARD of the transaction |
| cardId | string Unique identifier of a card that is not the PAN and is not to be classified as account data or PII |
| 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 |
{- "arn": "22223600332062290049858",
- "cardId": "b8ba25f3-c945-4ed0-9d4d-e3153a0dd048",
- "issuerAuthorizationId": "string",
- "authorizationBNR": "string",
- "startDate": 1670935380000,
- "endDate": 1670935380000,
- "merchantName": "Merchant name",
- "originalAmount": 0,
- "transactionType": "credit",
- "limit": 100,
- "offset": 0
}{- "transactions": [
- {
- "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": "00",
- "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",
- "customerReportDate": {
- "value": 1670889600000
}
}
], - "pagination": {
- "total": 0,
- "offset": 0,
- "limit": 0,
- "hasMore": true
}
}The specification is based on the IETF draft https://inadarei.github.io/rfc-healthcheck/.
Please refer to our Health Check documentation for more information.
{- "status": "fail"
}