Jump to

• Request
• Response
• Examples

Release a Customer Deposit

post

/bcws/webresources/v1.0/depositManagement/depositRelease

Releases a 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

• completedAt(required): string
  The deposit release completion date.
• createdAt(required): string
  The date when the deposit release is initiated.
• customerDepositRef(required): string
  The customer deposit reference.
• customerRef(required): string
  The customer reference.
• error(required): string
  Error message for the deposit release.
• glCode(required): string
  The general ledger ID.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The deposit reference ID.
• notes(required): string
  Notes about the deposit release.
• reason(required): string
  Reason for the deposit release.
• releaseAmount: object Money
• releaseRef(required): string
  The deposit release reference.
• releaseType: integer (int32)
  The deposit release type.
  Allowed Values: PREPAYMENT, REFUND
• status(required): string
  The deposit release status.
  Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "glCode",
        "href",
        "id",
        "notes",
        "reason",
        "releaseRef",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit reference ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit release."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit release is initiated."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit release completion date."
        },
        "status":{
            "type":"string",
            "description":"The deposit release status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit release."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit release."
        },
        "releaseAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releaseType":{
            "type":"integer",
            "description":"The deposit release type.<br/>Allowed Values: PREPAYMENT, REFUND",
            "format":"int32"
        },
        "releaseRef":{
            "type":"string",
            "description":"The deposit release reference."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositRelease"
    }
}

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

• completedAt(required): string
  The deposit release completion date.
• createdAt(required): string
  The date when the deposit release is initiated.
• customerDepositRef(required): string
  The customer deposit reference.
• customerRef(required): string
  The customer reference.
• error(required): string
  Error message for the deposit release.
• glCode(required): string
  The general ledger ID.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The deposit reference ID.
• notes(required): string
  Notes about the deposit release.
• reason(required): string
  Reason for the deposit release.
• releaseAmount: object Money
• releaseRef(required): string
  The deposit release reference.
• releaseType: integer (int32)
  The deposit release type.
  Allowed Values: PREPAYMENT, REFUND
• status(required): string
  The deposit release status.
  Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "glCode",
        "href",
        "id",
        "notes",
        "reason",
        "releaseRef",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit reference ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit release."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit release is initiated."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit release completion date."
        },
        "status":{
            "type":"string",
            "description":"The deposit release status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit release."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit release."
        },
        "releaseAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releaseType":{
            "type":"integer",
            "description":"The deposit release type.<br/>Allowed Values: PREPAYMENT, REFUND",
            "format":"int32"
        },
        "releaseRef":{
            "type":"string",
            "description":"The deposit release reference."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositRelease"
    }
}

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 release was created successfully, and the ID of the new deposit release was returned.

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to release 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/depositRelease' -H 'content-type: application/json' -d @releaseDeposit.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.
• releaseDeposit.json is the JSON file that specifies the deposit to release.

Example of Request Body

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

{  
  "customerDepositRef": "0.0.0.1+-purchased_deposit+2171288+0",
  "releaseAmount": {
    "amount": 1,
    "currency": "INR"
  },
  "releaseType": "ZEROISE",
  "notes": "release deposit"
}

Example of Response Body

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

{
    "id": "0.0.0.1+-purchased_deposit+2171288",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositRelease/0.0.0.1+-purchased_deposit+2171288"
}

Back to Top