REST API Reference for Billing Care

Create a Customer Deposit Payment

post

/bcws/webresources/v1.0/depositManagement/depositPayment

Creates a customer deposit payment.

Request

There are no request parameters for this operation.

Supported Media Types

The deposit payment. The minimum required parameters are:

customerRef
customerDepositRef
paymentAmount
paymentRef

Root Schema : schema

Type: object

Show Source

customerDepositRef(required): string

The customer deposit reference.
customerRef(required): string

The customer reference.
notes(required): string

Notes about the deposit payment.
payments: array payments

{
    "required":[
        "customerDepositRef",
        "customerRef",
        "notes"
    ],
    "type":"object",
    "properties":{
        "payments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositPayment"
            }
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit payment."
        }
    },
    "xml":{
        "name":"depositPayments"
    }
}

Nested Schema : payments

Type: array

Show Source

Array of: object DepositPayment

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

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:
- 10003 (Credit card)
- 10005 (Direct debit)
- 10011 (Cash)
- 10012 (Check)
- 10013 (Wire Transfer)
- 10014 (Inter-bank payment order)
- 10015 (Postal order)
- 3 (Prepayment)
- 4 (Other)
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>10003</b> (Credit card)</li><li><b>10005</b> (Direct debit)</li><li><b>10011</b> (Cash)</li><li><b>10012</b> (Check)</li><li><b>10013</b> (Wire Transfer)</li><li><b>10014</b> (Inter-bank payment order)</li><li><b>10015</b> (Postal order)</li><li><b>3</b> (Prepayment)</li><li><b>4</b> (Other)</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 : 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 : 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.

Response

201 Response

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

500 Response

An error occurred. An exception has been raised.

Examples

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

Example of Request Body

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

{
        "customerRef": "0.0.0.1+-account+2243823",
        "customerDepositRef": "0.0.0.1+-purchased_deposit+2519408",
        "notes":"abc",
        "payments": [
         {
            "paymentMethodType": "PREPAYMENT",
            "paymentRef": "0.0.0.1+-item-payment+2519378",
            "status": "COMPLETED",
            "paymentAmount": {
                "amount": 200,
                "currency": "EUR"
            }
         },
         {
            "paymentMethodType": "PREPAYMENT",
            "paymentRef": "0.0.0.1+-item-payment+2521840",
            "status": "COMPLETED",
            "paymentAmount": {
                "amount": 1300,
                "currency": "EUR"
            }
         },
         {
            "paymentMethodType": "CASH",
            "paymentRef": "R-1-2112",
            "status": "PENDING",
            "paymentAmount": {
                "amount": 1000,
                "currency": "EUR"
            }
         }
    	  ]
}

Example of Response Body

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

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