CHchariot-giving
deposits

Get a Deposit

Changed on

Get a deposit by its unique identifier.

get/v1/deposits/{id}

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/deposits/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique identifier for the deposit

Response

The deposit.

idstring required

The unique identifier for the deposit.

source_idstring

The identifier of the Source that sent this deposit.

payment_source_idstring

Deprecated. Use source_id.

deposit_address_idstring nullable

The identifier of the Deposit Address that received the funds. Null when the funds didn't arrive through a deposit address, such as a mailed check.

settled_atstring date-time

The date and time when the deposit was settled.

returned_atstring date-time

The date and time when the deposit was returned.

status'pending' | 'complete' | 'failed' required

The status of the deposit.

donation_countinteger required

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

created_atstring date-time required

The date and time when the deposit was created.

updated_atstring date-time required

The date and time when the deposit was last updated.

bank_created_atstring date-time

Deprecated. Use transfer.bank_created_at.

Example response

{
  "id": "deposit_01j8rs605a4gctmbm58d87mvsj",
  "source_id": "source_01m12tn300eh20gdqscje7s5jw",
  "deposit_address_id": "deposit_address_01m12tn300eh20gdqscje7s5jw",
  "status": "complete",
  "settled_at": "2026-09-25T18:00:00Z",
  "donation_count": 1,
  "transfer": {
    "amount": 25000,
    "currency": "USD",
    "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
    "description": "FIDELITY CHARITABLE GRANT",
    "bank_created_at": "2026-09-25T14:00:00Z",
    "inbound_ach_transfer": {
      "standard_entry_class_code": "CCD",
      "company_entry_description": "GRANTPMT",
      "originator_routing_number": "021000021",
      "originator_company_name": "Fidelity Charitable",
      "trace_number": "021000021234567",
      "effective_date": "2026-09-25T00:00:00Z",
      "status": "accepted",
      "company_discretionary_data": "GRANT-2026-001",
      "payment_related_info": "Grant 12345 for the Annual Fund"
    }
  },
  "properties": [],
  "created_at": "2026-09-25T14:00:00Z",
  "updated_at": "2026-09-25T18:00:00Z"
}

Changes

  • 2026-10-01f4ff1656e498Revision changes
    • info

      added the optional property ////////// to the response with the status

  • 2026-10-01ed57483469bdRevision changes
    • info

      added the required property to the response with the status