WOworldline
Authorization

Retrieve authorizations

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

get/acquiring/transaction/v3.0/acquirers/{acquirerId}/authorizations

Request

Path parameters

acquirerIdstring required

Unique identification of the acquirer, determined by equensWorldline

Query parameters

acquirerRefNostring required

Data supplied by an acquirer to assist in identifying an authorization. (Note: acquirerRefNo = acquirerReferenceNumber)

examples ARN29851, 74875009071000046650752

transactionAmountFromnumber double

Transaction search amount, amount should be greater than or equal to this value

transactionAmountTonumber double

Transaction search amount, amount should be less than this value

transactionAmountCurrencystring

Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR

sortField'TransactionId' | 'AuthorizationDateTime' | 'Brand' | 'TruncatedPan'

Sort field

sortOrder'Ascending' | 'Descending'

Sort order

pageSizestring

Page size (max 300)

pageNumberstring

Page number

Response

Successful

approvalCodestring

Code assigned by the authorising institution indicating approval

authorizationDateTimestring date-time

authorisation date-time (RFC 3339)

brandstring

Brand

cardAcceptorNameLocationstring

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)

cardExpiryDateinteger

The year and month after which the card expires

cardSequenceNumberinteger

card sequence number

cardValidationResultstring

Contains the result of a CVC2/CVV2 validation or the (i)CVC/CVV validation

channelinteger

Channel code (0 atm, 1 pos, 2 eCommerce, 3 moto)

contactlessIndicatorinteger

Indicates whether the transaction has been done contactless (0 no, 1 yes)

ecommerceIndicatorstring

Electronic Commerce Indicators

forwardingInstitutionIdstring

Code identifying the acquirer processor or card acceptor

iccDateFilledstring

EMV data present. Y or N

merchantCategoryCodeinteger

Merchant Catogory Code

paymentFacilitatorIdstring

Identifier for a Payment Facilitator which allows anyone who wants to offer merchant services on a sub-merchant platform.

pointOfServiceDataOnlinestring

A code used to indicate the local conditions at the point-of-service device, at the time a card payment transaction was initiated.

pointOfServiceDataOfflinestring

A code used to identify terminal capability, terminal environment and presentation of security data.

posEntryModestring

A code that identifies how the carddata was entered on the terminal and which PINentry capabilities the terminal possesses.

processingCodestring

Code which indicates the type of transaction being undertaken. Used in conjunction with the Account type code as part of the Processing code.

responseCodeInternalstring

response code internal

responseCodeExternalstring

Response Code from the authorization response received from the brand gateway

retrievalReferenceNumberstring

Retrieval Reference Number from the authorization request sent to Mastercard/Visa

serviceCodestring

The service code from the track

subMerchantIdstring

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

terminalBatchReferencestring

Reference of the terminal batch

terminalProtocolstring

Terminal Protocol

truncatedPanstring

truncated pan. Only the first 6 and last 3 digits are present. Values inbetween are zeros

paymentAccountReferencestring

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

tokenAssuranceMethodstring

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

tokenRequestorIdstring

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

Example response

[
  {
    "transactionIdentification": {
      "transactionId": "TDS16172008721825920",
      "actionId": "432956ee-6974-42d2-bfdb-878997f21653",
      "acquirerReferenceNumber": "11223344662288134679854",
      "merchantReference": "trx reference by merchant",
      "stan": 12752
    },
    "contractIdentification": {
      "acquirerId": "671234567",
      "holdingId": 200,
      "merchantId": "1280300",
      "contractId": "12872",
      "cardAcceptorId": "30010",
      "siteId": 30010,
      "terminalId": "20YT45"
    },
    "approvalCode": "AB90EF",
    "brand": "MAES",
    "cardAcceptorNameLocation": "Purchase Merchant/ CC \\ARNHEM       \\NLD",
    "cardExpiryDate": 2104,
    "cardSequenceNumber": 123,
    "cardValidationResult": "M",
    "contactlessIndicator": 1,
    "ecommerceIndicator": "2100000",
    "forwardingInstitutionId": "671734512",
    "iccDateFilled": "Y",
    "merchantCategoryCode": 7000,
    "paymentFacilitatorId": "10000000000",
    "pointOfServiceDataOnline": "0123456789012345678901245",
    "pointOfServiceDataOffline": "111121613024",
    "posEntryMode": "79x",
    "processingCode": "010000",
    "responseCodeInternal": "00",
    "responseCodeExternal": "00",
    "retrievalReferenceNumber": "012345678901",
    "serviceCode": "945",
    "subMerchantId": "734188",
    "terminalBatchReference": "0000000216",
    "terminalProtocol": "02",
    "truncatedPan": "6731230000000123",
    "cashBackAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "originalAmountRequested": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "amountAuthorized": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "tipAmount": {
      "amount": "3.00",
      "currency": "EUR"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.