Jump to

• Request
• Response
• Examples

Get a Deposit Refund by ID

get

/bcws/webresources/v1.0/depositManagement/depositRefund/{id}

Gets the specified deposit refund.

Request

Path Parameters

• id(required): string
  The deposit refund ID, for example: 0.0.0.1+-deposit_refund+1234567

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

The deposit refund details were returned successfully.

Body ()

Root Schema : depositRefund

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"
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

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

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/depositManagement/depositRefund/0.0.0.1+-deposit_refund_request+2645712'

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.

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/depositSpec/0.0.0.1+-deposit_refund_request+2645712",
    "createdAt": "2021-11-06T13:03:22.000Z",
    "modifiedAt": "2021-11-06T13:03:22.000Z",
    "status": "PENDING",
    "customerRef": "0.0.0.1+-account+2177032",
    "serviceRef": "0.0.0.1+-service-telco-gsm+2178184",
    "customerDepositRef": "0.0.0.1+-purchased_deposit+2172776",
    "refundAmount": {
        "amount": 10
    },
    "approvedRefundAmount": {
        "amount": 10
    }
}

Back to Top