To enable webhook, Go to More >> Developer Panel (https://live.onlinecheckwriter.com/manage/developer/index)
Under the Webhook settings window, provide the necessary details.
1. Webhook URL: The URL to receive the webhook.
2. Secret key: Set any key to verify it is going from Online Check Writer. (Not required unless you want to validate signature key).
3. Mail Tracking Status: If you want to get only mailed checks, physical status, for instance, in transit, delivered, etc. (See the sample response attached).
4. Send Check Status Update: If you want to track the check statement status change. It will also provide you a tracking code if it is a mail check after generating envelope (See the sample response attached).
To enable webhook for get paid by form, Go to Settings >> Developer Panel (https://live.onlinecheckwriter.com/manage/developer/index)
Under the Get Paid by Form Webhook window, provide the necessary details.
1. Webhook URL: The URL to receive the webhook
2. Secret Key: Set any key to verify it's going from Online Check Writer. (Not required unless you want to validate signature key).
3. Select an event: Select the events to receive webhook. (Select checkboxes. When the event occurs, you receive a webhook from the webhook URL).
Available events:
gpbf.check.created : Created when a check is created using GPBL (payment link). Sample file attached (getpaid_by_form_created.txt).
gpbf.check.updated : Created when a check created with GPBL (payment link) is updated. Sample file attached (getpaid_by_form_updated.txt)
Here are the possible status codes and descriptions that can occur.
Status code | Short description | Full description |
1 | GPBL Acpt/Rej | Accept Or Reject This Check, Got Paid by Your Dedicated Bank Ac Link |
2 | GPBL Viewed | You Viewed This Check, Now Accept/Reject, then Print/Direct Deposit It. You Can Print on Check Paper or Plain Paper |
3 | GPBL Rejected | You Rejected This Check, Got Paid by Your Dedicated Bank Ac Link |
4 | GPBL Accepted | You Accepted This Check, Print/Direct Deposit Now. You Can Print on Check Paper or Plain Paper |
5 | GPBL TTP | You Tried to Print This Check & Marked as NOT PRINTED. Sender Gets this Notification. |
6 | GPBL Printed | You Printed This Check, Got Paid by Your Dedicated Bank Ac Link |
50 | DD Initiated | Initiated & Processing. You get paid this by Get paid Link. |
51 | DD Completed | DD Completed and Credited. Got Paid by Link. |
52 | DD Failed | DD Failed. Please Click on the View-eyeball button to see the reason. |
For quick reference and immediate information about our API, please, visit this link https://onlinecheckwriter.com/online-check-writer-api/
For requests or more detailed information about our API, please, send your inquiry to us at Support@onlinecheckwriter.com. Our development team will be in contact.