Skip to content

Corgi BankDocumentation

OpenAPI

The Remote Deposit object

RemoteDeposit is one item a customer captured remotely.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

adjustment_amountintegerOptional

adjustment_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

adjustment_reasonstringOptional

amountintegerRequired

channelstringRequired

check_deposit_idstringOptional

created_atstring · date-timeRequired

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decided_bystringOptional

deposited_onstring · date or nullOptional

A business date, YYYY-MM-DD

endorsement_presentbooleanRequired

endorsement_restrictivebooleanRequired

has_imagesbooleanRequired

idstringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

microbjectRequired

MICR is a check's magnetic line.

4 child attributes

aux_on_usstringOptional

check_numberstringOptional

on_usstringRequired

Account number, "/" and serial as printed

payor_routing_numberstringRequired

payeestringOptional

pending_actorstringOptional

pending_decisionstringOptional

product_codestringRequired

quality_codesarray of stringsOptional

reject_reasonstringOptional

review_reasonsarray of stringsOptional

statusstringRequired

updated_atstring · date-timeRequired

The Remote Deposit object

{
  "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "adjustment_amount": 10000,
  "adjustment_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "adjustment_reason": "string",
  "amount": 10000,
  "channel": "string",
  "check_deposit_id": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "currency_code": "USD",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "decided_by": "string",
  "deposited_on": "2026-09-17",
  "endorsement_present": false,
  "endorsement_restrictive": false,
  "has_images": false,
  "id": "string",
  "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "micr": {
    "aux_on_us": "string",
    "check_number": "string",
    "on_us": "string",
    "payor_routing_number": "string"
  },
  "payee": "string",
  "pending_actor": "string",
  "pending_decision": "string",
  "product_code": "string",
  "quality_codes": [
    "string"
  ],
  "reject_reason": "string",
  "review_reasons": [
    "string"
  ],
  "status": "string",
  "updated_at": "2026-09-17T14:30:00Z"
}