Skip to content
/Payments

Payments

A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amount of the payment. Payments can be made via various methods including ACH, credit card, check, or wire transfer. Each payment can be applied to one or more invoices.

Operations

List payments

Request

Return a list of payments.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 25 .. 100 ]

Limit the number of payments returned.

Default:25
pagestring

Specify the page of payments returned.

Default:"1"
filterobject

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

sortstring

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)

Default:"-created_at"
Enum:"id""-id""created_at""-created_at""amount""-amount"
curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/payments?limit=25&page=1&filter=%7B%22customer_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22status%22%3A%7B%22eq%22%3A%22pending%22%7D%2C%22amount%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%7D&sort=id' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of payments.

Bodyapplication/json
countinteger
Example:1
limitinteger
Example:25
pageinteger
Example:1
resultsArray of objects(Payment)
Response
{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}