Jump to

• Request
• Response
• Examples

Get a Batch Template by Template ID

get

/bcws/webresources/v1.0/batchpayments/batchtemplates/{id}

Gets a batch template definition from the BRM database.

Request

Path Parameters

• id(required): string
  The ID of the /config/batch_templates object to be retrieved.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The batch template was retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema

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

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

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get a batch template definition from the BRM database by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/batchpayments/batchtemplates/0.0.0.1+-config-batch_templates-refund+601859'

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.

Example of Response Body

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

{
    "batchType": 2,
    "payType": 10011,
    "batchName": "Cash Refund Batch",
    "startRow": 16,
    "delimiter": "\t",
    "consecutive": 0,
    "qualifier": "none",
    "columnLink": [
        {
            "fieldName": "PIN_FLD_PAYMENT_AMOUNT",
            "index": 7,
            "purpose": 0
        },
        {
            "fieldName": "PIN_FLD_BILL_NO",
            "index": 2,
            "purpose": 0
        },
        {
            "fieldName": "PIN_FLD_ACCOUNT_NO",
            "index": 3,
            "purpose": 0
        },
        {
            "fieldName": "PIN_FLD_DESCR",
            "index": 6,
            "purpose": 0
        },
        {
            "fieldName": "PIN_FLD_EFFECTIVE_T",
            "index": 4,
            "purpose": 1
        },
        {
            "fieldName": "PIN_FLD_RECEIPT_NO",
            "index": 5,
            "purpose": 1
        }
    ],
    "headerStartRow": 4,
    "headerEndRow": 13,
    "footerStartRow": 0,
    "footerEndRow": 0,
    "batchTemplateRef": {
        "id": "0.0.0.1+-config-batch_templates-refund+601859",
        "uri": null
    }
}
 

Back to Top