---
title: "List authorizations"
method: GET
path: "/authorizations"
tags: ["Settlement"]
---

# List authorizations

`GET /authorizations`

Use this method to retrieve a [paginated](https://docs.payroc.com/api/pagination) list of authorizations.  

Use query parameters to filter the list of results that we return, for example, to search for authorizations linked to a specific merchant.  

> **Important:** You must provide a value for either the date query parameter or the batchId query parameter.  

Our gateway returns the following information about each authorization in the list:
- Authorization response from the issuing bank.
- Amount that the issuing bank authorized.
- Merchant that ran the authorization.
- Details about the customer's card, the transaction, and the batch.

## Query parameters

- `before` string
- `after` string
- `limit` integer
- `date` string, date
- `batchId` integer
- `merchantId` string

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns a paginated list of authorizations.

- ReportingSettlementListAuthorizationsResponse200 — Contains the pagination properties that you use to navigate through a list of results.
  - `limit` integer — Maximum number of results that we return for each page.
  - `count` integer — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query.
  - `hasMore` boolean — Indicates whether there is another page of results available.
  - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `data` Authorization[], required — Array of authorization objects.
    - `authorizationId` integer — Unique identifier that we assigned to the authorization.
    - `createdDate` string, date — Date that we received the authorization. The format of this value is **YYYY-MM-DD**.
    - `lastModifiedDate` string, date — Date that the authorization was last changed. The format of this value is **YYYY-MM-DD**.
    - `authorizationResponse` 'activityCountLimitExceeded' | 'alreadyReversed' | 'approved' | 'approveVip' | 'approveWithId' | 'cannotVerifyPin' | 'cardAuthenticationFailed' | 'cardTypeVerificationError' | 'cashRequestExceedsIssuerLimit' | 'cashServiceNotAvailable' | 'cidVerificationError' | 'contactCardIssuer' | 'cryptographicFailure' | 'dailyThresholdExceeded' | 'declineCvv2Failure' | 'deny' | 'denyAccountCanceled' | 'denyClosedMerchant' | 'denyNewCardIssued' | 'denyPickUpCard' | 'destinationCannotBeFoundForRouting' | 'doNotHonor' | 'duplicateTransmissionDetected' | 'error' | 'exceedsWithdrawalAmountLimit' | 'expiredCard' | 'fileTemporarilyUnavailable' | 'forceStip' | 'formatError' | 'forwardToIssuer' | 'functionNotSupported' | 'honorWithId' | 'incorrectCvv' | 'incorrectPin' | 'ineligibleForResubmission' | 'insufficientFunds' | 'invalidAccount' | 'invalidAccountNumber' | 'invalidAmount' | 'invalidAuthorizationLifeCycle' | 'invalidBillerInformation' | 'invalidCardSecurityCode' | 'invalidCurrencyCode' | 'invalidMerchant' | 'invalidResponse' | 'invalidTransaction' | 'issuerNotAvailable' | 'issuerTimeout' | 'issuerUnavailable' | 'noActionTaken' | 'noCardRecord' | 'noCheckingAccount' | 'noCreditAccount' | 'noFinancialImpact' | 'noReasonToDecline' | 'noSavingsAccount' | 'noSuchIssuer' | 'partialApproval' | 'partialAuthorization' | 'pickUpCard' | 'pickUpCardSpecialCondition' | 'pinChangeRequestDeclined' | 'pinCryptographicErrorFound' | 'pinEntryTriesExceeded' | 'pinNotChanged' | 'pleaseCallIssuer' | 'reenterTransaction' | 'referToCardIssuer' | 'referToCardIssuerSpecialCondition' | 'restrictedCard' | 'reversal' | 'reversalDataInconsistent' | 'revokeAllAuthorizationsOrder' | 'scheduledTransactionstoppedByCardholder' | 'securityViolation' | 'successful' | 'surchargeAmountNotPermitted' | 'suspectFraud' | 'systemMalfunction' | 'transactionAmountExceedsApprovalAmount' | 'transactionCannotBeCompleted' | 'transactionNotAllowedAtMerchant' | 'transactionNotAllowedAtTerminal' | 'transactionNotPermitted' | 'transactionNotPermittedToCardholder' | 'unableToGoOnline' | 'unableToLocateRecordInFile' | 'unableToVerifyPin' | 'unacceptablePin' | 'unknown' | 'unsafePin' — Response from the issuing bank for the authorization.
    - `preauthorizationRequestAmount` integer — Amount that the merchant requested for the authorization. We return the value in the currency's lowest denomination, for example, cents.
    - `currency` string — Currency of the authorization. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
    - `batch` BatchSummary — Object that contains information about the batch. If we can't match a dispute to a batch, we don't return 'batch' object.
      - `batchId` integer — Unique identifier of the batch.
      - `date` string, date — Date that the merchant submitted the batch.
      - `cycle` string — Indicates the cycle that contains the batch.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.
    - `card` CardSummary — Object that contains information about the card.
      - `cardNumber` string — Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, `500165******0000`.
      - `type` 'visa' | 'masterCard' | 'discover' | 'debit' | 'ebt' | 'wrightExpress' | 'voyager' | 'amex' | 'privateLabel' | 'storedValue' | 'discoverRetained' | 'jcbNonSettled' | 'dinersClub' | 'amexOptBlue' | 'fuelman' | 'unknown' — Card type, for example, Visa. **Note:** If we can’t match a dispute to a transaction, we don’t return a type object.
      - `cvvPresenceIndicator` boolean — Indicates whether the cardholder provided the Card Verification Value (CVV).
      - `avsRequest` boolean — Indicates whether the merchant used the Address Verification Service (AVS) to verify the cardholder's address.
      - `avsResponse` string — Response from the Address Verification Service (AVS).
    - `merchant` MerchantSummary — Object that contains information about the merchant.
      - `merchantId` string — Unique identifier that the processor assigned to the merchant.
      - `doingBusinessAs` string — Trading name of the business.
      - `processingAccountId` integer — Unique identifier that we assigned to the processing account.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.
    - `transaction` TransactionSummary — Object that contains summary information about the transaction that the dispute is linked to.
      - `transactionId` integer, nullable — Unique identifier of the transaction. If we can't match a dispute to a transaction, we don't return the transactionId or link object.
      - `type` 'capture' | 'return' — Indicates the type of transaction.
      - `date` string, date — Date of the transaction. The format of this value is **YYYY-MM-DD**.
      - `entryMethod` 'barcodeRead' | 'smartChipRead' | 'swipedOriginUnknown' | 'contactlessChip' | 'ecommerce' | 'manuallyEntered' | 'manuallyEnteredFallback' | 'swiped' | 'swipedFallback' | 'swipedError' | 'scannedCheckReader' | 'credentialOnFile' | 'unknown' — Describes how the merchant received the payment details. If we can't match a dispute to a transaction, we don't return an entryMethod object.
      - `amount` integer — Total amount of the transaction. The value is in the currency's lowest denomination, for example, cents.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.

## Other responses

- `400` — Validation error
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)