REST API Reference for Billing Care

Submit a Refund Batch

post

/bcws/webresources/v1.0/batchrefund/submit

Submits each validated record in the refund batch and returns the records with updated status.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

batchInformation: object BatchInfoType
batchRecords(required): array batchRecords
extension: object extension

The extended attributes.

{
    "required":[
        "batchRecords"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "batchInformation":{
            "$ref":"#/components/schemas/BatchInfoType"
        },
        "batchRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BatchRecordsType"
            }
        }
    }
}

Nested Schema : BatchInfoType

Type: object

Show Source

batchCurrency: integer (int32)

The currency of the batch
batchDate: integer (int64)

The date of the batch
batchId: string

The ID of the batch
batchTotalRecords: integer (int32)

The total number of records in the batch
batchTypeCode(required): string
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)
batchTypeName(required): string

The name of the batch type. Allowed values: Payment, Refund, or Reversal.
extension: object extension

The extended attributes.
lockBoxDate: integer (int64)

The date of the lockbox
lockBoxId: string

The lockbox ID

{
    "required":[
        "batchTypeCode",
        "batchTypeName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "lockBoxId":{
            "type":"string",
            "description":"The lockbox ID"
        },
        "lockBoxDate":{
            "type":"integer",
            "description":"The date of the lockbox",
            "format":"int64"
        },
        "batchCurrency":{
            "type":"integer",
            "description":"The currency of the batch",
            "format":"int32"
        },
        "batchId":{
            "type":"string",
            "description":"The ID of the batch"
        },
        "batchTypeCode":{
            "type":"string",
            "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></ul>"
        },
        "batchTypeName":{
            "type":"string",
            "description":"The name of the batch type.  Allowed values: <b>Payment</b>, <b>Refund</b>, or <b>Reversal</b>."
        },
        "batchDate":{
            "type":"integer",
            "description":"The date of the batch",
            "format":"int64"
        },
        "batchTotalRecords":{
            "type":"integer",
            "description":"The total number of records in the batch",
            "format":"int32"
        }
    }
}

Nested Schema : batchRecords

Type: array

Show Source

Array of: object BatchRecordsType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : BatchRecordsType

Type: object

Show Source

accountCurrency: integer (int32)

The account currency of the customer's account.
accountNumber: string

The customer's account number.
accountRef: object ResourceRef
accountType: integer (int32)

The accounting type associated with the account returned by the SelectItems opcode.
allocationDeferred: integer (int32)

Whether to allocate payments to items (0) or keep them unallocaeted at the account level (1). This only applies to payments, so for refund and reversal batches, this value should be null.
amount: number

Amount to be paid, refunded, or reversed.
billinfo: array billinfo
billItem: array billItem
billNumber: string

The customer's bill number to which the record should be applied.
channelId: integer (int32)

The description of the channel
chargebackDate: integer (int64)

The date and time the bill item was created.
comment: string

Notes associated with the record
dueAmount: number

The amount due
extension: object extension

The extended attributes.
firstName: string

Person's first name
lastName: string

Person's last name
originalTransactionDate: integer (int64)

The original transaction date for reversal batch records
payInfo: object payInfo

The payment information.
paymentId: string

The ID of the record.
reasonDomainId: integer (int32)

The reason Domain ID returned by the validation opcode
reasonId: integer (int32)

The reason ID returned in by the validation opcode
selectResult: integer (int32)

The result returned by the SelectItems opcode for validation
selectStatus: integer (int32)

The select status returned by the SelectItems opcode
status: integer (int32)
The status of the record. Allowed values:
- 0 (Input)
- 1 (Validated)
- 2 (Validated (with MBI distribution))
- 3 (Validated (written-off))
- 4 (Suspended)
- 5 (Manually Suspended)
- 6 (Allocate)
- 7 (Error)
- 8 (Submit)
- 9 (Batch Submit Error)
- 10 (Empty)
statusCode: integer

The status code for the record
statusDescription: integer (int32)
The status description of the record. Allowed values:
- 0 (Empty)
- 1 (Error finding account or bill)
- 2 (Error selecting items for payment)
- 3 (Payment allocation required)
- 4 (Payment allocation required due to overpayment)
- 5 (Payment allocation required due to underpayment)
- 6 (Payment allocation suggested)
- 7 (Payment allocation suggested due to overpayment)
- 8 (Payment allocation suggested due to underpayment)
- 9 (Multiple payments to the same account are not allowed in the same batch. Remove or modify this row)
- 10 (Bill number and account number mismatch)
- 11 (Currency Conversion Rates)
- 12 (Duplicate Account)
- 13 (Invalid Payment ID)
- 14 (Duplicate Payment ID)
- 15 (Payment has already been reversed)
- 16 (Payment not able to reverse)
- 17 (Error in distribution to Multiple Bill Infos)

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountNumber":{
            "type":"string",
            "description":"The customer's account number."
        },
        "accountCurrency":{
            "type":"integer",
            "description":"The account currency of the customer's account.",
            "format":"int32"
        },
        "paymentId":{
            "type":"string",
            "description":"The ID of the record."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billNumber":{
            "type":"string",
            "description":"The customer's bill number to which the record should be applied."
        },
        "allocationDeferred":{
            "type":"integer",
            "description":"Whether to allocate payments to items (<b>0</b>) or keep them unallocaeted at the account level (<b>1</b>). This only applies to payments, so for refund and reversal batches, this value should be null.",
            "format":"int32"
        },
        "amount":{
            "type":"number",
            "description":"Amount to be paid, refunded, or reversed."
        },
        "payInfo":{
            "type":"object",
            "description":"The payment information."
        },
        "status":{
            "type":"integer",
            "description":"The status of the record. Allowed values: <ul><li><b>0</b> (Input)</li><li><b>1</b> (Validated)</li><li><b>2</b> (Validated (with MBI distribution))</li><li><b>3</b> (Validated (written-off))</li><li><b>4</b> (Suspended)</li><li><b>5</b> (Manually Suspended)</li><li><b>6</b> (Allocate)</li><li><b>7</b> (Error)</li><li><b>8</b> (Submit)</li><li><b>9</b> (Batch Submit Error)</li><li><b>10</b> (Empty)</li></ul>",
            "format":"int32"
        },
        "statusDescription":{
            "type":"integer",
            "description":"The status description of the record.  Allowed values: <ul><li><b>0</b> (Empty)</li><li><b>1</b> (Error finding account or bill)</li><li><b>2</b> (Error selecting items for payment)</li><li><b>3</b> (Payment allocation required)</li><li><b>4</b> (Payment allocation required due to overpayment)</li><li><b>5</b> (Payment allocation required due to underpayment)</li><li><b>6</b> (Payment allocation suggested)</li><li><b>7</b> (Payment allocation suggested due to overpayment)</li><li><b>8</b> (Payment allocation suggested due to underpayment)</li><li><b>9</b> (Multiple payments to the same account are not allowed in the same batch.  Remove or modify this row)</li><li><b>10</b> (Bill number and account number mismatch)</li><li><b>11</b> (Currency Conversion Rates)</li><li><b>12</b> (Duplicate Account)</li><li><b>13</b> (Invalid Payment ID)</li><li><b>14</b> (Duplicate Payment ID)</li><li><b>15</b> (Payment has already been reversed)</li><li><b>16</b> (Payment not able to reverse)</li><li><b>17</b> (Error in distribution to Multiple Bill Infos)</li></ul>",
            "format":"int32"
        },
        "comment":{
            "type":"string",
            "description":"Notes associated with the record"
        },
        "firstName":{
            "type":"string",
            "description":"Person's first name"
        },
        "lastName":{
            "type":"string",
            "description":"Person's last name"
        },
        "dueAmount":{
            "type":"number",
            "description":"The amount due"
        },
        "channelId":{
            "type":"integer",
            "description":"The description of the channel",
            "format":"int32"
        },
        "billItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "billinfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillinfoType"
            }
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code for the record"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID returned in by the validation opcode",
            "format":"int32"
        },
        "reasonDomainId":{
            "type":"integer",
            "description":"The reason Domain ID returned by the validation opcode",
            "format":"int32"
        },
        "selectResult":{
            "type":"integer",
            "description":"The result returned by the SelectItems opcode for validation",
            "format":"int32"
        },
        "selectStatus":{
            "type":"integer",
            "description":"The select status returned by the SelectItems opcode",
            "format":"int32"
        },
        "accountType":{
            "type":"integer",
            "description":"The accounting type associated with the account returned by the SelectItems opcode.",
            "format":"int32"
        },
        "chargebackDate":{
            "type":"integer",
            "description":"The date and time the bill item was created.",
            "format":"int64"
        },
        "originalTransactionDate":{
            "type":"integer",
            "description":"The original transaction date for reversal batch records",
            "format":"int64"
        }
    }
}

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 : billinfo

Type: array

Show Source

Array of: object BillinfoType

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

Nested Schema : billItem

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : payInfo

Type: object

The payment information.

Nested Schema : BillinfoType

Type: object

Show Source

accountingType: integer (int32)

The bill unit's accounting type. Allowed values: 1 (Open item) or 2 (Balance forward).
amount: number

The amount allocated.
billinfoRef: object ResourceRef
bills: array bills
extension: object extension

The extended attributes.
items: array items

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "bills":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "amount":{
            "type":"number",
            "description":"The amount allocated."
        },
        "accountingType":{
            "type":"integer",
            "description":"The bill unit's accounting type. Allowed values: <b>1</b> (Open item) or <b>2</b> (Balance forward).",
            "format":"int32"
        }
    }
}

Nested Schema : bills

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : items

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : BillItemType

Type: object

Show Source

amount(required): number

The amount of the bill item.
billinfoRef: object ResourceRef
billRef: object ResourceRef
due: number

The amount due for the bill item.
extension: object extension

The extended attributes.
id(required): string

The ID.

{
    "required":[
        "amount",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "amount":{
            "type":"number",
            "description":"The amount of the bill item."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the bill item."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Response

Supported Media Types

application/json

200 Response

The submission process is complete.

Root Schema : schema

Type: object

Show Source

batchInformation: object BatchInfoType
batchRecords(required): array batchRecords
extension: object extension

The extended attributes.

{
    "required":[
        "batchRecords"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "batchInformation":{
            "$ref":"#/components/schemas/BatchInfoType"
        },
        "batchRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BatchRecordsType"
            }
        }
    }
}

Nested Schema : BatchInfoType

Type: object

Show Source

batchCurrency: integer (int32)

The currency of the batch
batchDate: integer (int64)

The date of the batch
batchId: string

The ID of the batch
batchTotalRecords: integer (int32)

The total number of records in the batch
batchTypeCode(required): string
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)
batchTypeName(required): string

The name of the batch type. Allowed values: Payment, Refund, or Reversal.
extension: object extension

The extended attributes.
lockBoxDate: integer (int64)

The date of the lockbox
lockBoxId: string

The lockbox ID

{
    "required":[
        "batchTypeCode",
        "batchTypeName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "lockBoxId":{
            "type":"string",
            "description":"The lockbox ID"
        },
        "lockBoxDate":{
            "type":"integer",
            "description":"The date of the lockbox",
            "format":"int64"
        },
        "batchCurrency":{
            "type":"integer",
            "description":"The currency of the batch",
            "format":"int32"
        },
        "batchId":{
            "type":"string",
            "description":"The ID of the batch"
        },
        "batchTypeCode":{
            "type":"string",
            "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></ul>"
        },
        "batchTypeName":{
            "type":"string",
            "description":"The name of the batch type.  Allowed values: <b>Payment</b>, <b>Refund</b>, or <b>Reversal</b>."
        },
        "batchDate":{
            "type":"integer",
            "description":"The date of the batch",
            "format":"int64"
        },
        "batchTotalRecords":{
            "type":"integer",
            "description":"The total number of records in the batch",
            "format":"int32"
        }
    }
}

Nested Schema : batchRecords

Type: array

Show Source

Array of: object BatchRecordsType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : BatchRecordsType

Type: object

Show Source

accountCurrency: integer (int32)

The account currency of the customer's account.
accountNumber: string

The customer's account number.
accountRef: object ResourceRef
accountType: integer (int32)

The accounting type associated with the account returned by the SelectItems opcode.
allocationDeferred: integer (int32)

Whether to allocate payments to items (0) or keep them unallocaeted at the account level (1). This only applies to payments, so for refund and reversal batches, this value should be null.
amount: number

Amount to be paid, refunded, or reversed.
billinfo: array billinfo
billItem: array billItem
billNumber: string

The customer's bill number to which the record should be applied.
channelId: integer (int32)

The description of the channel
chargebackDate: integer (int64)

The date and time the bill item was created.
comment: string

Notes associated with the record
dueAmount: number

The amount due
extension: object extension

The extended attributes.
firstName: string

Person's first name
lastName: string

Person's last name
originalTransactionDate: integer (int64)

The original transaction date for reversal batch records
payInfo: object payInfo

The payment information.
paymentId: string

The ID of the record.
reasonDomainId: integer (int32)

The reason Domain ID returned by the validation opcode
reasonId: integer (int32)

The reason ID returned in by the validation opcode
selectResult: integer (int32)

The result returned by the SelectItems opcode for validation
selectStatus: integer (int32)

The select status returned by the SelectItems opcode
status: integer (int32)
The status of the record. Allowed values:
- 0 (Input)
- 1 (Validated)
- 2 (Validated (with MBI distribution))
- 3 (Validated (written-off))
- 4 (Suspended)
- 5 (Manually Suspended)
- 6 (Allocate)
- 7 (Error)
- 8 (Submit)
- 9 (Batch Submit Error)
- 10 (Empty)
statusCode: integer

The status code for the record
statusDescription: integer (int32)
The status description of the record. Allowed values:
- 0 (Empty)
- 1 (Error finding account or bill)
- 2 (Error selecting items for payment)
- 3 (Payment allocation required)
- 4 (Payment allocation required due to overpayment)
- 5 (Payment allocation required due to underpayment)
- 6 (Payment allocation suggested)
- 7 (Payment allocation suggested due to overpayment)
- 8 (Payment allocation suggested due to underpayment)
- 9 (Multiple payments to the same account are not allowed in the same batch. Remove or modify this row)
- 10 (Bill number and account number mismatch)
- 11 (Currency Conversion Rates)
- 12 (Duplicate Account)
- 13 (Invalid Payment ID)
- 14 (Duplicate Payment ID)
- 15 (Payment has already been reversed)
- 16 (Payment not able to reverse)
- 17 (Error in distribution to Multiple Bill Infos)

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountNumber":{
            "type":"string",
            "description":"The customer's account number."
        },
        "accountCurrency":{
            "type":"integer",
            "description":"The account currency of the customer's account.",
            "format":"int32"
        },
        "paymentId":{
            "type":"string",
            "description":"The ID of the record."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billNumber":{
            "type":"string",
            "description":"The customer's bill number to which the record should be applied."
        },
        "allocationDeferred":{
            "type":"integer",
            "description":"Whether to allocate payments to items (<b>0</b>) or keep them unallocaeted at the account level (<b>1</b>). This only applies to payments, so for refund and reversal batches, this value should be null.",
            "format":"int32"
        },
        "amount":{
            "type":"number",
            "description":"Amount to be paid, refunded, or reversed."
        },
        "payInfo":{
            "type":"object",
            "description":"The payment information."
        },
        "status":{
            "type":"integer",
            "description":"The status of the record. Allowed values: <ul><li><b>0</b> (Input)</li><li><b>1</b> (Validated)</li><li><b>2</b> (Validated (with MBI distribution))</li><li><b>3</b> (Validated (written-off))</li><li><b>4</b> (Suspended)</li><li><b>5</b> (Manually Suspended)</li><li><b>6</b> (Allocate)</li><li><b>7</b> (Error)</li><li><b>8</b> (Submit)</li><li><b>9</b> (Batch Submit Error)</li><li><b>10</b> (Empty)</li></ul>",
            "format":"int32"
        },
        "statusDescription":{
            "type":"integer",
            "description":"The status description of the record.  Allowed values: <ul><li><b>0</b> (Empty)</li><li><b>1</b> (Error finding account or bill)</li><li><b>2</b> (Error selecting items for payment)</li><li><b>3</b> (Payment allocation required)</li><li><b>4</b> (Payment allocation required due to overpayment)</li><li><b>5</b> (Payment allocation required due to underpayment)</li><li><b>6</b> (Payment allocation suggested)</li><li><b>7</b> (Payment allocation suggested due to overpayment)</li><li><b>8</b> (Payment allocation suggested due to underpayment)</li><li><b>9</b> (Multiple payments to the same account are not allowed in the same batch.  Remove or modify this row)</li><li><b>10</b> (Bill number and account number mismatch)</li><li><b>11</b> (Currency Conversion Rates)</li><li><b>12</b> (Duplicate Account)</li><li><b>13</b> (Invalid Payment ID)</li><li><b>14</b> (Duplicate Payment ID)</li><li><b>15</b> (Payment has already been reversed)</li><li><b>16</b> (Payment not able to reverse)</li><li><b>17</b> (Error in distribution to Multiple Bill Infos)</li></ul>",
            "format":"int32"
        },
        "comment":{
            "type":"string",
            "description":"Notes associated with the record"
        },
        "firstName":{
            "type":"string",
            "description":"Person's first name"
        },
        "lastName":{
            "type":"string",
            "description":"Person's last name"
        },
        "dueAmount":{
            "type":"number",
            "description":"The amount due"
        },
        "channelId":{
            "type":"integer",
            "description":"The description of the channel",
            "format":"int32"
        },
        "billItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "billinfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillinfoType"
            }
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code for the record"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID returned in by the validation opcode",
            "format":"int32"
        },
        "reasonDomainId":{
            "type":"integer",
            "description":"The reason Domain ID returned by the validation opcode",
            "format":"int32"
        },
        "selectResult":{
            "type":"integer",
            "description":"The result returned by the SelectItems opcode for validation",
            "format":"int32"
        },
        "selectStatus":{
            "type":"integer",
            "description":"The select status returned by the SelectItems opcode",
            "format":"int32"
        },
        "accountType":{
            "type":"integer",
            "description":"The accounting type associated with the account returned by the SelectItems opcode.",
            "format":"int32"
        },
        "chargebackDate":{
            "type":"integer",
            "description":"The date and time the bill item was created.",
            "format":"int64"
        },
        "originalTransactionDate":{
            "type":"integer",
            "description":"The original transaction date for reversal batch records",
            "format":"int64"
        }
    }
}

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 : billinfo

Type: array

Show Source

Array of: object BillinfoType

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

Nested Schema : billItem

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : payInfo

Type: object

The payment information.

Nested Schema : BillinfoType

Type: object

Show Source

accountingType: integer (int32)

The bill unit's accounting type. Allowed values: 1 (Open item) or 2 (Balance forward).
amount: number

The amount allocated.
billinfoRef: object ResourceRef
bills: array bills
extension: object extension

The extended attributes.
items: array items

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "bills":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillItemType"
            }
        },
        "amount":{
            "type":"number",
            "description":"The amount allocated."
        },
        "accountingType":{
            "type":"integer",
            "description":"The bill unit's accounting type. Allowed values: <b>1</b> (Open item) or <b>2</b> (Balance forward).",
            "format":"int32"
        }
    }
}

Nested Schema : bills

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : items

Type: array

Show Source

Array of: object BillItemType

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

Nested Schema : BillItemType

Type: object

Show Source

amount(required): number

The amount of the bill item.
billinfoRef: object ResourceRef
billRef: object ResourceRef
due: number

The amount due for the bill item.
extension: object extension

The extended attributes.
id(required): string

The ID.

{
    "required":[
        "amount",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "amount":{
            "type":"number",
            "description":"The amount of the bill item."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the bill item."
        }
    }
}

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 submit each validated record in the refund batch and return the records with updated status 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/batchrefund/submit' -H 'content-type: application/json' -d @submit.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.
submit.json is the JSON file that specifies the items to submit.

Example of Request Body

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

{
    "batchInformation": {
        "batchCurrency": 840,
        "batchId": "",
        "batchTypeCode": 10011,
        "batchDate": 1712290649000,
        "lockBoxId": "",
        "lockBoxDate": null
    },
    "batchRecords": [
        {
            "extension": null,
            "accountNumber": "0.0.0.1-136236",
            "accountCurrency": null,
            "paymentId": null,
            "accountRef": {
                "id": "0.0.0.1+-account+136236",
                "uri": null
            },
            "billNumber": "B1-7",
            "allocationDeferred": null,
            "amount": 2,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": 1712290649000,
                "PIN_FLD_RECEIPT_NO": "QBX123"
            },
            "status": 1,
            "statusDescription": 0,
            "comment": null
        },
        {
            "extension": null,
            "accountNumber": "0.0.0.1-66744",
            "accountCurrency": null,
            "paymentId": null,
            "accountRef": {
                "id": "0.0.0.1+-account+66744",
                "uri": null
            },
            "billNumber": "",
            "allocationDeferred": null,
            "amount": 2,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": 1712290649000,
                "PIN_FLD_RECEIPT_NO": "REC123"
            },
            "status": 1,
            "statusDescription": 0,
            "comment": null
        }
    ]
}

Example of Response Body

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

{
    "extension": null,
    "batchInformation": {
        "extension": null,
        "lockBoxId": "",
        "lockBoxDate": null,
        "batchCurrency": 840,
        "batchId": "T1,83",
        "batchTypeCode": "10011",
        "batchTypeName": null,
        "batchDate": 1712290649000,
        "batchTotalRecords": 0
    },
    "batchRecords": [
        {
            "extension": null,
            "accountNumber": "0.0.0.1-136236",
            "accountCurrency": null,
            "paymentId": null,
            "accountRef": {
                "id": "0.0.0.1+-account+136236",
                "uri": null
            },
            "billNumber": "B1-7",
            "allocationDeferred": null,
            "amount": 2,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": 1712290649000,
                "PIN_FLD_RECEIPT_NO": "QBX123"
            },
            "status": 9,
            "statusDescription": 0,
            "comment": null
        },
        {
            "extension": null,
            "accountNumber": "0.0.0.1-66744",
            "accountCurrency": null,
            "paymentId": null,
            "accountRef": {
                "id": "0.0.0.1+-account+66744",
                "uri": null
            },
            "billNumber": "",
            "allocationDeferred": null,
            "amount": 2,
            "payInfo": {
                "PIN_FLD_EFFECTIVE_T": 1712290649000,
                "PIN_FLD_RECEIPT_NO": "REC123"
            },
            "status": 8,
            "statusDescription": 0,
            "comment": null
        }
    ]
}