Skip to main content
GET
/
v2
/
bank-transactions
List Bank Transactions
curl --request GET \
  --url https://api.example.com/v2/bank-transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "account_mask": "<string>",
      "account_id": "<string>",
      "reference_number": "<string>",
      "description": "<string>",
      "posted": true,
      "amount": "<string>",
      "currency": "ADP",
      "type": "deposit",
      "agent_extractions": {
        "counterparty_name": "<string>",
        "invoice_numbers": [
          "<string>"
        ]
      },
      "agent_metrics": {
        "confidence_reason": "<string>",
        "confidence_score": 123,
        "error_code": "duplicate",
        "uncertainties": [
          "<string>"
        ]
      },
      "payment_status": "non_payment",
      "is_payment": true,
      "non_payment_reason": "<string>",
      "total_allocated": "<string>",
      "counterparty_info": {
        "display": "<string>",
        "id": "<string>",
        "partner_count": 0
      },
      "has_remittance": true,
      "object": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
sort_by
enum<string>
default:timestamp
Available options:
timestamp,
amount,
account_mask,
agent_confidence_score
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc
​
date
string<date> | null
​
bank_account_id
string | null

Bank account ID to filter by

​
search
string | null

Search in description, reference_number, counterparty_name, remote_id

​
status__in
enum<string>[] | null

Filter by cash application status

Status indicating the phase of cash application for a bank transaction.

Available options:
non_payment,
potential_payment,
draft_payment,
posted_payment
​
allocation_status__in
enum<string>[] | null

Filter by allocation status (unallocated, partially_allocated, fully_allocated)

Allocation status for bank transactions.

Available options:
unallocated,
partially_allocated,
fully_allocated
​
include_withdrawals
boolean
default:false

Include withdrawal transactions in results (default: False)

Response

Successful Response

​
data
BankTransactionListItem · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.