> ## Documentation Index > Fetch the complete documentation index at: https://docs.riseworks.io/llms.txt > Use this file to discover all available pages before exploring further. # Query Payments > Query payments for a team, optionally filtered by recipient and date range. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v2/payments openapi: 3.0.3 info: title: Rise description: Web3-enabled payroll and compliance for the modern workforce version: 2.0.0 servers: - url: https://b2b-api.dev-riseworks.io description: Development - url: https://integrations-api.staging-riseworks.io description: Staging - url: https://integrations-api.riseworks.io description: Production security: [] paths: /v2/payments: get: tags: - B2B Payments summary: Query Payments description: >- Query payments for a team, optionally filtered by recipient and date range. parameters: - schema: type: string minLength: 15 maxLength: 15 pattern: ^te-.* in: query name: team_nanoid required: true description: >- Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - schema: type: string enum: - all - intent - scheduled - complete in: query name: state required: true - schema: anyOf: - type: number - type: string - {} in: query name: start_date required: false description: >- 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. - schema: anyOf: - type: number - type: string - {} in: query name: end_date required: false description: >- 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. - schema: type: string enum: - payable - receivable in: query name: query_type required: true - schema: type: string minLength: 15 maxLength: 15 pattern: ^us-.* in: query name: recipient required: false description: Identifier of a Rise user. 15-character nanoid prefixed with `us-`. responses: '200': description: Default Response content: application/json: schema: type: object properties: success: type: boolean enum: - true data: type: object properties: items: type: array items: type: object properties: recipient: type: object properties: nanoid: anyOf: - type: string minLength: 15 maxLength: 15 pattern: ^us-.* description: >- Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - type: string minLength: 15 maxLength: 15 pattern: ^co-.* description: >- Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). riseid: type: string minLength: 42 maxLength: 42 description: >- On-chain identifier of a Rise user — the 42-character EVM address of the user's RiseAccount contract. avatar: type: string first_name: type: string nullable: true middle_name: type: string nullable: true last_name: type: string nullable: true company_name: type: string nullable: true email: type: string nullable: true address: type: object properties: country: type: string pattern: ^[A-Z]{2}$ description: >- Country code in ISO 3166-1 alpha-2 form — exactly two uppercase letters (e.g. `US`, `GB`, `BR`). state: type: string city: type: string line_1: type: string line_2: type: string nullable: true zip_code: type: string required: - country additionalProperties: false required: - nanoid - riseid - avatar - first_name - middle_name - last_name - company_name - email - address additionalProperties: false payer: type: object properties: nanoid: type: string minLength: 15 maxLength: 15 pattern: ^te-.* description: >- Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. riseid: type: string minLength: 42 maxLength: 42 description: >- On-chain identifier of a Rise team — the 42-character EVM address of the team's RiseAccount contract. avatar: type: string name: type: string required: - nanoid - riseid - avatar - name additionalProperties: false invoice: type: object properties: amount_cents: default: 0 type: number automated_payment: default: true type: boolean created_at: {} currency: type: string enum: - 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 description: >- Any currency Rise supports — fiat (ISO-4217 codes like USD, GBP) or crypto (USDC, EURC, BTC, etc.). documents_ids: type: array items: type: string external_id: type: string nullable: true external_id_unique_claim: type: boolean nullable: true external_sow_url: type: string nullable: true flat_type: type: string enum: - reimbursement - product - service nullable: true group_nanoid: type: string minLength: 15 maxLength: 15 pattern: ^pg-.* description: >- Identifier of a payment group (a batch of payments scheduled together). 15-character nanoid prefixed with `pg-`. group_onchain_id: type: string hourly_rate_usd_cents: type: number invoice_description: type: string nullable: true invoice_number: default: '' type: string nullable: true invoice_status: default: draft type: string enum: - draft - creating - open - processing - flushing - closed - open_canceled - canceled - failed is_aor: default: false type: boolean nanoid: type: string minLength: 15 maxLength: 15 pattern: ^iv-.* description: >- Identifier of an invoice. 15-character nanoid prefixed with `iv-`. pay_intent_time: default: 0 type: number payer_nanoid: anyOf: - anyOf: - anyOf: - anyOf: - type: string minLength: 15 maxLength: 15 pattern: ^us-.* description: >- Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - type: string minLength: 15 maxLength: 15 pattern: ^co-.* description: >- Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). - type: string minLength: 15 maxLength: 15 pattern: ^te-.* description: >- Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - type: string minLength: 15 maxLength: 15 pattern: ^tr-.* description: >- Identifier of a team-scoped role assignment (e.g. team admin, team employee, contractor). 15-character nanoid prefixed with `tr-`. - type: string minLength: 15 maxLength: 15 pattern: ^tp-.* description: >- Identifier of a team payroll run. 15-character nanoid prefixed with `tp-`. payer_payee_relationship: type: string enum: - contractor - aor_contractor - team_employee - external_recipient nullable: true payment_details: type: string nullable: true payment_onchain_id: type: string nullable: true payroll_program: type: string enum: - 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: true reason_id: type: number nullable: true recipient_nanoid: anyOf: - anyOf: - anyOf: - anyOf: - type: string minLength: 15 maxLength: 15 pattern: ^us-.* description: >- Identifier of a Rise user. 15-character nanoid prefixed with `us-`. - type: string minLength: 15 maxLength: 15 pattern: ^co-.* description: >- Identifier of a Rise company. 15-character nanoid prefixed with `co-` (e.g. `co-aBcD1234EfGh`). - type: string minLength: 15 maxLength: 15 pattern: ^te-.* description: >- Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with `te-`. - type: string minLength: 15 maxLength: 15 pattern: ^tr-.* description: >- Identifier of a team-scoped role assignment (e.g. team admin, team employee, contractor). 15-character nanoid prefixed with `tr-`. - type: string minLength: 15 maxLength: 15 pattern: ^tp-.* description: >- Identifier of a team payroll run. 15-character nanoid prefixed with `tp-`. recurrence: type: string enum: - daily - weekly - bi_weekly - four_weeks - monthly - bi_monthly - quartely - six_months - annually nullable: true rise_sow: type: boolean role_description: type: string nullable: true services_description: type: string nullable: true sow_document_nanoid: type: string nullable: true subscription_fee_metadata: type: object properties: subscription_type: type: integer minimum: -9007199254740991 maximum: 9007199254740991 fee_month_epoch: type: integer minimum: -9007199254740991 maximum: 9007199254740991 usage_month_epoch: type: integer minimum: -9007199254740991 maximum: 9007199254740991 recipients: type: array items: type: object properties: address: type: string amount: type: number required: - address - amount additionalProperties: false v1_migration_type: type: string enum: - V1_SUBSCRIPTION - V1_CHARGEBACK source_payment_invoice_number: type: string required: - subscription_type - fee_month_epoch - recipients additionalProperties: false nullable: true time_entries: type: array items: type: object properties: date: type: string hours: type: integer minimum: -9007199254740991 maximum: 9007199254740991 minutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 notes: type: string required: - date - hours - minutes - notes additionalProperties: false type: type: string enum: - time_entry - flat - paynow - payonce - recurring - milestone - batch - payroll_cash_requirement - payroll_cash_requirement_chargeback - payroll_net_payment - external_recipient_payment - subscription_fee updated_at: {} required: - amount_cents - automated_payment - currency - documents_ids - group_nanoid - group_onchain_id - hourly_rate_usd_cents - invoice_number - invoice_status - is_aor - nanoid - pay_intent_time - payer_nanoid - recipient_nanoid - rise_sow - time_entries - type additionalProperties: false payment: type: object properties: created_at: {} creation_transaction: type: string minLength: 15 maxLength: 15 pattern: ^tx-.* description: >- 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. nullable: true group_onchain_id: type: string invoice_nanoid: type: string minLength: 15 maxLength: 15 pattern: ^iv-.* description: >- Identifier of an invoice. 15-character nanoid prefixed with `iv-`. nanoid: type: string minLength: 15 maxLength: 15 pattern: ^pa-.* description: >- Identifier of a single payment. 15-character nanoid prefixed with `pa-`. onchain_id: type: string payment_group_nanoid: type: string minLength: 15 maxLength: 15 pattern: ^pg-.* description: >- Identifier of a payment group (a batch of payments scheduled together). 15-character nanoid prefixed with `pg-`. process_transaction: type: string minLength: 15 maxLength: 15 pattern: ^tx-.* description: >- 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. nullable: true updated_at: {} v1_metadata: type: string nullable: true state: type: string enum: - Undefined - Intent - Scheduled - Complete - Removed pay_at_time: type: integer minimum: -9007199254740991 maximum: 9007199254740991 token_amount: type: string amount_cents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 currency_symbol: type: string token_decimals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 valid_minutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - creation_transaction - group_onchain_id - invoice_nanoid - nanoid - onchain_id - payment_group_nanoid - process_transaction - state - pay_at_time - token_amount - amount_cents - currency_symbol - token_decimals - valid_minutes additionalProperties: false required: - recipient - payer - invoice - payment additionalProperties: false required: - items additionalProperties: false required: - success - data additionalProperties: false '400': description: Bad Request content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: string error_code: type: string required: - success - data additionalProperties: false description: Bad Request '401': description: Unauthorized content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: string error_code: type: string required: - success - data additionalProperties: false description: Unauthorized '403': description: Forbidden content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: string error_code: type: string required: - success - data additionalProperties: false description: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: string error_code: type: string required: - success - data additionalProperties: false description: Not Found '500': description: Internal Server Error content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: string error_code: type: string required: - success - data additionalProperties: false description: Internal Server Error security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````