Sign in
Refunds

Get a paginated list of refunds for the marketplace. Custom sorting is not allowed, and results are sorted by Refund ID.

get/refunds

Query parameters

offsetinteger

The offset value used to paginate through a list of entries. If the dir query parameter is prev then the offset will be the id of the first record of the data set otherwise the offset will be the id of the last record

limitinteger

An optional limit for the number of entries on a page with a maximum value of 100. Default value is 100 if not provided.

dir'next' | 'prev'

The direction to paginate the next set of data. If dir is prev the page will return a data set before the offset otherwise the data set will be after the offset. Default value is next if not provided.

Response

Successful operation

Example response

{
  "data": {
    "id": 1337,
    "charge_id": 1337,
    "cart_item_id": 1234,
    "created_at": "2020-03-04 00:18:35",
    "test_mode": true,
    "charge_refund_status": "refunded",
    "currency": "USD",
    "refund_amount": 1525,
    "remaining_refundable_amount": 7500,
    "charge": {
      "charge_date": "2021-03-08 00:18:35",
      "test_mode": true,
      "processor_transaction_id": "H241L4ZX",
      "currency": "USD",
      "card_used": "4242",
      "paypal_email": "my_paypal@email.com"
    },
    "order": {
      "test_mode": true
    }
  },
  "pagination": {
    "next": "https://example.samcart.com/v1/example?offset=1337&dir=next"
  }
}

Changes

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