B2B Payments

Query Payments

Query payments for a team, optionally filtered by recipient and date range.

get/v2/payments

Request

Query parameters

team_nanoidstring required

Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with te-.

state'all' | 'intent' | 'scheduled' | 'complete' required
number
OR
string
OR
unknown

A date accepted as ISO-8601 string, epoch milliseconds (number), or Date. Legacy v1 format YYYY-MM-DD HH:mm:ss is normalized to YYYY-MM-DDTHH:mm:ss before parsing. Coerced to a Date after validation.

number
OR
string
OR
unknown

A date accepted as ISO-8601 string, epoch milliseconds (number), or Date. Legacy v1 format YYYY-MM-DD HH:mm:ss is normalized to YYYY-MM-DDTHH:mm:ss before parsing. Coerced to a Date after validation.

query_type'payable' | 'receivable' required
recipientstring

Identifier of a Rise user. 15-character nanoid prefixed with us-.

Response

Default Response

successtrue required

Changes

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