Jump to

• Request
• Response
• Examples

Get Batch Payment Files

get

/bcws/webresources/v1.0/batchpayments/poll

Gets the list of batch payment files. This method polls the Unprocessed, Processing, and Error folders and, if there are any changes in a folder, it returns information about the batch payment files.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of batch payment files was returned successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• currency(required): string
  The currency of all payments in the batch payment file.
• extension: object extension
  The extended attributes.
• fileCreationDate(required): string (date-time)
  The date and time the batch payment file was created.
• fileName(required): string
  The file name for the batch payment file.
• fileSize: number (double)
  The size of the batch payment file.
• institutionName(required): string
  The name of the institution that created the batch payment file.
• lockBoxId(required): string
  The lockbox's ID.
• lockBoxName: string
  The lockbox's name.
• noOfPayments: integer (int64)
  The number of payments in the batch payment file.
• status: integer (int32)
  The status of the batch payment file. Can be one of the following:

  • 1: New
  • 2: Format error
  • 3: Unknown template
  • 4: Processing error
  • 5: Threshold exceeded
  • 6: Processing
• templateName(required): string
  The template name.

{
    "required":[
        "currency",
        "fileCreationDate",
        "fileName",
        "institutionName",
        "lockBoxId",
        "templateName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "lockBoxName":{
            "type":"string",
            "description":"The lockbox's name."
        },
        "lockBoxId":{
            "type":"string",
            "description":"The lockbox's ID."
        },
        "institutionName":{
            "type":"string",
            "description":"The name of the institution that created the batch payment file."
        },
        "templateName":{
            "type":"string",
            "description":"The template name."
        },
        "currency":{
            "type":"string",
            "description":"The currency of all payments in the batch payment file."
        },
        "fileName":{
            "type":"string",
            "description":"The file name for the batch payment file."
        },
        "fileCreationDate":{
            "type":"string",
            "description":"The date and time the batch payment file was created.",
            "format":"date-time"
        },
        "fileSize":{
            "type":"number",
            "description":"The size of the batch payment file.",
            "format":"double"
        },
        "noOfPayments":{
            "type":"integer",
            "description":"The number of payments in the batch payment file.",
            "format":"int64"
        },
        "status":{
            "type":"integer",
            "description":"The status of the batch payment file. Can be one of the following: <ul><li><b>1</b>: New</li><li><b>2</b>: Format error</li><li><b>3</b>: Unknown template</li><li><b>4</b>: Processing error</li><li><b>5</b>: Threshold exceeded</li><li><b>6</b>: Processing</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"paymentBatchFileHeader"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get information about all unprocessed, processing, and error batch payment files 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/poll'

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,
      "lockBoxName":null,
      "lockBoxId":null,
      "institutionName":"Cash Payment Batch",
      "templateName":null,
      "currency":"840",
      "fileName":"samplePmt2.pmt",
      "fileCreationDate":1612440698046,
      "fileSize":0.578125,
      "noOfPayments":1,
      "status":1
   }
]

Back to Top