REST API Reference for Billing Care

Create a Batch Template

post

/bcws/webresources/v1.0/batchpayments/batchtemplates

Creates a batch template in the BRM database.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

batchName(required): string

The batch name, for example Cash Payment Batch or Check Payment Batch.
batchTemplateRef: object ResourceRef
batchType: integer (int32)

The type of the batch. Allowed values: 1 (payment), 2 (refund), or 3 (reversal).
columnLink: array columnLink

Indicates the order of the columns present in the batch.
consecutive: integer (int32)

Whether to treat consecutive delimiters as one (true) or not (false).
delimiter: string

The delimiter that is used to separate fields.
footerEndRow: integer (int32)

The row at which the footer ends.
footerStartRow: integer (int32)

The row from which the footer starts.
headerEndRow: integer (int32)

The row at which the header ends.
headerStartRow: integer (int32)

The row from which the header starts.
payType: 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)
- Any customized payment methods that have been added for your implementation
qualifier(required): string

Ignore delimiters between specific characters. Valid characters are ", ', or none.
startRow: integer (int32)

The row from which import should start.

{
    "required":[
        "batchName",
        "qualifier"
    ],
    "type":"object",
    "properties":{
        "batchType":{
            "type":"integer",
            "description":"The type of the batch.  Allowed values: <b>1</b> (payment), <b>2</b> (refund), or <b>3</b> (reversal).",
            "format":"int32"
        },
        "payType":{
            "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>Any customized payment methods that have been added for your implementation</li></ul>",
            "format":"int32"
        },
        "batchName":{
            "type":"string",
            "description":"The batch name, for example Cash Payment Batch or Check Payment Batch."
        },
        "startRow":{
            "type":"integer",
            "description":"The row from which import should start.",
            "format":"int32"
        },
        "delimiter":{
            "type":"string",
            "description":"The delimiter that is used to separate fields."
        },
        "consecutive":{
            "type":"integer",
            "description":"Whether to treat consecutive delimiters as one (<b>true</b>) or not (<b>false</b>).",
            "format":"int32"
        },
        "qualifier":{
            "type":"string",
            "description":"Ignore delimiters between specific characters. Valid characters are <b>\"</b>, <b>'</b>, or <b>none</b>."
        },
        "columnLink":{
            "type":"array",
            "description":"Indicates the order of the columns present in the batch.",
            "items":{
                "$ref":"#/components/schemas/ColumnLink"
            }
        },
        "headerStartRow":{
            "type":"integer",
            "description":"The row from which the header starts.",
            "format":"int32"
        },
        "headerEndRow":{
            "type":"integer",
            "description":"The row at which the header ends.",
            "format":"int32"
        },
        "footerStartRow":{
            "type":"integer",
            "description":"The row from which the footer starts.",
            "format":"int32"
        },
        "footerEndRow":{
            "type":"integer",
            "description":"The row at which the footer ends.",
            "format":"int32"
        },
        "batchTemplateRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"templateFields"
    }
}

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 : columnLink

Type: array

Indicates the order of the columns present in the batch.

Show Source

Array of: object ColumnLink

Indicates the order of the columns present in the batch.

{
    "type":"array",
    "description":"Indicates the order of the columns present in the batch.",
    "items":{
        "$ref":"#/components/schemas/ColumnLink"
    }
}

Nested Schema : ColumnLink

Type: object

Indicates the order of the columns present in the batch.

Show Source

fieldName(required): string

The name of the column.
index: integer (int32)

The position in which the column appears.
purpose: integer (int32)

Whether the field is specific to the batch (1) or not (0).

{
    "required":[
        "fieldName"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The name of the column."
        },
        "index":{
            "type":"integer",
            "description":"The position in which the column appears.",
            "format":"int32"
        },
        "purpose":{
            "type":"integer",
            "description":"Whether the field is specific to the batch (<b>1</b>) or not (<b>0</b>).",
            "format":"int32"
        }
    },
    "description":"Indicates the order of the columns present in the batch."
}

Root Schema : schema

Type: object

Show Source

batchName(required): string

The batch name, for example Cash Payment Batch or Check Payment Batch.
batchTemplateRef: object ResourceRef
batchType: integer (int32)

The type of the batch. Allowed values: 1 (payment), 2 (refund), or 3 (reversal).
columnLink: array columnLink

Indicates the order of the columns present in the batch.
consecutive: integer (int32)

Whether to treat consecutive delimiters as one (true) or not (false).
delimiter: string

The delimiter that is used to separate fields.
footerEndRow: integer (int32)

The row at which the footer ends.
footerStartRow: integer (int32)

The row from which the footer starts.
headerEndRow: integer (int32)

The row at which the header ends.
headerStartRow: integer (int32)

The row from which the header starts.
payType: 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)
- Any customized payment methods that have been added for your implementation
qualifier(required): string

Ignore delimiters between specific characters. Valid characters are ", ', or none.
startRow: integer (int32)

The row from which import should start.

{
    "required":[
        "batchName",
        "qualifier"
    ],
    "type":"object",
    "properties":{
        "batchType":{
            "type":"integer",
            "description":"The type of the batch.  Allowed values: <b>1</b> (payment), <b>2</b> (refund), or <b>3</b> (reversal).",
            "format":"int32"
        },
        "payType":{
            "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>Any customized payment methods that have been added for your implementation</li></ul>",
            "format":"int32"
        },
        "batchName":{
            "type":"string",
            "description":"The batch name, for example Cash Payment Batch or Check Payment Batch."
        },
        "startRow":{
            "type":"integer",
            "description":"The row from which import should start.",
            "format":"int32"
        },
        "delimiter":{
            "type":"string",
            "description":"The delimiter that is used to separate fields."
        },
        "consecutive":{
            "type":"integer",
            "description":"Whether to treat consecutive delimiters as one (<b>true</b>) or not (<b>false</b>).",
            "format":"int32"
        },
        "qualifier":{
            "type":"string",
            "description":"Ignore delimiters between specific characters. Valid characters are <b>\"</b>, <b>'</b>, or <b>none</b>."
        },
        "columnLink":{
            "type":"array",
            "description":"Indicates the order of the columns present in the batch.",
            "items":{
                "$ref":"#/components/schemas/ColumnLink"
            }
        },
        "headerStartRow":{
            "type":"integer",
            "description":"The row from which the header starts.",
            "format":"int32"
        },
        "headerEndRow":{
            "type":"integer",
            "description":"The row at which the header ends.",
            "format":"int32"
        },
        "footerStartRow":{
            "type":"integer",
            "description":"The row from which the footer starts.",
            "format":"int32"
        },
        "footerEndRow":{
            "type":"integer",
            "description":"The row at which the footer ends.",
            "format":"int32"
        },
        "batchTemplateRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"templateFields"
    }
}

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 : columnLink

Type: array

Indicates the order of the columns present in the batch.

Show Source

Array of: object ColumnLink

Indicates the order of the columns present in the batch.

{
    "type":"array",
    "description":"Indicates the order of the columns present in the batch.",
    "items":{
        "$ref":"#/components/schemas/ColumnLink"
    }
}

Nested Schema : ColumnLink

Type: object

Indicates the order of the columns present in the batch.

Show Source

fieldName(required): string

The name of the column.
index: integer (int32)

The position in which the column appears.
purpose: integer (int32)

Whether the field is specific to the batch (1) or not (0).

{
    "required":[
        "fieldName"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The name of the column."
        },
        "index":{
            "type":"integer",
            "description":"The position in which the column appears.",
            "format":"int32"
        },
        "purpose":{
            "type":"integer",
            "description":"Whether the field is specific to the batch (<b>1</b>) or not (<b>0</b>).",
            "format":"int32"
        }
    },
    "description":"Indicates the order of the columns present in the batch."
}

Response

Supported Media Types

application/xml
application/json

201 Response

The batch template was created successfully.

Root Schema : schema

Type: object

Show Source

batchName(required): string

The batch name, for example Cash Payment Batch or Check Payment Batch.
batchTemplateRef: object ResourceRef
batchType: integer (int32)

The type of the batch. Allowed values: 1 (payment), 2 (refund), or 3 (reversal).
columnLink: array columnLink

Indicates the order of the columns present in the batch.
consecutive: integer (int32)

Whether to treat consecutive delimiters as one (true) or not (false).
delimiter: string

The delimiter that is used to separate fields.
footerEndRow: integer (int32)

The row at which the footer ends.
footerStartRow: integer (int32)

The row from which the footer starts.
headerEndRow: integer (int32)

The row at which the header ends.
headerStartRow: integer (int32)

The row from which the header starts.
payType: 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)
- Any customized payment methods that have been added for your implementation
qualifier(required): string

Ignore delimiters between specific characters. Valid characters are ", ', or none.
startRow: integer (int32)

The row from which import should start.

{
    "required":[
        "batchName",
        "qualifier"
    ],
    "type":"object",
    "properties":{
        "batchType":{
            "type":"integer",
            "description":"The type of the batch.  Allowed values: <b>1</b> (payment), <b>2</b> (refund), or <b>3</b> (reversal).",
            "format":"int32"
        },
        "payType":{
            "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>Any customized payment methods that have been added for your implementation</li></ul>",
            "format":"int32"
        },
        "batchName":{
            "type":"string",
            "description":"The batch name, for example Cash Payment Batch or Check Payment Batch."
        },
        "startRow":{
            "type":"integer",
            "description":"The row from which import should start.",
            "format":"int32"
        },
        "delimiter":{
            "type":"string",
            "description":"The delimiter that is used to separate fields."
        },
        "consecutive":{
            "type":"integer",
            "description":"Whether to treat consecutive delimiters as one (<b>true</b>) or not (<b>false</b>).",
            "format":"int32"
        },
        "qualifier":{
            "type":"string",
            "description":"Ignore delimiters between specific characters. Valid characters are <b>\"</b>, <b>'</b>, or <b>none</b>."
        },
        "columnLink":{
            "type":"array",
            "description":"Indicates the order of the columns present in the batch.",
            "items":{
                "$ref":"#/components/schemas/ColumnLink"
            }
        },
        "headerStartRow":{
            "type":"integer",
            "description":"The row from which the header starts.",
            "format":"int32"
        },
        "headerEndRow":{
            "type":"integer",
            "description":"The row at which the header ends.",
            "format":"int32"
        },
        "footerStartRow":{
            "type":"integer",
            "description":"The row from which the footer starts.",
            "format":"int32"
        },
        "footerEndRow":{
            "type":"integer",
            "description":"The row at which the footer ends.",
            "format":"int32"
        },
        "batchTemplateRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"templateFields"
    }
}

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 : columnLink

Type: array

Indicates the order of the columns present in the batch.

Show Source

Array of: object ColumnLink

Indicates the order of the columns present in the batch.

{
    "type":"array",
    "description":"Indicates the order of the columns present in the batch.",
    "items":{
        "$ref":"#/components/schemas/ColumnLink"
    }
}

Nested Schema : ColumnLink

Type: object

Indicates the order of the columns present in the batch.

Show Source

fieldName(required): string

The name of the column.
index: integer (int32)

The position in which the column appears.
purpose: integer (int32)

Whether the field is specific to the batch (1) or not (0).

{
    "required":[
        "fieldName"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The name of the column."
        },
        "index":{
            "type":"integer",
            "description":"The position in which the column appears.",
            "format":"int32"
        },
        "purpose":{
            "type":"integer",
            "description":"Whether the field is specific to the batch (<b>1</b>) or not (<b>0</b>).",
            "format":"int32"
        }
    },
    "description":"Indicates the order of the columns present in the batch."
}

500 Response

An internal server error occurred.

Examples

This example shows how to create a batch template in the BRM database 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/v1.0/batchpayments/batchtemplates' -H 'content-type: application/json' -d @create.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.
create.json is the JSON file that specifies the template to create.

Example of Request Body

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

{
    "batchName": "Postal order Reversal Batch",
    "batchType": 3,
    "payType": 10015,
    "startRow": 16,
    "delimiter": "\t",
    "consecutive": 0,
    "qualifier": "none",
    "columnLink": [
        {
            "fieldName": "PIN_FLD_PAYMENT_TRANS_ID",
            "index": 2,
            "purpose":0
        },
        {
            "fieldName": "PIN_FLD_FIRST_NAME",
            "index": 4,
            "purpose":0
        },
        {
            "fieldName": "PIN_FLD_LAST_NAME",
            "index": 5,
            "purpose":0
        },
        {
            "fieldName": "PIN_FLD_DESCR",
            "index": 10,
            "purpose":0
        },
        {
            "fieldName": "PIN_FLD_ORDER_ID",
            "index": 7,
            "purpose":1
        },
        {
            "fieldName": "PIN_FLD_REASON_CODE",
            "index": 8,
            "purpose":1
        },
        {
            "fieldName": "PIN_FLD_EFFECTIVE_T",
            "index": 9,
            "purpose":1
        }
    ],
    "headerStartRow": 4,
    "headerEndRow": 13,
    "footerStartRow": 0,
    "footerEndRow": 0
}

Example of Response Body

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

{
    "id": "0.0.0.1+-config-batch_templates-reversal+599456",
    "uri": null
}