REST API Reference for Billing Care

Get Batch Payment Templates

get

/bcws/webresources/v1.0/batchpayments/templates

Gets the batch payment templates either from the path specified during installation or from the local configured location. The returned BatchPaymentTemplates contain the batch name and the template name.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The list of batch payment templates was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object batchPaymentTemplates

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

Nested Schema : batchPaymentTemplates

Type: object

Show Source

extension: object extension

The extended attributes.
locale(required): string

The template's locale, such as en_US or fr_FR. For a list of valid values, see \"Locale Names\" in BRM Developer's Guide.
payTypeCode: integer (int32)

The payment type code: cash payment batch (10011), check payment batch (10012), wire-transfer payment batch (10013), interbank payment order payment batch (10014), postal order payment batch (10015), or failed payment batch (10017).
payTypeName(required): string

The payment type name, such as Cash Payment Batch or Failed Payment Batch.
templateName(required): string

The file name for the batch payment template.

{
    "required":[
        "locale",
        "payTypeName",
        "templateName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "payTypeCode":{
            "type":"integer",
            "description":"The payment type code: cash payment batch (<b>10011</b>), check payment batch (<b>10012</b>), wire-transfer payment batch (<b>10013</b>), interbank payment order payment batch (<b>10014</b>), postal order payment batch (<b>10015</b>), or failed payment batch (<b>10017</b>).",
            "format":"int32"
        },
        "payTypeName":{
            "type":"string",
            "description":"The payment type name, such as Cash Payment Batch or Failed Payment Batch."
        },
        "templateName":{
            "type":"string",
            "description":"The file name for the batch payment template."
        },
        "locale":{
            "type":"string",
            "description":"The template's locale, such as <b>en_US</b> or <b>fr_FR</b>. For a list of valid values, see \\\"Locale Names\\\" in <i>BRM Developer's Guide</i>."
        }
    },
    "xml":{
        "name":"batchPaymentTemplates"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Examples

This example shows how to get all batch payment templates in your BRM environment 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/templates'

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.

[
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Cash Payment Batch",
      "templateName":"cash_payment_template.pit",
      "locale":null
   },
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Check Payment Batch",
      "templateName":"check_payment_template.pit",
      "locale":null
   },
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Failed Payment Batch",
      "templateName":"failed_payment_template.pit",
      "locale":null
   },
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Inter Bank Payment order Payment Batch",
      "templateName":"interbankpayorder_payment_template.pit",
      "locale":null
   },
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Postal order Payment Batch",
      "templateName":"postalorder_payment_template.pit",
      "locale":null
   },
   {
      "extension":null,
      "payTypeCode":0,
      "payTypeName":"Wire-Transfer Payment Batch",
      "templateName":"wire-transfer_payment_template.pit",
      "locale":null
   }
]