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

Create a Refund

post

/refund

Creates a refund.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : Refund Create
Type: object
Title: Refund Create
A refund for a payment, used in the create refund request. The paymentMethod 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 refunded instead.

The id, href, status, statusDate, and refundDate properties are not used in the create request.

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
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root 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

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 create a refund by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/payment/version/refund' -d @refundCreate.json

When the refund is created successfully, the only response is a 201 status code.

Example of Request Body

The following is an example of the contents of the refundCreate.json file sent as the request body. 

{
    "@type": "RefundCreate",
    "account": {
        "id": "0.0.0.1+-account+84808"
    },
    "paymentMethod": { 
        "id": "0.0.0.1+-payinfo-dd+249648",
        "@type": "PaymentMethodRef"
    },
    "totalAmount": {
        "value": 10,
        "unit": "USD"
    },
    "description": "Refunding service fee."
}

Example of 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-30",
        "description": "Item refund",
        "name": "Billing Event Log",
        "refundDate": "2021-12-09T00:38:15-08:00",
        "status": "Success",
        "statusDate": "2021-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": null,
        "paymentMethod": {
            "id": "0.0.0.1+-payinfo-dd+249648",
            "href": null,
            "description": null,
            "isPreferred": true,
            "name": "Grace Wang's Direct Debit Account",
            "status": null,
            "statusDate": null,
            "account": "0.0.0.1+-account+104221",
            "relatedParty": null,
            "validFor": null,
            "@baseType": "PaymentMethodRefOrValue",
            "@schemaLocation": null,
            "@type": "PaymentMethodRef",
            "@referredType": null
        },
        "requestor": null,
        "taxAmount": null,
        "totalAmount": {
            "unit": "USD",
            "value": 10.0
        },
        "@baseType": "Refund",
        "@schemaLocation": null,
        "@type": "Refund"
    }
Back to Top