logoOPEN BANKING DOCS

Get transaction history

Retrieve transaction history with filtering and pagination

GET
/transactions/history
X-API-Key<token>

In: header

Query Parameters

page?integer

Page number

Default1
Range1 <= value
limit?integer

Items per page

Default20
Range1 <= value <= 200
currencystring

ISO currency code

Value in"NGN" | "USD" | "EUR" | "GBP"
institutionstring

Institution type

Value in"BANK" | "WALLET" | "CARD"
walletId?string

Filter by wallet ID

Formatuuid
startDate?string

Start date for filtering

Formatdate
endDate?string

End date for filtering

Formatdate

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Response Body

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/transactions/history?page=1&limit=20&currency=NGN&institution=BANK&walletId=497f6eca-6276-4993-bfeb-53cbbbba6f08&startDate=2019-08-24&endDate=2019-08-24" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "transactions": [
      {
        "id": "string",
        "amount": 0,
        "currency": "string",
        "flow": "INFLOW",
        "narration": "string",
        "reference": "string",
        "status": "PENDING",
        "method": "TRANSFER",
        "fromAccount": "string",
        "toAccount": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "pagination": {
      "currentPage": 0,
      "totalPages": 0,
      "totalItems": 0,
      "pageSize": 0
    },
    "summary": {
      "totalAmount": 0,
      "totalTransactions": 0,
      "currency": "string"
    }
  }
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}