Skip to content
/Charges

Charges

A charge represents an agreement by the customer to accept credit terms for a transaction. It consists of a charge amount, term length (i.e. 30, 60, 90), and reference to the merchant's original order or purchase order numbers.

These endpoints are intended for merchants using the Checkout SDK. If you are not using the Checkout SDK flow, these endpoints are generally not needed.

Operations

List charges

Request

Return a paginated list of charges.

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

Limit the number of charges returned.

Default:100
pagestring

Specify the page of charges returned.

Default:"1"
searchstring

Search across supported charge fields.

Search is applied to charge and associated record values including: id, number, merchant_invoice.order_number, merchant_invoice.po_number, and customer/merchant identifying fields.

orderstring

Sort charges by field. Prefix with - for descending order.

Examples:

  • order=-created_at
  • order=amount
Default:"-created_at"
starting_atstring, (date-time)

Return charges created at or after this timestamp.

ending_atstring, (date-time)

Return charges created at or before this timestamp.

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/charges?limit=100&page=1&search=string&order=-created_at&starting_at=2019-08-24T14%3A15%3A22Z&ending_at=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of charges.

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