Creates a new check
POST {{baseUrl}}/checks
Creates a new check with the provided properties.
Request Body
[{"name"=>"description", "value"=>"Check Num 12345", "datatype"=>"string"}, {"name"=>"to", "value"=>"adr_69ccbb7384a84b77", "datatype"=>"string"}, {"name"=>"from", "value"=>"adr_69ccbb7384a84b77", "datatype"=>"string"}, {"name"=>"bank_account", "value"=>"bank_33afcfcbf73a7b3", "datatype"=>"string"}, {"name"=>"amount", "value"=>"1000", "datatype"=>"number"}, {"name"=>"memo", "value"=>"foobar", "datatype"=>"string"}, {"name"=>"check_number", "value"=>"12345", "datatype"=>"number"}, {"name"=>"logo", "value"=>"", "datatype"=>"null"}, {"name"=>"message", "value"=>"foobar", "datatype"=>"string"}, {"name"=>"check_bottom", "value"=>"<html><body>check bottom</body></html>", "datatype"=>"string"}, {"name"=>"attachment", "value"=>"", "datatype"=>"null"}, {"name"=>"mail_type", "value"=>"usps_first_class", "datatype"=>"string"}, {"name"=>"send_date", "value"=>"2021-11-01", "datatype"=>"string"}, {"name"=>"billing_group_id", "value"=>"", "datatype"=>"null"}, {"name"=>"merge_variables", "value"=>"{\"name\" : \"Harry\"}", "datatype"=>"string"}, {"name"=>"metadata", "value"=>"{\"customer_id\": \"987654\"}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Idempotency-Key | string | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our implementation guide. | |
Content-Type | string |
RESPONSES
status: OK
{"id":"chk_534f10783683daa0","description":"Demo Check","metadata":{},"check_number":10062,"memo":"rent","amount":22.5,"url":"https://lob-assets.com/checks/chk_534f10783683daa0.pdf?expires=1540372221\u0026signature=Ty3IV2bGPEoQfrdraYHlNYTaarnHLXb","to":{"id":"adr_d3489cd64c791ab5","name":"HARRY ZHANG","address_line1":"185 BERRY ST STE 6100","address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2017-09-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","deleted":true,"object":"address"},"from":{"id":"adr_b8fb5acf3a2b55db","name":"LEORE AVIDAR","address_line1":"185 BERRY ST STE 6100","address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2017-09-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","object":"address"},"bank_account":{"id":"bank_8cad8df5354d33f","description":"Test Bank Account","metadata":{},"routing_number":"322271627","account_number":"123456789","signatory":"John Doe","bank_name":"J.P. MORGAN CHASE BANK, N.A.","verified":true,"account_type":"company","date_created":"2015-11-06T19:24:24.440Z","date_modified":"2015-11-06T19:41:28.312Z","object":"bank_account"},"carrier":"USPS","tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/checks/chk_534f10783683daa0_thumb_small_1.png?expires=1540372221\u0026signature=ShhPpH74wYkNiAj7Il9B6q8ZKkzlGd4","medium":"https://lob-assets.com/checks/chk_534f10783683daa0_thumb_medium_1.png?expires=1540372221\u0026signature=tmIOq6aAyKgzAECp7STj1rvJuMS5Svd","large":"https://lob-assets.com/checks/chk_534f10783683daa0_thumb_large_1.png?expires=1540372221\u0026signature=04nLEwE9d2qgQJNgJYWSOgPnU0FZbEv"}],"merge_variables":{"name":"Harry"},"expected_delivery_date":"2017-09-12","mail_type":"usps_first_class","date_created":"2017-09-05T17:47:53.896Z","date_modified":"2017-09-05T17:47:53.896Z","send_date":"2017-09-05T17:47:53.896Z","object":"check"}