---
title: "List transaction for a payee account"
method: GET
path: "/v1/payees/{payeeId}/transactions"
tags: ["Payees"]
---

# List transaction for a payee account

`GET /v1/payees/{payeeId}/transactions`

This endpoint retrieves the list of transactions and transaction information associated with a payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE_TRANSACTIONS to use this endpoint.

## Path parameters

- `payeeId` integer, required — The unique ID of the payee.

## Response `200`

An array of payee transaction information

- object
  - `total` integer — The total number of card transactions in the list.
  - `dateRangeTo` integer — milisecond timestamp of date range to value.
  - `transactions` Transaction[]
    - `txnId` integer — The id of this side of the transaction (each transaction has two sides - a to and a from). This is used to get the details of the transaction.
    - `refId` integer — The id of the transaction.
    - `ican` integer — identifier for the fire.com account (assigned by fire.com) This field is only used in the condensed version.
    - `currency` Currency — The currency.
      - `code` string — The three letter code for the currency.
      - `description` string — The name of the currency
    - `amountBeforeCharges` integer — Amount of the transaction before the fees and taxes were applied.
    - `feeAmount` integer — The amount of the fee, if any.
    - `taxAmount` integer — The amount of the tax, if any (e.g. Stamp duty for ATM transactions)
    - `amountAfterCharges` integer — Net amount lodged or taken from the account after fees and charges were applied.
    - `balance` integer — the balance of the account (in minor currency units - pence, cent etc. 434050 == 4,340.50 GBP for a GBP account).
    - `myRef` string — The comment/reference on the transaction
    - `yourRef` string — The comment/reference on the transaction that appears on the recipients statement. Only for withdrawals
    - `date` string, date-time — Date of the transaction
    - `paymentRequestPublicCode` string — (FOP payments only) The FOP Payment Code that was used to make this payment.
    - `card` RelatedCard — Details of the card used (if applicable)
      - `cardId` integer
      - `provider` string
      - `alias` string
      - `maskedPan` string
      - `embossCardName` string
      - `embossBusinessName` string
      - `expiryDate` string, date-time
    - `type` string — The type of the transaction: * `LODGEMENT` - Bank Transfer received * `PIS_LODGEMENT` - Fire Open Payments Lodgement received * `MANUAL_TRANSFER` - Manual Transfer to * `WITHDRAWAL` - Bank Transfer sent * `REVERSAL` - Credit Reversal * `DIRECT_DEBIT` - A direct debit. * `DIRECT_DEBIT_REPRESENTED` - A Direct Debit that was requested again after initially failing. * `DIRECT_DEBIT_REFUND` - A refund of a Direct debit. * `INTERNAL_TRANSFER_TO` - Internal Transfer sent (between two of my accounts of the same currency) * `INTERNAL_TRANSFER_FROM` - Internal Transfer received (between two of my accounts of the same currency) * `WITHDRAWAL_RETURNED` - Bank Transfer sent returned * `LODGEMENT_REVERSED` - Bank Transfer received returned * `FX_INTERNAL_TRANSFER_FROM` - FX Internal Transfer received (between two of my accounts of different currency) * `FX_INTERNAL_TRANSFER_TO` - FX Internal Transfer sent (between two of my accounts of different currency) * `CREATE_CARD` - The fee taken when a debit card is issued. * `ADD_ACCOUNT` - The fee taken when an account is created. * `CREATE_ADDITIONAL_USER` - The fee taken when an additional user is created. * `CARD_POS_CONTACT_DEBIT` - Card used in store; read by magnetic stripe or pin * `CARD_POS_CONTACT_CREDIT` - Card used in store; read by magnetic stripe or pin * `CARD_POS_CONTACTLESS_DEBIT` - Card used in store; read by NFC * `CARD_POS_CONTACTLESS_CREDIT` - Card used in store; read by NFC * `CARD_ECOMMERCE_DEBIT` - Card used on the internet * `CARD_ECOMMERCE_CREDIT` - Card used on the internet * `CARD_ATM_DEBIT` - Card used in an ATM * `CARD_ATM_CREDIT` - Card used in an ATM * `CARD_INTERNATIONAL_POS_CONTACT_DEBIT` - Card used in store in non-processing currency; read by magnetic stripe or pin * `CARD_INTERNATIONAL_POS_CONTACT_CREDIT` - Card used in store in non-processing currency; read by magnetic stripe or pin * `CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT` - Card used in store in non-processing currency; read by NFC * `CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT` - Card used in store in non-processing currency; read by NFC * `CARD_INTERNATIONAL_ECOMMERCE_DEBIT ` - Card used on the internet in non-processing currency * `CARD_INTERNATIONAL_ECOMMERCE_CREDIT` - Card used on the internet in non-processing currency * `CARD_INTERNATIONAL_ATM_DEBIT` - Card used in an ATM in non-processing currency * `CARD_INTERNATIONAL_ATM_CREDIT` - Card used in an ATM in non-processing currency * `CARD_POS_CONTACT_DEBIT_REVERSAL` - Card used in store; read by magnetic stripe or pin - reversed * `CARD_POS_CONTACT_CREDIT_REVERSAL` - Card used in store; read by magnetic stripe or pin - reversed * `CARD_POS_CONTACTLESS_DEBIT_REVERSAL` - Card used in store; read by NFC - reversed * `CARD_POS_CONTACTLESS_CREDIT_REVERSAL` - Card used in store; read by NFC - reversed * `CARD_ECOMMERCE_DEBIT_REVERSAL ` - Card used on the internet - reversed * `CARD_ECOMMERCE_CREDIT_REVERSAL` - Card used on the internet - reversed * `CARD_ATM_DEBIT_REVERSAL` - Card used in an ATM - reversed * `CARD_ATM_CREDIT_REVERSAL` - Card used in an ATM - reversed * `CARD_INTERNATIONAL_POS_CONTACT_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by magnetic stripe or pin - reversed * `CARD_INTERNATIONAL_POS_CONTACT_CREDIT_REVERSAL` - Card used in store in non-processing currency; read by magnetic stripe or pin - reversed * `CARD_INTERNATIONAL_POS_CONTACTLESS_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed * `CARD_INTERNATIONAL_POS_CONTACTLESS_CREDIT_REVERSAL` - One or more of the transaction types above. This field can be repeated multiple times to allow for multiple transaction types. * `CARD_INTERNATIONAL_ECOMMERCE_DEBIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed * `CARD_INTERNATIONAL_ECOMMERCE_CREDIT_REVERSAL` - Card used in store in non-processing currency; read by NFC - reversed * `CARD_INTERNATIONAL_ATM_DEBIT_REVERSAL` - Card used on the internet in non-processing currency - reversed * `CARD_INTERNATIONAL_ATM_CREDIT_REVERSAL` - Card used on the internet in non-processing currency - reversed
    - `dateAcknowledged` string, date-time
    - `fxTradeDetails` FxTrade — Details of the FX trade (if applicable)
      - `buyCurrency` string — currency which is being bought
      - `sellCurrency` string — currency which is being sold
      - `fixedSide` string — type of trade - BUY or SELL
      - `buyAmount` integer — amount of buyCurrency being bought
      - `sellAmount` integer — amount of sellCurrency being sold
      - `rate4d` integer — exchange rate
      - `provider` string — The FX provider used to make the trade.
    - `batchItemDetails` BatchItemDetails — Details of the batch run if this transaction was part of a batch.
      - `batchPublicUuid` string — The UUID for this batch.
      - `batchItemPublicUuid` string — The UUID for this item in the batch.
      - `batchName` string — The optional name given to the batch at creation time.
      - `jobNumber` string — The optional job number given to the batch to link it to your own system.
    - `directDebitDetails` DirectDebitDetails — Details of the direct debit (if applicable)
      - `directDebitUuid` string — The UUID for the direct debit payment
      - `mandateUUid` string — The UUID for the mandate
      - `originatorReference` string — Set by party who sets up the direct debit.
      - `originatorName` string — The creator of the party who sets up the direct debit.
      - `originatorAlias` string — The Alias of the party who sets up the direct debit.
      - `directDebitReference` string — The direct debit reference.
      - `originatorLogoUrlSmall` string — URL pointing to a small version of the Originator Logo (if available)
      - `originatorLogoUrlLarge` string — URL pointing to a large version of the Originator Logo (if available)
      - `mandateReference` string — the reference of the mandate
      - `mandateUuid` string — The UUID for the mandate
    - `proprietarySchemeDetails` object[] — Extra details about the transaction based on the scheme used to make the payment.
      - `type` string — the type of proprietary scheme - SCT for SEPA, FPS for Faster Payments etc.
      - `data` string — the scheme proprietary data - key pairs separated by | and key/values separated by ^
    - `relatedParty` union — Details of the related third party involved in the transaction.
      - RelatedPartyFireAccount
        - `type` 'FIRE_ACCOUNT'
        - `account` object
          - `id` integer — identifier for the fire.com account (assigned by fire.com)
          - `alias` string — the name the user gives to the account to help them identify it.
          - `bic` string — the BIC of the account (provided if currency is EUR).
          - `iban` string — the IBAN of the account (provided if currency is EUR).
          - `nsc` string — the Sort Code of the account.
          - `accountNumber` string — the Account Number of the account.
      - RelatedPartyExternalAccount
        - `type` 'EXTERNAL_ACCOUNT'
        - `account` object
          - `id` integer
          - `alias` string — the name the user gives to the account to help them identify it.
          - `nsc` string — the Sort Code of the account.
          - `accountNumber` string — the Account Number of the account.
          - `bic` string — the BIC of the account (provided if currency is EUR).
          - `iban` string — the IBAN of the account (provided if currency is EUR).
      - RelatedPartyPayee
        - `type` 'WITHDRAWAL_ACCOUNT'
        - `account` object
          - `id` integer — The ID of the payee.
          - `alias` string — The name of the payee.
          - `nsc` string — The sort code of the payee (for GBP payments)
          - `accountNumber` string — The account number of the payee (for GBP payments)
          - `bic` string — The BIC of the payee (for EUR payments)
          - `iban` string — The IBAN of the payee (for EUR payments)
      - RelatedPartyCardPayment
        - `type` 'CARD_MERCHANT' | 'CARD_ATM'
        - `cardMerchant` object
          - `acquirerIdDe32` string
          - `additionalAmtDe54` string
          - `authCodeDe38` string
          - `billAmt` integer
          - `billCcy` string
          - `expiryDate` string
          - `mccCode` string
          - `merchIdDe42` string
          - `merchNameDe43` string
          - `posDataDe61` string
          - `posTermnlDe41` string
          - `posDataDe22` string
          - `procCode` string
          - `respCodeDe39` string
          - `retRefNoDe37` string
          - `statusCode` string
          - `token` string
          - `txnAmt4d` integer
          - `txnCcy` string
          - `txnCtry` string
          - `txnDesc` string
          - `txnStatCode` string
          - `txnType` string
          - `additionalDataDe48` string
          - `authorisedByGps` string
          - `avsResult` string
          - `mtId` string
          - `recordDataDe120` string
          - `additionalDataDe124` string
    - `eventUuid` string — An internal Fire reference for the transaction (UUID)

## Other responses

- `400` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `401` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `403` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

---

[API](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api.md) · [All operations](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefinancialservices/fire-financial-services-business-api/revisions/1d19896d095c/schema)