1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Payment Management
  4. Refund

Get Refunds

get

/refund

Gets the refunds that match the specified query criteria.

Request

Query Parameters
  • The type of object to return. Use @type=Refund for a base object, or @type=RefundOracle for an extended object.
  • Retrieves the refunds from the account with the specified account ID or account number.
    Examples

  • The comma-separated list of fields to return in the response.
    Examples

  • Retrieves the refund associated with the specified item refund ID or item refund number.
    Examples

  • The maximum number of results to return.
    Examples

  • The number of results to offset the response by.
    Examples

  • Retrieves the refunds with a refundDate that is equal to the specified dateTime.
    Examples

  • Retrieves the refunds with a refundDate that is greater than the specified dateTime.
    Examples

  • Retrieves the refunds with a refundDate that is greater than or equal to the specified dateTime.
    Examples

  • Retrieves the refunds with a refundDate that is less than the specified dateTime.
    Examples

  • Retrieves the refunds with a refundDate that is less than or equal to the specified dateTime.
    Examples

  • Retrieves the refunds with a totalAmount that is equal to the specified amount.
    Examples

  • Retrieves the refunds with a totalAmount that is greater than the specified amount.
    Examples

  • Retrieves the refunds with a totalAmount that is greater than or equal to the specified amount.
    Examples

  • Retrieves the refunds with a totalAmount that is less than the specified amount.
    Examples

  • Retrieves the refunds with a totalAmount is less than or equal to the specified amount.
    Examples

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The refunds were retrieved successfully.
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Refund
Type: object
Title: Refund
A refund for a payment.
Show Source
Nested Schema : AccountRef
Type: object
The account reference.
Match All
The account reference.
Show Source
Nested Schema : Money
Type: object
The base / value business entity used to represent money.
Show Source
  • The currency (ISO4217 norm uses 3 letters to define the currency).
  • The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type
Nested Schema : ChannelRef
Type: object
A reference to a channel.
Show Source
Nested Schema : PaymentRef
Type: object
A payment received at order time.
Show Source
Nested Schema : Payment Method Ref Or Value
Type: object
Title: Payment Method Ref Or Value
A link to the resource containing information about the payment method.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : EntityRef
Match All
The entity reference schema to be use for all entityRef class.
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Addressable
    The base schema for adressable entities.
  • EntityRef-allOf[2]
    The entity reference schema to be use for all entityRef class.
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Addressable
Type: object
The base schema for adressable entities.
Show Source
Nested Schema : EntityRef-allOf[2]
Type: object
The entity reference schema to be use for all entityRef class.
Show Source
Nested Schema : account
Type: array
Accounts associated with the payment method.
Show Source
Nested Schema : TimePeriod
Type: object
The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The client doesn't have the correct privileges.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request wasn't authorized.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The requested resource couldn't be found.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

409 Response

The request could not be processed due to the conflict with the existing state of the resource.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

The system encountered an internal error.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

Examples

Example 1: Get Refunds Using Account POID Query Parameter

The following example shows how to get refunds by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the account.id and totalAmount.value.gte query parameters to limit the results. 

curl -X GET 'http://host:port/brm/payment/version/refund?account.id=0.0.0.1+-account+84808&totalAmount.value.get=50'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "0.0.0.1+-item-refund+82547",
      "href": "http://host:port/brm/payment/version/refund/0.0.0.1+-item-refund+82547",
      "authorizationCode": null,
      "correlatorId": "R1-29",
      "description": "Item refund",
      "name": "Billing Event Log",
      "refundDate": "2025-12-09T00:38:15-08:00",
      "status": "Success",
      "statusDate": "2025-12-09T00:38:15-08:00",
      "account": {
         "id": "0.0.0.1+-account+84808",
         "href": null,
         "description": null,
         "name": "Adam Baker",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payment": {
         "id": "0.0.0.1+-item-payment+85939",
         "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+85939",
         "name": null,
         "amount": null,
         "paymentDate": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "Payment"
      },
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Cash",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "Cash",
         "@referredType": null
      },
      "requestor": null,
      "taxAmount": null,
      "totalAmount": {
         "unit": "USD",
         "value": 200.0
      },
      "@baseType": "Refund",
      "@schemaLocation": null,
      "@type": "Refund"
   },
   {
      "id": "0.0.0.1+-item-refund+90658",
      "href": "http://host:port/brm/payment/version/refund/0.0.0.1+-item-refund+90658",
      "authorizationCode": null,
      "correlatorId": "R1-27",
      "description": "Item refund",
      "name": "Billing Event Log",
      "refundDate": "2025-12-08T22:58:32-08:00",
      "status": "Success",
      "statusDate": "2025-12-08T22:58:32-08:00",
      "account": {
         "id": "0.0.0.1+-account+84808",
         "href": null,
         "description": null,
         "name": "Adam Baker",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payment": {
         "id": "0.0.0.1+-item-payment+88145",
         "href": "0.0.0.1+-account+84808/brm/payment/version/payment/0.0.0.1+-item-payment+88145",
         "name": null,
         "amount": null,
         "paymentDate": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "Payment"
      },
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Cash",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "Cash",
         "@referredType": null
      },
      "requestor": null,
      "taxAmount": null,
      "totalAmount": {
         "unit": "USD",
         "value": 85.0
      },
      "@baseType": "Refund",
      "@schemaLocation": null,
      "@type": "Refund"
   }
]

Example 2: Get Refunds Using Item Refund Number

The following example shows how to get refunds by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the id query parameter set to an item request number. 

curl -X GET 'http://host:port/brm/payment/version/refund?id=R-123'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "R-123",
      "href": "http://host:port/brm/payment/version/refund/R-123",
      "authorizationCode": null,
      "correlatorId": "R-123",
      "description": "Item refund",
      "name": "Billing Event Log",
      "refundDate": "2025-12-09T00:38:15-08:00",
      "status": "Success",
      "statusDate": "2025-12-09T00:38:15-08:00",
      "account": {
         "id": "0.0.0.1+-account+84808",
         "href": null,
         "description": null,
         "name": "Mary Smith",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "billingAccount"
      },
      "amount": null,
      "channel": {
         "id": "0",
         "href": null,
         "name": "Unspecified",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
      },
      "payment": {
         "id": "0.0.0.1+-item-payment+85939",
         "href": "http://host:port/brm/payment/version/payment/0.0.0.1+-item-payment+85939",
         "name": null,
         "amount": null,
         "paymentDate": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": "Payment"
      },
      "paymentMethod": {
         "id": null,
         "href": null,
         "description": null,
         "isPreferred": null,
         "name": "Cash",
         "status": null,
         "statusDate": null,
         "account": null,
         "relatedParty": null,
         "validFor": null,
         "@baseType": "PaymentMethodRefOrValue",
         "@schemaLocation": null,
         "@type": "Cash",
         "@referredType": null
      },
      "requestor": null,
      "taxAmount": null,
      "totalAmount": {
         "unit": "EUR",
         "value": 50.0
      },
      "@baseType": "Refund",
      "@schemaLocation": null,
      "@type": "Refund"
   },
]
Back to Top