Check management
You can manage both deposit and withdrawal checking for your customers using Cross River APIs.
Checks APIs are found in the checks module of our COS sandbox.
Get started with Cross River APIs.
This table presents checks management APIs that we describe in detail.
Action | API Call | Description |
|---|---|---|
POST /checks/v1/payments | Sends COS the information needed to deposit a check into a CR account | |
POST /checks/v1/payments/{id}/cancel | Cancels a check deposit | |
GET /checks/v1/payments/{id}/images/{view} | Returns the image of the front or back of the check encoded in Base64 | |
GET /checks/v1/payments/{id}/analysis | Returns an analysis of the check's image quality assurance (IQA) status based on the Fed's metrics | |
Positive Pay: Authorize a check | POST /checks/v1/positive-pay-authorizations | Authorizes a check using Positive Pay |
Positive Pay: Revoke authorization | POST checks/v1/positive-pay-authorizations/{id}/revoke | Revokes Positive Pay authorization already given for a specific check |
Sends the CR system information needed to deposit a check into a CR account using the API. This information includes images of both the front and the back of the check. You submit these images after converting each one to a Base64-encoded value.
Request attributes
Cancels a specific check deposit according to its payment ID.
There are times when you need to cancel a check deposit. For example, to prevent a loss on an account where check kiting activity has been identified. You can only cancel a check if the payment hasn't been processed yet.
Response attributes
The response attributes for this call are the same as for Deposit a check.
Returns the Base64-encoded image of the requested side of the check.
Use a Base64 decoder to view the requested check side as a human-visible image.
Returns an analysis of the check's image quality assurance (IQA) status based on the Fed's metrics.
The remaining response attributes for this call are the same as for Deposit a check.
Authorizes a check using Positive Pay.
Request attributes
Revokes authorization already given for a specific check. You can only revoke authorization prior to the authorization expiration date.
Response attributes
The response attributes for this call are the same as for Authorize a check.
Event Name | Description |
|---|---|
Check.Payment.Sent | A check deposit has been sent to the Federal Reserve for clearing |
Check.Payment.Received | A check drawn on an account in COS has been deposited at another bank and has been received from the Federal Reserve for posting |
Check.Payment.Canceled | An outbound payment has been canceled at the request of the partner |
Check.Payment.Rejected | Outbound check could not be processed due to compliance reasons or was rejected by the Federal Reserve |
Check.Return.Received | A previously deposited check has been returned by the receiving bank |
Check.Details.Changed | Details of a check have been changed |
Check.Hold.Escalated | A hold relating to either an inbound or outbound check was marked for escalation by a member of the Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner. |
Check.Policy.Changed | A check's Reg CC Policy has been updated |
Check.PositivePay.Created | A check has been authorized for Positive Pay |
Check.PositivePay.Revoked | A check's Positive Pay status has been revoked |
Check.Payment.Unauthorized | A check drawn on an account in COS has been presented but was not authorized for Positive Pay |
