REST API Reference for Billing Care

Upload a Batch Payment File

post

/bcws/webresources/v1.0/batchpayments/upload

Imports a payment batch file, validates its content, and then uploads it to a directory.

Request

Query Parameters

override(required): boolean

Whether to override an older version of the batch payment file (true) or not (false).

Supported Media Types

multipart/form-data

Root Schema : schema

Type: object

Show Source

file: object FormDataContentDisposition
filename: string

{
    "type":"object",
    "properties":{
        "filename":{
            "type":"string"
        },
        "file":{
            "$ref":"#/components/schemas/FormDataContentDisposition"
        }
    }
}

Nested Schema : FormDataContentDisposition

Type: object

Show Source

creationDate: string (date-time)
fileName: string
modificationDate: string (date-time)
name: string
parameters: object parameters

Additional Properties Allowed: additionalProperties
readDate: string (date-time)
size: integer (int64)
type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

The batch payment file was uploaded successfully.

Root Schema : paymentBatchFileHeader

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.

201 Response

The batch payment file was uploaded successfully. The batch payment file header details such as the file name, file creation date, number of payments, and institution name are returned.

500 Response

An internal server error occurred.

Examples

This example shows how to upload a batch payment file 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/upload' -F @batchPaymentData.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.
batchPaymentData.json is the JSON file that specifies the batch payment file to upload.

Example of Request Body

This example shows the contents of the batchPaymentData.json form file sent as the request body to specify the details of the batch file to be uploaded. The cashPayment.pmt file contains the actual payment details.

{
	"fileName': "cashPayment.pmt",
	"name": "Cash Batch Payment",
	"currency": "840",
	"institutionName": "Cash Payment Batch",
	"lockBoxName": "Cash Payment Batch",
	"lockBoxId": "10011",
	"fileCreationDate": 1612442456000,
	"fileSize": 0.7109375,
	"noOfPayments": 2,
	"status": 1,
	"templateName": null
}

Example of Response Body

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

{
    "extension": null,
    "lockBoxName": "Cash Payment Batch",
    "lockBoxId": "10011",
    "institutionName": "Cash Payment Batch",
    "templateName": null,
    "currency": "840",
    "fileName": "cashPayment.pmt",
    "fileCreationDate": 1612442456000,
    "fileSize": 0.7109375,
    "noOfPayments": 2,
    "status": 1
}