Checks

Create Checks

Creates a new Checks

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
check_ID
required
integer <int32>

ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.

acH_Number
string or null <= 32 characters

ACH (Automated Clearing House) number of the check.

account_Key
integer or null <int32>

The account key associated with the check.

address2_On_Check
string or null <= 128 characters

The second address line on the check.

address_On_Check
string or null <= 255 characters

Address line 1 listed on the check.

adjustment
number or null <double>

An adjustment amount assigned to the check.

admin_Amt
number or null <double>

Indicates any administrative fee associated with the check.

amount_Due
number or null <double>

Amount that was written on the check.

check_Batch
integer or null <int32>

Identifies which batch the check belongs to.

check_Date
string or null <date-time>

Date that was written on the check.

check_Number
string or null <= 20 characters

Number of the check.

check_Paid_Date
string or null <date-time>

The date the check was paid.

check_Status
string or null <= 1 characters

Indicates the status of the check.

check_Type
string or null <= 3 characters

Indicates the type associated with the check.

city_On_Check
string or null <= 30 characters

City of the check's address.

cleared_Amount
number or null <double>

The amount that was cleared.

cleared_Date
string or null <date-time>

The date the check cleared.

country_ID_On_Check
string or null <= 8 characters

The country ID on the check.

create_Date
string or null <date-time>

The date the check was created.

create_User
string or null <= 20 characters

The user that created the check.

date_Printed
string or null <date-time>

Date when the check was printed.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

generated_835
required
boolean

Flag that determines if an 835 was generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

interest
number or null <double>

The interest amount of the check.

memo
string or null <= 64 characters

Memo line of the check.

name_On_Address
string or null <= 50 characters

The name associated with the address on the check.

name_On_Check
string or null <= 50 characters

Name that was written on the check.

paid_Amount
number or null <double>

The amount paid of the check.

pay_To_Account_Key
integer or null <int32>

The account the check was paid to.

pay_To_ID
string or null <= 20 characters

Pay_To_ID is the ID based on the Send_Check_To. 'P' = Payee_ID, 'V' = Provider_ID, 'S'= Subscriber_ID, 'G' = Group_ID, 'B' = Beneficiary_ID

payee_ID
string or null <= 20 characters

ID of the Payee associated with the check.

payment_Method
string or null <= 3 characters

Identifies the check as a check or wire transfer.

payor_ID
string or null <= 20 characters

ID of the Payor associated with the check.

reconcile_Key
integer or null <int32>

The reconcile key associated with the check.

send_Check_To
string or null <= 1 characters

A code identifying who the check is sent to.

signature_Key
integer or null <int32>

The signature key associated with the check.

state_On_Check
string or null <= 2 characters

State of the check's address.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

wire_Transfer_Date
string or null <date-time>

The date of the wire transfer.

zip_On_Check
string or null <= 32 characters

Zip code of the check's address.

Responses
200

Success

401

Unauthorized

post/checks
Request samples
{
  • "check_ID": 0,
  • "acH_Number": "string",
  • "account_Key": 0,
  • "address2_On_Check": "string",
  • "address_On_Check": "string",
  • "adjustment": 0.1,
  • "admin_Amt": 0.1,
  • "amount_Due": 0.1,
  • "check_Batch": 0,
  • "check_Date": "2019-08-24T14:15:22Z",
  • "check_Number": "string",
  • "check_Paid_Date": "2019-08-24T14:15:22Z",
  • "check_Status": "s",
  • "check_Type": "str",
  • "city_On_Check": "string",
  • "cleared_Amount": 0.1,
  • "cleared_Date": "2019-08-24T14:15:22Z",
  • "country_ID_On_Check": "string",
  • "create_Date": "2019-08-24T14:15:22Z",
  • "create_User": "string",
  • "date_Printed": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "generated_835": true,
  • "interest": 0.1,
  • "memo": "string",
  • "name_On_Address": "string",
  • "name_On_Check": "string",
  • "paid_Amount": 0.1,
  • "pay_To_Account_Key": 0,
  • "pay_To_ID": "string",
  • "payee_ID": "string",
  • "payment_Method": "str",
  • "payor_ID": "string",
  • "reconcile_Key": 0,
  • "send_Check_To": "s",
  • "signature_Key": 0,
  • "state_On_Check": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer_Date": "2019-08-24T14:15:22Z",
  • "zip_On_Check": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Checks

Lists all Checks

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/checks
Request samples 
Response samples 
No sample
Void Check Advanced API 
Voids an existing Check


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
check_ID
integer <int32> 
 
reentry_Batch_Number
integer or null <int32> 
 
backout_Ex_Code
string or null
 
reentry_Ex_Code
string or null
 
reentry_Provider_ID
string or null
 
reentry_Subscriber_ID
string or null
 
reentry_Member_Seq
string or null
 
user_ID
string or null
 
Responses 
200
Success


401
Unauthorized


post/checks/{checkID}/void
Request samples 
{
  • "check_ID": 0,
  • "reentry_Batch_Number": 0,
  • "backout_Ex_Code": "string",
  • "reentry_Ex_Code": "string",
  • "reentry_Provider_ID": "string",
  • "reentry_Subscriber_ID": "string",
  • "reentry_Member_Seq": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get Name and Address Information Advanced API 
Using Send Check To and a dynamic Pay To ID, get the delivery information for a potential check.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
send_Check_To
required
string  non-empty 
 
pay_To_ID
required
string  non-empty 
 
subscriber_ID
string or null
 
member_Seq
string or null
 
name_On_Check
string or null
 
address_On_Check
string or null
 
address2_On_Check
string or null
 
city_On_Check
string or null
 
state_On_Check
string or null
 
zip_On_Check
string or null
 
country_ID_On_Check
string or null
 
name_On_Address
string or null
 
Responses 
200
Success


401
Unauthorized


post/checks-name-on-check
Request samples 
{
  • "send_Check_To": "string",
  • "pay_To_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "name_On_Check": "string",
  • "address_On_Check": "string",
  • "address2_On_Check": "string",
  • "city_On_Check": "string",
  • "state_On_Check": "string",
  • "zip_On_Check": "string",
  • "country_ID_On_Check": "string",
  • "name_On_Address": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get Checks
Gets Checks


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/checks/{checkID}
Request samples 
Response samples 
No sample
Update Checks
Updates a specific Checks.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
check_ID
required
integer <int32> 
ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
acH_Number
string or null  <= 32 characters 
ACH (Automated Clearing House) number of the check.


 
account_Key
integer or null <int32> 
The account key associated with the check.


 
address2_On_Check
string or null  <= 128 characters 
The second address line on the check.


 
address_On_Check
string or null  <= 255 characters 
Address line 1 listed on the check.


 
adjustment
number or null <double> 
An adjustment amount assigned to the check.


 
admin_Amt
number or null <double> 
Indicates any administrative fee associated with the check.


 
amount_Due
number or null <double> 
Amount that was written on the check.


 
check_Batch
integer or null <int32> 
Identifies which batch the check belongs to.


 
check_Date
string or null <date-time> 
Date that was written on the check.


 
check_Number
string or null  <= 20 characters 
Number of the check.


 
check_Paid_Date
string or null <date-time> 
The date the check was paid.


 
check_Status
string or null  <= 1 characters 
Indicates the status of the check.


 
check_Type
string or null  <= 3 characters 
Indicates the type associated with the check.


 
city_On_Check
string or null  <= 30 characters 
City of the check's address.


 
cleared_Amount
number or null <double> 
The amount that was cleared.


 
cleared_Date
string or null <date-time> 
The date the check cleared.


 
country_ID_On_Check
string or null  <= 8 characters 
The country ID on the check.


 
create_Date
string or null <date-time> 
The date the check was created.


 
create_User
string or null  <= 20 characters 
The user that created the check.


 
date_Printed
string or null <date-time> 
Date when the check was printed.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
generated_835
required
boolean
Flag that determines if an 835 was generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interest
number or null <double> 
The interest amount of the check.


 
memo
string or null  <= 64 characters 
Memo line of the check.


 
name_On_Address
string or null  <= 50 characters 
The name associated with the address on the check.


 
name_On_Check
string or null  <= 50 characters 
Name that was written on the check.


 
paid_Amount
number or null <double> 
The amount paid of the check.


 
pay_To_Account_Key
integer or null <int32> 
The account the check was paid to.


 
pay_To_ID
string or null  <= 20 characters 
Pay_To_ID is the ID based on the Send_Check_To. 'P' = Payee_ID, 'V' = Provider_ID, 'S'= Subscriber_ID, 'G' = Group_ID, 'B' = Beneficiary_ID


 
payee_ID
string or null  <= 20 characters 
ID of the Payee associated with the check.


 
payment_Method
string or null  <= 3 characters 
Identifies the check as a check or wire transfer.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor associated with the check.


 
reconcile_Key
integer or null <int32> 
The reconcile key associated with the check.


 
send_Check_To
string or null  <= 1 characters 
A code identifying who the check is sent to.


 
signature_Key
integer or null <int32> 
The signature key associated with the check.


 
state_On_Check
string or null  <= 2 characters 
State of the check's address.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
wire_Transfer_Date
string or null <date-time> 
The date of the wire transfer.


 
zip_On_Check
string or null  <= 32 characters 
Zip code of the check's address.


 
Responses 
200
Success


401
Unauthorized


put/checks/{checkID}
Request samples 
{
  • "check_ID": 0,
  • "acH_Number": "string",
  • "account_Key": 0,
  • "address2_On_Check": "string",
  • "address_On_Check": "string",
  • "adjustment": 0.1,
  • "admin_Amt": 0.1,
  • "amount_Due": 0.1,
  • "check_Batch": 0,
  • "check_Date": "2019-08-24T14:15:22Z",
  • "check_Number": "string",
  • "check_Paid_Date": "2019-08-24T14:15:22Z",
  • "check_Status": "s",
  • "check_Type": "str",
  • "city_On_Check": "string",
  • "cleared_Amount": 0.1,
  • "cleared_Date": "2019-08-24T14:15:22Z",
  • "country_ID_On_Check": "string",
  • "create_Date": "2019-08-24T14:15:22Z",
  • "create_User": "string",
  • "date_Printed": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "generated_835": true,
  • "interest": 0.1,
  • "memo": "string",
  • "name_On_Address": "string",
  • "name_On_Check": "string",
  • "paid_Amount": 0.1,
  • "pay_To_Account_Key": 0,
  • "pay_To_ID": "string",
  • "payee_ID": "string",
  • "payment_Method": "str",
  • "payor_ID": "string",
  • "reconcile_Key": 0,
  • "send_Check_To": "s",
  • "signature_Key": 0,
  • "state_On_Check": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wire_Transfer_Date": "2019-08-24T14:15:22Z",
  • "zip_On_Check": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Checks
Deletes an Checks


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
checkID
required
integer <int32> 
Check ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/checks/{checkID}
Request samples 
Create or Update Batch Checks
Create or Update multiple Checks at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
check_ID
required
integer <int32> 
ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
acH_Number
string or null  <= 32 characters 
ACH (Automated Clearing House) number of the check.


 
account_Key
integer or null <int32> 
The account key associated with the check.


 
address2_On_Check
string or null  <= 128 characters 
The second address line on the check.


 
address_On_Check
string or null  <= 255 characters 
Address line 1 listed on the check.


 
adjustment
number or null <double> 
An adjustment amount assigned to the check.


 
admin_Amt
number or null <double> 
Indicates any administrative fee associated with the check.


 
amount_Due
number or null <double> 
Amount that was written on the check.


 
check_Batch
integer or null <int32> 
Identifies which batch the check belongs to.


 
check_Date
string or null <date-time> 
Date that was written on the check.


 
check_Number
string or null  <= 20 characters 
Number of the check.


 
check_Paid_Date
string or null <date-time> 
The date the check was paid.


 
check_Status
string or null  <= 1 characters 
Indicates the status of the check.


 
check_Type
string or null  <= 3 characters 
Indicates the type associated with the check.


 
city_On_Check
string or null  <= 30 characters 
City of the check's address.


 
cleared_Amount
number or null <double> 
The amount that was cleared.


 
cleared_Date
string or null <date-time> 
The date the check cleared.


 
country_ID_On_Check
string or null  <= 8 characters 
The country ID on the check.


 
create_Date
string or null <date-time> 
The date the check was created.


 
create_User
string or null  <= 20 characters 
The user that created the check.


 
date_Printed
string or null <date-time> 
Date when the check was printed.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
generated_835
required
boolean
Flag that determines if an 835 was generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interest
number or null <double> 
The interest amount of the check.


 
memo
string or null  <= 64 characters 
Memo line of the check.


 
name_On_Address
string or null  <= 50 characters 
The name associated with the address on the check.


 
name_On_Check
string or null  <= 50 characters 
Name that was written on the check.


 
paid_Amount
number or null <double> 
The amount paid of the check.


 
pay_To_Account_Key
integer or null <int32> 
The account the check was paid to.


 
pay_To_ID
string or null  <= 20 characters 
Pay_To_ID is the ID based on the Send_Check_To. 'P' = Payee_ID, 'V' = Provider_ID, 'S'= Subscriber_ID, 'G' = Group_ID, 'B' = Beneficiary_ID


 
payee_ID
string or null  <= 20 characters 
ID of the Payee associated with the check.


 
payment_Method
string or null  <= 3 characters 
Identifies the check as a check or wire transfer.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor associated with the check.


 
reconcile_Key
integer or null <int32> 
The reconcile key associated with the check.


 
send_Check_To
string or null  <= 1 characters 
A code identifying who the check is sent to.


 
signature_Key
integer or null <int32> 
The signature key associated with the check.


 
state_On_Check
string or null  <= 2 characters 
State of the check's address.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
wire_Transfer_Date
string or null <date-time> 
The date of the wire transfer.


 
zip_On_Check
string or null  <= 32 characters 
Zip code of the check's address.


 
Responses 
207
Success


401
Unauthorized


put/checks-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Process Checks Advanced API 
Initiates the process of Check Processing. If the request is valid, the system will generate the necessary actions to process checks and respond with a success status code of 202 Accepted, along with the generated process key.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
posted_Date
string or null <date-time> 
 
user_ID
string or null
 
Array of objects or null (ProcessCheckOption) 
 
Responses 
202
Accepted for processing, returns the generated process key


401
Unauthorized


post/checks-process
Request samples 
{
  • "posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "process_Check_Options": [
    ]
}
Response samples 
{
  • "data": 0,
  • "error": {
    },
  • "debug": {
    }
}