--- title: "Query Payments" method: GET path: "/v2/payments" tags: ["B2B Payments"] --- # Query Payments `GET /v2/payments` Query payments for a team, optionally filtered by recipient and date range. ## Query parameters - `team_nanoid` string, required - `state` 'all' | 'intent' | 'scheduled' | 'complete', required - `start_date` union - number - string - unknown - `end_date` union - number - string - unknown - `query_type` 'payable' | 'receivable', required - `recipient` string ## Response `200` Default Response - object - `success` true, required - `data` object, required - `items` object[], required - `recipient` object, required - `nanoid` union, required - string — Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - string — Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). - `riseid` string, required — On-chain identifier of a Rise user — the 42-character EVM address of the user's RiseAccount contract. - `avatar` string, required - `first_name` string, nullable, required - `middle_name` string, nullable, required - `last_name` string, nullable, required - `company_name` string, nullable, required - `email` string, nullable, required - `address` object, required - `country` string, required — Country code in ISO 3166-1 alpha-2 form — exactly two uppercase letters (e.g. `US`, `GB`, `BR`). - `state` string - `city` string - `line_1` string - `line_2` string, nullable - `zip_code` string - `payer` object, required - `nanoid` string, required — Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - `riseid` string, required — On-chain identifier of a Rise team — the 42-character EVM address of the team's RiseAccount contract. - `avatar` string, required - `name` string, required - `invoice` object, required - `amount_cents` number, required - `automated_payment` boolean, required - `created_at` unknown - `currency` 'AED' | 'ARS' | 'AUD' | 'BDT' | 'BIF' | 'BOB' | 'BRL' | 'BTC' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'ETB' | 'EUR' | 'GBP' | 'GHS' | 'GMD' | 'GTQ' | 'HKD' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JOD' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'LKR' | 'MAD' | 'MMK' | 'MNT' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NGN' | 'NOK' | 'NPR' | 'NZD' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RWF' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TZS' | 'UGX' | 'USD' | 'USDC' | 'USDT' | 'UYU' | 'UZS' | 'VND' | 'XAF' | 'XOF' | 'ZAR', required — Any currency Rise supports — fiat (ISO-4217 codes like USD, GBP) or crypto (USDC, EURC, BTC, etc.). - `documents_ids` string[], required - `external_id` string, nullable - `external_id_unique_claim` boolean, nullable - `external_sow_url` string, nullable - `flat_type` 'reimbursement' | 'product' | 'service', nullable - `group_nanoid` string, required — Identifier of a payment group (a batch of payments scheduled together). 15-character nanoid prefixed with `pg-`. - `group_onchain_id` string, required - `hourly_rate_usd_cents` number, required - `invoice_description` string, nullable - `invoice_number` string, nullable, required - `invoice_status` 'draft' | 'creating' | 'open' | 'processing' | 'flushing' | 'closed' | 'open_canceled' | 'canceled' | 'failed', required - `is_aor` boolean, required - `nanoid` string, required — Identifier of an invoice. 15-character nanoid prefixed with `iv-`. - `pay_intent_time` number, required - `payer_nanoid` union, required - string — Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - string — Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). - string — Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - string — Identifier of a team-scoped role assignment (e.g. team admin, team employee, contractor). 15-character nanoid prefixed with `tr-`. - string — Identifier of a team payroll run. 15-character nanoid prefixed with `tp-`. - `payer_payee_relationship` 'contractor' | 'aor_contractor' | 'team_employee' | 'external_recipient', nullable - `payment_details` string, nullable - `payment_onchain_id` string, nullable - `payroll_program` 'riseworks_inc' | 'riseworks_inc_gb' | 'riseworks_eor_us' | 'riseworks_pps_us' | 'riseworks_eor_gb' | 'riseworks_eor_ca' | 'riseworks_eor_gr' | 'riseworks_eor_ie' | 'riseworks_eor_cy' | 'riseworks_eor_cz' | 'riseworks_eor_mx' | 'riseworks_eor_co' | 'riseworks_eor_in' | 'riseworks_eor_au' | 'riseworks_eor_nz' | 'riseworks_eor_za' | 'riseworks_eor_it' | 'riseworks_eor_pt' | 'riseworks_eor_fi' | 'riseworks_eor_cr' | 'riseworks_eor_ee' | 'riseworks_eor_mt' | 'riseworks_eor_pe' | 'riseworks_eor_nl' | 'riseworks_eor_lt' | 'riseworks_eor_sg' | 'riseworks_eor_ph' | 'riseworks_eor_pl' | 'riseworks_eor_ke' | 'riseworks_eor_ae' | 'riseworks_eor_ro' | 'riseworks_eor_ch' | 'riseworks_eor_sv' | 'riseworks_eor_cl' | 'riseworks_eor_pa' | 'riseworks_eor_es' | 'riseworks_eor_br' | 'riseworks_eor_dk', nullable - `reason_id` number, nullable - `recipient_nanoid` union, required - string — Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - string — Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). - string — Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - string — Identifier of a team-scoped role assignment (e.g. team admin, team employee, contractor). 15-character nanoid prefixed with `tr-`. - string — Identifier of a team payroll run. 15-character nanoid prefixed with `tp-`. - `recurrence` 'daily' | 'weekly' | 'bi_weekly' | 'four_weeks' | 'monthly' | 'bi_monthly' | 'quartely' | 'six_months' | 'annually', nullable - `rise_sow` boolean, required - `role_description` string, nullable - `services_description` string, nullable - `sow_document_nanoid` string, nullable - `subscription_fee_metadata` object, nullable - `subscription_type` integer, required - `fee_month_epoch` integer, required - `usage_month_epoch` integer - `recipients` object[], required - `address` string, required - `amount` number, required - `v1_migration_type` 'V1_SUBSCRIPTION' | 'V1_CHARGEBACK' - `source_payment_invoice_number` string - `time_entries` object[], required - `date` string, required - `hours` integer, required - `minutes` integer, required - `notes` string, required - `type` 'time_entry' | 'flat' | 'paynow' | 'payonce' | 'recurring' | 'milestone' | 'batch' | 'payroll_cash_requirement' | 'payroll_cash_requirement_chargeback' | 'payroll_net_payment' | 'external_recipient_payment' | 'subscription_fee', required - `updated_at` unknown - `payment` object, required - `created_at` unknown - `creation_transaction` string, nullable, required — Identifier of a Rise transaction (the unit tracked end-to-end across the payment-handler pipeline). 15-character nanoid prefixed with `tx-`. Distinct from on-chain tx hashes. - `group_onchain_id` string, required - `invoice_nanoid` string, required — Identifier of an invoice. 15-character nanoid prefixed with `iv-`. - `nanoid` string, required — Identifier of a single payment. 15-character nanoid prefixed with `pa-`. - `onchain_id` string, required - `payment_group_nanoid` string, required — Identifier of a payment group (a batch of payments scheduled together). 15-character nanoid prefixed with `pg-`. - `process_transaction` string, nullable, required — Identifier of a Rise transaction (the unit tracked end-to-end across the payment-handler pipeline). 15-character nanoid prefixed with `tx-`. Distinct from on-chain tx hashes. - `updated_at` unknown - `v1_metadata` string, nullable - `state` 'Undefined' | 'Intent' | 'Scheduled' | 'Complete' | 'Removed', required - `pay_at_time` integer, required - `token_amount` string, required - `amount_cents` integer, required - `currency_symbol` string, required - `token_decimals` integer, required - `valid_minutes` integer, required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/riseworks/apis/b2b-api-v1-legacy.md) · [All operations](https://skmtc.net/riseworks/apis/b2b-api-v1-legacy/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/riseworks/b2b-api-v1-legacy/versions/6f6941749255/schema)