List all refund types

GET /api/configuration/refund-reasons

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Returns every refund reason code configured for your tenant. A refund reason is a short coded label — such as the reason a payment was returned — that staff and integrations attach to a refund so that refunds can be grouped and reported on consistently.

The list contains only reason codes of type REFUND; cancellation and other reason-code types are not returned here. A reason code added or edited in the back office may not appear on the very next call.

The list is not paginated or filtered — you always receive the complete set, and an empty array means no refund reason codes have been configured for the tenant.

Endpoint

GET {base_url}/api/configuration/refund-reasons

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Sample request

cURL

curl -X GET '{base_url}/api/configuration/refund-reasons' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	integer (int32)	The reason code's identifier, unique within the tenant. This is the value to store and send back when your integration needs to record which refund reason applies.
`[].name`	string	The short label for the reason code, as entered when the code was configured. Use it as the display text in a picker.
`[].description`	string	The longer free-text explanation held against the reason code, for when `name` alone is too terse. Configured per reason code, so it may be `null` where no description was entered.

Sample response

200 OK

[
  {
    "id": 12345,
    "name": "string",
    "description": "string"
  }
]

Errors

Status	Meaning	When
`500`	Internal server error

This page as markdown · All pages · llms.txt