Sign in
Payments

List outgoing payments. Filter server-side rather than paging and filtering client-side.

get/payments

Query parameters

limitstring

Page size, 1–100 (default 25).

Page size, 1–100 (default 25).

cursorstring

Opaque cursor from a prior response nextCursor.

Opaque cursor from a prior response nextCursor.

fromstring

Inclusive lower bound, YYYY-MM-DD.

Inclusive lower bound, YYYY-MM-DD.

tostring

Inclusive upper bound, YYYY-MM-DD.

Inclusive upper bound, YYYY-MM-DD.

status'all' | 'paid' | 'scheduled' | 'draft' | 'pending-approval' | 'canceled'

Filter by lifecycle state; defaults to all states.

Filter by lifecycle state; defaults to all states.

counterpartystring

Case-insensitive substring match on the payee name. A canceled or declined payment with no saved contact reports the destination institution name instead, and is not matched by this filter.

Case-insensitive substring match on the payee name. A canceled or declined payment with no saved contact reports the destination institution name instead, and is not matched by this filter.

method'ach' | 'international-wire' | 'international-wire-fee' | 'intra-transfer' | 'wire'

Payment method; wire matches domestic and international wires.

Payment method; wire matches domestic and international wires.

minAmountstring

Lower bound on the amount, in integer minor units (100000 = $1,000.00).

Lower bound on the amount, in integer minor units (100000 = $1,000.00).

maxAmountstring

Upper bound on the amount, in integer minor units.

Upper bound on the amount, in integer minor units.

Response

A page of payments.

nextCursorstring nullable required

Pass back as ?cursor for the next page; null on the last page.

Changes

No recorded changes to this endpoint across all 1 revision of this API.