Get a Refund by ID
get
/refund/{id}
Gets the specified refund.
Request
Path Parameters
-
id(required): string
The refund's ID or item number.Examples
Query Parameters
-
@type: string
The type of object to return. Use @type=Refund for a base object, or @type=RefundOracle for an extended object.Examples
-
fields: string
The comma-separated list of fields to return in the response.Examples
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
The refund was retrieved successfully.
Root Schema : Refund
Type:
objectTitle:
RefundA refund for a payment.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
account(required): object
AccountRef
The account reference.
-
amount: object
Money
The base / value business entity used to represent money.
-
authorizationCode: string
Title:
Authorization codeAn authorization code from an external payment gateway. -
channel: object
ChannelRef
A reference to a channel.
-
correlatorId: string
Title:
correlator IDA refund correlation ID from a client application. -
description: string
Title:
Refund DescriptionThe refund's description. -
href: string
Title:
Refund HrefThe refund's href. -
id: string
Title:
Refund IDThe refund's ID or item refund number. -
name: string
Title:
Refund NameThe refund's name. -
payment: object
PaymentRef
A payment received at order time.
-
paymentMethod(required): object
Payment Method Ref Or Value
Title:
Payment Method Ref Or ValueA link to the resource containing information about the payment method. -
refundDate: string
(date-time)
Title:
Refund DateThe date when the refund was made. -
requestor: object
Related Party
Title:
Related PartyA party related to another object. -
status: string
Title:
Refund StatusThe refund's status. -
statusDate: string
(date-time)
Title:
Status DateThe date when the refund's status was recorded. -
taxAmount: object
Money
The base / value business entity used to represent money.
-
totalAmount: object
Money
The base / value business entity used to represent money.
Nested Schema : AccountRef
Type:
objectThe account reference.
Match All
The account reference.
Show Source
Nested Schema : Money
Type:
objectThe base / value business entity used to represent money.
Show Source
-
unit: string
The currency (ISO4217 norm uses 3 letters to define the currency).
-
value: number
(float)
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:
objectA reference to a channel.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Channel HrefThe channel's href. -
id(required): string
Title:
Channel IDThe channel's ID. -
name: string
Title:
Channel NameThe channel's name.
Nested Schema : PaymentRef
Type:
objectA payment received at order time.
Show Source
-
@baseType: string
The object's superclass.
-
@referredType: string
The object's type in the target system, if baseType and type need further disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
href: string
(uri)
The payment's href.
-
id(required): string
The payment's ID.
-
name: string
The payment's name.
Nested Schema : Payment Method Ref Or Value
Type:
objectTitle:
Payment Method Ref Or ValueA link to the resource containing information about the payment method.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-schema file that defines additional attributes and relationships. -
@type(required): string
Title:
TypeThe payment method's type. Valid values are PaymentMethodRef for a credit or debit card, Cash, or Check. When the value is PaymentMethodRef, the payment method specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit is refunded instead. (For payments and refunds, @type is not used for subclassing.) -
account: array
account
Accounts associated with the payment method.
-
description: string
Title:
Payment Method DescriptionThe payment method's description. -
href: string
Title:
Payment Method HrefThe payment method's href. -
id(required): string
Title:
Payment Method IDThe payment method's ID or external ID. -
isPreferred: boolean
Title:
Payment Method PreferredWhether this is the preferred payment method (true) or not (false). -
name: string
Title:
Payment Method NameThe payment method's name. - relatedParty: object Related Party
-
status: string
Title:
StatusThe payment method's status. -
statusDate: string
(date-time)
Title:
Status DateThe date the payment method's status was recorded. -
validFor: object
TimePeriod
The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Nested Schema : Related Party
Type:
objectTitle:
Related PartyA party related to another object.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType(required): string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
(uri)
Title:
HrefThe party's href. -
id(required): string
Title:
Party IDThe party's ID. -
name: string
Title:
Party NameThe party's name. -
role: string
Title:
Party RoleThe party's role.
Nested Schema : EntityRef
Match All
The entity reference schema to be use for all entityRef class.
Show Source
-
object
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
-
object
Addressable
The base schema for adressable entities.
-
object
EntityRef-allOf[2]
The entity reference schema to be use for all entityRef class.
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Addressable
Type:
objectThe base schema for adressable entities.
Show Source
-
href: string
The hyperlink reference.
-
id: string
The unique identifier.
Nested Schema : EntityRef-allOf[2]
Type:
objectThe entity reference schema to be use for all entityRef class.
Show Source
-
@referredType: string
The actual type of the target instance when needed for disambiguation.
-
href: string
The URI of the referred entity.
-
id(required): string
The identifier of the referred entity.
-
name: string
The name of the referred entity.
Nested Schema : account
Type:
arrayAccounts associated with the payment method.
Show Source
-
Array of:
object AccountRef
The account reference.
Nested Schema : TimePeriod
Type:
objectThe period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Show Source
-
endDateTime: string
(date-time)
The end of the time period, using IETC-RFC-3339 format.Example:
1985-04-12T23:20:50.52Z -
startDateTime: string
(date-time)
The start of the time period, using IETC-RFC-3339 format.Example:
1985-04-12T23:20:50.52Z
400 Response
The request isn't valid.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
401 Response
The client doesn't have the correct privileges.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
403 Response
The request wasn't authorized.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
404 Response
The requested resource couldn't be found.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
405 Response
This method is not allowed.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
409 Response
The request could not be processed due to the conflict with the existing state of the resource.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
500 Response
The system encountered an internal error.
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
-
object
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
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe 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
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
Examples
Example 1: Get a Refund by Item Refund ID
The following example shows how to get a refund with a specified item refund POID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/brm/payment/version/refund/0.0.0.1+-item-refund+82547'
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"
}Example 2: Get a Refund by Item Refund Number
The following example shows how to get a refund with a specified item refund number by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/brm/payment/version/refund/R1-29'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "R1-29",
"href": "http://host:port/brm/payment/version/refund/R1-29",
"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": "Test123XYZ",
"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"
}