Query Payments

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

GET /v2/payments

Query Payments

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/payments \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "items": [
      {
        "recipient": {
          "nanoid": "<string>",
          "riseid": "<string>",
          "avatar": "<string>",
          "first_name": "<string>",
          "middle_name": "<string>",
          "last_name": "<string>",
          "company_name": "<string>",
          "email": "<string>",
          "address": {
            "country": "<string>",
            "state": "<string>",
            "city": "<string>",
            "line_1": "<string>",
            "line_2": "<string>",
            "zip_code": "<string>"
          }
        },
        "payer": {
          "nanoid": "<string>",
          "riseid": "<string>",
          "avatar": "<string>",
          "name": "<string>"
        },
        "invoice": {
          "amount_cents": 0,
          "documents_ids": [
            "<string>"
          ],
          "group_nanoid": "<string>",
          "group_onchain_id": "<string>",
          "hourly_rate_usd_cents": 123,
          "invoice_number": "",
          "invoice_status": "draft",
          "is_aor": false,
          "nanoid": "<string>",
          "pay_intent_time": 0,
          "payer_nanoid": "<string>",
          "recipient_nanoid": "<string>",
          "rise_sow": true,
          "time_entries": [
            {
              "date": "<string>",
              "hours": 0,
              "minutes": 0,
              "notes": "<string>"
            }
          ],
          "created_at": "<unknown>",
          "external_sow_url": "<string>",
          "invoice_description": "<string>",
          "payment_details": "<string>",
          "reason_id": 123,
          "role_description": "<string>",
          "services_description": "<string>",
          "sow_document_nanoid": "<string>",
          "subscription_fee_metadata": {
            "subscription_type": 0,
            "fee_month_epoch": 0,
            "recipients": [
              {
                "address": "<string>",
                "amount": 123
              }
            ]
          },
          "updated_at": "<unknown>"
        },
        "payment": {
          "creation_transaction": "<string>",
          "group_onchain_id": "<string>",
          "invoice_nanoid": "<string>",
          "nanoid": "<string>",
          "onchain_id": "<string>",
          "payment_group_nanoid": "<string>",
          "process_transaction": "<string>",
          "pay_at_time": 0,
          "token_amount": "<string>",
          "amount_cents": 0,
          "currency_symbol": "<string>",
          "token_decimals": 0,
          "valid_minutes": 0,
          "created_at": "<unknown>",
          "updated_at": "<unknown>",
          "v1_metadata": "<string>"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

team_nanoid · string · required

TeamNanoid

Required string length: 15

Pattern: ^te-.*

state · enum<string> · required

Available options: all, intent, scheduled, complete

start_date · number string · required

end_date · number string · required

query_type · enum<string> · required

Available options: payable, receivable

recipient · string

UserNanoid

Required string length: 15

Pattern: ^us-.*

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes