Sign in

v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Payments

List payments

get/payments

Query parameters

business_entity_idstring required
payroll_idstring
remittance_account_idstring
'canceled' | 'failed' | 'overdue' | 'paid' | 'pending' | 'processing'
OR
string[]

Filter by payment status. Supports multiple comma-separated values.

'bill_pay' | 'cra' | 'employee' | 'internal' | 'no_op' | 'payroll_float' | 'rq'
OR
string[]

Filter by payment destination. Supports multiple comma-separated values.

'direct_deposit' | 'manual' | 'pad' | 'wire'
OR
string[]

Filter by payment method. Supports multiple comma-separated values.

is_heldboolean

Filter by hold status. true returns only held payments, false returns only non-held payments.

expected_atobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: expected_at=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: expected_at[gte]=2024-01-01&expected_at[lt]=2024-12-31
process_atobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: process_at=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: process_at[gte]=2024-01-01&process_at[lt]=2024-12-31
sort'amount' | 'destination' | 'expected_at' | 'process_at' | 'status'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

expandstring[]

Response

OK

objectstring

The type of the object in Nmbr ("list").