REST API Reference for Billing Care

Transfer a Customer Deposit

post

/bcws/webresources/v1.0/depositManagement/depositTransfer

Transfers the specified customer deposit to another customer.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

The deposit to transfer. The minimum required parameters are:

customerRef
customerDepositRef
destCustomerRef

Root Schema : schema

Type: object

Show Source

completedAt(required): string

The deposit transfer completion date.
createdAt(required): string

The date when the deposit transfer is initiated.
customerDepositRef(required): string

The customer deposit reference.
customerRef(required): string

The customer reference.
destBillProfileRef(required): string

The destination bill profile reference for the transfer.
destCustomerRef(required): string

The destination customer reference for the transfer.
destServiceRef(required): string

The destination service reference for the transfer.
error(required): string

Error message for the deposit transfer.
glCode(required): string

The general ledger ID.
href(required): string

The unique resource URL, used to get the object.
id(required): string

The deposit transfer ID.
reason(required): string

Reason for the deposit transfer.
status(required): string

The deposit transfer status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED
transferAmount: object Money
transferRef(required): string

The deposit transfer reference.

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "destBillProfileRef",
        "destCustomerRef",
        "destServiceRef",
        "error",
        "glCode",
        "href",
        "id",
        "reason",
        "status",
        "transferRef"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit transfer ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit transfer completion date."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit transfer is initiated."
        },
        "status":{
            "type":"string",
            "description":"The deposit transfer status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "destCustomerRef":{
            "type":"string",
            "description":"The destination customer reference for the transfer."
        },
        "destServiceRef":{
            "type":"string",
            "description":"The destination service reference for the transfer."
        },
        "destBillProfileRef":{
            "type":"string",
            "description":"The destination bill profile reference for the transfer."
        },
        "transferRef":{
            "type":"string",
            "description":"The deposit transfer reference."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit transfer."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit transfer."
        },
        "transferAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositTransfer"
    }
}

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

The deposit to transfer. The minimum required parameters are:

customerRef
customerDepositRef
destCustomerRef

Root Schema : schema

Type: object

Show Source

completedAt(required): string

The deposit transfer completion date.
createdAt(required): string

The date when the deposit transfer is initiated.
customerDepositRef(required): string

The customer deposit reference.
customerRef(required): string

The customer reference.
destBillProfileRef(required): string

The destination bill profile reference for the transfer.
destCustomerRef(required): string

The destination customer reference for the transfer.
destServiceRef(required): string

The destination service reference for the transfer.
error(required): string

Error message for the deposit transfer.
glCode(required): string

The general ledger ID.
href(required): string

The unique resource URL, used to get the object.
id(required): string

The deposit transfer ID.
reason(required): string

Reason for the deposit transfer.
status(required): string

The deposit transfer status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED
transferAmount: object Money
transferRef(required): string

The deposit transfer reference.

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "destBillProfileRef",
        "destCustomerRef",
        "destServiceRef",
        "error",
        "glCode",
        "href",
        "id",
        "reason",
        "status",
        "transferRef"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit transfer ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit transfer completion date."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit transfer is initiated."
        },
        "status":{
            "type":"string",
            "description":"The deposit transfer status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "destCustomerRef":{
            "type":"string",
            "description":"The destination customer reference for the transfer."
        },
        "destServiceRef":{
            "type":"string",
            "description":"The destination service reference for the transfer."
        },
        "destBillProfileRef":{
            "type":"string",
            "description":"The destination bill profile reference for the transfer."
        },
        "transferRef":{
            "type":"string",
            "description":"The deposit transfer reference."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit transfer."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit transfer."
        },
        "transferAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositTransfer"
    }
}

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

Response

201 Response

The customer deposit transfer was created successfully.

500 Response

An error occurred. An exception has been raised.

Examples

This example shows how to transfer 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/depositTransfer' -H 'content-type: application/json' -d @transferDeposit.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.
transferDeposit.json is the JSON file that specifies the deposit transfer to create.

Example of Request Body

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

{
    "customerRef": "0.0.0.1+-account+2655150",
    "customerDepositRef": "0.0.0.1+-purchased_deposit+2707380",
    "destCustomerRef": "0.0.0.1+-account+2652930",
    "transferAmount": {
        "amount": 50,
        "currency": "EUR"
    },
    "destBillProfileRef": "0.0.0.1+-billinfo+2650242",
    "destServiceRef": "0.0.0.1+-service-telco-gsm+2651039"
}

Example of Response Body

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

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