Jump to

• Request
• Response
• Examples

Refund a Customer Deposit

post

/bcws/webresources/v1.0/depositManagement/depositRefund

Refunds the specified customer deposit.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountNumber(required): string
  The account number.
• approvedRefundAmount: object Money
• completedAt(required): string
  The deposit refund completion date.
• createdAt(required): string
  The date when the deposit refund is initiated.
• customerDepositRef(required): string
  The customer deposit reference.
• customerRef(required): string
  The customer reference.
• error(required): string
  Error message for the deposit refund.
• glCode(required): string
  The general ledger ID.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The deposit refund ID.
• modifiedAt(required): string
  The date when the deposit refund is modified.
• notes(required): string
  Notes about the deposit refund.
• reason(required): string
  Reason for the deposit refund.
• refundAmount: object Money
• refundRef(required): string
  The deposit refund reference.
• serviceRef(required): string
  The service reference.
• status: integer (int32)
  The deposit refund status. Allowed Values:

  • 0 (Completed)
  • 1 (Failed)
  • 2 (Pending)
  • 3 (Accepted)
  • 4 (Rejected)

{
    "required":[
        "accountNumber",
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "glCode",
        "href",
        "id",
        "modifiedAt",
        "notes",
        "reason",
        "refundRef",
        "serviceRef"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit refund ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit refund is initiated."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit refund is modified."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit refund completion date."
        },
        "status":{
            "type":"integer",
            "description":"The deposit refund status. Allowed Values: <ul><li><b>0</b> (Completed)</li><li><b>1</b> (Failed)</li><li><b>2</b> (Pending)</li><li><b>3</b> (Accepted)</li><li><b>4</b> (Rejected)</li></ul>",
            "format":"int32"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit refund."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit refund."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit refund."
        },
        "refundRef":{
            "type":"string",
            "description":"The deposit refund reference."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        },
        "refundAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "approvedRefundAmount":{
            "$ref":"#/components/schemas/Money"
        }
    },
    "xml":{
        "name":"depositRefund"
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountNumber(required): string
  The account number.
• approvedRefundAmount: object Money
• completedAt(required): string
  The deposit refund completion date.
• createdAt(required): string
  The date when the deposit refund is initiated.
• customerDepositRef(required): string
  The customer deposit reference.
• customerRef(required): string
  The customer reference.
• error(required): string
  Error message for the deposit refund.
• glCode(required): string
  The general ledger ID.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The deposit refund ID.
• modifiedAt(required): string
  The date when the deposit refund is modified.
• notes(required): string
  Notes about the deposit refund.
• reason(required): string
  Reason for the deposit refund.
• refundAmount: object Money
• refundRef(required): string
  The deposit refund reference.
• serviceRef(required): string
  The service reference.
• status: integer (int32)
  The deposit refund status. Allowed Values:

  • 0 (Completed)
  • 1 (Failed)
  • 2 (Pending)
  • 3 (Accepted)
  • 4 (Rejected)

{
    "required":[
        "accountNumber",
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "glCode",
        "href",
        "id",
        "modifiedAt",
        "notes",
        "reason",
        "refundRef",
        "serviceRef"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit refund ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit refund is initiated."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit refund is modified."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit refund completion date."
        },
        "status":{
            "type":"integer",
            "description":"The deposit refund status. Allowed Values: <ul><li><b>0</b> (Completed)</li><li><b>1</b> (Failed)</li><li><b>2</b> (Pending)</li><li><b>3</b> (Accepted)</li><li><b>4</b> (Rejected)</li></ul>",
            "format":"int32"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit refund."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit refund."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit refund."
        },
        "refundRef":{
            "type":"string",
            "description":"The deposit refund reference."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        },
        "refundAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "approvedRefundAmount":{
            "$ref":"#/components/schemas/Money"
        }
    },
    "xml":{
        "name":"depositRefund"
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

Back to Top

Response

201 Response

The deposit refund was created successfully, and the ID of the new deposit refund was returned.

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to refund a deposit by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/depositManagement/depositRefund' -H 'content-type: application/json' -d @refundDeposit.json

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.
• refundDeposit.json is the JSON file that specifies the deposit to refund.

Example of Request Body

This example shows the contents of the refundDeposit.json file sent as the request body.

{  
  "customerDepositRef": "0.0.0.1+-purchased_deposit+2172776+0",
  "refundAmount": {
    "amount": 10,
    "currency": "INR"
  },
  "notes": "Deposit refund request"
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "id": "0.0.0.1+-deposit_refund_request+2645712",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositRefund/0.0.0.1+-deposit_refund_request+2645712"
}

Back to Top