--- title: "Retrieve authorizations" method: GET path: "/acquiring/transaction/v3.0/acquirers/{acquirerId}/authorizations" tags: ["Authorization"] --- # Retrieve authorizations `GET /acquiring/transaction/v3.0/acquirers/{acquirerId}/authorizations` ## Request - Base URL: `https://financial-services.developer.worldline.com/MerchantApiTransaction/api` - URL: `https://financial-services.developer.worldline.com/MerchantApiTransaction/api/acquiring/transaction/v3.0/acquirers/{acquirerId}/authorizations` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) This operation uses the unique AcquirerRefNo (acquirerReferenceNumber ARN) to retrieve the associated authorization(s) data. If there is a previous and/or next page the http response header will have a link (url) to this data. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link#pagination_through_links ## Path parameters - `acquirerId` string, required ## Query parameters - `acquirerRefNo` string, required - `transactionAmountFrom` number, double - `transactionAmountTo` number, double - `transactionAmountCurrency` string - `sortField` 'TransactionId' | 'AuthorizationDateTime' | 'Brand' | 'TruncatedPan' - `sortOrder` 'Ascending' | 'Descending' - `pageSize` string - `pageNumber` string ## Response `200` Successful - Authorization[] - `transactionIdentification` TransactionIdentification - `transactionId` string: Unique identification for a Cardholder Initiated Transaction - `actionId` string: Action ID in UUID format - `acquirerReferenceNumber` string: Data supplied by an acquirer to assist in identifying a transaction, e.g. for researching retrievals and chargebacks - `merchantReference` string: Merchant Reference. This is a reference that the merchant can add to an authorization request towards the terminal by entering it via the keyboard of the merchant. - `pspReference` string: Additional information provided by the concentrator to return on his statement. - `retrievalReferenceNumber` string: External retrieval reference number. - `stan` integer: Systems Trace Audit Number - `contractIdentification` ContractIdentification - `acquirerId` string: Unique identification of the acquirer, determined by equensWorldline - `pspId` string: Psp Id - `holdingId` integer: Unique identification of the holding, determined by equensWorldline - `merchantId` string: Unique identification of the merchant, determined by the acquirer - `contractId` string: Unique identification of the contract, determined by the acquirer - `cardAcceptorId` string: Unique identification of the cardAcceptor within the contract - `siteId` integer: Unique identification of the site within the contract - `terminalId` string: Unique code identifying the terminal at the Card acceptor location - `approvalCode` string: Code assigned by the authorising institution indicating approval - `authorizationDateTime` string, date-time: authorisation date-time (RFC 3339) - `brand` string: Brand - `cardAcceptorNameLocation` string: The name and place where the terminal is located. Note - A backslash is not valid json. So a backslash will be escaped (with a backslash) - `cardExpiryDate` integer: The year and month after which the card expires - `cardSequenceNumber` integer: card sequence number - `cardValidationResult` string: Contains the result of a CVC2/CVV2 validation or the (i)CVC/CVV validation - `channel` integer: Channel code (0 atm, 1 pos, 2 eCommerce, 3 moto) - `contactlessIndicator` integer: Indicates whether the transaction has been done contactless (0 no, 1 yes) - `ecommerceIndicator` string: Electronic Commerce Indicators - `forwardingInstitutionId` string: Code identifying the acquirer processor or card acceptor - `iccDateFilled` string: EMV data present. Y or N - `merchantCategoryCode` integer: Merchant Catogory Code - `paymentFacilitatorId` string: Identifier for a Payment Facilitator which allows anyone who wants to offer merchant services on a sub-merchant platform. - `pointOfServiceDataOnline` string: A code used to indicate the local conditions at the point-of-service device, at the time a card payment transaction was initiated. - `pointOfServiceDataOffline` string: A code used to identify terminal capability, terminal environment and presentation of security data. - `posEntryMode` string: A code that identifies how the carddata was entered on the terminal and which PINentry capabilities the terminal possesses. - `processingCode` string: Code which indicates the type of transaction being undertaken. Used in conjunction with the Account type code as part of the Processing code. - `responseCodeInternal` string: response code internal - `responseCodeExternal` string: Response Code from the authorization response received from the brand gateway - `retrievalReferenceNumber` string: Retrieval Reference Number from the authorization request sent to Mastercard/Visa - `serviceCode` string: The service code from the track - `subMerchantId` string: Sub Merchant ID, defined by a Payment Facilitator (merchant). Each merchant that is considered to be a “Payment Facilitator” by MasterCard needs to uniquely identify all of its sites with a sub merchant ID - `terminalBatchReference` string: Reference of the terminal batch - `terminalProtocol` string: Terminal Protocol - `truncatedPan` string: truncated pan. Only the first 6 and last 3 digits are present. Values inbetween are zeros - `paymentAccountReference` string: this is a unique reference value that is assigned to a single PAN to link the Payment Account to its associated tokens. The PAR is made of 29 unique alphanumeric characters and does not change throughout the PAN’s lifecycle event - `tokenAssuranceMethod` string: this is the outcome of the token assurance steps and represents the confidence level of the token to the PAN/cardholder binding. These numbers range between 01 and 99 and can be divided into three categories. The first category ranges between 01 and 19. The second category ranges between 20 and 89. The third category ranges between 90 and 99 - `tokenRequestorId` string: this identifies each unique combination of Token Requestor and Token Domain(s) for a given Token Service Provider. It is possible for the the merchant to have multiple token requestor IDs to support different usage scenarios - `cashBackAmount` Amount - `amount` string, unlimited size decimal: Amount in the major units of the currency according to ISO 4217. In case of euro, "3.10" (is 3.10 euro) - `currency` string: Currency of the amount - `originalAmountRequested` Amount - `amount` string, unlimited size decimal: Amount in the major units of the currency according to ISO 4217. In case of euro, "3.10" (is 3.10 euro) - `currency` string: Currency of the amount - `amountAuthorized` Amount - `amount` string, unlimited size decimal: Amount in the major units of the currency according to ISO 4217. In case of euro, "3.10" (is 3.10 euro) - `currency` string: Currency of the amount - `tipAmount` Amount - `amount` string, unlimited size decimal: Amount in the major units of the currency according to ISO 4217. In case of euro, "3.10" (is 3.10 euro) - `currency` string: Currency of the amount ## Other responses - `400`: Invalid input provided - `401`: Unauthorized - `403`: Forbidden - `404`: Resource not found - `500`: Unexpected error or Internal error - `502`: Backend service problem --- [API](https://skmtc.dev/worldline/apis/merchant-payments-transactions-api.md) - [All operations](https://skmtc.dev/worldline/apis/merchant-payments-transactions-api/llms.txt) - [OpenAPI document](https://skmtc.dev/worldline/apis/merchant-payments-transactions-api/revisions/409c9f008803?raw)