Paper Checks
Paper Checks APIs can be used for paper check related functions.
Paper Checks API Endpoints
This endpoint allows partners to request a stop payment on checks. The request must include the check number.
API Call Structure
PUT /programs/{programCode}/accounts/{accountIdentifier}/checkInventory
Response Codes
| Condition | HTTP Code | Code | subCode |
|---|---|---|---|
| Success | 200 | 0 | 0 |
| Success (Check Stopped already) (idempotency on check #) | 200 | 0 | 0 |
| Check not found. | 404 | 10 | 1 |
| Check paid already. | 409 | 409 | 0 |
| Account Not Found. | 404 | 10 | 0 |
| Invalid arguments. (Downstream 503 error) | 400 | 400 | 0 |
| Account is closed. | 200 | 4 | 105 |
This endpoint allows Partners to update paper check orders to notReceived.
API Call Structure
PUT /programs/{programCode}/accounts/{accountIdentifier}/checkBookOrder
Response Codes
| Condition | HTTP Code | Code | subCode |
|---|---|---|---|
| Success | 200 | 0 | 0 |
| Order not found. | 404 | 10 | 1 |
| Account Not found. | 404 | 10 | 0 |
| Invalid arguments. (Downstream 503 error) | 400 | 400 | 0 |
| Account Closed. | 409 | 4 | 105 |
| checkBookOrder already has checks that have been used. It cannot be modified. | 409 | 409 | 0 |
This endpoint allows partners to request check order information.
Transaction Description
For check purchases, the customer will see transaction description Paper Check Debit #XXXX, where XXXX is a check number.
Additional Response Codes
| Code | subCode | Description |
|---|---|---|
| 10 | 1 | Check book order is not found. |
| 10 | 0 | Account Not Found. |
Retrieves images of check payments.
API Call Structure
GET /programs/{programCode}/accounts/{accountIdentifier}/checkImages
Updated 22 days ago