v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Remote Check Deposit (beta)

Create a Remote Check Deposit

Create a new deposit using remote deposit capture to an account

post/rdc/deposits

Headers

Idempotency-Keystring

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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.

Request body

account_idstring uuid required

The ID of the account

back_image_idstring uuid required

ID of the uploaded image of the back of the check

business_idstring uuid

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

check_amountinteger required

Amount on check in ISO 4217 minor currency units

deposit_currencystring required

ISO 4217 currency code for the deposit amount

front_image_idstring uuid required

ID of the uploaded image of the front of the check

metadataMetadata

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

person_idstring uuid

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

tenantstring

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

Example request

{
  "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "back_image_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "business_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "check_amount": 12345,
  "deposit_currency": "USD",
  "front_image_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "person_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "tenant": "abcdef_ghijkl"
}

Response

Successful creation of a deposit using remote deposit capture

account_idstring uuid required

The ID of the account

back_image_idstring uuid required

ID of the uploaded image of the back of the check

business_idstring uuid

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

check_amountinteger required

Amount on check in ISO 4217 minor currency units

deposit_currencystring required

ISO 4217 currency code for the deposit amount

front_image_idstring uuid required

ID of the uploaded image of the front of the check

metadataMetadata

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

person_idstring uuid

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

tenantstring

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

creation_timestring date-time

date_capturedstring date-time required

Date the deposit was captured, in RFC 3339 format

date_processedstring date-time required

Date the deposit was processed, in RFC 3339 format

deposit_amountinteger required

Amount deposited in ISO 4217 minor currency units

file_loc_identifierstring nullable

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

idstring uuid required

Remote Check Deposit ID

last_updated_timestring date-time

matching_declined_checkstring[]

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_checkstring[]

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_checkstring[]

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_numberstring

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

ocr_check_numberstring

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

ocr_routing_numberstring

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

The status of the deposit

transaction_idstring uuid

The ID of the transaction associated with this deposit

Example response

{
  "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "back_image_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "business_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "check_amount": 12345,
  "deposit_currency": "USD",
  "front_image_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "person_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "tenant": "abcdef_ghijkl",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "date_captured": "2010-05-06T12:23:34.321Z",
  "date_processed": "2010-05-06T12:23:34.321Z",
  "deposit_amount": 12345,
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "ocr_account_number": "123456789",
  "ocr_check_number": "001",
  "ocr_routing_number": "026009593",
  "transaction_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "vendor_info": {
    "vendor": "SOCURE"
  }
}