Send a Check

Sends a check to a contact.
Send a Check
 last updated: 
February 28, 2022

Send a check is done by passing the required account id, contact id, type, amount and description. Currently, only physical check ("type": "physical") is supported. Response is a transfer object.

ENDPOINT

  1. POST v1/send/check

REQUEST

  1. {
  2.     "accountId": "{{accountId}}",
  3.     "contactId": "{{contactId}}",
  4.     "type": "physical",
  5.     "amount": "80.00",
  6.     "description": "Payment"
  7. }

RESPONSE

  1. {
  2.     "id": "tra-edc1deaf-138a-465d-8a15-a146bbe9d466",
  3.     "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  4.     "contactId": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  5.     "name": "Bright Might LLC",
  6.     "accountNumber": "",
  7.     "routingNumber": "",
  8.     "address": {
  9.         "addressType": "check",
  10.         "line1": "123 Main St",
  11.         "line2": "",
  12.         "city": "New York",
  13.         "state": "NY",
  14.         "country": "US",
  15.         "postalCode": "10001"
  16.     },
  17.     "amount": "80.00",
  18.     "status": "completed",
  19.     "description": "Payment",
  20.     "txnType": "debit",
  21.     "transferType": "physicalCheck",
  22.     "transferSubType": "originated",
  23.     "createdAt": "2021-12-16T08:37:23Z",
  24.     "modifiedAt": "2021-12-16T08:37:23Z",
  25.     "transferredAt": "2021-12-16T08:37:23Z",
  26.     "accountType": "",
  27.     "iban": "",
  28.     "valid": "",
  29.     "parentTransferId": "",
  30.     "reviewCode": "",
  31.     "reviewMessage": "",
  32.     "type": "",
  33.     "metadata": null
  34. }