Get Refunds

get

/refund

Gets the refunds that match the specified query criteria.

Request

Query Parameters
  • The type of object to return.
    Example:
    Use @type=Refund for a base object, or @type=RefundOracle for an extended object.
  • Retrieves the refunds from the account with the specified ID.
    Example:
    account.id=0.0.0.1+-account+79731
  • The comma-separated list of fields to return in the response.
    Example:
    fields=refundDate,account
  • Retrieves the refund with the specified ID.
    Example:
    id=0.0.0.1+-item-refund+106589
  • The maximum number of results to return.
    Example:
    Use limit=10 to return the first 10 results only.
  • The number of results to offset the response by.
    Example:
    Use offset=10 to return results 10 and higher.
  • Retrieves the refunds with a refundDate that is equal to the specified dateTime.
    Example:
    refundDate=2020-01-01T04:00:27-08:00
  • Retrieves the refunds with a refundDate that is greater than the specified dateTime.
    Example:
    refundDate.gt=2020-01-01T04:00:27-08:00
  • Retrieves the refunds with a refundDate that is greater than or equal to the specified dateTime.
    Example:
    refundDate.gte=2020-01-01T04:00:27-08:00
  • Retrieves the refunds with a refundDate that is less than the specified dateTime.
    Example:
    refundDate.lt=2020-01-01T04:00:27-08:00
  • Retrieves the refunds with a refundDate that is less than or equal to the specified dateTime.
    Example:
    refundDate.lte=2020-01-01T04:00:27-08:00
  • Retrieves the refunds with a totalAmount that is equal to the specified amount.
    Example:
    totalAmount.value=40
  • Retrieves the refunds with a totalAmount that is greater than the specified amount.
    Example:
    totalAmount.value.gt=40
  • Retrieves the refunds with a totalAmount that is greater than or equal to the specified amount.
    Example:
    totalAmount.value.gte=40
  • Retrieves the refunds with a totalAmount that is less than the specified amount.
    Example:
    totalAmount.value.lt=40
  • Retrieves the refunds with a totalAmount is less than or equal to the specified amount.
    Example:
    totalAmount.value.lte=40

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
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 : Account Ref
Type: object
Title: Account Ref
An account's reference.
Show Source
Nested Schema : Money
Type: object
Title: Money
An amount of money.
Show Source
Nested Schema : Channel Ref
Type: object
Title: Channel Ref
A reference to a channel.
Show Source
Nested Schema : Payment Ref
Type: object
Title: Payment Ref
A payment captured as a reference on an order. Used when a payment is made immediately on an order rather than at a later billing date.
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
  • Title: Base Type
    The object's superclass.
  • Title: Referred Type
    The payment method's type, further refined from the @type value. To create a payment when @type is PaymentMethodRef, this is required, and valid values are tokenizedCard, bankAccountDebit, and bankCard.
  • Title: Schema Location
    A URI to a JSON-Schema file that defines additional attributes and relationships.
  • Title: Type
    The 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 will be used instead.
  • account
    Accounts associated with the payment method.
  • Title: Payment Method Description
    The payment method's description.
  • Title: Payment Method Href
    The payment method's href.
  • Title: Payment Method ID
    The payment method's ID.
  • Title: Payment Method Preferred
    Whether this is the preferred payment method (true) or not (false).
  • Title: Payment Method Name
    The payment method's name.
  • Related Party
    Title: Related Party
    A party related to another object.
  • Title: Status
    The payment method's status.
  • Title: Status Date
    The date the payment method's status was recorded.
  • Time Period
    Title: Time Period
    A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : account
Type: array
Accounts associated with the payment method.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
Back to Top

Examples

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 parameter 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": "2020-12-09T00:38:15-08:00",
        "status": "Success",
        "statusDate": "2020-12-09T00:38:15-08:00",
        "account": {
            "id": "0.0.0.1+-account+84808",
            "href": null,
            "description": null,
            "name": "Grace Wang",
            "@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": "2020-12-08T22:58:32-08:00",
        "status": "Success",
        "statusDate": "2020-12-08T22:58:32-08:00",
        "account": {
            "id": "0.0.0.1+-account+84808",
            "href": null,
            "description": null,
            "name": "Grace Wang",
            "@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"
    }
]
Back to Top