---
title: "List Authorisations"
method: GET
path: "/authorisations"
tags: ["Endpoints"]
---

# List Authorisations

`GET /authorisations`

Return a list of all authorisations, restricted by your allianceCode,
partnerCode or merchant ID (as appropriate) for the given datetime range.

## Query parameters

- `createdAfter` string, date
- `createdBefore` string, date
- `limit` integer — Number of elements to be returned in a single query. Can be used for page/offset or cursor based pagination
- `offset` integer — Starting point to start retrieving the elements from. It is "0" based i.e. value "0" signifies the first page. This can be used with "limit". Can be used for page/offset based pagination.
- `sort` string — Specifies the sequence of elements and order to sort the payload by
- `storeId` string
- `terminalId` string
- `orderId` string

## Headers

- `Partner-Code` string
- `Merchant-Id` string

## Response `200`

OK

- Authorisation[] — The list of returned authorisation objects.
  - `id` string, required — Unique system identifier of the record in our system.
  - `created` string, date-time, required — Date and time the authorisation was processed (in ISO 8601 format `yyyy-MM-ddTHH:mm:ssZ`). Determined on the basis of the merchants location.
  - `status` 'APPROVED' | 'DECLINED' | 'PENDING', required — A flag indicating the status of the authorisation and whether it has been approved.
  - `code` string — 6-digit code returned by the issuer responsible for approving the authorisation in the event that it is approved. Can be used along with other metadata to reference the authorisation, such as in the case of a dispute.
  - `channel` 'ECOMMERCE' | 'POINT_OF_SALE' | 'PAY_BY_LINK' | 'MAIL_ORDER' | 'TELEPHONE_ORDER', required — A categorisation for the system which generated the transaction record. The most common being point of sale (such as an in-store card payment) or ecommerce (via an online store), but also includes channels like pay by link, mail order and telephone order.
  - `transactionType` 'PURCHASE' | 'PAYMENT' | 'CASH_ADVANCE' | 'REFUND' | 'PURCHASE_WITH_CASHBACK' | 'CARD_VERIFICATION' | 'PREPAID_LOAD' | 'BALANCE_ENQUIRY' | 'CHECK_VERIFICATION' | 'CHECK_GUARANTEE' | 'PURCHASE_ADJUSTMENT' | 'MOBILE_TOPUP' | 'PURCHASE_WITH_TIP' | 'ADMIN' | 'ACCOUNT_FUNDING_TRANSACTION' | 'ORIGINAL_CREDIT' | 'MONEY_TRANSFER', required — The nature of the transaction, which often signifies how it is processed. The most common type is a purchase (the transfer of money for goods or services), but may refer to things like a refund or card verification.
  - `transactionSubtype` 'PRE_AUTH' | 'PRE_AUTH_INCREMENT' | 'PRE_AUTH_DECREMENT' | 'COMPLETION' | 'CANCEL' | 'OTHER', nullable — Optional subtype for the authorisation, used to indicate whether it was part of a pre-auth sequence. Most authorisations are known as a 'purchase' or 'sale', which involves both the pre-auth and completion in one (in which case this field would be null). However for purchases like a pay-at-pump petrol transaction, a pre-auth may occur first for a fixed amount, before a completion finalises the transaction. In which case there would be two authorisation records in our system.
  - `messageType` string, required — [ISO 8583](https://en.wikipedia.org/wiki/ISO_8583) code determining type of transaction message being submitted, for example `0110` is an authorisation request response. Each digit has a specific meaning following the format below: * `0xxx` - version of ISO 8583 (0 = 1987 version) * `x1xx` - class of the message (1 = authorisation message) * `xx1x` - function of the message (1 = response) * `xxx0` - who began the communication (0 = acquirer)
  - `merchant` object, required — A merchant is the business entity that the transaction was performed at.
    - `id` string, required — External merchant id provided by client (if merchant ids have been pre allocated) or generated by our systems during merchant boarding.
    - `name` string — Trade name of the merchant, often printed on a card receipt.
    - `countryCode` string, nullable, required — The Alpha 3 ISO location of the merchant.
    - `mcc` string, nullable, required — A [Merchant Category Code (MCC)](https://en.wikipedia.org/wiki/Merchant_category_code) is assigned to each merchant by an acquirer. It classifies the merchant based on the type of goods or services provided, as each industry has different transaction patterns and differing levels of fraud risk. **Examples:** | Code | Description | |---|---| | 0742 | Veterinary Services | | 0763 | Agricultural Co-operatives | | 1520 | General Contractors - Residential and Commercial | For a **full list** of example values, see our [reference guide](https://docs.fiserv.dev/public/docs/merchant-category-codes).
    - `allianceCode` string, nullable, required — An alliance is typically an organization holding an acquiring licence issued by card schemes (like VISA, MasterCard etc). This code is assigned by us.
    - `partnerCode` string, nullable — Partners are typically companies (such as Payment Facilitators, Independent Software Vendors, Independent Sale Organisations) who can contract merchants for card acceptance but they don't hold an acquiring licence so must always be authorized by an Alliance.
    - `storeId` string, nullable — A digital store id assigned in our payment gateway. The store holds configuration such as what payment methods are accepted.
  - `meta` object — Reference metadata used by both the merchant and acquirer to link the authorisation to other records or systems.
    - `orderId` string, nullable — Unique ID of the end-to-end sale which can link together multiple authorisation or cleared transaction records.
    - `referenceId` string, nullable — Optional Id used to link together authorisation pre-auth records, such as initial pre-auth, increment and completion. For normal authorisation records this is usually null.
    - `GUID` string, nullable — Identifier assigned to the authorisation which can uniqely identify and link related messages between the full authorisation, clearing and settlement process.
    - `retrievalReferenceNumber` string, nullable — 12 digit reference number following ISO 8583 which can be used with other key data elements to identify and track all messages related to a given transaction. It is usually assigned by the acquirer, but it may be assigned by a merchant or by an individual electronic terminal.
    - `merchantReference1` string, nullable — Flexible reference field provided by the merchant via our payment gateway, usually something that is printed on the receipt and uniquely references the transaction in the merchants system.
    - `merchantReference2` string, nullable — Optional reference number provided by the merchant via our payment gateway, such as an order reference number. Can be used in addition to `merchantReference1` to provide additional linking to the merchant's internal systems.
    - `reservationNumber` string, nullable — Reservation number generated by the merchant and used as a reference. For example, in transactions involving hotel reservations.
    - `customerIPAddress` string, nullable — IP address of the customer recorded by the payment gateway, for example when payments are made via a hosted web store.
    - `products` object[] — References to any products recorded as part of the transaction.
      - `id` string, required — Unique identifier or internal product code of a product related to the transaction.
  - `paymentInstrument` union, required — The instrument used to make the payment, which will be one of a few specific categories. For more details see our page on [payment types](https://docs.fiserv.com/docs/general/ZG9jOjI2NjE5MjE0-payment-types).
    - object — Basic payment instrument parent
      - `category` 'CARD' | 'CASH' | 'ALTERNATIVE', required — The discriminator used to determine the payment category and object type. For more details see our page on [payment instruments](https://docs.fiserv.dev/public/docs/payment-instruments).
      - `brand` 'AMEX' | 'CUP' | 'DINERS' | 'GIRO' | 'JCB' | 'MAESTRO' | 'MC' | 'PAGO' | 'PP' | 'PRIV' | 'VISA' | 'VPAY' | 'GIFT' | 'C_EGIFT' | 'CARTBLANC' | 'RUPAY', required — The brand or scheme of payment card.
      - `number` string, required — Masked instrument number or account number used to pay for goods or services such as a PAN, PayPal account reference, bank account number. With first 6 and last 4 digits visible in the clear.
      - `expiryDate` string, nullable — Expiry date of payment instrument in the format 'YYMM'.
      - `subType` string, nullable — Additional information about the type of instrument, for example card products such as Visa Select (N2) and MasterCard Platinum (MPL).
      - `serviceType` 'CREDIT' | 'DEBIT' | 'PREPAID', nullable — Used for card-based payments to determine the service type, such as credit or debit.
      - `token` string, nullable — Reference or token for a payment instrument, for example: * A token generated from a card number by using the Payments API * A system-specific reporting token * A PAR (Payment Account Reference)
    - object — Basic payment instrument parent
      - `category` 'CARD' | 'CASH' | 'ALTERNATIVE', required — The discriminator used to determine the payment category and object type. For more details see our page on [payment instruments](https://docs.fiserv.dev/public/docs/payment-instruments).
    - object — Basic payment instrument parent
      - `category` 'CARD' | 'CASH' | 'ALTERNATIVE', required — The discriminator used to determine the payment category and object type. For more details see our page on [payment instruments](https://docs.fiserv.dev/public/docs/payment-instruments).
      - `service` 'BLIK' | 'ELV' | 'IDEAL' | 'KLARNA' | 'PAYPAL' | 'PBL' | 'SEPADD' | 'SOFORT' | 'TOPUP' | 'EASYCASH' | 'VIPP' | 'MOBILEPAY' | 'TWINT' | 'SWISH' | 'ALIPAY' | 'WECHATPAY' | 'POSTFINANCE' | 'OTHER', required — Name of the APM (Alternative Payment Method) service used for the payment.
      - `number` string — Masked instrument number or account number used to pay for goods or services such as a PAN, PayPal account reference, bank account number. With first 6 and last 4 digits visible in the clear.
      - `token` string, nullable — Reference or token for a payment instrument, for example: * A token generated from a card number by using the Payments API * A system-specific reporting token * A PAR (Payment Account Reference)
      - `expiryDate` string, nullable — Expiry date of payment instrument in the format 'YYMM'.
  - `financial` object, required — Groups financial and currency data for the transaction
    - `amounts` object, required
      - `currencyCode` string, nullable, required — ISO alpha 3 currency code of the transaction amounts in cardholder currency. In cases that DCC is used (see `financials.dcc`), it may differ from the merchant's currency.
      - `authorised` string, required — Authorisation amount in cardholder currency.
      - `cashback` string, nullable — Cashback amount in acceptor currency.
      - `tip` string, nullable — Tip amount in authorization currency.
    - `dcc` object
      - `rate` string, nullable — Dynamic currency conversion (DCC) is a credit card feature that allows you to make a point-of-sale (POS) credit card purchase in a foreign country using the currency of your home country. The rate is the conversion from the authorised amount into the merchant's currency.
      - `indicator` 'NONE' | 'DCC' | 'DECLINED' — This indicates whether the transaction is DCC transaction, DCC was accepted or not applicable. | Code | Description | |---|---| | NONE | Non-DCC | | DCC | DCC converted transaction | | DECLINED | Declined by cardholder |
      - `currencyCode` string, nullable — ISO Alpha 3 currency code for the DCC conversion in the merchant's currency.
    - `instalment` object
      - `totalNumber` integer, nullable — Total number of instalments
      - `totalAmount` string, nullable — Total sum of all instalments in authorisation currency
      - `deferredPeriod` integer, nullable — Number of months for which payment shall not be enforceable (buy today, pay later). Can have a value from 0 to 99.
      - `first` string, nullable — The amount of first instalment in auth message currency.
  - `transactionAttributes` object — Additional attributes regarding the transaction, such as reponse codes as part of security checks.
    - `issuerResponseCode` string, nullable — Code send back from the issuer in response to an authorisation request which contains detail on whether the request was approved or declined and the reason for a decline. For example, a successful authorisation is identified by the code `00`, while a declined authorisation based on insufficient funds would be `51`. For more detail on these codes and a full list of examples, see our page on [response codes](https://docs.fiserv.dev/public/docs/response-codes).
    - `avsResponse` string, nullable — Address Verification Service (AVS) helps to protect against fraudulent use of cards, particularly in ecommerce transactions, by verifying the cardholder’s billing address against those provided. The single-character codes returned by this service are defined by the card schemes; for more details and a list of possible values see our page on [response codes](https://docs.fiserv.dev/public/docs/response-codes#address-verification-service-avs).
    - `cvv2Result` 'M' | 'N' | 'P' | 'S' | 'U', nullable — The CVV Number ("Card Verification Value") is the 3 digit number on the back of a credit or debit card. It adds a layer of additional security for ecommerce transactions to help prevent card fraud. On American Express branded credit or debit cards, it is a 4 digit numeric code. | Code | Description | |---|---| | M | CVV2 Match | | N | CVV2 Not match | | P | Not Processed | | S | Should be on the card, but merchant indicates it is not | | U | User is not certified or has not provided Visa with encryption keys or both |
    - `reversal` 'NON_REVERSED' | 'REVERSAL' — A flag indicating if the authorisation was reversed or not. A reversal is the act of 'undoing' a transaction, which in the case of authorisations results in any hold on funds being released.
  - `captureEnvironment` object — Detail about the environment used to capture the payment, such as a terminal.
    - `platform` string — The platform or system which processed the authorisation, such as 'IPG' (International Payment Gateway).
    - `transactionSource` 'TERMINAL' | 'CONTACTLESS_TAP_TERMINAL' | 'CLOVER_TERMINAL' | 'NEXO_TERMINAL' | 'TERMINAL_ZVT' | 'API' | 'CONNECT' | 'VIRTUAL_TERMINAL', nullable — A description of the where the transaction originated, in addition to the `channel` field. Gives more detail on the type of terminal or system used.
    - `captureMethod` 'ECOMMERCE' | 'CHIP' | 'CHIP_CONTACTLESS' | 'CHIP_UNRELIABLE' | 'MAGNETIC' | 'MAGNETIC_CONTACTLESS' | 'MAGNETIC_UNREADABLE' | 'MAGNETIC_FALLBACK' | 'MANUAL' | 'OCR' | 'UNKNOWN' — The method for which the payment instrument details were captured.
    - `threeDS` 'NON_3DS' | 'MERCHANT_3DS' | 'FULL_3DS' | 'MERCHANT_UCAF' | 'MASTERPASS_MASTERCARD_DECISION' | 'MASTERPASS_ISSUER_DECISION' | 'MASTERPASS_MERCHANT_DECISION' | 'REMOTE_PAYMENT', nullable — Represents the level of security used for an ecommerce transaction. 3-D Secure, also known as payer authentication, is a security protocol that helps to prevent fraud in online credit and debit card transactions by asking the user to provide authentication approval. The decision for approving the transaction based on this data may be made by the merchant or the issuer / card schemes or both (which is referred to as full). The important note being that a party that approves the transaction on this basis accepts liability.
    - `terminal` object
      - `id` string, nullable — Terminal ID is the number assigned to the POI and used between POI and Central Acceptance Host and displayed on terminal and used for reconciliation purposes.
      - `workstationId` string, nullable — Identifies the workstation ID of the merchant's ePOS system
      - `serialNumber` string, nullable — The device serial number of the terminal. The format may depend on the specific terminal or type, so the field should be assumed to contain a string with a flexible format.
      - `captureMode` 'OFFLINE' | 'ONLINE' | 'OFFLINE_ONLY', nullable — Describes mode of capturing authorisation at the POI.
      - `capability` 'MANUAL' | 'MAGNETIC' | 'CHIP' | 'KEY' | 'CONTACTLESS' | 'CONTACTLESS_MAGNETIC' | 'UNKNOWN' | 'CHIP_MAGNETIC_KEY' | 'MAGNETIC_KEY' | 'CHIP_MAGNETIC' | 'CHIP_KEY', nullable — Capability of the terminal to read the payment instrument.
      - `activationFlag` 'ACTIVATED' | 'NOT_ACTIVATED', nullable — Whether the terminal has been activated with a terminal ID.
      - `pinCaptureCapability` integer, nullable — Maximum PIN length which the terminal is capable of capturing. Represented as numeric value. Field value is `0` in the case where there is no PIN capture capability.
  - `_links` object — A collection of references to other related items in our APIs, using HAL-style formatting, use these for reconciling the current record against other records
    - `transactions` object — A reference to the `/transactions` endpoint for any transaction records related to the current authorisation, using the following params: - `orderId` field from the current authorisations - `postedAfter` the current `created` date - `postedBefore` the current day
      - `href` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests
- `500` — Internal server error

---

[API](https://skmtc.net/fiserv/apis/acquirer-profile-in-design.md) · [All operations](https://skmtc.net/fiserv/apis/acquirer-profile-in-design/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fiserv/acquirer-profile-in-design/versions/dd7ef6ce81a1/schema)