Transaction

Retrieve transactions on merchant level

This operation retrieves all transaction(s) on specific merchant level.

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}/merchants/{merchantId}/transactions

Request

Base URL
https://financial-services.developer.worldline.com/MerchantApiTransaction/api
Auth
none declared

Path parameters

acquirerIdstring required

Unique identification of the acquirer, determined by equensWorldline

merchantIdstring required

Unique identification of the merchant, determined by equensWorldline

Query parameters

startDateTimestring date-time

Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) Either the update (start/end) time or the creation (start/end) time is required

endDateTimestring date-time

End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) Either the update (start/end) time or the creation (start/end) time is required

updateStartDateTimestring date-time

Update start Datetime of processing (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) Either the update (start/end) time or the creation (start/end) time is required

updateEndDateTimestring date-time

Update end Datetime of processing (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) Either the update (start/end) time or the creation (start/end) time is required

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

cardNumberLast4string

Last 4 digits from the cardnumber

refundOnlystring

Return refunds only indicator. (0 = return all transactions, 1 = refunds only)

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

Unique identification of the brand (payment product). Maestro MAES, Visa VISA, etc.

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

matStatusstring

MAT transactions are flagged as MAT so that acquirer and merchant can see the transaction was approved in back-up mode. Values 0 (No MAT) or 1 (Approved MAT).

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)

posEntryModestring

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.

processingDateTimeSchemestring 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, 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

result3dsstring

Indicates result of the 3-D Secure authentication process.

version3dsstring

Indicates the applied 3-D Secure version.

cavvstring

CAVV (Cardholder Authentication Verification Value) data in hexadecimal notation (40 characters for 20 bytes).

xidstring

XID (eCommerce transaction ID) in hexadecimal notation (40 characters for 20 bytes).

ucafstring

UCAF (Universal Cardholder Authentication Field) in hexadecimal notation (40 characters for 20 bytes).

mitCausestring

Cause detailing the Merchant Initiated Transaction.

initiatorTypestring

Indicates which entity has triggered the operation.

captureSequenceNumberinteger

Number of current capture in the entire capture sequence starting from 1.

captureSequenceCountinteger

Total number of captures for the business case in case BusinessCaseType is FinancialRequest.

schemeMerchantIdstring

Id for the merchant assigned by the card scheme

schemeTransactionIdstring

The Trace-ID/TID assigned by the scheme

paymentInitiationChannelstring

Used to provide information about the form factor of the token that was used to initiate a payment

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",
    "contactlessIndicator": 1,
    "creditDebitIndicator": "D",
    "forwardingInstitutionId": "671734512",
    "matStatus": "1",
    "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",
    "posEntryMode": "79x",
    "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%",
    "result3ds": "Full",
    "version3ds": "V2",
    "mitCause": "Unscheduled",
    "initiatorType": "Cardholder",
    "captureSequenceNumber": 2,
    "captureSequenceCount": 3,
    "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.