Skip to main content
POST
Create a Remote Check Deposit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Attributes of the Remote Check Deposit to create

User provided request to submit an RDC

account_id
string<uuid>
required

The ID of the account

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

back_image_id
string<uuid>
required

ID of the uploaded image of the back of the check

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

check_amount
integer
required

Amount on check in ISO 4217 minor currency units

Required range: x >= 1
Example:

12345

deposit_currency
string
required

ISO 4217 currency code for the deposit amount

Example:

"USD"

front_image_id
string<uuid>
required

ID of the uploaded image of the front of the check

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

business_id
string<uuid>

Unique ID for the business. Exactly one of business_id or person_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

Response

Successful creation of a deposit using remote deposit capture

Deposit using remote deposit capture

account_id
string<uuid>
required

The ID of the account

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

back_image_id
string<uuid>
required

ID of the uploaded image of the back of the check

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

check_amount
integer
required

Amount on check in ISO 4217 minor currency units

Required range: x >= 1
Example:

12345

deposit_currency
string
required

ISO 4217 currency code for the deposit amount

Example:

"USD"

front_image_id
string<uuid>
required

ID of the uploaded image of the front of the check

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

date_captured
string<date-time>
required

Date the deposit was captured, in RFC 3339 format

Example:

"2010-05-06T12:23:34.321Z"

date_processed
string<date-time>
required

Date the deposit was processed, in RFC 3339 format

Example:

"2010-05-06T12:23:34.321Z"

deposit_amount
integer
required

Amount deposited in ISO 4217 minor currency units

Example:

12345

id
string<uuid>
required

Remote Check Deposit ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

status
enum<string>
required

The status of the deposit

Available options:
FAILED,
MANUAL_POST_REJECTED,
PENDING,
REJECTED,
RETURNED,
SUBMITTED
business_id
string<uuid>

Unique ID for the business. Exactly one of business_id or person_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

creation_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

file_loc_identifier
string | null

Identifier of the ICL file this deposit was transmitted in, if any

last_updated_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

matching_declined_check
string<uuid>[]

IDs of other deposits, already rejected, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit.

matching_pending_check
string<uuid>[]

IDs of other deposits, currently pending, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit.

matching_submitted_check
string<uuid>[]

IDs of other deposits, already submitted, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit.

ocr_account_number
string

Account number of the issuer of the check, included if OCR is successful

Example:

"123456789"

ocr_check_number
string

The unique check number for this check in the checkbook, included if OCR is successful and there is a check number on the check

Example:

"001"

ocr_routing_number
string

Routing number of the issuing bank, included if OCR is successful

Example:

"026009593"

transaction_id
string<uuid>

The ID of the transaction associated with this deposit

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

vendor_info
Vendor Info · object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.