1. REST API Reference for Billing Care
  2. Tasks
  3. Batch Payments

Validate a Reversal Batch

post

/bcws/webresources/v1.0/batchreversal/validate

Validates each record in the reversal batch and returns the records with validation status and any appropriate messages.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : BatchInfoType
Type: object
Show Source
Nested Schema : batchRecords
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : BatchRecordsType
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billinfo
Type: array
Show Source
Nested Schema : billItem
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : payInfo
Type: object
The payment information.
Nested Schema : BillinfoType
Type: object
Show Source
Nested Schema : bills
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : items
Type: array
Show Source
Nested Schema : BillItemType
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : BatchInfoType
Type: object
Show Source
Nested Schema : batchRecords
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : BatchRecordsType
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billinfo
Type: array
Show Source
Nested Schema : billItem
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : payInfo
Type: object
The payment information.
Nested Schema : BillinfoType
Type: object
Show Source
Nested Schema : bills
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : items
Type: array
Show Source
Nested Schema : BillItemType
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Back to Top

Response

200 Response

The validation process is complete.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to validate each record in the reversal batch and return the records with validation status and any appropriate messages 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/batchreversal/validate' -H 'content-type: application/json' -d @validate.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.
  • validate.json is the JSON file that specifies the items to validate.

Example of Request Body

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

{
    "batchInformation": {
        "batchCurrency": 840,
        "batchId": "",
        "batchTypeCode": 10012,
        "batchDate": 1712926495000,
        "lockBoxId": "LA-136",
        "lockBoxDate": 1712926970000
    },
    "batchRecords": [
        {
            "accountNumber": "0.0.0.1-117491",
            "amount": 2,
            "payInfo": {
                "PIN_FLD_CHECK_NO": "",
                "PIN_FLD_BANK_CODE": "",
                "PIN_FLD_BANK_ACCOUNT_NO": "",
                "PIN_FLD_REASON_CODE": "",
                "PIN_FLD_EFFECTIVE_T": 1712926495500
            },
            "paymentId": "T1,66,0"
        },
        {
            "accountNumber": "0.0.0.1-117491",
            "amount": 4,
            "payInfo": {
                "PIN_FLD_CHECK_NO": "",
                "PIN_FLD_BANK_CODE": "",
                "PIN_FLD_BANK_ACCOUNT_NO": "",
                "PIN_FLD_REASON_CODE": "",
                "PIN_FLD_EFFECTIVE_T": 1712926495500
            },
            "paymentId": "T1,65,0"
        }
    ]
}

Example of Response Body

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

{
    "extension": null,
    "batchInformation": {
        "extension": null,
        "lockBoxId": "LA-136",
        "lockBoxDate": 1712926970000,
        "batchCurrency": 840,
        "batchId": "",
        "batchTypeCode": "10012",
        "batchTypeName": null,
        "batchDate": 1712926495000,
        "batchTotalRecords": 0
    },
    "batchRecords": [
        {
            "extension": null,
            "accountNumber": "0.0.0.1-117491",
            "accountCurrency": null,
            "paymentId": "T1,66,0",
            "accountRef": {
                "id": "0.0.0.1+-account+117491",
                "uri": null
            },
            "billNumber": null,
            "allocationDeferred": null,
            "amount": 2,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": "1712926495000",
                "PIN_FLD_REASON_CODE": ""
            },
            "status": 1,
            "statusDescription": 0,
            "comment": null,
            "firstName": "Thea",
            "lastName": "Rivera",
            "dueAmount": null,
            "channelId": null,
            "billItem": [],
            "billinfo": [],
            "statusCode": null,
            "reasonId": null,
            "reasonDomainId": null,
            "selectResult": null,
            "selectStatus": null,
            "accountType": null,
            "chargebackDate": null,
            "originalTransactionDate": 1712908716000
        },
        {
            "extension": null,
            "accountNumber": "0.0.0.1-117491",
            "accountCurrency": null,
            "paymentId": "T1,65,0",
            "accountRef": {
                "id": "0.0.0.1+-account+117491",
                "uri": null
            },
            "billNumber": null,
            "allocationDeferred": null,
            "amount": 4,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": "1712926495000",
                "PIN_FLD_REASON_CODE": ""
            },
            "status": 1,
            "statusDescription": 0,
            "comment": null,
            "firstName": "Thea",
            "lastName": "Rivera",
            "dueAmount": null,
            "channelId": null,
            "billItem": [],
            "billinfo": [],
            "statusCode": null,
            "reasonId": null,
            "reasonDomainId": null,
            "selectResult": null,
            "selectStatus": null,
            "accountType": null,
            "chargebackDate": null,
            "originalTransactionDate": 1712908168000
        }
    ]
}
Back to Top