OCW
Check Mailing API. Direct Deposit/ACH API, Echeck API To know more visit https://onlinecheckwriter.com/online-check-writer-api
57 subscribers
56 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
OCW endpoints
| Method | Endpoint | Description |
|---|---|---|
| Bank Account | ||
| PUT |
UpdateabankAccount /bankAccounts/{bankAccountId} |
Update an existing bank account Path parameters bankAccountId Required The id of the Bank account to update. Payload parameters name Required String The name of the bank… |
| GET |
Retrieveabankaccount /bankAccounts/{bankAccountId} |
Details of an existing bank account. Path parameters bankAccountId Required The id of the Bank account to be retrieved. |
| DELETE |
DeleteabankAccount /bankAccounts/{bankAccountId} |
Delete an existing bank account. Path parameters bankAccountId Required The id of the Bank account to be deleted. |
| POST |
AddSignature /bankAccounts/{bankAccountId}/signatures |
Add signature to existing bank account Path parameters bankAccountId Required The id of the Bank account to update. Payload parameters signature Required File Accepted file types… |
| GET |
Retrieveallbankaccounts /bankAccounts |
List all bank account records. Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For navigating… |
| POST |
Createbankaccounts /bankAccounts |
You can create multiple bank accounts in one single request by passing bank accounts attributes. Payload parameters bankAccounts Required Array An array of bankaccount attributes… |
| POST |
AddLogo /bankAccounts/{bankAccountId}/logos |
Add logo to existing bank account Path parameters bankAccountId Required The id of the Bank account to update. Payload parameters logo Required File Accepted file types are… |
| Attachments | ||
| POST |
Addnewattachment /checks/{checkId}/attachments |
Add new attachment to existing check Path parameters checkId Required The id of the check. Payload parameters attachment Required File File of type pdf,xls,xlsx,rtf,doc and docx |
| POST |
Createchecks /checks |
You can create multiple checks in one single request by passing check attributes. If you would like to create check with advance stub you need to pass voucherId or voucher data… |
| DELETE |
Deleteacheck /checks/{checkId} |
Permanently deletes a check. Path parameters checkId Required The id of the check to delete. |
| POST |
Printchecks /checks/print |
You can print checks by passing check id and paper type,if you would like to print multiple checks you need to pass checkId as array. Payload parameters paperType Required… |
| GET |
Retrieveacheck /checks/{checkId} |
Details of an existing check. Path parameters checkId Required The id of the check to retrieved. |
| DELETE |
Deleteaattachment /checks/{checkId}/attachments/{checkAttachmentId} |
Remove attachment. Path parameters checkId Required The id of the check. checkAttachmentId Required The id of the check attachment. |
| GET |
Retrieveallattachmentsdetails /checks/{checkId}/attachments |
Retrieve all attachments of a existing check. Path parameters checkId Required The id of the check. |
| GET |
Retrieveallchecks /checks |
List all check records Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For navigating through pages… |
| GET |
RetrievevoucherbycheckId /checks/{checkId}/voucher |
Details of an existing voucher. It can be retrieve by passing checkId as well as retrieve directly by passing voucherId. Path parameters checkId Required The id of the check to… |
| PUT |
Updateacheck /checks/{checkId} |
Update details of an existing check Path parameters checkId Required The id of the check to update. Payload parameters bankAccountId Required String Must be a bank account ID… |
| GET |
Retrieveaattachmentdetails /checks/{checkId}/attachments/{checkAttachmentId} |
Retrieve details of existing attachment. Path parameters checkId Required The id of the check. checkAttachmentId Required The id of the check attachment. |
| Payee | ||
| PUT |
Updateapayee /payees/{payeeId} |
Update details of an existing payee. Path parameters payeeId Required The id of the payee to update Payload parameters name Required String Name of payee,Must be no longer than… |
| GET |
Retrieveapayee /payees/{payeeId} |
Details of an existing payee. Path parameters payeeId Required The id of the payee to retrieve |
| GET |
Retrieveallpayees /payees |
List all payee records. Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For navigating through pages… |
| DELETE |
DeleteaPayee /payees/{payeeId} |
Permanently deletes a payee. Path parameters payeeId Required The id of the payee to delete |
| POST |
CreatePayees /payees |
You can create multiple payees in one single request by passing payee attributes. Payload parameters payees Required An array of payee attributes payee attributes name Required… |
| Custom From Address | ||
| GET |
Retrieveacustomfromaddress /customFromAddresses/{customFromAddressId} |
Details of custom from address. Path parameters customFromAddressId Required The id of the Custom from address to be retrieved. |
| POST |
Createacustomfromaddress /customFromAddresses |
Create a custom from address Payload parameters name Required String Must be no longer than 50 characters. companyName Optional String Must be no longer than 50 characters.… |
| DELETE |
Deleteacustomfromaddress /customFromAddresses/{customFromAddressId} |
Permanently deletes a custom from address. Path parameters customFromAddressId Required The id of the Custom from address to be delete. |
| PUT |
Updateacustomfromaddress /customFromAddresses/8X0Kmz47g4LOM27 |
Update details of an existing custom from address Path parameters customFromAddressId Required The id of the Custom from address to be update. Payload parameters name Required… |
| GET |
RetrieveallCustomfromaddresses /customFromAddresses |
List of all custom from address records. Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For… |
| Custom To Address | ||
| GET |
Retrieveacustomtoaddress /customToAddresses/{customToAddressId} |
Details of custom to address. Path parameters customToAddressId Required The id of the Custom to address to be retrieve. |
| GET |
RetrieveallCustomtoaddresses /customToAddresses |
List of all custom to address records Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For navigating… |
| DELETE |
Deleteacustomtoaddress /customToAddresses/{customToAddressId} |
Permanently deletes a custom to address. Path parameters customToAddressId Required The id of the Custom to address to be delete. |
| PUT |
Updateacustomtoaddress /customToAddresses/{customToAddressId} |
Update details of an existing custom to address Path parameters customToAddressId Required The id of the Custom to address to be update. Payload parameters name Required String… |
| POST |
Createacustomtoaddress /customToAddresses |
Create a custom to address Payload parameters name Required String Must be no longer than 50 characters. companyName Optional String Must be no longer than 50 characters.… |
| Email Check | ||
| POST |
CreateEmailCheck /emailchecks |
You can create multiple Email check in one single request. Payload parameters emailChecks Required An array of emailCheck attributes emailCheck attributes checkId Required String… |
| Category | ||
| POST |
CreateCategory /categories |
Create a category Payload parameters name Required String Must be no longer than 50 characters. type Required String Must be either income or expense |
| GET |
RetrieveallCategories /categories |
List of all category records. Query parameters perPage Number of records that you want to receive in the response,By default 10 records will be listed page For navigating through… |
| Voucher | ||
| DELETE |
Deletevoucher /vouchers/{voucherId} |
Permanently deletes a voucher. Path parameters voucherId Required The id of the voucher to be delete. |
| POST |
Createvoucher /vouchers |
Create New Voucher Payload parameters voucherNumber Required String Must be no longer than 50 characters. memo Optional String Must be no longer than 100 characters. date… |
| PUT |
UpdateVoucher /vouchers/{voucherId} |
Update existing voucher details Path parameters voucherId Required The id of the voucher to be update. Payload parameters voucherNumber Required String Must be no longer than 50… |
| GET |
Retrievevoucher /vouchers/{voucherId} |
Details of an existing voucher. It can be retrieve by passing checkId as well as retrieve directly by passing voucherId. Path parameters voucherId Required The id of the voucher… |
| ACH | ||
| GET |
GetAllstatus /ach/{checkId}/statusAll |
|
| GET |
GetStatus /ach/{checkId}/status |
|
| GetPaidForm | ||
| GET |
GetAllshortUrl /getpaid-by-form/ |
|
| POST |
CreateGetPaidByCheck /getpaid-by-form/check/ |
You can create Get Paid By check in one single request by passing attributes. Check attributes linkId Required String amount Required Decimal memo optional string maximum 150… |
| POST |
Createcustomer /getpaid-by-form/customer |
|
| GET |
GetCustomerDetails /getpaid-by-form/customer/{customerId} |
|
| PUT |
Updatecustomer /getpaid-by-form/customer/{id} |
|
| POST |
Createcustomerbankaccount /getpaid-by-form/bank-account/ |
Create Customer Bank Account |
| GET |
Retrievecustomerbankaccount /getpaid-by-form/bank-account/{customerBankAccountId} |
Retrieve customer bank account |
| PUT |
Updatecustomerbankaccount /getpaid-by-form/bank-account/{customerBankAccountId} |
|
+ 6 more endpoints on the provider's documentation.
OCW pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
