Responses

• • 200 object

  Organization

  • organization_id string Required

    The Canopy-generated ID for the organization.

  • created_at string(date-time) Required

    The Date-Time that this organization was created on the server.

  • logo_url string

    Organization's logo URL.

  • features object

    Feature settings for your organization

    • strict_entity_client_id boolean

      If true, all entity ids (account_id, customer_id, product_id, etc.) should be communicated with your organization's identifier for that resource. Otherwise, Canopy-generated ID's should be used. See document versioning for additional details.

  • organization_overview object Required

    General organization details.

    • organization_name string Required

      Name of Organization, i.e. LeverCard 3000.

    • webhook_url string | null

      A URL to which events pertaining to your organization get posted

    • address_name string | null
    • address_line_one string | null
    • address_line_two string | null
    • address_city string | null
    • address_state string | null
    • address_zip string | null
  • issuer_processors object | null
    • lithic_config object | null
      • api_key string Required

        Lithic API key for your organization. You can generate this in your Lithic dashboard as a self-service option.

      • enable_consumer_accounts boolean

        Whether the Lithic API key should manage a portfolio of consumer accounts. Review https://docs.lithic.com/docs/managing-accounts

    • galileo_config object | null
      • apiLogin string Required

        Provider's web service username, as provided by Galileo for the requesting IP address.

      • apiTransKey string Required

        Web service password, as provided by Galileo for the requesting IP address.

      • providerId string Required

        Galileo-issued unique provider identifier.

      • prodId string Required

        Galileo-generated identifier for a product.

  • payment_processors object
    • repay_config object

      Repay API configurations.

      • api_user string

        Your Repay API user key.

      • api_token string

        Your Repay API access key.

      • merchant_id string

        The merchant config value obtained from the corresponding payment processor.

    • checkout_config object

      Checkout.com API configurations.

      • secret_key string | null

        Checkout.com secret key.

      • public_key string | null

        Checkout.com public key

      • processing_channel_id string | null

        A processing channel is the equivalent of a business line. In order to process your transactions you may need to denote which processing channel to process the transaction request on.

    • dwolla_config object

      Dwolla API configurations.

      • app_key string | null

        Dwolla app key.

      • app_secret string | null

        Dwolla app secret

      • master_account string | null

        Your Dwolla master account.

    • modern_treasury_config object

      Modern Treasury API configurations.

      • api_key string | null

        Modern Treasury api key.

      • org_id string | null

        Modern Treasury organization id.

      • originating_account_id string | null

        Modern Treasury originating account id.

    • authorize_net_config object

      Authorize.net API configurations.

      • merchant_name string | null

        Your Authorize.net merchant name.

      • transaction_key string | null

        Your Authorize.net merchant transaction key.

      • is_prod boolean | null

        Whether you are using production mode for Authorize.net.

    • stripe_config object

      Stripe API configuration

      • api_url string | null

        URL to use for stripe API requests. For switching end points to use sandbox, etc..

      • api_client_id string | null

        Client ID to use for stripe API requests.

      • api_secret_key string | null

        Secret to use for stripe API requests.

      • webhook_url string | null

        URL that will receive webhook callbacks from the stripe service.

      • webhook_signing_key string | null

        Signing key for validating the webhook body.

  • credit_reporting object
    • transunion_program_identifier integer

      If included, a metro2 report will be generated for your organization which uses this code to report to TransUnion.

    • experian_program_identifier integer

      If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

    • equifax_program_identifier integer

      If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

    • program_date string(date)

      The date your program started reporting credit to the bureaus.

    • reporter_name string

      Your organization's name, as reporting to the credit bureaus.

    • reporter_address_line_one string

      Reporter address line one.

    • reporter_address_line_two string

      Reporter address line two.

    • reporter_address_city string

      Reporter address city.

    • reporter_address_state string

      Address state.

      Values are AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, or WY.

    • reporter_address_zip string

      Reporter address, five digit zipcode or nine digit 'ZIP+4'.

    • reporter_phone_number string

      Reporter's phone number in E.164 format.

• • 401

  Unauthorized.

• • 403

  Forbidden.

• • 422

  Invalid input

• • 429

  Too many requests.

• • default

  Unexpected Error.