Payments

List orders customers placed through agents' Take-payment options.

get/api/v1/orders

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/orders
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

agentIdstring

Only orders taken by this agent.

leadIdstring

Only orders for this lead.

status'awaiting_amount' | 'open' | 'partially_paid' | 'paid' | 'cancelled' | 'needs_attention' | 'outstanding'

Filter by status; 'outstanding' = open or partially paid.

limitinteger

Default 25.

cursorstring

Opaque cursor from the previous page's nextCursor.

Response

Success.

Changes

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