Get a Deposit | Chariot

curl https://api.givechariot.com/v1/deposits/deposit_01j8rs605a4gctmbm58d87mvsj \
     -H "Authorization: Bearer <token>"

{
  "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-31T23:00:00Z",
      "status": "accepted"
    },
    "check_deposit": {
      "auxiliary_on_us": "102",
      "routing_number": "101050001",
      "submitted_at": "2020-01-31T23:00:00Z",
      "status": "deposited"
    }
  },
  "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": "property_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
      }
    }
  ]
}

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.

created_atstringformat: "date-time"

The date and time when the deposit was created.

updated_atstringformat: "date-time"

The date and time when the deposit was last updated.

settled_atstringformat: "date-time"

The date and time when the deposit was settled.

returned_atstringformat: "date-time"

The date and time when the deposit was returned.

propertieslist of objects

A list of properties assigned to the deposit.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error