PATCH web_api/private_bad_checks/{id}

Toggle a current Private Bad Check item's status between Active and Inactive

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the item to set as inactive	integer	Required

Body Parameters

Update the Active/Inactive status of the Private Bad Check item. Pass either "true" or "false" in the body to update the Current Status property.

boolean

Request Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PrivateBadCheck

Name	Description	Type	Additional information
BadCheckID	The unique identifier for the Private Bad Check list item	integer	None.
RoutingNumber	The Routing/ABA number of the bank account	string	Required Matching regular expression pattern: ^[0-9]{9}$
AccountNumber	The individual account number of the bank account	string	Required Matching regular expression pattern: ^[0-9]{4,17}$
Active	The current active/inactive status of the item. Items that are active will cause a value of GP01 to be returned for the AccountResponseCode for any inquiries on the bank account. To stop this, set the item's active property to false.	boolean	None.
CheckRejectReason	The reason that you listed for wanting to not accept items from this bank account	string	Required Max length: 200
AddedDate	The DateTime that this Private Bad Checks item was added to your list	date	None.
LastUpdatedDate	The most recent date this item was updated	date	None.
LastActiveChanged	The most recent date this item's Active property was changed	date	None.
NameOnCheck	The name associated with this bank account on your records	string	Required Max length: 50
CheckNumber	The check number for the item that caused you to add this bank account to you Private Bad Checks list	integer	Matching regular expression pattern: ^[0-9]{4,15}$
PhoneNumber	The phone number associated with this bank account on your records	string	Matching regular expression pattern: ^[0-9]{10}$

Response Formats

application/json, text/json

Sample:

{
  "BadCheckID": 1,
  "RoutingNumber": "sample string 2",
  "AccountNumber": "sample string 3",
  "Active": true,
  "CheckRejectReason": "sample string 5",
  "AddedDate": "2025-04-28T06:31:18.3649768-05:00",
  "LastUpdatedDate": "2025-04-28T06:31:18.3649768-05:00",
  "LastActiveChanged": "2025-04-28T06:31:18.3649768-05:00",
  "NameOnCheck": "sample string 7",
  "CheckNumber": 1,
  "PhoneNumber": "sample string 8"
}

application/xml, text/xml

Sample:

<PrivateBadCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <AccountNumber>sample string 3</AccountNumber>
  <Active>true</Active>
  <AddedDate>2025-04-28T06:31:18.3649768-05:00</AddedDate>
  <BadCheckID>1</BadCheckID>
  <CheckNumber>1</CheckNumber>
  <CheckRejectReason>sample string 5</CheckRejectReason>
  <LastActiveChanged>2025-04-28T06:31:18.3649768-05:00</LastActiveChanged>
  <LastUpdatedDate>2025-04-28T06:31:18.3649768-05:00</LastUpdatedDate>
  <NameOnCheck>sample string 7</NameOnCheck>
  <PhoneNumber>sample string 8</PhoneNumber>
  <RoutingNumber>sample string 2</RoutingNumber>
</PrivateBadCheck>