Receive a Check Deposit

Receive a check deposit money transfer is done by passing the required account id, contact id, amount and description. Response is a transfer object. It takes 3-5 business days for the credit to reflect in the account.

Depositing checks is a two step process:
Step 1: Initiate a check deposit via POST /v1/receive/check
Step 2: Pass the front and back of the check as images via PATCH /v1/receive/check/{{transferId}}/files

Step 1: Initiate a check deposit

ENDPOINT

1. POST v1/receive/check

REQUEST

1. {
2.     "accountId": "{{accountId}}",
3.     "contactId": "{{contactId}}",
4.     "amount": "58.00",
5.     "description": "Payment"
6. }

RESPONSE

1. {
2.     "id": "tra-cb841dfa-8ff8-4705-a99e-0bfe9d42cc29",
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": "58.00",
18.     "status": "waitingForFiles",
19.     "description": "Payment",
20.     "txnType": "credit",
21.     "transferType": "physicalCheck",
22.     "transferSubType": "originated",
23.     "createdAt": "2021-12-17T00:42:29Z",
24.     "modifiedAt": "2021-12-17T00:42:29Z",
25.     "transferredAt": "2021-12-17T00:42:29Z",
26.     "accountType": "",
27.     "iban": "",
28.     "valid": "",
29.     "parentTransferId": "",
30.     "reviewCode": "",
31.     "reviewMessage": "",
32.     "type": "",
33.     "metadata": null
34. }

Once the check deposit transfer object is created via the POST v1/receive/check, the transfer object is returned in the response with the status "waiting for files". Now, you move to Step 2, which is uploading the front and back of the check, by referencing the transferId via a PATCH.

Below file types are supported for Check files.
- jpg
- jpeg
- png
Max file size is 10MB for each file.

Step 2: Pass the front and back of the check as images

Notes: 
- The check needs to be in landscape orientation (horizontal)
- Please don't rotate the check and send to the Solid Platform
- As an alternative to uploading images via file path, you can send the image encoded in Base64 format.

ENDPOINT

1. PATCH /v1/receive/check/{{transferId}}/files
   

REQUEST

1. curl --location --request PATCH 'https://test-api.solidfi.com/v1/receive/check/{{transferId}}/files' \
2. --header 'sd-api-key: {{api-key}}' \
3. --header 'sd-person-id: {{personId}}' \
4. --form 'front=@"/{{path}}/front.jpg"' \
5. --form 'back=@"/{{path}}/back.jpg"'

RESPONSE

1. {
2.     "id": "tra-c1c89979-2302-4710-a80f-1ac0f72cc9de",
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": "28.00",
18.     "status": "pending",
19.     "description": "Payment",
20.     "txnType": "credit",
21.     "transferType": "physicalCheck",
22.     "transferSubType": "originated",
23.     "createdAt": "2021-12-17T00:51:01Z",
24.     "modifiedAt": "2021-12-17T00:51:24Z",
25.     "transferredAt": "2021-12-17T00:51:01Z",
26.     "accountType": "",
27.     "iban": "",
28.     "valid": "",
29.     "parentTransferId": "",
30.     "reviewCode": "",
31.     "reviewMessage": "",
32.     "type": "",
33.     "metadata": null
34. }

‍