Chariot paymentSources API

openapi: 3.0.0
info:
  title: Chariot FDX Accounts paymentSources API
  version: '6.0'
  description: Financial Data Exchange (FDX) v6 compatible API for read-only access to Chariot bank account data. Implements the FDX v6 standard for account information, transactions, and statements.
  contact:
    name: Chariot Development Team
    url: https://givechariot.com/contact
    email: developers@givechariot.com
servers:
- url: https://api.givechariot.com/fdx/v6
  description: Production
- url: https://devapi.givechariot.com/fdx/v6
  description: Staging
security:
- oauth2: []
tags:
- name: paymentSources
paths:
  /v1/payment_sources:
    get:
      summary: List Payment Sources
      description: '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.'
      operationId: listPaymentSources
      tags:
      - paymentSources
      security:
      - bearerAuth: []
      parameters:
      - name: limit
        in: query
        description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
        required: false
        schema:
          type: integer
          format: int32
      - name: page_token
        in: query
        description: The cursor to use for pagination. If not set, the first page of results will be returned.
        required: false
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/ListPaymentSourcesResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /v1/payment_sources/{id}:
    get:
      summary: Get a Payment Source
      description: '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.'
      operationId: getPaymentSource
      tags:
      - paymentSources
      security:
      - bearerAuth: []
      parameters:
      - name: id
        in: path
        description: The unique identifier for the payment source
        required: true
        schema:
          type: string
        example: payment_source_01j8rs605a4gctmbm58d87mvsj
      responses:
        '200':
          description: Successfully retrieved the payment source.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSource'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    FinancialAddress:
      type: object
      description: 'A subhash containing information about the electronic bank address payment rail details.

        This is only available for manual and connected_account payment sources.'
      properties:
        ach:
          $ref: '#/components/schemas/AchAddress'
    AchAddress:
      type: object
      description: A subhash containing information about the electronic bank address payment rail details.
      required:
      - institution_name
      - account_number
      - routing_number
      properties:
        account_number:
          type: string
          description: The account number of that uniquely identifies the account at the institution
          example: '987654321'
        routing_number:
          type: string
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
          example: '101050001'
    ProblemDetails:
      type: object
      description: RFC 7807 problem-details error (media type application/problem+json). The `status` field is an integer HTTP status code.
      required:
      - type
      - title
      - status
      - detail
      properties:
        type:
          type: string
          description: A URI reference identifying the problem type.
          example: about:blank
        title:
          type: string
          description: A short, human-readable summary of the problem type.
          example: API Error
        status:
          type: integer
          description: The HTTP status code for this error.
          example: 400
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence.
          example: The request is invalid or contains invalid parameters.
      example:
        type: about:blank
        title: API Error
        status: 400
        detail: The request is invalid or contains invalid parameters.
    PaymentSource:
      type: object
      description: '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.'
      properties:
        id:
          type: string
          readOnly: true
          description: The unique identifier for the payment source
          example: payment_source_01j8rs605a4gctmbm58d87mvsj
        financial_account_id:
          type: string
          description: The unique identifier for the financial account that the payment source belongs to
          example: fa_01j8rs605a4gctmbm58d87mvsj
        name:
          type: string
          description: The name of the payment source
          example: Main Payment Source
        source_type:
          type: string
          description: The type of the payment source
          example: portal
          enum:
          - manual
          - portal
          - lockbox
          - grantmaker
        financial_address:
          $ref: '#/components/schemas/FinancialAddress'
        lockbox:
          $ref: '#/components/schemas/Lockbox'
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: The date and time when the payment source was created
          example: '2020-01-31T23:59:59Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          description: The date and time when the payment source was last updated
          example: '2020-01-31T23:59:59Z'
    Lockbox:
      type: object
      description: 'A US mailing address to process incoming physical mail and checks.

        This is only available for lockbox payment sources.'
      properties:
        address:
          $ref: '#/components/schemas/PostalAddress'
    PostalAddress:
      type: object
      description: 'A postal address is a mailing address where physical mail can be received.

        Postal addresses can be used to receive paper checks.'
      required:
      - city
      - country
      - line1
      - postal_code
      - state
      properties:
        city:
          type: string
          description: City, district, suburb, town, or village.
          example: New York
        country:
          type: string
          description: Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
          example: US
        line1:
          type: string
          description: Address line 1 (e.g. street, PO Box, or company name)
          example: 123 Main St.
        line2:
          type: string
          description: Address line 2 (e.g. apartment, suite, unit, or building)
          example: Suite 2504
        postal_code:
          type: string
          description: ZIP or postal code
          example: '12345'
        state:
          type: string
          description: State, county, province, or region
          example: NY
  responses:
    BadRequestError:
      description: The request is invalid or contains invalid parameters
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            BadRequest:
              value:
                type: about:blank
                title: API Error
                status: 400
                detail: The request is invalid or contains invalid parameters.
    InternalServerError:
      description: Internal Server Error
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            InternalServerError:
              value:
                type: about:blank
                title: API Error
                status: 500
                detail: The server encountered an error processing your request.
    NotFoundError:
      description: Resource Not Found
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            NotFound:
              value:
                type: about:blank
                title: API Error
                status: 404
                detail: The requested resource was not found.
    AuthenticationError:
      description: Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            Unauthorized:
              value:
                type: about:blank
                title: API Error
                status: 401
                detail: Authentication credentials were missing or invalid.
    ForbiddenError:
      description: Access denied
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            Forbidden:
              value:
                type: about:blank
                title: API Error
                status: 403
                detail: You do not have permission to access this resource.
    ListPaymentSourcesResponse:
      description: The response for PaymentSources.list
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            type: object
            properties:
              results:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentSource'
              next_page_token:
                type: string
                description: "A cursor token to use to retrieve the next page of results by making another API call\n to the same endpoint with the same parameters (only changing the pageToken). If\n specified, then more results exist on the server that were not returned, otherwise\n no more results exist on the server."
  headers:
    X-Request-Id:
      description: The unique identifier for the request
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 Bearer token. A client may hold both scopes, but each FDX authorization must contain exactly one — they are mutually exclusive per authorization. An authorization containing both will be rejected. See the Authentication page for token exchange details.
      flows:
        authorizationCode:
          authorizationUrl: https://dashboard.givechariot.com/oauth/authorize
          tokenUrl: https://api.givechariot.com/auth/oauth/token
          scopes:
            read:bank_accounts: Read access to bank account data
            sync:connected_accounts: Sync access to connected account data