Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

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

Query Parameters

business_entity_id
string
required
payroll_id
string
remittance_account_id
string
status

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

Available options:
canceled,
failed,
overdue,
paid,
pending,
processing
destination

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

Available options:
bill_pay,
cra,
employee,
internal,
no_op,
payroll_float,
rq
method

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

Available options:
direct_deposit,
manual,
pad,
wire
is_held
boolean

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

expected_at
object

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_at
object

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
enum<string>

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).

Available options:
amount,
destination,
expected_at,
process_at,
status
expand
enum<string>[]
Available options:
payroll,
remittance_account

Response

200 - application/json

OK

object
string
read-only

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

data
object[]