REresolvepay
Payments

List payments

Return a list of payments.

get/payments

Request

Query parameters

limitinteger

Limit the number of payments returned.

pagestring

Specify the page of payments returned.

Filter payments by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)
  • after - after date
  • before - before date
  • start - start date
  • end - end date

Filtering is allowed by the following fields:

  • customer_id (eq)
  • status (eq)
  • amount (eq, gt, lt, gte, lte)

Example: filter[customer_id][eq]=X50sgfRd

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

sort'id' | '-id' | 'created_at' | '-created_at' | 'amount' | '-amount'

Sort payments by the specified field. Use - prefix for descending order.

Available sort fields:

  • id
  • created_at
  • amount

Example: sort=-created_at (sort by created_at in descending order)

Response

A paginated list of payments.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    {
      "id": "PMMlaE5wbg0",
      "customer_id": "X50sgfRd",
      "source": "customer_user",
      "amount": 1000,
      "method": "ach_debit",
      "status": "paid",
      "created_at": "2020-01-01T00:00:00.730Z",
      "paid_at": "2020-01-02T00:00:00.730Z",
      "processed_at": "2020-01-01T12:00:00.730Z",
      "processing_fee": 25.5,
      "forward_reason_code": "check",
      "forward_reason_message": "Customer paid by wire transfer outside Resolve.",
      "payment_links": [
        {
          "record_id": "PMMlaE5wbg0",
          "record_type": "invoice",
          "amount": 500
        }
      ]
    }
  ]
}

Changes

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