Refunds

List Refunds

Lists refunds, newest first. Without filters this is every refund the caller can read; narrow it to one payment with payment_id, one account with account_id, or one buyer with user_id.

get/refunds

Query parameters

account_idstring

Only refunds issued by this account, prefixed biz_.

payment_idstring

Only refunds of this payment, prefixed pay_.

user_idstring

Only refunds to this buyer, prefixed user_.

created_beforestring date-time

Only refunds requested before this ISO 8601 timestamp.

created_afterstring date-time

Only refunds requested after this ISO 8601 timestamp.

order'created_at'

The field to sort by.

direction'asc' | 'desc'

The sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

refunds listed

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "failure_message": "Insufficient funds on the merchant balance.",
      "failure_reason": "insufficient_funds",
      "id": "rf_xxxxxxxxxxxxxx",
      "original_amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "payment_id": "pay_xxxxxxxxxxxxxx",
      "provider": "stripe",
      "provider_created_at": "2026-01-01T12:00:00.000Z",
      "reason": "duplicate",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "status": "failed",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 7 of the 74 revisions of this API.121839

    • ●

      added the new dispute_alert enum value to the // response property for the response status

      response-property-enum-value-added

  • ff3a7657356312See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

  • 697924df40d1101236See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      added subschema #2 to the // response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      the // response's property type changed from number to no type for status

      response-property-type-changed

    • ▲

      the // response's property format changed from date-time to no format for status

      response-property-type-changed

    • ▲

      the // response's property format changed from date-time to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string null for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to string null for status

      response-property-type-changed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      added the new acquirer_reference_number enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new available enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new pending enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new retrieval_reference_number enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new system_trace_audit_number enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new unavailable enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new undefined enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new undefined enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      api operation id listRefund removed and replaced with listRefunds

      api-operation-id-removed

    • ○

      added the new optional header request parameter Api-Version-Date to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter order

      new-optional-request-parameter

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the adyen enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the airwallex enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the apple enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the braintree enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the checkout_dot_com enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the claritypay enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the coinbase enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the coinflow enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the dlocal enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the flex_pay enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the masspay enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the multi_psp enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the paypal enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the platform_balance enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the sequra enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the sezzle enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the splitit enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stripe enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      added the new flex_pay enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f67a043e319013See the full diff
    • ▲

      the query request parameter direction was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value asc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      for the query request parameter direction, the type was generalized from no type to string

      request-parameter-type-generalized

    • ●

      added the new braintree enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      added the new masspay enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.