Get a Deposit | Chariot

{
  "id": "deposit_01j8rs605a4gctmbm58d87mvsj",
  "payment_source_id": "payment_source_01j8rs605a4gctmbm58d87mvsj",
  "status": "complete",
  "transfer": {
    "amount": 10000,
    "currency": "USD",
    "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
    "description": "Disbursement to nonprofit",
    "inbound_account_transfer": {
      "created_at": "2020-01-31T23:00:00Z"
    },
    "inbound_ach_transfer": {
      "standard_entry_class_code": "WEB",
      "company_entry_description": "GRANTPMT",
      "originator_routing_number": "1234567890",
      "originator_company_name": "Charity Good",
      "trace_number": "1234567890",
      "effective_date": "2020-01-31T00:00:00Z",
      "status": "accepted",
      "company_discretionary_data": "GRANT-2024-001",
      "payment_related_info": "Grant 12345 for the Annual Fund"
    },
    "ach_transfer": {
      "transfer_id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
      "amount": 10000,
      "status": "initiated",
      "created_at": "2020-01-31T23:00:00Z",
      "direction": "credit",
      "standard_entry_class_code": "corporate_credit_or_debit",
      "company_entry_description": "Disbursement to nonprofit",
      "trace_number": "012345678901234",
      "effective_date": "2020-01-31T00:00:00Z",
      "submitted_at": "2020-01-31T23:00:00Z",
      "settled_at": "2020-07-12 15:00:00.000",
      "rejected_at": "2020-07-12 15:00:00.000",
      "returned_at": "2020-07-12 15:00:00.000",
      "updated_at": "2020-01-31T23:00:00Z"
    },
    "check_deposit": {
      "auxiliary_on_us": "102",
      "routing_number": "101050001",
      "submitted_at": "2020-01-31T23:00:00Z",
      "status": "deposited"
    },
    "inbound_real_time_payments_transfer": {
      "status": "confirmed",
      "debtor_name": "Charity Good",
      "debtor_routing_number": "1234567890",
      "debtor_account_number": "9876543210",
      "transaction_identification": "20240101ABC123",
      "remittance_information": "Grant payment",
      "confirmed_at": "2020-01-31T23:00:00Z"
    },
    "inbound_wire_transfer": {
      "status": "confirmed",
      "originator_name": "Charity Good",
      "originator_routing_number": "1234567890",
      "originator_account_number": "9876543210",
      "confirmed_at": "2020-01-31T23:00:00Z"
    }
  },
  "donation_count": 1,
  "created_at": "2020-01-31T23:59:59Z",
  "updated_at": "2020-01-31T23:59:59Z",
  "settled_at": "2020-01-31T23:59:59Z",
  "returned_at": "2020-01-31T23:59:59Z",
  "properties": [
    {
      "property_id": "prop_01j8rs605a4gctmbm58d87mvsj",
      "value": {
        "type": "text",
        "text_value": "string",
        "enum_value_id": "string",
        "user_value_id": "string",
        "boolean_value": true,
        "date_value": "2024-01-15T09:30:00Z",
        "empty": true
      }
    }
  ],
  "bank_created_at": "2020-01-31T23:59:59Z"
}

Get a deposit by its unique identifier.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the deposit

Response

The deposit was retrieved

idstringRead-only

The unique identifier for this object.

payment_source_idstring

The unique identifier for the payment source that contains the money for the deposit.

statusenum

The status of the deposit.

Allowed values:

transferobject

A subhash containing information about the transfer associated with the deposit.

donation_countintegerRead-only

The number of donations reconciled to this deposit. 0 when no donations are reconciled to it.

created_atdatetime

The date and time when the deposit was created.

updated_atdatetime

The date and time when the deposit was last updated.

settled_atdatetimeOptional

The date and time when the deposit was settled.

returned_atdatetimeOptional

The date and time when the deposit was returned.

propertieslist of objectsOptional

A list of properties assigned to the deposit.

bank_created_atdatetimeOptional

The date and time when the bank created the deposit.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error