​
Endpoint

GET /3p/api/v2/bank-accounts/{aggregator_type}/{account_uuid}/history

​
Path Parameters

NameTypeRequiredDescription
aggregator_typestringYesBank account provider. Possible values: bank_link
account_uuidstringYesUUID of the bank account

​
Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for the transaction history in YYYY-MM-DD format
end_datestringNoEnd date for the transaction history in YYYY-MM-DD format
pageintNoPage number for pagination (default is 1)
per_pageintNoNumber of records per page (default is 10, maximum is 100)

​
Response

{
  "status": true,
  "message": null,
  "data": {
    "transactions": [
      {
        "transaction_id": "c7318ff7-257c-490e-8242-03a815b223b7",
        "account_id": "acc_6Tef269B6ZArSVpYrxtjBV",
        "amount": 384.05,
        "type": "debit",
        "currency": "USD",
        "date": "2023-02-16T00:00:00",
        "datetime": "2023-02-16T09:14:11",
        "description": "Regina's Mulberry",
        "raw_description": "Regina's Mulberry #1402 T48999-84",
        "pending": true,
        "enrichment": {
          "category": {
            "value": "food_and_drink",
            "confidence": 99
          },
          "subcategory": {
            "value": "coffee",
            "confidence": 99
          },
          "merchant": {
            "id": "a0822a4f-a59b-4fc9-a768-d880da5bd090",
            "name": "Starbucks",
            "logo": "https://example.com/starbucks.png",
            "confidence": 99
          },
          "processor": {
            "id": "a0822a4f-a59b-4fc9-a768-d880da5bd090",
            "name": "Square",
            "logo": "https://example.com/square.png",
            "confidence": 99
          },
          "recurrence": {
            "frequency": "monthly",
            "next_predicted_date": "2024-08-03"
          }
        },
        "original_id": ""
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_items": 50,
      "per_page": 10
    }
  },
  "errors": []
}

​
Errors & Warnings

{
    "status": false,
    "message": "We are unable to retrieve the transaction history for this bank account.",
    "data": null,
    "errors": null,
    "error_code": null
}

{
    "status": false,
    "message": "Only a bank account connected through GrailPay's bank link widget can provide access to the transaction history.",
    "data": null,
    "errors": null,
    "error_code": null
}

{
  "status": false,
  "message": "Fetching transaction history from this bank account is disabled.",
  "data": null,
  "errors": null,
  "error_code": null
}

{
  "status": false,
  "message": "The bank account was not found.",
  "data": null,
  "errors": null,
  "error_code": null
}