Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Get transaction data

Get transaction and authorization given transactionId

This operation will respond with a transaction given transactionId.

get/v3/{id}

Path parameters

idstring biginteger required

The transaction id for given transaction

Query parameters

auditUserstring required

The audit user to log the request

Response

Successful lookup of the transaction

idstring

Unique transaction id

linkIdstring

Unique Root id for the transaction or Authorization

transactionDatestring date-time

The local date (and time) when the transaction was made. I.e. the date/time in the time zone in which the payment terminal/merchant is. In date-time format YYYY-MM-DDThh:mm:ss. Please note that the authorisation and clearing formats used by card schemes for do not support conveying the time zone in which the transaction has been done. The card scheme may also just include the date and no specific time. Enfuce relays the date and time as received from the card scheme.

postingDatestring date-time

The date and time when transaction was posted at Enfuce. In date-time format YYYY-MM-DDThh:mm:ss. Timezone is Enfuce system timezone, i.e. UTC.

postingStatus'POSTED' | 'POSTED_DISPUTE' | 'CLOSED' | 'PENDING' | 'REJECTED'

Posting status values:

  • POSTED - Transaction/authorization has been successfully posted.
  • POSTED_DISPUTE - Transaction has been posted with the dispute contract.
  • CLOSED - Authorization status after its matching transaction was successfully processed, or if the authorization is expired.
  • PENDING - Transaction/authorization is waiting for processing or being processed.
  • REJECTED - Transaction/authorization was rejected.
responseCodestring

After authorization, Enfuce generates a response code that guides the merchant how to proceed with the purchase. If approved (Response code 0 or 10), the purchase is finalized. If declined (Response code is not 0 or 10), the merchant must cancel the purchase or request an alternative payment method. Refer to our service description for a complete list of response codes and their usage details. Response code values according to ISO-8583:1987:

  • Approved: 0 or 10
  • Declined: 3-96 and 1A, N0, N7
responseDescriptionstring

When a payment is declined, a response description is returned, if available, providing more context on why the transaction failed. This includes a return code and a brief explanation. If multiple issues cause the decline, only one response description is sent, prioritized as the most relevant for the decline. Refer to our service description for the list of most relevant response descriptions and their usage details.

transactionType'RETAIL' | 'CASH' | 'ATM' | 'CREDIT' | 'UNIQUE' | 'P2P_CREDIT' | 'P2P_DEBIT' | 'BALANCE_INQUIRY' | 'CASH_DISBURSEMENT'

The transaction type. The only fully supported type is RETAIL. Other transaction types may be used, but no guarantees are made about their behaviour. Some transaction types have specific limitations:

  • ATM - In order to create ATM transactions, merchantData.merchantCategoryCode must be 6011. This behaviour is downstream from the VISA and MC authorization systems. If a different code is used, transactions will be treated as CASH
transactionConditionCodestring

Transaction conditions define the specific circumstances under which a card transaction occurred. For example, they describe whether the chip was read or if the transaction was contactless, how the cardholder was authenticated, and whether the transaction was e-commerce or card-present. For more information, see our Transaction Conditions Service Description.

retrievalReferenceNumberstring

Retrieval reference number

authorizationCodestring

Authorization code

acquiringInstitutionIdentificationCodestring

Acquiring Institution Identification Code

cardAcceptorIdentificationCodestring

Card Acceptor Identification Code

terminalIdstring

For authorizations and clearings, this is a unique alphanumeric identifier (typically up to 8–16 characters) used to distinguish a specific physical or virtual payment device, such as a POS machine or ATM, from all others. For other transactions, this refers to the originating source or channel

submerchantIdstring

Related to cardAcceptorIdentificationCode, represents sub card acceptor

textstring

Represents value of text field provided during transaction posting

paymentReferencestring

Reference number used for the transaction

payerNamestring

First and last name of payer

paymentReceiverstring

Payment receiver name

fromAddressstring

Address of payer

fromZipstring

Zip code of payer

fromCitystring

City of payer

fromBankAccountNumberstring

Source account number

toBankAccountNumberstring

Target account number

fromCustomerAccountNumberstring

from the Enfuce system, where the payment was posted

fromOrganizationalNumberstring

Send organization number

fromBankNamestring

Source bank name

fromBankAccountType'BBAN' | 'IBAN' | 'PLUSGIRO' | 'BANKGIRO'

The type of bank account

toBankAccountType'BBAN' | 'IBAN' | 'PLUSGIRO' | 'BANKGIRO'

The type of bank account

toBicstring

Target BIC code, used for pain file generation

discLinkTransactionIdstring

The transactionId of the original financial transaction of this discount

createdAtstring date-time

The date and time in YYYY-MM-DDThh:mm:ss format when transaction was created. Timezone is Enfuce system timezone, i.e. UTC.

fileNamestring

Name of processed file, typically for managing incoming payments.

processedByEnfuceStipboolean

For authorizations, indicates whether authorization was processed by Enfuce STIP or not.

receivedFromCollectionAgencyboolean

Whether a collection payment transaction (CPT) is received from a collection agency or not. Only applies to payment transactions for invoices in collection.

acqRefNumberstring

Acquirer Reference Number (ARN) is a unique number assigned to a card transaction by the acquirer (merchant's bank). It is used to track a specific transaction across banks (merchant bank, cardholder bank, etc.).

authValidityInDaysinteger

Specifies the number of days the authorisation is valid when longer than the default (7 days). If not provided, the default authorisation validity period applies.

exchangeRatestring

Exchange rate used for the transaction.

unitstring

Unit of measure if available

siteCountrystring

Site country code

transSrnstring

Enfuce NDU Transaction SRN

enfuceNduIdstring

Enfuce NDU transaction id

accountIdstring

AccountId transaction is posted to

cardIdstring

If transaction is posted to a card then this cardId will be set

Example response

{
  "transactionDate": "2019-01-28T00:00:00",
  "postingDate": "2019-01-28T00:00:00",
  "postingStatus": "POSTED",
  "responseCode": "1A",
  "responseDescription": "061-Usage Limit \"24H_RETAIL\" Amount Exceeded",
  "transactionConditionCode": "ATM",
  "settlementAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "transactionAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "feeAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "merchant": {
    "id": "9260003",
    "acquirerId": "123456",
    "country": "FIN",
    "city": "Helsinki",
    "name": "Airline of the world",
    "subMerchantId": "9260003"
  },
  "createdAt": "2019-01-28T00:00:00"
}