v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Payments

Retrieves all payments.

get/dashboards/{dashboard_id}/payments

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

Query parameters

reference_numberstring

User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.

phone_numberstring

Phone number

sort_type'amount' | 'contact' | 'date' | 'status'

Property to sort payments by.

sort_direction'desc' | 'asc'

Direction to sort payments in. Either greatest to smallest, or smallest to greatest.

pageinteger

The page number. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned. The first item returned will be page multiplied by page_size

Response

All payments in a list.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "payment_id": 2510,
      "recipient": "John Doe",
      "description": "Housecall for plumbing services",
      "amount_requested": 220.5,
      "transaction_status": "Unknown",
      "textrequest_payment_status": "Sent",
      "reference_number": "receipt-chicago"
    }
  ]
}