Status Paper Check

A reverse process happens when the new status is one of the following: (REVERSED, STOPPED, DROP)

There are 2 ways to send the request:

  1. Using account_guid and check_number
  2. Using txn_guid
  • new_status is required
  • notes is Optional
Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
account_guid
string <uuid>
check_number
string or null <= 40 characters
txn_guid
string <uuid>
new_status
required
string (CheckNewStatusType)
Enum: "ISSUED" "DISPUTED" "STOPPED" "REVERSED" "DROP"
notes
string or null <= 512 characters
reverse_txn_guid
string or null <uuid>
Responses
200

Returns a check status response

400

Bad request

401

Unauthorized

500

Server Error

patch/api/{version}/Check/ChangeStatus
Request samples
application/json
{
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "check_number": "string",
  • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
  • "new_status": "ISSUED",
  • "notes": "string",
  • "reverse_txn_guid": "1c5ffe75-1896-4946-ad70-748a1803a4ef"
}
Response samples
application/json
{
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "check_number": "string",
  • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
  • "new_status": "ISSUED",
  • "notes": "string",
  • "reverse_txn_guid": "1c5ffe75-1896-4946-ad70-748a1803a4ef"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.