Accounts

Get a transaction.

<b>Authorization</b>: End user or Merchant token (IP address whitelisted) is required.

<b>User permissions required</b>: CanViewTransactions

get/api/v1/accounts/{accountID}/transactions/{id}

Request

Base URL: https://api.nofrixion.com
URL: https://api.nofrixion.com/api/v1/accounts/{accountID}/transactions/{id}
Auth: API key in header Authorization

Path parameters

accountIDstring uuid required

The ID of the account to retrieve transactions for.

idstring uuid required

The transaction ID

Response

The transaction.

idstring uuid

Unique ID for the transaction.

accountIDstring uuid

The ID of the account the transaction belongs to.

accountNamestring nullable

The name of the account the transaction belongs to.

merchantIDstring uuid

The ID of the merchant that owns the account.

Type of the transaction.

amountnumber double

Amount of the transaction. Negative values indicate a pay out debit), positive values a pay in (credit).

amountMinorUnitsinteger

Amount of the transaction expressed in the currency’s minor units (e.g. cents, pence).

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

Currency of transaction.

descriptionstring nullable

Description of the transaction.

transactionDatestring date-time

Date when the transaction occurred.

insertedstring date-time

Date when the transaction was inserted into the ledger.

yourReferencestring nullable

For a pay in the reference the sending party attached. For a pay out the reference that the payer attached for themselves.

theirReferencestring nullable

For a pay out the reference that the payer attached for the receiving party. For a pay in this will typically be empty but for internal transactions may contain the reference the sending party set for themselves.

counterpartySummarystring nullable

For pay in (credit) transactions this will contain a descriptive string with the most important fields about the counterparty.

balancenumber double

Balance left on the account after the transaction.

balanceMinorUnitsinteger

Balance on the account expressed in the currency’s minor units (e.g. cents, pence).

ruleIDstring uuid nullable

ID of the rule that resulted in the transaction.

payoutIDstring uuid nullable

ID of the payout that resulted in the transaction.

virtualIBANstring nullable

If set it indicates the payin was to a virtual IBAN.

accountSequenceNumberinteger

The sequence number of transaction on a per account basis. This sequence number is guaranteed to be an arithemtic sequence number for all transactions belonging to the same account.

paymentRequestIDstring uuid nullable

For Pay by Bank and Direct Debit transactions this will contain the ID of the payment request.

fxCurrency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' nullable

For an FX payout this is the currency that was received or that was instructed.

fxAmountnumber double nullable

For an FX payout this is the amound in the FX currency.

fxRatenumber double nullable

For an FX payout this is the exchange rate between the transaction currency and the FX currency.

paymentRequestCustomFieldsobject nullable

The custom fields that were attached to the payment request that resulted in this transaction.

rawReferencestring nullable

The raw payment reference details as received from the payment processor. For Banking Circle transactions this contains the concatenated payment details fields from which the payment lifecycle ID can be derived.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.