Jump to

• Request
• Response
• Examples

Update a Customer Deposit

patch

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

Updates the specified customer deposit.

Request

Path Parameters

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

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• customerDeposit: object CustomerDeposit
• payments(required): array payments

{
    "required":[
        "payments"
    ],
    "type":"object",
    "properties":{
        "payments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositPayment"
            }
        },
        "customerDeposit":{
            "$ref":"#/components/schemas/CustomerDeposit"
        }
    },
    "xml":{
        "name":"depositOrder"
    }
}

Nested Schema : CustomerDeposit

Type: object

Show Source

• balanceAmount: object Money
• billProfileRef(required): string
  The bill profile reference.
• code(required): string
  The external identifier.
• createdAt(required): string
  The date when the customer deposit is created.
• customerRef(required): string
  The customer reference.
• depositSpecName(required): string
  The deposit specoification name.
• depositSpecRef(required): string
  The deposit specification reference.
• discountAmount: object Money
• effectiveDate(required): string
  The date from which the customer deposit is effective.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The customer deposit ID.
• interestAmount: object Money
• modifiedAt(required): string
  The date when the customer deposit is modified.
• notes: string
  The notes for the customer deposit.
• receivedAmount: object Money
• releasedAmount: object Money
• releaseType: integer (int32)
  The release type. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
• serviceRef(required): string
  The service reference.
• status(required): string
  The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED
• totalAmount: object Money
• transactions(required): array transactions
• validFor: object TimePeriod
• validityRule: object DepositValidityRule

{
    "required":[
        "billProfileRef",
        "code",
        "createdAt",
        "customerRef",
        "depositSpecName",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "modifiedAt",
        "serviceRef",
        "status",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The customer deposit ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the customer deposit is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the customer deposit is modified."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date from which the customer deposit is effective."
        },
        "status":{
            "type":"string",
            "description":"The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED"
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"The notes for the customer deposit."
        },
        "receivedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releasedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "interestAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "balanceAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "discountAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "depositSpecName":{
            "type":"string",
            "description":"The deposit specoification name."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "releaseType":{
            "type":"integer",
            "description":"The release type. Allowed Values: <b>1</b> (Prepayment), <b>2</b> (Refund), <b>3</b> (Zeroise).",
            "format":"int32"
        },
        "code":{
            "type":"string",
            "description":"The external identifier."
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomerDepositTransactions"
            }
        },
        "validityRule":{
            "$ref":"#/components/schemas/DepositValidityRule"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    }
}

Nested Schema : payments

Type: array

Show Source

• Array of: object DepositPayment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositPayment"
    }
}

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

Nested Schema : transactions

Type: array

Show Source

• Array of: object CustomerDepositTransactions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerDepositTransactions"
    }
}

Nested Schema : TimePeriod

Type: object

Show Source

• endDateTime(required): string
• startDateTime(required): string

{
    "required":[
        "endDateTime",
        "startDateTime"
    ],
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        }
    }
}

Nested Schema : DepositValidityRule

Type: object

Show Source

• endOffsetPeriodUnit: integer (int32)
  The unit of measure for the end offset.
  Allowed Values:

  • 0 (Month)
  • 1 (Day)
  • 2 (Week)
  • 3 (Year)
• endOffsetPeriodValue: integer (int32)
  The value for the end offset.

{
    "type":"object",
    "properties":{
        "endOffsetPeriodUnit":{
            "type":"integer",
            "description":"The unit of measure for the end offset.<br/>Allowed Values: <ul><li><b>0</b> (Month)</li><li><b>1</b> (Day)</li><li><b>2</b> (Week)</li><li><b>3</b> (Year)</li></ul>",
            "format":"int32"
        },
        "endOffsetPeriodValue":{
            "type":"integer",
            "description":"The value for the end offset.",
            "format":"int32"
        }
    }
}

Nested Schema : CustomerDepositTransactions

Type: object

Show Source

• transactionRef(required): string
  Reference to the transaction record.
• transactions(required): string
  The transactions.

{
    "required":[
        "transactionRef",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "transactions":{
            "type":"string",
            "description":"The transactions."
        },
        "transactionRef":{
            "type":"string",
            "description":"Reference to the transaction record."
        }
    }
}

Nested Schema : DepositPayment

Type: object

Show Source

• completedAt: string
  The deposit payment completion date.
• createdAt: string
  The date when the deposit payment is created.
• currency: integer (int32)
  The code for the payment's currency.
• customerDepositRef: string
  The customer deposit reference.
• customerRef: string
  The customer reference.
• glCode: string
  The general ledger ID.
• href: string
  The unique resource URL, used to get the object.
• id: string
  The deposit payment ID.
• notes: string
  Notes about the deposit payment.
• payinfoTypeObject: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }
• paymentAmount: object Money
• paymentMethodType: integer (int32)
  The payment method type. Allowed Values:

  • 10011 (Cash payment batch)
  • 10012 (Check payment batch)
  • 10013 (Wire-transfer payment batch)
  • 10014 (Inter-bank payment order payment batch)
  • 10015 (Postal order payment batch)
  • 10017 (Failed payment batch)
• paymentRef: string
  The payment reference.
• status: integer (int32)
  The deposit payment status. Allowed Values: 1 (Completed), 2 (Failed), 3 (Pending).

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit payment ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit payment is created."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit payment completion date."
        },
        "status":{
            "type":"integer",
            "description":"The deposit payment status. Allowed Values: <b>1</b> (Completed), <b>2</b> (Failed), <b>3</b> (Pending).",
            "format":"int32"
        },
        "paymentAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit payment."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        },
        "paymentMethodType":{
            "type":"integer",
            "description":"The payment method type. Allowed Values: <ul><li><b>10011</b> (Cash payment batch)</li><li><b>10012</b> (Check payment batch)</li><li><b>10013</b> (Wire-transfer payment batch)</li><li><b>10014</b> (Inter-bank payment order payment batch)</li><li><b>10015</b> (Postal order payment batch)</li><li><b>10017</b> (Failed payment batch)</li></ul>",
            "format":"int32"
        },
        "paymentRef":{
            "type":"string",
            "description":"The payment reference."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "currency":{
            "type":"integer",
            "description":"The code for the payment's currency.",
            "format":"int32"
        },
        "payinfoTypeObject":{
            "$ref":"#/components/schemas/PaymentTypeBase"
        }
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountObj: object ResourceRef
• creationDate: string (date-time)
  The date and time the payment type was created.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• name: string
  The name of the payment type.
• paymentType: integer (int32)
  The payment type.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• customerDeposit: object CustomerDeposit
• payments(required): array payments

{
    "required":[
        "payments"
    ],
    "type":"object",
    "properties":{
        "payments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositPayment"
            }
        },
        "customerDeposit":{
            "$ref":"#/components/schemas/CustomerDeposit"
        }
    },
    "xml":{
        "name":"depositOrder"
    }
}

Nested Schema : CustomerDeposit

Type: object

Show Source

• balanceAmount: object Money
• billProfileRef(required): string
  The bill profile reference.
• code(required): string
  The external identifier.
• createdAt(required): string
  The date when the customer deposit is created.
• customerRef(required): string
  The customer reference.
• depositSpecName(required): string
  The deposit specoification name.
• depositSpecRef(required): string
  The deposit specification reference.
• discountAmount: object Money
• effectiveDate(required): string
  The date from which the customer deposit is effective.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The customer deposit ID.
• interestAmount: object Money
• modifiedAt(required): string
  The date when the customer deposit is modified.
• notes: string
  The notes for the customer deposit.
• receivedAmount: object Money
• releasedAmount: object Money
• releaseType: integer (int32)
  The release type. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
• serviceRef(required): string
  The service reference.
• status(required): string
  The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED
• totalAmount: object Money
• transactions(required): array transactions
• validFor: object TimePeriod
• validityRule: object DepositValidityRule

{
    "required":[
        "billProfileRef",
        "code",
        "createdAt",
        "customerRef",
        "depositSpecName",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "modifiedAt",
        "serviceRef",
        "status",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The customer deposit ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the customer deposit is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the customer deposit is modified."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date from which the customer deposit is effective."
        },
        "status":{
            "type":"string",
            "description":"The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED"
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"The notes for the customer deposit."
        },
        "receivedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releasedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "interestAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "balanceAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "discountAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "depositSpecName":{
            "type":"string",
            "description":"The deposit specoification name."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "releaseType":{
            "type":"integer",
            "description":"The release type. Allowed Values: <b>1</b> (Prepayment), <b>2</b> (Refund), <b>3</b> (Zeroise).",
            "format":"int32"
        },
        "code":{
            "type":"string",
            "description":"The external identifier."
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomerDepositTransactions"
            }
        },
        "validityRule":{
            "$ref":"#/components/schemas/DepositValidityRule"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    }
}

Nested Schema : payments

Type: array

Show Source

• Array of: object DepositPayment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositPayment"
    }
}

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

Nested Schema : transactions

Type: array

Show Source

• Array of: object CustomerDepositTransactions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerDepositTransactions"
    }
}

Nested Schema : TimePeriod

Type: object

Show Source

• endDateTime(required): string
• startDateTime(required): string

{
    "required":[
        "endDateTime",
        "startDateTime"
    ],
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        }
    }
}

Nested Schema : DepositValidityRule

Type: object

Show Source

• endOffsetPeriodUnit: integer (int32)
  The unit of measure for the end offset.
  Allowed Values:

  • 0 (Month)
  • 1 (Day)
  • 2 (Week)
  • 3 (Year)
• endOffsetPeriodValue: integer (int32)
  The value for the end offset.

{
    "type":"object",
    "properties":{
        "endOffsetPeriodUnit":{
            "type":"integer",
            "description":"The unit of measure for the end offset.<br/>Allowed Values: <ul><li><b>0</b> (Month)</li><li><b>1</b> (Day)</li><li><b>2</b> (Week)</li><li><b>3</b> (Year)</li></ul>",
            "format":"int32"
        },
        "endOffsetPeriodValue":{
            "type":"integer",
            "description":"The value for the end offset.",
            "format":"int32"
        }
    }
}

Nested Schema : CustomerDepositTransactions

Type: object

Show Source

• transactionRef(required): string
  Reference to the transaction record.
• transactions(required): string
  The transactions.

{
    "required":[
        "transactionRef",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "transactions":{
            "type":"string",
            "description":"The transactions."
        },
        "transactionRef":{
            "type":"string",
            "description":"Reference to the transaction record."
        }
    }
}

Nested Schema : DepositPayment

Type: object

Show Source

• completedAt: string
  The deposit payment completion date.
• createdAt: string
  The date when the deposit payment is created.
• currency: integer (int32)
  The code for the payment's currency.
• customerDepositRef: string
  The customer deposit reference.
• customerRef: string
  The customer reference.
• glCode: string
  The general ledger ID.
• href: string
  The unique resource URL, used to get the object.
• id: string
  The deposit payment ID.
• notes: string
  Notes about the deposit payment.
• payinfoTypeObject: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }
• paymentAmount: object Money
• paymentMethodType: integer (int32)
  The payment method type. Allowed Values:

  • 10011 (Cash payment batch)
  • 10012 (Check payment batch)
  • 10013 (Wire-transfer payment batch)
  • 10014 (Inter-bank payment order payment batch)
  • 10015 (Postal order payment batch)
  • 10017 (Failed payment batch)
• paymentRef: string
  The payment reference.
• status: integer (int32)
  The deposit payment status. Allowed Values: 1 (Completed), 2 (Failed), 3 (Pending).

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit payment ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit payment is created."
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit payment completion date."
        },
        "status":{
            "type":"integer",
            "description":"The deposit payment status. Allowed Values: <b>1</b> (Completed), <b>2</b> (Failed), <b>3</b> (Pending).",
            "format":"int32"
        },
        "paymentAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit payment."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        },
        "paymentMethodType":{
            "type":"integer",
            "description":"The payment method type. Allowed Values: <ul><li><b>10011</b> (Cash payment batch)</li><li><b>10012</b> (Check payment batch)</li><li><b>10013</b> (Wire-transfer payment batch)</li><li><b>10014</b> (Inter-bank payment order payment batch)</li><li><b>10015</b> (Postal order payment batch)</li><li><b>10017</b> (Failed payment batch)</li></ul>",
            "format":"int32"
        },
        "paymentRef":{
            "type":"string",
            "description":"The payment reference."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "currency":{
            "type":"integer",
            "description":"The code for the payment's currency.",
            "format":"int32"
        },
        "payinfoTypeObject":{
            "$ref":"#/components/schemas/PaymentTypeBase"
        }
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountObj: object ResourceRef
• creationDate: string (date-time)
  The date and time the payment type was created.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• name: string
  The name of the payment type.
• paymentType: integer (int32)
  The payment type.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Back to Top

Response

201 Response

The customer deposit order was updated successfully, and the ID of the updated deposit was returned.

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

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

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/depositManagement/customerDeposit/0.0.0.1+-purchased_deposit+2552521' -H 'content-type: application/json' -d @updateDeposit.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.
• updateDeposit.json is the JSON file that specifies the details to update.

Example of Request Body

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

{
    "customerDeposit": {
        "customerRef": "0.0.0.1+-account+2205426",
        "billProfileRef": "0.0.0.1+-billinfo+2206194",
        "depositSpecRef": "0.0.0.1+-deposit_specification+2207626",
        "serviceRef": "0.0.0.1+-service-telco-gsm+2203914",
		"validityRule": {
            "endOffsetPeriodUnit": "DAYS",
            "endOffsetPeriodValue": "10"
        },
        "totalAmount": {
            "amount": "123",
            "currency": "EUR"
        },
        "releaseType": "PREPAYMENT"
       
    },
    "payments": [
        {
            "paymentAmount": {
                "amount": 99.95,
                "currency": "EUR"
            },
            "notes": "HELO",
            "glCode": "101",
            "paymentMethodType": "CASH",
            "paymentRef": "0.0.0.1+-payment+1563385",
            "status": "PENDING"
        }
    ]
}

Example of Response Body

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

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

Back to Top