Get a Payment Source

{
  "id": "payment_source_01j8rs605a4gctmbm58d87mvsj",
  "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
  "name": "Main Payment Source",
  "source_type": "portal",
  "financial_address": {
    "ach": {
      "account_number": "987654321",
      "routing_number": "101050001"
    }
  },
  "lockbox": {
    "id": "lockbox_01j8rs605a4gctmbm58d87mvsj",
    "created_at": "2020-01-31T23:59:59Z",
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "123 Main St.",
      "postal_code": "12345",
      "state": "NY",
      "line2": "Suite 2504"
    },
    "updated_at": "2020-01-31T23:59:59Z"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "updated_at": "2020-01-31T23:59:59Z"
}

Get a payment source by its unique identifier.

A Payment Source represents a segregated address for incoming deposits. In practice, this can be separate electronic bank addresses (account + routing numbers) or physical mailing addresses (lockboxes). Payment Sources make it easy to independently manage and consolidate incoming payments and donations from different sources which in turn makes reconciliation of money and data seamless. Every Payment Source belongs to a specific Financial Account and can be thought of as a gateway/door for money to flow into the Financial Account. Payment Sources are not separately ledgered which means you can’t get the balance of a Payment Source separately from the Financial Account.

Payment Sources should be setup and managed through the Chariot Dashboard.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the payment source

Response

Successfully retrieved the payment source.

idstringOptionalRead-only

The unique identifier for the payment source

financial_account_idstringOptional

The unique identifier for the financial account that the payment source belongs to

namestringOptional

The name of the payment source

source_typeenumOptional

The type of the payment source

Allowed values:

financial_addressobjectOptional

A subhash containing information about the electronic bank address payment rail details. This is only available for manual and connected_account payment sources.

lockboxobjectOptional

A Lockbox represents a physical mailing address operated by a third-party provider (e.g., Stable, CDS) that receives physical mail and scans checks on Chariot's behalf. Lockboxes are the source of Mail Items, which in turn produce Donations and Deposits. Lockboxes are provisioned and managed by Chariot in partnership with the provider.

created_atdatetimeOptionalRead-only

The date and time when the payment source was created

updated_atdatetimeOptionalRead-only

The date and time when the payment source was last updated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error