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 register with cross river apis this table presents checks management apis that we describe in detail action api call description check management docid\ nrrvehm 6ju3udzxmyzo post /checks/v1/payments sends cos the information needed to deposit a check into a cr account check management docid\ nrrvehm 6ju3udzxmyzo post /checks/v1/payments/{id}/cancel cancels a check deposit check management docid\ nrrvehm 6ju3udzxmyzo get /checks/v1/payments/{id}/images/{view} returns the image of the front or back of the check encoded in base64 check management docid\ nrrvehm 6ju3udzxmyzo 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 check management docid\ nrrvehm 6ju3udzxmyzo post /checks/v1/positive pay authorizations authorizes a check using positive pay positive pay check management docid\ nrrvehm 6ju3udzxmyzo post checks/v1/positive pay authorizations/{id}/revoke revokes positive pay authorization already given for a specific check deposit a 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 cancel a check deposit 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 view check images 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 payment analysis 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 authorize a check authorizes a check using checks management request attributes revoke authorization 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 associated webhook envents 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 related topics checks management request and response codes error codes what is a check tutorials deposit a check