CHchariot-giving
paymentSources

Get a Payment Source

Changed on

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.

get/v1/payment_sources/{id}

Request

Path parameters

idstring required

The unique identifier for the payment source

Response

Successfully retrieved the payment source.

idstring

The unique identifier for the payment source

financial_account_idstring

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

namestring

The name of the payment source

source_type'manual' | 'portal' | 'lockbox' | 'grantmaker'

The type of the payment source

created_atstring date-time

The date and time when the payment source was created

updated_atstring date-time

The date and time when the payment source was last updated

Example response

{
  "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