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
- POST v1/send/check
REQUEST
- {
- "accountId": "{{accountId}}",
- "contactId": "{{contactId}}",
- "type": "physical",
- "amount": "80.00",
- "description": "Payment"
- }
RESPONSE
- {
- "id": "tra-edc1deaf-138a-465d-8a15-a146bbe9d466",
- "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
- "contactId": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
- "name": "Bright Might LLC",
- "accountNumber": "",
- "routingNumber": "",
- "address": {
- "addressType": "check",
- "line1": "123 Main St",
- "line2": "",
- "city": "New York",
- "state": "NY",
- "country": "US",
- "postalCode": "10001"
- },
- "amount": "80.00",
- "status": "completed",
- "description": "Payment",
- "txnType": "debit",
- "transferType": "physicalCheck",
- "transferSubType": "originated",
- "createdAt": "2021-12-16T08:37:23Z",
- "modifiedAt": "2021-12-16T08:37:23Z",
- "transferredAt": "2021-12-16T08:37:23Z",
- "accountType": "",
- "iban": "",
- "valid": "",
- "parentTransferId": "",
- "reviewCode": "",
- "reviewMessage": "",
- "type": "",
- "metadata": null
- }