GET
/
v2
/
payments
Query Payments
curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/payments \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "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,
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "documents_ids": [
            "<string>"
          ],
          "external_sow_url": "<string>",
          "flat_type": "product",
          "group_nanoid": "<string>",
          "group_onchain_id": "<string>",
          "hourly_rate_usd_cents": 123,
          "invoice_description": "<string>",
          "invoice_number": "",
          "invoice_status": "draft",
          "nanoid": "<string>",
          "pay_intent_time": 0,
          "payer_nanoid": "<string>",
          "payroll_program": "riseworks_eor_us",
          "recipient_nanoid": "<string>",
          "recurrence": "annually",
          "rise_sow": true,
          "role_description": "<string>",
          "sow_document_nanoid": "<string>",
          "time_entries": [
            {
              "date": "<string>",
              "hours": 123,
              "minutes": 123,
              "notes": "<string>"
            }
          ],
          "type": "batch",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "payment": {
          "created_at": "2023-11-07T05:31:56Z",
          "creation_transaction": "<string>",
          "group_onchain_id": "<string>",
          "invoice_nanoid": "<string>",
          "nanoid": "<string>",
          "onchain_id": "<string>",
          "payment_group_nanoid": "<string>",
          "process_transaction": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "state": "Undefined",
          "pay_at_time": 123,
          "token_amount": "<string>",
          "amount_cents": 123,
          "currency_symbol": "<string>",
          "token_decimals": 123,
          "valid_minutes": 123
        }
      }
    ]
  }
}

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
​
state
enum<string>
required
Available options:
all,
intent,
scheduled,
complete
​
start_date
required
​
end_date
required
​
query_type
enum<string>
required
Available options:
payable,
receivable
​
recipient
string

UserNanoid

Required string length: 15

Response

200
application/json

Default Response

The response is of type object.