swagger: '2.0' info: description: This is the API server supplied by equensWorldline. version: '2.0' title: Merchant payments - Transactions API contact: name: equensWorldline API team. See developer portal host: developer.equensworldline.com basePath: /MerchantApiTransaction/api schemes: - https paths: /acquiring/transaction/v2.0/acquirers/{acquirerId}/transactions/{transactionId}: get: tags: - Transaction summary: Retrieve a transaction description: | This operation uses the unique transactionId to retrieve the transaction data operationId: getTransaction consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: transactionId in: path description: | Unique identification of the transaction examples TDS16172008721825920, TDS16172008721825921 required: true type: string example: "TDS19071000000036832" responses: '200': description: Successful schema: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/transactions: get: tags: - Transaction summary: Retrieve transactions on search criteria description: | This operation uses the unique AcquirerRefNo (ARN) to retrieve the associated transaction(s) data. For example, with a MC 2nd Chargeback the unique AcquirerRefNo retrieves the unique transactionId’s and associated transaction data of all 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 operationId: getTransactionBySearchCriteria consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: acquirerRefNo in: query description: | Data supplied by an acquirer to assist in identifying a transaction, e.g. for researching retrievals and chargebacks If present, a startDateTime and endDateTime must be present too required: false type: string example: "74875009071000046650752" - name: merchantTransactionRefNo in: query description: | 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. If present, a startDateTime and endDateTime must be present too required: false type: string example: "Web order 1" - name: startDateTime in: query description: Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) required: true type: string format: date-time example: "2019-03-01 13:30:00" - name: endDateTime in: query description: End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) required: true type: string format: date-time example: "2019-03-31 14:30:00" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: sortField in: query description: Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/payments/{paymentId}/transactions: get: tags: - Transaction summary: Retrieve transactions for payment id description: | This operation uses the paymentId to retrieve the associated transaction(s) data. For example, with a MC 2nd Chargeback the unique AcquirerRefNo retrieves the unique transactionId’s and associated transaction data of all 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 operationId: getTransactionListByPaymentId consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: paymentId in: path description: | Unique identification of the payment in which this transaction has been paid out If present, the paymentDate must be present too required: true type: string example: "SO-000000000004665998" - name: paymentDate in: query description: | Payment Date (yyyy-mm-dd), known as payment posting date (required for search on paymentId) If present, the paymentId must be present too required: true type: string format: date example: "2019-03-14" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: sortField in: query description: Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/holdings/{holdingId}/transactions: get: tags: - Transaction summary: Retrieve transactions on holding level description: | This operation retrieves all transaction(s) on specific contract level If there is a previous and/or next page the http response header will have a link (url) to this data operationId: getTransactionsOnHoldingLevel consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: holdingId in: path description: Unique identification of the holding, determined by equensWorldline required: true type: integer format: int32 example: 1 - name: startDateTime in: query description: Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) required: true type: string format: date-time example: "2019-03-01 08:30:00" - name: endDateTime in: query description: End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) required: true type: string format: date-time example: "2019-03-31 10:30:00" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: cardNumberLast4 in: query description: Last 4 digits from the cardnumber required: false type: string - name: refundOnly in: query description: Return refunds only indicator. (0 = return all transactions, 1 = refunds only) required: false type: string - name: sortField in: query description: | Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/transactions: get: tags: - Transaction summary: Retrieve transactions on merchant level description: | This operation retrieves all transaction(s) on specific contract level If there is a previous and/or next page the http response header will have a link (url) to this data operationId: getTransactionsOnMerchantLevel consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: merchantId in: path description: Unique identification of the merchant, determined by equensWorldline required: true type: string example: "1100001" - name: startDateTime in: query description: | 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 required: false type: string format: date-time example: "2019-03-01 08:30:00" - name: endDateTime in: query description: | 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 required: false type: string format: date-time example: "2019-03-31 10:30:00" - name: updateStartDateTime in: query description: | 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 required: false type: string format: date-time - name: updateEndDateTime in: query description: | 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 required: false type: string format: date-time - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: cardNumberLast4 in: query description: Last 4 digits from the cardnumber required: false type: string - name: refundOnly in: query description: Return refunds only indicator. (0 = return all transactions, 1 = refunds only) required: false type: string - name: sortField in: query description: | Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/contracts/{contractId}/transactions: get: tags: - Transaction summary: Retrieve transactions on contract level description: | This operation retrieves all transaction(s) on specific contract level If there is a previous and/or next page the http response header will have a link (url) to this data operationId: getTransactionsOnContractLevel consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true type: string example: "1000016" - name: startDateTime in: query description: Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) required: true type: string format: date-time example: "2019-03-01 08:30:00" - name: endDateTime in: query description: End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) required: true type: string format: date-time example: "2019-03-31 10:30:00" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: cardNumberLast4 in: query description: Last 4 digits from the cardnumber required: false type: string - name: refundOnly in: query description: Return refunds only indicator. (0 = return all transactions, 1 = refunds only) required: false type: string - name: sortField in: query description: | Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/transactions: get: tags: - Transaction summary: Retrieve transactions on site level description: | This operation retrieves all transaction(s) on specific contract level If there is a previous and/or next page the http response header will have a link (url) to this data operationId: getTransactionsOnSiteLevel consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true type: string example: "1000016" - name: siteId in: path description: Unique identification of the site within the contract required: true type: integer format: int32 example: 100016 - name: startDateTime in: query description: Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) required: true type: string format: date-time example: "2019-03-01 08:30:00" - name: endDateTime in: query description: End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) required: true type: string format: date-time example: "2019-03-31 10:30:00" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: cardNumberLast4 in: query description: Last 4 digits from the cardnumber required: false type: string - name: refundOnly in: query description: Return refunds only indicator. (0 = return all transactions, 1 = refunds only) required: false type: string - name: sortField in: query description: | Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/transactions: get: tags: - Transaction summary: Retrieve transactions on terminal level description: | This operation retrieves all transaction(s) on specific contract level If there is a previous and/or next page the http response header will have a link (url) to this data operationId: getTransactionsOnTerminalLevel consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true type: string example: "1000016" - name: siteId in: path description: Unique identification of the site within the contract required: true type: integer format: int32 example: 100016 - name: terminalId in: path description: Unique code identifying the terminal at the Card acceptor location required: true type: string example: "ACA005" - name: startDateTime in: query description: Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value) required: true type: string format: date-time example: "2019-03-01 08:30:00" - name: endDateTime in: query description: End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded) required: true type: string format: date-time example: "2019-03-31 10:30:00" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: cardNumberLast4 in: query description: Last 4 digits from the cardnumber required: false type: string - name: refundOnly in: query description: Return refunds only indicator. (0 = return all transactions, 1 = refunds only) required: false type: string - name: sortField in: query description: | Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Transaction' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/authorizations: get: tags: - Authorization summary: Retrieve authorizations description: | This operation uses the unique AcquirerRefNo (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 operationId: getAuthorizations consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: acquirerRefNo in: query description: | Data supplied by an acquirer to assist in identifying an authorization. examples ARN29851, 74875009071000046650752 required: true type: string example: "74875009071000046650752" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: sortField in: query description: Sort field required: false type: string enum: - TransactionId - AuthorizationDateTime - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Authorization' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem /acquiring/transaction/v2.0/acquirers/{acquirerId}/transactionlifecycle: get: tags: - Transaction Lifecycle summary: Retrieve by AcquirerRefNo description: | This operation uses the unique AcquirerRefNo (ARN) to retrieve the associated first/second presentment(s) data and 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 operationId: getLifeCycle consumes: - application/json - '*/*' produces: - application/json parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by equensWorldline required: true type: string example: "671234567" - name: acquirerRefNo in: query description: | Data supplied by an acquirer to assist in identifying a transaction, e.g. for researching retrievals and chargebacks examples ARN29851, 74875009071000046650752 required: true type: string example: "74875009071000046650752" - name: transactionAmountFrom in: query description: Transaction amount (whole units), amount should be greater than or equal to this value required: false type: integer format: int32 - name: transactionAmountTo in: query description: Transaction amount (whole units), amount should be less than this value required: false type: integer format: int32 - name: transactionAmountCurrency in: query description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR required: false type: string - name: sortField in: query description: Sort field required: false type: string enum: - TransactionId - TransactionDateTime - TransactionType - Brand - TruncatedPan - name: sortOrder in: query description: Sort order required: false type: string enum: - Ascending - Descending - name: pageSize in: query description: Page size (max 300) required: false type: string - name: pageNumber in: query description: Page number required: false type: string responses: '200': description: Successful schema: type: array items: $ref: '#/definitions/Lifecycle' '400': description: Invalid input provided '401': description: Unauthorized '403': description: Forbidden '404': description: Resource not found '500': description: Unexpected error or Internal error '502': description: Backend service problem ################################################################################ # Definitions # ################################################################################ definitions: Transaction: type: object properties: transactionIdentification: $ref: '#/definitions/TransactionIdentification' contractIdentification: $ref: '#/definitions/ContractIdentification' approvalCode: type: string description: Code assigned by the authorising institution indicating approval example: "AB90EF" brand: type: string description: Unique identification of the brand (payment product). Maestro MAES, Visa VISA, etc. example: "MAES" cardAcceptorNameLocation: type: string description: 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) example: "Purchase Merchant/ CC \\ARNHEM \\NLD" channel: format: int32 description: Channel code (0 atm, 1 pos, 2 eCommerce, 3 moto) type: integer contactlessIndicator: type: integer format: int32 description: Indicates whether the transaction has been done contactless (0 no, 1 yes) example: 1 creditDebitIndicator: type: string description: Indicator credit/debit. (C = Credit. D = Debit) example: "D" forwardingInstitutionId: type: string description: Code identifying the acquirer processor or card acceptor example: "671734512" merchantCategoryCode: type: integer format: int32 description: Merchant Catogory Code example: 7000 paymentFacilitatorId: type: string description: Identifier for a Payment Facilitator which allows anyone who wants to offer merchant services on a sub-merchant platform. example: "10000000000" paymentInfo: $ref: '#/definitions/PaymentInfo' paymentProductTypeCode: type: string description: Code for the type of payment product. (Z Commercial Card. 2 Consumer Card) example: "2" posEntryMode: type: string description: A code that identifies how the carddata was entered on the terminal and which PINentry capabilities the terminal possesses. example: "79x" pricePlanTarifId: type: string description: Unique identification for the price plan tarif. example: "tarifId" processingDateTimeScheme: type: string format: date-time description: processing date-time by scheme (yyyy-mm-dd hh:mm:ss) example: 2019-01-11 09:30:47 region: type: string description: Region of the payment scheme (Netherlands Maestro, etc) example: "Netherlands Maestro" regionCode: type: string description: Region of the payment scheme code example: "31" subMerchantId: type: string description: 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 example: "734188" terminalBatchReference: type: string description: Reference of the terminal batch example: "0000000216" terminalProtocol: type: string description: Terminal Protocol example: "02" transactionDateTime: type: string format: date-time description: authorisation date-time (yyyy-mm-dd hh:mm:ss) example: 2016-08-21 09:30:47 transactionDescription: type: string description: Transaction currency combination description example: "0150 Chargeback Correction case id 0000001" transactionFeePricePlanTypeCode: type: string description: Type of Merchant transaction fee price plan code. (00 No price plan type, 01 Standard pricing, 02 Interchange plus, 03 Advanced pricing) example: "01" transactionLevel: type: string description: Code that identifies the transaction level example: "Contract" transactionStatus: type: string description: Status of the transaction (CAPT transaction is captured, TFEE transaction fee is added, PAID transaction is paid out) example: "TFEE" transactionType: type: string description: Description of transaction being undertaken example: "Purchase Presentment" transactionTypeCode: type: string description: | 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.) example: "904" truncatedPan: type: string description: truncated pan. Only the first 6 and last 3 digits are present. Values inbetween are zeros example: "6731230000000123" vatLabel: type: string description: Describes the rate of the VAT example: "21%" transactionAmount: $ref: '#/definitions/Amount' transactionVatAmount: $ref: '#/definitions/Amount' merchantTransactionFeeAmount: $ref: '#/definitions/Amount' merchantTransactionFeeVatAmount: $ref: '#/definitions/Amount' netAmount: $ref: '#/definitions/Amount' schemeMarkupAmount: $ref: '#/definitions/Amount' interchangeFeeAmount: $ref: '#/definitions/Amount' cashBackAmount: $ref: '#/definitions/Amount' acquirerMarkupAmount: $ref: '#/definitions/Amount' merchantTransactionAmount: $ref: '#/definitions/Amount' Authorization: type: object properties: transactionIdentification: $ref: '#/definitions/TransactionIdentification' contractIdentification: $ref: '#/definitions/ContractIdentification' approvalCode: type: string description: Code assigned by the authorising institution indicating approval example: "AB90EF" authorizationDateTime: type: string format: date-time description: authorisation date-time (yyyy-mm-dd hh:mm:ss) example: 2016-08-21 09:30:47 brand: type: string description: Brand example: "MAES" cardAcceptorNameLocation: type: string description: 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) example: "Purchase Merchant/ CC \\ARNHEM \\NLD" cardExpiryDate: type: integer format: int32 description: The year and month after which the card expires example: 2104 cardSequenceNumber: type: integer format: int32 description: card sequence number example: "123" cardValidationResult: type: string description: Contains the result of a CVC2/CVV2 validation or the (i)CVC/CVV validation example: "M" channel: format: int32 description: Channel code (0 atm, 1 pos, 2 eCommerce, 3 moto) type: integer contactlessIndicator: type: integer format: int32 description: Indicates whether the transaction has been done contactless (0 no, 1 yes) example: 1 ecommerceIndicator: type: string description: Electronic Commerce Indicators example: "2100000" forwardingInstitutionId: type: string description: Code identifying the acquirer processor or card acceptor example: "671734512" iccDateFilled: type: string description: EMV data present. Y or N example: "Y" merchantCategoryCode: type: integer format: int32 description: Merchant Catogory Code example: 7000 paymentFacilitatorId: type: string description: Identifier for a Payment Facilitator which allows anyone who wants to offer merchant services on a sub-merchant platform. example: "10000000000" pointOfServiceDataOnline: type: string description: A code used to indicate the local conditions at the point-of-service device, at the time a card payment transaction was initiated. example: "0123456789012345678901245" pointOfServiceDataOffline: type: string description: A code used to identify terminal capability, terminal environment and presentation of security data. example: "111121613024" posEntryMode: type: string description: A code that identifies how the carddata was entered on the terminal and which PINentry capabilities the terminal possesses. example: "79x" processingCode: type: string description: Code which indicates the type of transaction being undertaken. Used in conjunction with the Account type code as part of the Processing code. example: "010000" responseCodeInternal: type: string description: response code internal example: "00" responseCodeExternal: type: string description: Response Code from the authorization response received from the brand gateway example: "00" retrievalReferenceNumber: type: string description: Retrieval Reference Number from the authorization request sent to Mastercard/Visa example: "012345678901" serviceCode: type: string description: The service code from the track example: "945" subMerchantId: type: string description: 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 example: "734188" terminalBatchReference: type: string description: Reference of the terminal batch example: "0000000216" terminalProtocol: type: string description: Terminal Protocol example: "02" truncatedPan: type: string description: truncated pan. Only the first 6 and last 3 digits are present. Values inbetween are zeros example: "6731230000000123" cashBackAmount: $ref: '#/definitions/Amount' originalAmountRequested: $ref: '#/definitions/Amount' amountAuthorized: $ref: '#/definitions/Amount' tipAmount: $ref: '#/definitions/Amount' Lifecycle: type: object properties: transactionIdentification: $ref: '#/definitions/TransactionIdentification' contractIdentification: $ref: '#/definitions/ContractIdentification' approvalCode: type: string description: Code assigned by the authorising institution indicating approval example: "AB90EF" brand: type: string description: Brand example: "MAES" cardAcceptorNameLocation: type: string description: 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) example: "Purchase Merchant/ CC \\ARNHEM \\NLD" channel: format: int32 description: Channel code (0 atm, 1 pos, 2 eCommerce, 3 moto) type: integer contactlessIndicator: type: integer format: int32 description: Indicates whether the transaction has been done contactless (0 no, 1 yes) example: 1 creditDebitIndicator: type: string description: Indicator credit/debit. (C = Credit. D = Debit) example: "D" forwardingInstitutionId: type: string description: Code identifying the acquirer processor or card acceptor example: "671734512" merchantCategoryCode: type: integer format: int32 description: Merchant Catogory Code example: 7000 paymentFacilitatorId: type: string description: Identifier for a Payment Facilitator which allows anyone who wants to offer merchant services on a sub-merchant platform. example: "10000000000" paymentInfo: $ref: '#/definitions/PaymentInfo' paymentProductTypeCode: type: string description: Code for the type of payment product. (Z Commercial Card. 2 Consumer Card) example: "2" posEntryModeClearing: type: string description: A code that identifies how the carddata was entered on the terminal and which PINentry capabilities the terminal possesses. example: "02" pricePlanTarifId: type: string description: Unique identification for the price plan tarif. example: "tarifId" processingDateScheme: type: string format: date-time description: processing date-time by scheme (yyyy-mm-dd hh:mm:ss) example: 2019-01-11 09:30:47 region: type: string description: Region of the payment scheme (Netherlands Maestro, etc) example: "Netherlands Maestro" regionCode: type: string description: Region of the payment scheme code example: "31" subMerchantId: type: string description: 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 example: "734188" terminalBatchReference: type: string description: Reference of the terminal batch example: "0000000216" terminalProtocol: type: string description: Terminal Protocol example: "02" transactionDateTime: type: string format: date-time description: authorisation date-time (yyyy-mm-dd hh:mm:ss) example: 2016-08-21 09:30:47 transactionDescription: type: string description: Transaction currency combination description example: "0150 Chargeback Correction case id 0000001" transactionFeePricePlanTypeCode: type: string description: Type of Merchant transaction fee price plan code. (00 No price plan type, 01 Standard pricing, 02 Interchange plus, 03 Advanced pricing) example: "01" transactionLevel: type: string description: Code that identifies the transaction level example: "Contract" transactionStatus: type: string description: Status of the transaction (CAPT transaction is captured, TFEE transaction fee is added, PAID transaction is paid out) example: "TFEE" transactionType: type: string description: Description of transaction being undertaken example: "Purchase Presentment" transactionTypeCode: type: string description: | 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. example: "904" truncatedPan: type: string description: truncated pan. Only the first 6 and last 3 digits are present. Values inbetween are zeros example: "6731230000000123" vatLabel: type: string description: Describes the rate of the VAT example: "21%" transactionAmount: $ref: '#/definitions/Amount' transactionVatAmount: $ref: '#/definitions/Amount' merchantTransactionFeeAmount: $ref: '#/definitions/Amount' merchantTransactionFeeVatAmount: $ref: '#/definitions/Amount' netAmount: $ref: '#/definitions/Amount' schemeMarkupAmount: $ref: '#/definitions/Amount' interchangeFeeAmount: $ref: '#/definitions/Amount' cashBackAmount: $ref: '#/definitions/Amount' acquirerMarkupAmount: $ref: '#/definitions/Amount' merchantTransactionAmount: $ref: '#/definitions/Amount' TransactionIdentification: type: object properties: transactionId: type: string description: Unique identification for a Cardholder Initiated Transaction example: "TDS16172008721825920" acquirerReferenceNumber: type: string description: Data supplied by an acquirer to assist in identifying a transaction, e.g. for researching retrievals and chargebacks example: "11223344662288134679854" stan: type: integer format: int32 description: Systems Trace Audit Number example: 12752 merchantTransactionReference: type: string description: Merchant Transaction 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. example: "trx reference by merchant" ContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by equensWorldline example: "671234567" holdingId: type: integer format: int32 description: Unique identification of the holding, determined by equensWorldline example: 200 merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1280300" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "12872" cardAcceptorId: type: string description: Unique identification of the cardAcceptor within the contract example: "30010" siteId: type: integer format: int32 description: Unique identification of the site within the contract example: 30010 terminalId: type: string description: Unique code identifying the terminal at the Card acceptor location example: "20YT45" Amount: type: object properties: amount: type: string format: unlimited size decimal description: | Amount in the major units of the currency according to ISO 4217. In case of euro, "3.10" (is 3.10 euro) example: "3.00" currency: type: string description: Currency of the amount example: "EUR" PaymentInfo: type: array items: $ref: '#/definitions/PaymentData' PaymentData: type: object properties: merchantPaymentId: type: string description: Unique identification of the payment in which this transaction has been paid out example: "SO-000000017036619028" merchantPaymentAggregationLevelCode: type: string description: Code for the merchant payment aggregation level. example: "02" paymentType: type: string description: Type for which payment created. Transaction Fee, Transaction example: "03" paymentDate: type: string format: date description: payment date (yyyy-mm-dd) example: 2016-08-21 00:00:00 paymentCrossReferenceURI: type: string description: URI to the MerchantApiPayment to get the payment that belongs to this transaction. Only available if there is a payment date. example: "acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD"