List outbound payments

Operation ID: outboundPayments

Group: Accounting › Outbound Payments

Open in the interactive reference

GET /accounting/outbound-payments

Read-only: Reads and returns; changes nothing.

Lists outbound payments, without their lines. To get the lines, use GET accounting/outbound-payments/:id or POST accounting/outbound-payments/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of outboundPaymentsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the outbound payment.
outboundPaymentNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The outbound payment number. Absent until a number has been assigned.
description string | null no no no A description of the payment.
paymentDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date the payment was made. Format YYYY-MM-DD.
paymentCurrency string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The currency the payment is denominated in. Format ISO 4217, for example 'USD'.
paymentType string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes How the money was sent, for example 'ach', 'wire' or 'check'.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The processing status of the payment.
approvalStatus string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes Where the payment sits in the approval workflow.
applicationStatus string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes How much of the payment has been applied to bills. Values include 'unapplied', 'partiallyApplied' and 'applied'.
paymentId string | null no no no The payment reference assigned by the bank or payment provider. It is not filterable. Match on it through POST accounting/outbound-payments/search.
externalId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The identifier this payment has in the upstream system that produced it. It is not unique.
origin string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The source system this payment came from. Recorded when an integration created the payment.
singlePayment boolean | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) no Whether the payment covers a single bill rather than a batch.
paymentAccountName string | null no no no The name of the bank general ledger account the money left. It is not filterable. To scope by account, use paymentAccountId on POST accounting/outbound-payments/search.
entityName string | null no no no The name of the legal entity that made the payment. It is not filterable. To scope by entity, use entityId on POST accounting/outbound-payments/search.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outboundPaymentNumber": "<outboundPaymentNumber>",
      "description": "<description>",
      "paymentDate": "2026-01-15",
      "paymentCurrency": "<paymentCurrency>",
      "paymentType": "<paymentType>",
      "status": "<status>",
      "approvalStatus": "<approvalStatus>",
      "applicationStatus": "<applicationStatus>",
      "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "origin": "<origin>",
      "singlePayment": true,
      "paymentAccountName": "<paymentAccountName>",
      "entityName": "<entityName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses