Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Get transaction data

Get all suspended transactions

If any payment cannot be posted to any end-user account it will be posted to an institution suspense account for further processing by the issuer. The latest transactions will be listed in descending order by date.

get/v3/SUSPENDED

Query parameters

auditUserstring required

The audit user to log the request

fromDatestring date-time
Example:2019-01-28T00:00:00

From which date you want to list the transactions in ISO-8601 date-time format.

toDatestring date-time
Example:2019-01-28T00:00:00

To which date you want to list the transactions in ISO-8601 date-time format.

pageinteger

Current page

sizeinteger

How many transactions should be returned per page, default is 15. Cannot be more than 30.

Response

Successful lookup of transactions

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
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
acquiringInstitutionIdentificationCodestring

Acquiring Institution Identification Code

paymentReferencestring

Reference number used for the transaction

payerNamestring

Name of the payer for the transaction

fromAddressstring

Address of payer

fromZipstring

Zip code of payer

fromCitystring

City of payer

fromBankAccountNumberstring

Source account number

fromCustomerAccountNumberstring

from the Enfuce system, where the payment was posted

fromOrganizationalNumberstring

Send organization number

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

The type of bank account

fromBankNamestring

Source bank name

toBicstring

Target BIC code, used for pain file generation

discLinkTransactionIdstring

The transactionId of the original financial transaction of this discount

fileNamestring

Name of processed file, typically for managing incoming payments.

toBankAccountNumberstring

Target account number

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

The type of bank account

reasonstring

Reason for the suspension of the transaction

Example response

[
  {
    "transactionDate": "2019-01-28T00:00:00",
    "postingDate": "2019-01-28T00:00:00",
    "postingStatus": "POSTED",
    "responseCode": "1A",
    "settlementAmount": {
      "amount": 3.14,
      "currency": "EUR"
    },
    "transactionAmount": {
      "amount": 3.14,
      "currency": "EUR"
    }
  }
]