Fetch Transactions

This endpoint allows you to retrieve a list of transactions for a selected account.

{{baseUrl}}/production/fetch-transaction

curl --request POST \
     --url https://jys6b5m8pd.execute-api.us-east-2.amazonaws.com/production/fetch-transactions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "monthRange": "12",
  "accountNumber": "1234567890"
}
'

Request Parameters

parameter	type	description
month_range	string	specified period that encompasses one or more months	required
accountNumber	string	Business account number	required

Successful Response

{
  "data": [
    {
      "Nuban": "1234567890",
      "datedStamp": "2023-09-21T17:03:15.611Z",
      "Amount": "225000",
      "dated": "2023-09-21T00:00:00.000Z",
      "TransactionType": "credit",
      "Narration": "N-10140722181/Collection Credit for 20",
      "TransType": "credit",
      "Balance": "30933952",
      "BeneficiaryName": "null"
    },
    {
      "Nuban": "12345678905",
      "datedStamp": "2023-09-21T17:03:15.612Z",
      "Amount": "150000",
      "dated": "2023-09-21T00:00:00.000Z",
      "TransactionType": "credit",
      "Narration": "N-10140716665/Collection Credit for 20",
      "TransType": "credit",
      "Balance": "30708952",
      "BeneficiaryName": "null"
    },
    {
      "Nuban": "1234567890",
      "datedStamp": "2023-09-21T17:03:15.613Z",
      "Amount": "900000",
      "dated": "2023-09-21T00:00:00.000Z",
      "TransactionType": "credit",
      "Narration": "N-10140720013/Collection Credit for 20",
      "TransType": "credit",
      "Balance": "30558952",
      "BeneficiaryName": "null"
    }
  ]
}

Error Handling (Failed Response)

In case of any errors, the API will respond with an appropriate status code and error message.

{
  status:"404",
  message:"accountNumber length must be 10 characters long",
}

Parameters

Field	Description
id `ObjectID`	Unique Auth ID (Unique Flick Identifier)
debit `Number`	The amount deducted from an account
credit `Number`	The amount credited to an account
account `ObjectID`	Unique account ID (Unique Flick Identifier)
connected `Boolean`	Customer connection status (Did they choose to connect this account to you?)
customer `ObjectID`	Unique Customer ID (Unique Flick Identifier) See Manage Customers ]
record `ObjectID`	Unique Record ID(Unique Flick Identifier) See Records
owner `ObjectID`	Unique Company ID(Unique Flick Identifier) ( Your Client Token)
env `String`	Flick API env the Auth was pulled from `production` or `production-sandbox`
created_at `Date`	Date transaction was fetched
last_updated `Date`	Last date transaction fetched
trans_date `Date`	The date a transaction occurred
cleared_date `Date`	The date a transaction was cleared at the bank
unformatted_trans_date `String`	The date transaction occurred (from the bank)
unformatted_cleared_date `String`	The date transaction cleared (from the bank)
branch `String`	The branch transactions occurred
ref `String`	The bank reference ID (from the bank)
env `String`	Flick API env the transaction was pulled from `production` or `production-sandbox`
code `String`	Bank Code (from the bank)
benefactor `ObjectID`	Customer ID of the sender (within Flick)
location `String`	The location or channel the transaction took place
notes `Object`	Breakdown of Narrative from bank
bank `ObjectID`	Unique Bank ID (Unique Flick Identifier)
balance `Number`	Balance after transaction line
mean `Integer`	Mean Average Error: Average ‘naira’ the statement is off by