List Refunds

GET

/api/:account_id/payments/refunds/

GET

/api/:account_id/payments/refunds/

curl https://app.paymentkit.com/api/account_id/payments/refunds/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "items": [
    {
      "id": "ref_9f8b7c6d5a4e3b2c1d0e",
      "account_id": "acc_1234567890abcdef",
      "charge_id": "ch_0987654321fedcba",
      "amount_atom": 250000,
      "currency": "usd",
      "status": "succeeded",
      "created_at": "2024-04-09T10:15:00Z",
      "updated_at": "2024-04-10T14:22:00Z",
      "reason": "requested_by_customer",
      "processor_refund_id": "re_1J2K3L4M5N6O7P8Q",
      "failure_code": null,
      "failure_message": null,
      "acquirer_reference_number": "ARN123456789012",
      "processed_at": "2024-04-10T14:22:00Z",
      "metadata": {
        "order_id": "ORD1002345",
        "customer_note": "Refund for returned item"
      }
    }
  ],
  "total": 1,
  "has_more": false
}

List every refund in the account, with pagination, filtering and sorting.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstring or objectOptional

Filter conditions as a JSON string or object. All fields are optional.

status (string)
currency (string)
reason (string)
charge_id (string)
amount_atom (integer | number | object)
created_at (string | object)
processed_at (string | object)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error