WOworldline
Transaction Lifecycle

Retrieve by AcquirerRefNo

This operation uses the unique AcquirerRefNo (acquirerReferenceNumber ARN) to retrieve the associated first/second presentment(s) data \nand the associated transaction data of the different stages in the dispute life cycle.

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}/transactionlifecycle

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 a transaction, e.g. for researching retrievals and chargebacks (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' | 'TransactionDateTime' | 'TransactionType' | '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

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)

channelinteger

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

contactlessIndicatorinteger

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

creditDebitIndicatorstring

Funding source. The field describes how the cardholder funds his account. (C = Credit, D = Debit, P = Prepaid)

forwardingInstitutionIdstring

Code identifying the acquirer processor or card acceptor

merchantCategoryCodeinteger

Merchant Catogory Code

paymentFacilitatorIdstring

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

paymentProductTypeCodestring

Code for the type of payment product. (Z Commercial Card. 2 Consumer Card)

posEntryModeClearingstring

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

pricePlanTarifIdstring

Unique identification for the price plan tarif.

processingDateSchemestring date-time

processing date-time by scheme (RFC 3339)

regionstring

Region of the payment scheme (Netherlands Maestro, etc)

regionCodestring

Region of the payment scheme code

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

transactionDateTimestring date-time

authorisation date-time (RFC 3339)

transactionDescriptionstring

Transaction currency combination description

transactionFeePricePlanTypeCodestring

Type of Merchant transaction fee price plan code. (00 No price plan type, 01 Standard pricing, 02 Interchange plus, 03 Advanced pricing)

transactionLevelstring

Code that identifies the transaction level

transactionStatusstring

Status of the transaction (CAPT transaction is captured, TFEE transaction fee is added, PAID transaction is paid out)

transactionTypestring

Description of transaction being undertaken

transactionTypeCodestring

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

Most common codes are the following: 904 Purchase Presentment, 905 Cash Withdrawal/Advance Presentment, 901 Refund Presentment, 047 Reimbursement Equens Merchant Loss Settled Debit, 024 Adjustment (Corrections or Manual Adjustments) Correction, 030 Adjustment (Corrections or Manual Adjustments) Paid debt, 038 Adjustment (Corrections or Manual Adjustments) Fee Correction, etc.

truncatedPanstring

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

vatLabelstring

Describes the rate of the VAT

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",
    "contactlessIndicator": 1,
    "creditDebitIndicator": "D",
    "forwardingInstitutionId": "671734512",
    "merchantCategoryCode": 7000,
    "paymentFacilitatorId": "10000000000",
    "paymentInfo": [
      {
        "merchantPaymentId": "SO-000000017036619028",
        "merchantPaymentAggregationLevelCode": "02",
        "paymentType": "03",
        "paymentCrossReferenceURI": "acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD"
      }
    ],
    "paymentProductTypeCode": "2",
    "posEntryModeClearing": "02",
    "pricePlanTarifId": "tarifId",
    "region": "Netherlands Maestro",
    "regionCode": "31",
    "subMerchantId": "734188",
    "terminalBatchReference": "0000000216",
    "terminalProtocol": "02",
    "transactionDescription": "0150 Chargeback Correction case id 0000001",
    "transactionFeePricePlanTypeCode": "01",
    "transactionLevel": "Contract",
    "transactionStatus": "TFEE",
    "transactionType": "Purchase Presentment",
    "transactionTypeCode": "904",
    "truncatedPan": "6731230000000123",
    "vatLabel": "21%",
    "transactionAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "transactionVatAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "merchantTransactionFeeAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "merchantTransactionFeeVatAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "netAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "schemeMarkupAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "interchangeFeeAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "cashBackAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "acquirerMarkupAmount": {
      "amount": "3.00",
      "currency": "EUR"
    },
    "merchantTransactionAmount": {
      "amount": "3.00",
      "currency": "EUR"
    }
  }
]

Changes

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