List payments

Returns one page of payments.

GET /payments

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/payments?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "account": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "credit_applied": [
        {
          "amount": "<string>",
          "code": "<string>"
        }
      ],
      "gift_certificate_applied": [
        {
          "amount": "<string>",
          "code": "<string>"
        }
      ],
      "id": "<string>",
      "invoices": [
        {
          "applied": "<string>",
          "due_date": "<string>",
          "id": "<string>",
          "issue_date": "<string>",
          "outstanding": "<string>",
          "total": "<string>"
        }
      ],
      "last_updated_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "last_updated_on": "<string>",
      "object": "<string>",
      "origin": "<string>",
      "payment_applied": [
        {
          "amount": "<string>",
          "gateway_response": "<unknown>",
          "method": "<string>",
          "processor": "<string>",
          "reference": "<string>"
        }
      ],
      "payment_note": "<string>",
      "reconcile_status": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Lists every payment, one page at a time, under data. Each record carries its status, reconcile_status, the money received under payment_applied, any credit or gift certificate spent, and the invoices it paid. To filter, add filter_<field>=<value>, or filter_<field>_<operator>=<value> with an operator such as gte or contains.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor value from the previous page, to fetch the page after it.

sort · string

The field to sort by. Put - in front for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

One page of payments, under data, with pagination.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string