Lob Checks API

openapi: 3.2.0
info:
  title: Lob Checks API
  version: 1.20.2
  description: Experience direct mail like never before, with unmatched personalization and scalability  all in one intuitive platform.
  license:
    name: MIT
    url: https://mit-license.org/
  contact:
    name: Lob Developer Experience
    url: https://support.lob.com/
    email: lob-openapi@lob.com
  termsOfService: https://www.lob.com/legal
servers:
- url: https://api.lob.com/v1
  description: production
security:
- basicAuth: []
tags:
- name: Checks
  description: 'Checks allow you to send payments via physical checks. The API provides endpoints

    for creating checks, retrieving individual checks, canceling checks, and retrieving a list of checks.

    <div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>

    '
paths:
  /checks:
    get:
      operationId: checks_list
      summary: List
      description: Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first.
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/before_after'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/date_created'
      - $ref: '#/components/parameters/metadata'
      - $ref: '#/components/parameters/scheduled'
      - $ref: '#/components/parameters/send_date'
      - $ref: '#/components/parameters/mail_type'
      - $ref: '#/components/parameters/sort_by'
      - $ref: '#/components/parameters/status'
      responses:
        '200':
          $ref: '#/components/responses/all_checks'
        default:
          $ref: '#/components/responses/mailpiece_error'
      x-codeSamples:
      - lang: Shell
        source: "curl -X GET \"https://api.lob.com/v1/checks?limit=2\" \\\n  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
        label: CURL
      - lang: typescript
        source: "try {\n  const checks = await new ChecksApi(config).list(2);\n} catch (err: any) {\n  console.error(err);\n}\n"
        label: TYPESCRIPT
      - lang: Javascript
        source: "Lob.checks.list({limit: 2}, function (err, res) {\n  console.log(err, res);\n});\n"
        label: NODE
      - lang: Ruby
        source: "checksApi = ChecksApi.new(config)\n\nbegin\n  checks = checksApi.list({ limit: 2 })\nrescue => err\n  p err.message\nend\n"
        label: RUBY
      - lang: Python
        source: "with ApiClient(configuration) as api_client:\n  api = ChecksApi(api_client)\n\ntry:\n  checks = api.list(limit=2)\nexcept ApiException as e:\n  print(e)\n"
        label: PYTHON
      - lang: PHP
        source: "$apiInstance = new OpenAPI\\Client\\Api\\ChecksApi($config, new GuzzleHttp\\Client());\n\ntry {\n    $result = $apiInstance->list(\n      2, // limit\n    );\n} catch (Exception $e) {\n    echo $e->getMessage(), PHP_EOL;\n}\n"
      - lang: Java
        source: "ChecksApi apiInstance = new ChecksApi(config);\n\ntry {\n  CheckList response = apiInstance.list(\n    2, // limit\n    null, // before\n    null, // after\n    null, // include\n    null, // dateCreated\n    null, // metadata\n    null, // scheduled\n    null, // sendDate\n    null, // mailType\n    null // sortBy\n  );\n} catch (ApiException e) {\n  e.printStackTrace();\n}\n"
        label: JAVA
      - lang: Elixir
        source: 'Lob.Check.list(%{limit: 2})

          '
        label: ELIXIR
      - lang: CSharp
        source: "ChecksApi api = new ChecksApi(config);\n\nList<string> includeList = new List<string>();\nincludeList.Add(\"total_count\");\nDictionary<String, String> metadata = new Dictionary<String, String>();\nmetadata.Add(\"name\", \"Harry\");\nDictionary<String, DateTime> dateCreated = new Dictionary<String, DateTime>();\nDateTime dateCreatedDate = DateTime.Today.AddMonths(-1);\ndateCreated.Add(\"lt\", dateCreatedDate);\nDictionary<String, String> sendDate = new Dictionary<String, String>();\nsendDate.Add(\"lt\", DateTime.Now.ToString(\"yyyy-MM-ddTHH\\\\:mm\\\\:ss.fffffffzzz\"));\nSortBy3 sortBy = new SortBy3(SortBy3.DateCreatedEnum.Asc);\n\ntry {\n  CheckList response = api.list(\n    2, // limit\n    null, // before\n    null, // after\n    includeList, // include\n    dateCreated, // dateCreated\n    metadata, // metadata\n    true, // scheduled\n    sendDate, // sendDate\n    MailType.FirstClass, // mailType\n    sortBy // sortBy\n  );\n} catch (ApiException e) {\n  Console.WriteLine(e.ToString());\n}\n"
        label: CSHARP
      - lang: Go
        source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\nCheckList = apiClient.ChecksApi.List(context).Execute()\nif err != nil {\n    return err\n}\n"
        label: GO
    post:
      operationId: check_create
      summary: Create
      description: Creates a new check with the provided properties.
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/idem-header'
      - $ref: '#/components/parameters/idem-query'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/check_editable'
            example:
              description: Demo Check
              to:
                description: Harry - Office
                name: Harry Zhang
                company: Lob
                email: harry@lob.com
                phone: '5555555555'
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: '94107'
                address_country: US
              from:
                name: Leore Avidar
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: 94107-1741
              bank_account: bank_8cad8df5354d33f
              amount: 22.5
              memo: rent
              logo: https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png
              check_bottom: tmpl_23668b406d5afef
              merge_variables:
                name: Harry
              metadata:
                memo: rafting trip
              attachment: ./cool.pdf
              send_date: '2017-11-01T00:00:00.000Z'
              use_type: operational
              mail_type: usps_first_class
              check_number: 10001
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/check_editable'
            example:
              description: Demo Check
              to:
                description: Harry - Office
                name: Harry Zhang
                company: Lob
                email: harry@lob.com
                phone: '5555555555'
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: '94107'
                address_country: US
              from:
                name: Leore Avidar
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: 94107-1741
              bank_account: bank_8cad8df5354d33f
              amount: 22.5
              memo: rent
              logo: https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png
              check_bottom: tmpl_23668b406d5afef
              merge_variables:
                name: Harry
              metadata:
                memo: rafting trip
              attachment: ./cool.pdf
              send_date: '2017-11-01T00:00:00.000Z'
              mail_type: usps_first_class
              check_number: 10001
            encoding:
              to:
                style: deepObject
                explode: true
              from:
                style: deepObject
                explode: true
              merge_variables:
                style: deepObject
                explode: true
              metadata:
                style: deepObject
                explode: true
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/check_editable'
            example:
              description: Demo Check
              to:
                description: Harry - Office
                name: Harry Zhang
                company: Lob
                email: harry@lob.com
                phone: '5555555555'
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: '94107'
                address_country: US
              from:
                name: Leore Avidar
                address_line1: 210 King St
                address_line2: '# 6100'
                address_city: San Francisco
                address_state: CA
                address_zip: 94107-1741
              bank_account: bank_8cad8df5354d33f
              amount: 22.5
              memo: rent
              logo: https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png
              check_bottom: tmpl_23668b406d5afef
              merge_variables:
                name: Harry
              metadata:
                memo: rafting trip
              attachment: ./cool.pdf
              send_date: '2017-11-01T00:00:00.000Z'
              use_type: operational
              mail_type: usps_first_class
              check_number: 10001
            encoding:
              logo:
                contentType: image/png, image/jpeg
      responses:
        '200':
          $ref: '#/components/responses/post_check'
        default:
          $ref: '#/components/responses/mailpiece_error'
      x-codeSamples:
      - lang: Shell
        source: "curl https://api.lob.com/v1/checks \\\n  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n  -d 'description=Demo Check' \\\n  -d 'to[name]=Harry Zhang' \\\n  -d 'to[address_line1]=210 King St' \\\n  -d 'to[address_line2]=# 6100' \\\n  -d 'to[address_city]=San Francisco' \\\n  -d 'to[address_state]=CA' \\\n  -d 'to[address_zip]=94107' \\\n  -d 'from=adr_210a8d4b0b76d77b' \\\n  -d 'bank_account=bank_8cad8df5354d33f' \\\n  -d 'amount=22.50' \\\n  -d 'use_type=operational' \\\n  -d 'memo=rent' \\\n  --data-urlencode 'logo=https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png' \\\n  --data-urlencode 'check_bottom=<h1 style=\"padding-top:4in;\">Demo Check for {{name}}</h1>' \\\n  -d 'merge_variables[name]=Harry'\n"
        label: CURL
      - lang: Typescript
        source: "const checkCreate = new CheckEditable({\nto: new AddressEditable({\n  name: 'Harry Zhang',\n  address_line1: '210 King St',\n  address_line2: '# 6100',\n  address_city: 'San Francisco',\n  address_state: 'CA',\n  address_zip: '94107',\n}),\nfrom: 'adr_xxxx',\nbank_account: 'bank_xxxx',\namount: 100,\nuse_type: 'operational'\n});\n\ntry {\n  const myCheck = await new ChecksApi(config).create(checkCreate);\n} catch (err: any) {\n  console.error(err);\n}\n"
        label: TYPESCRIPT
      - lang: Javascript
        source: "Lob.checks.create({\n  description: 'Demo Check',\n  bank_account: 'bank_8cad8df5354d33f',\n  to: {\n    name: 'Harry Zhang',\n    address_line1: '210 King St',\n    address_line2: '# 6100',\n    address_city: 'San Francisco',\n    address_state: 'CA',\n    address_zip: '94107'\n  },\n  from: 'adr_210a8d4b0b76d77b',\n  amount: 22.50,\n  use_type: 'operational', \n  memo: 'rent',\n  logo: 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png',\n  check_bottom: '<h1 style=\"padding-top:4in;\">Demo Check for {{name}}</h1>',\n  merge_variables: {\n    name: 'Harry'\n  }\n}, function (err, res) {\n  console.log(err, res);\n});\n"
        label: NODE
      - lang: Ruby
        source: "checkCreate = CheckEditable.new({\n  description: \"Demo Check\",\n  bank_account: \"bank_8cad8df5354d33f\",\n  amount: 22.5,\n  memo: \"rent\",\n  logo: \"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\",\n  check_bottom: \"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\",\n  from: \"adr_210a8d4b0b76d77b\",\n  to: AddressDomestic.new({\n    name: \"Harry Zhang\",\n    address_line1: \"210 King St\",\n    address_line2: \"# 6100\",\n    address_city: \"San Francisco\",\n    address_state: \"CA\",\n    address_zip: \"94107\",\n  }),\n  merge_variables: {\n    name: \"Harry\"\n  },\n  use_type: \"operational\"\n});\n\ncheckApi = ChecksApi.new(config)\n\nbegin\n  createdCheck = checkApi.create(checkCreate)\nrescue => err\n  p err.message\nend\n"
        label: RUBY
      - lang: Python
        source: "check_editable = CheckEditable(\n  description = \"Demo Check\",\n  bank_account = \"bank_8cad8df5354d33f\",\n  amount = 22.5,\n  memo = \"rent\",\n  logo = \"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\",\n  check_bottom = \"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\",\n  _from = \"adr_210a8d4b0b76d77b\",\n  to = AddressDomestic(\n    name = \"Harry Zhang\",\n    address_line1 = \"210 King St\",\n    address_line2 = \"# 6100\",\n    address_city = \"San Francisco\",\n    address_state = \"CA\",\n    address_zip = \"94107\",\n  ),\n  merge_variables = MergeVariables(\n    name = \"Harry\",\n  ),\n  use_type = \"operational\"\n)\n\nwith ApiClient(configuration) as api_client:\n  api = ChecksApi(api_client)\n\ntry:\n  created_check = api.create(check_editable)\nexcept ApiException as e:\n  print(e)\n"
        label: PYTHON
      - lang: PHP
        source: "$to = new OpenAPI\\Client\\Model\\AddressEditable(\n  array(\n    \"name\"     => \"Harry Zhang\",\n    \"address_line1\"     => \"210 King St\",\n    \"address_line2\"     => \"# 6100\",\n    \"address_city\"     => \"San Francisco\",\n    \"address_state\"     => \"CA\",\n    \"address_zip\"     => \"94107\",\n  )\n);\n\n$merge_variables = new stdClass;\n$merge_variables->name = \"Harry\";\n\n$use_type = \"operational\";\n\n$apiInstance = new OpenAPI\\Client\\Api\\ChecksApi($config, new GuzzleHttp\\Client());\n$check_editable = new OpenAPI\\Client\\Model\\CheckEditable(\n  array(\n    \"description\"     => \"Demo Check\",\n    \"bank_account\"     => \"bank_8cad8df5354d33f\",\n    \"amount\"     => \"22.5\",\n    \"memo\"     => \"rent\",\n    \"logo\"     => \"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\",\n    \"check_bottom\"     => \"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\",\n    \"from\"     => \"adr_210a8d4b0b76d77b\",\n    \"to\"     => $to,\n    \"merge_variables\"     => $merge_variables,\n    \"use_type\" => $use_type\n  )\n);\n\ntry {\n    $result = $apiInstance->create($check_editable);\n} catch (Exception $e) {\n    echo $e->getMessage(), PHP_EOL;\n}\n"
      - lang: Java
        source: "Map<String, String> merge_variables = new HashMap<String, String>();\nmerge_variables.put(\"name\", \"Harry\");\n\nChecksApi apiInstance = new ChecksApi(config);\n\nAddressEditable to = new AddressEditable();\nto.setName(\"Harry Zhang\");\nto.setAddressLine1(\"210 King St\");\nto.setAddressLine2(\"# 6100\");\nto.setAddressCity(\"San Francisco\");\nto.setAddressState(\"CA\");\nto.setAddressZip(\"94107\");\n\ntry {\n  CheckEditable checkEditable = new CheckEditable();\n  checkEditable.setDescription(\"Demo Check\");\n  checkEditable.setBankAccount(\"bank_8cad8df5354d33f\");\n  checkEditable.setAmount(22.5f);\n  checkEditable.setMemo(\"rent\");\n  checkEditable.setLogo(\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\");\n  checkEditable.setCheckBottom(\"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\");\n  checkEditable.setFrom(\"adr_210a8d4b0b76d77b\");\n  checkEditable.setTo(to);\n  checkEditable.setMergeVariables(merge_variables);\n  checkEditable.setUseType(\"operational\");\n\n  Check result = apiInstance.create(checkEditable, null);\n} catch (ApiException e) {\n  e.printStackTrace();\n}\n"
        label: JAVA
      - lang: Elixir
        source: "Lob.Check.create(%{\n  description: 'Demo Check',\n  bank_account: 'bank_8cad8df5354d33f',\n  to: %{\n    name: 'Harry Zhang',\n    address_line1: '210 King St',\n    address_line2: '# 6100',\n    address_city: 'San Francisco',\n    address_state: 'CA',\n    address_zip: '94107'\n  },\n  from: 'adr_210a8d4b0b76d77b',\n  amount: 22.50,\n  memo: 'rent',\n  logo: 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png',\n  check_bottom: '<h1 style=\"padding-top:4in;\">Demo Check for {{name}}</h1>',\n  merge_variables: %{\n    name: 'Harry'\n  },\n  use_type: 'operational'\n})\n"
        label: ELIXIR
      - lang: CSharp
        source: "Dictionary<string, string> mergeVariables = new Dictionary<string, string>();\nmergeVariables.Add(\"name\", \"Harry\");\n\nChecksApi api = new ChecksApi(config);\n\nAddressEditable to = new AddressEditable(\n  \"210 King St\",  // addressLine1\n  \"# 6100\",  // addressLine2\n  \"San Francisco\",  // addressCity\n  \"CA\",  // addressState\n  \"94107\",  // addressZip\n  default(CountryExtended),  // addressCounty\n  \"\",  // description\n  \"Harry Zhang\" // name\n);\n\nCheckEditable checkEditable = new CheckEditable(\n  \"adr_249af768103d2810\",  // from\n  to.ToJson(),  // to\n  \"bank_8cad8df5354d33f\",  // bank_account\n  22.5f,  // amount\n  \"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\",  // logo\n  \"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\",  // checkBottom\n  default(string),  // attachment\n  \"Demo Check\",  // description\n  default(Dictionary<string, string>),  // metadata\n  mergeVariables,  // mergeVariables\n  default(DateTime),  // sendDate\n  CheckEditable.MailTypeEnum.UspsFirstClass,  // mailType\n  \"rent\", // memo\n  \"operational\" // use_type\n);\n\ntry {\n  Check result = api.create(checkEditable, null);\n} catch (ApiException e) {\n  Console.WriteLine(e.ToString());\n}\n"
        label: CSHARP
      - lang: Go
        source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\nvar to = *lob.NewAddressEditable()\nto.SetAddressLine1(\"210 King St\")\nto.SetAddressLine2(\"# 6100\")\nto.SetAddressCity(\"San Francisco\")\nto.SetAddressState(\"CA\")\nto.SetAddressZip(\"94107\")\nto.SetAddressCountry(lob.COUNTRYEXTENDED_US)\nto.SetDescription(\"\")\nto.SetName(\"Harry Zhang\")\n\nvar checkCreate = *lob.NewCheckEditable()\ncheckCreate.SetDescription(\"Demo Check\")\ncheckCreate.SetBankAccount(\"bank_8cad8df5354d33f\")\ncheckCreate.SetAmount(22.5)\ncheckCreate.SetMemo(\"rent\")\ncheckCreate.SetLogo(\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png\")\ncheckCreate.SetCheckBottom(\"<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>\")\ncheckCreate.SetFrom(\"adr_210a8d4b0b76d77b\")\ncheckCreate.SetTo(to)\n\n\ncreatedcheck, _, err := apiClient.ChecksApi.Create(context).CheckEditable(checkCreate).Execute()\n\nif err != nil {\n    return err\n}\n"
        label: GO
  /checks/{chk_id}:
    parameters:
    - in: path
      name: chk_id
      description: id of the check
      required: true
      schema:
        $ref: '#/components/schemas/chk_id'
    get:
      operationId: check_retrieve
      summary: Retrieve
      description: Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation.
      tags:
      - Checks
      responses:
        '200':
          description: Returns a check object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check'
              example:
                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&signature=Ty3IV2bGPEoQfrdraYHlNYTaarnHLXb
                to:
                  id: adr_bae820679f3f536b
                  description: Harry - Office
                  name: HARRY ZHANG
                  company: LOB
                  email: harry@lob.com
                  phone: '5555555555'
                  address_line1: 210 KING ST STE 6100
                  address_line2: ''
                  address_city: SAN FRANCISCO
                  address_state: CA
                  address_zip: 94107-1741
                  address_country: UNITED STATES
                  metadata: {}
                  date_created: '2018-12-08T03:08:43.446Z'
                  date_modified: '2018-12-08T03:08:43.446Z'
                  object: address
                  recipient_moved: false
                from:
                  id: adr_b8fb5acf3a2b55db
                  name: LEORE AVIDAR
                  address_line1: 210 KING 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
                  signature_url: https://lob-assets.com/bank-accounts/asd_asdfghjkqwertyui.pdf?expires=1234567890&signature=aksdf
                carrier: USPS
                tracking_events: []
                thumbnails:
                - small: https://lob-assets.com/checks/chk_534f10783683daa0_thumb_small_1.png?expires=1540372221&signature=ShhPpH74wYkNiAj7Il9B6q8ZKkzlGd4
                  medium: https://lob-assets.com/checks/chk_534f10783683daa0_thumb_medium_1.png?expires=1540372221&signature=tmIOq6aAyKgzAECp7STj1rvJuMS5Svd
                  large: https://lob-assets.com/checks/chk_534f10783683daa0_thumb_large_1.png?expires=1540372221&signature=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
                message: pancakes are good
                check_bottom_template_id: tmpl_a
                attachment_template_id: tmpl_a
                check_bottom_template_version_id: vrsn_a
                attachment_template_version_id: vrsn_a
                use_type: operational
                deleted: true
        default:
          $ref: '#/components/responses/mailpiece_error'
      x-codeSamples:
      - lang: Shell
        source: "curl https://api.lob.com/v1/checks/chk_534f10783683daa0 \\\n  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
        label: CURL
      - lang: Typescript
        source: "try {\n  const check = await new ChecksApi(config).get('chk_xxxx');\n} catch (err: any) {\n  console.error(err);\n}\n"
        label: TYPESCRIPT
      - lang: Javascript
        source: "Lob.checks.retrieve('chk_534f10783683daa0', function (err, res) {\n  console.log(err, res);\n});\n"
        label: NODE
      - lang: Ruby
        source: "checkApi = ChecksApi.new(config)\n\nbegin\n  retrievedCheck = checkApi.get(\"chk_534f10783683daa0\")\nrescue => err\n  p err.message\nend\n"
        label: RUBY
      - lang: Python
        source: "with ApiClient(configuration) as api_client:\n  api = ChecksApi(api_client)\n\ntry:\n  check = api.get(\"chk_534f10783683daa0\")\nexcept ApiException as e:\n  print(e)\n"
        label: PYTHON
      - lang: PHP
        source: "$apiInstance = new OpenAPI\\Client\\Api\\ChecksApi($config, new GuzzleHttp\\Client());\n\ntry {\n    $result = $apiInstance->get(\"chk_534f10783683daa0\");\n} catch (Exception $e) {\n    echo $e->getMessage(), PHP_EOL;\n}\n"
      - lang: Java
        source: "ChecksApi apiInstance = new ChecksApi(config);\n\ntry {\n  Check response = apiInstance.get(\"chk_534f10783683daa0\");\n} catch (ApiException e) {\n  e.printStackTrace();\n}\n"
        label: JAVA
      - lang: Elixir
        source: 'Lob.Check.find("chk_534f10783683daa0")

          '
        label: ELIXIR
      - lang: CSharp
        source: "ChecksApi api = new ChecksApi(config);\n\ntry {\n  Check response = api.get(\"chk_534f10783683daa0\");\n} catch (ApiException e) {\n  Console.WriteLine(e.ToString());\n}\n"
        label: CSHARP
      - lang: Go
        source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\nfetchedCheck, _, err := apiClient.ChecksApi.Get(context,\"chk_534f10783683daa0\").Execute()\n\nif err != nil {\n    return err\n}\n"
        label: GO
    delete:
      operationId: check_cancel
      summary: Cancel
      description: Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a> to gain access.
      tags:
      - Checks
      responses:
        '200':
          $ref: '#/components/responses/check_canceled'
        default:
          $ref: '#/components/responses/mailpiece_error'
      x-codeSamples:
      - lang: Shell
        source: "curl -X DELETE https://api.lob.com/v1/checks/chk_534f10783683daa0 \\\n  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
        label: CURL
      - lang: Typescript
        source: "try {\n  const deleteCheck = await new ChecksApi(config).cancel('chk_xxxx');\n} catch (err: any) {\n  console.error(err);\n}\n"
        label: TYPESCRIPT
      - lang: Javascript
        source: "Lob.checks.cancel('chk_534f10783683daa0', function (err, res) {\n  console.log(err, res);\n});\n"
        label: NODE
      - lang: Ruby
        source: "checkApi = ChecksApi.new(config)\n\nbegin\n  deletedCheck = checkApi.cancel(\"chk_534f10783683daa0\")\nrescue => err\n  p err.message\nend\n"
        label: RUBY
      - lang: Python
        source: "with ApiClient(configuration) as api_client:\n  api = ChecksApi(api_client)\n\ntry:\n  deleted_resource = api.cancel(\"chk_534f10783683daa0\")\nexcept ApiException as e:\n  print(e)\n"
        label: PYTHON
      - lang: PHP
        source: "$apiInstance = new OpenAPI\\Client\\Api\\ChecksApi($config, new GuzzleHttp\\Client());\n\ntry {\n    $result = $apiInstance->cancel(\"chk_534f10783683daa0\");\n} catch (Exception $e) {\n    echo $e->getMessage(), PHP_EOL;\n}\n"
      - lang: Java
        source: "ChecksApi apiInstance = new ChecksApi(config);\n\ntry {\n    CheckDeletion response = apiInstance.cancel(\"chk_534f10783683daa0\");\n} catch (ApiException e) {\n    e.printStackTrace();\n}\n"
        label: JAVA
      - lang: Elixir
        source: 'Lob.Check.destroy("chk_534f10783683daa0")

          '
        label: ELIXIR
      - lang: CSharp
        source: "ChecksApi api = new ChecksApi(config);\n\ntry {\n  CheckDeletion response = api.cancel(\"chk_534f10783683daa0\");\n} catch (ApiException e) {\n  Console.WriteLine(e.ToString());\n}\n"
        label: CSHARP
      - lang: Go
        source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\ndeletedCheck, _, err := apiClient.ChecksApi.Cancel(context, \"chk_534f10783683daa0\").Execute()\n\nif err != nil {\n    return err\n}\n"
        label: GO
components:
  schemas:
    check_editable:
      oneOf:
      - title: words at check bottom
        allOf:
        - required:
          - message
        - $ref: '#/components/schemas/check_editable_props'
      - title: image at check bottom
        allOf:
        - required:
          - check_bottom
        - $ref: '#/components/schemas/check_editable_props'
    check_editable_props:
      allOf:
      - $ref: '#/components/schemas/check_base'
      - $ref: '#/components/schemas/check_input_to'
      - type: object
        required:
        - bank_account
        - to
        - from
        - amount
        - use_type
        properties:
          from:
            description: Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification.
            oneOf:
            - $ref: '#/components/schemas/adr_id'
            - $ref: '#/components/schemas/inline_address_us'
          bank_account:
            allOf:
            - $ref: '#/components/schemas/bank_id_no_description'
            - type: string
              description: The id for a verified bank account.
          amount:
            description: The payment amount to be sent in US dollars. Amounts will be rounded to two decimal places.
            type: number
            format: float
            maximum: 999999.99
          logo:
            description: "Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. Image requirements:\n\n  * RGB or CMYK\n\n  * square\n\n  * minimum size: 100px x 100px\n\n  * transparent backgrond\n\n  * `png` or `jpg`"
            oneOf:
            - type: string
              pattern: ^https://[-a-zA-Z0-9@:%._+~#=/]{1,256}.(png|jpg)$
            - type: string
              pattern: ^(?!https://)[a-zA-Z0-9@:%._+~#=/]{1,256}.(png|jpg)$
          check_bottom:
            $ref: '#/components/schemas/check_bottom'
          attachment:
            description: 'A document to include with the check.


              Notes:

              - HTML merge variables should not include delimiting whitespace.

              - All pages of PDF, PNG, and JPGs must be sized at 8.5"x11" at 300 DPI, while supplied HTML will be rendered and trimmed to as many 8.5"x11" pages as necessary.

              - If a PDF is provided, it must be 6 pages or fewer.

              - The attachment will be printed double-sided in black & white and will be included in the envelope after the check page.

              - Please follow these <a href="https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_attachment_template.pdf" target="_blank">design guidelines</a>.


              See <a href="https://lob.com/pricing/print-mail#compare" target="_blank">pricing</a> for extra costs incurred. Need more help? Consult our [HTML examples](#section/HTML-Examples).'
            oneOf:
            - $ref: '#/components/schemas/html_string'
            - $ref: '#/components/schemas/tmpl_id'
            - $ref: '#/components/schemas/remote_file_url'
            - $ref: '#/components/schemas/local_file_path'
          billing_group_id:
            $ref: '#/components/schemas/billing_group_id'
          use_type:
            $ref: '#/components/schemas/chk_use_type'
    expected_delivery_date:
      type: string
      description: A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.
      format: date
    count:
      type: integer
      description: number of resources in a set
    address_editable_us:
      allOf:
     

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lob/refs/heads/main/openapi/lob-checks-api-openapi.yml