CHchariot-giving
paymentSources

List Payment Sources

Changed on

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

Request

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

  • f97aa0ff99e3Revision changes
    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

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

    • info

      added to the /// response property allOf list for the response status

    • info

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

    • info

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

  • 2f40f9c4810aRevision changes
    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

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

    • info

      removed from the /// response property allOf list for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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