paymentSources

List Payment Sources

List payment sources for your Chariot account.

Payment Sources represent segregated addresses 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.

get/v1/payment_sources

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

Response

The response for PaymentSources.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "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",
        "address": {
          "city": "New York",
          "country": "US",
          "line1": "123 Main St.",
          "line2": "Suite 2504",
          "postal_code": "12345",
          "state": "NY"
        },
        "created_at": "2020-01-31T23:59:59Z",
        "updated_at": "2020-01-31T23:59:59Z"
      },
      "created_at": "2020-01-31T23:59:59Z",
      "updated_at": "2020-01-31T23:59:59Z"
    }
  ]
}

Changes

Changed in 5 of the 41 revisions of this API.26540

Aug 20, 20268446023e02fb614See the full diff
- ▲
  the results/items/lockbox/address response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property results/items/lockbox/address/city from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property results/items/lockbox/address/country from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property results/items/lockbox/address/line1 from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property results/items/lockbox/address/postal_code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property results/items/lockbox/address/state from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property results/items/lockbox/address/line2 from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property results/items/lockbox/updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added PostalAddress to the results/items/lockbox/address response property allOf list for the response status 200
  response-property-all-of-added
- ○
  added the required property results/items/lockbox/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property results/items/lockbox/id to the response with the 200 status
  response-required-property-added
Jun 29, 2026b87f7738d336820See the full diff
- ▲
  removed the required property code from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 401
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 403
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 500
  response-media-type-name-specialized
- ○
  added the required property detail to the response with the 400 status
  response-required-property-added
- ○
  added the required property detail to the response with the 401 status
  response-required-property-added
- ○
  added the required property detail to the response with the 403 status
  response-required-property-added
- ○
  added the required property detail to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 400 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 403 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
- ○
  added the required property title to the response with the 400 status
  response-required-property-added
- ○
  added the required property title to the response with the 401 status
  response-required-property-added
- ○
  added the required property title to the response with the 403 status
  response-required-property-added
- ○
  added the required property title to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026c65f43c5ad904See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
Jun 25, 2026f89b4f376e9412See the full diff
- ○
  added the optional property details/items/debug to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 500 status
  response-optional-property-added
Jun 25, 202690671617b825124See the full diff
- ▲
  the code response's property type/format changed from number/ to string/ for status 400
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 401
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 403
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 500
  response-property-type-changed
- ▲
  removed the required property error from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 500 status
  response-required-property-removed
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history