Responses

• 200

  Organization

  Hide response attributes Show response attributes object

  • 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

    Hide features attribute Show features attribute object

    • 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.

    Hide organization_overview attributes Show organization_overview attributes object

    • 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
    Hide issuer_processors attribute Show issuer_processors attribute object

    • lithic_config object

      Lithic API configurations.

      Hide lithic_config attribute Show lithic_config attribute object

      • api_key string

        Lithic's API key

  • payment_processors object
    Hide payment_processors attributes Show payment_processors attributes object

    • repay_config object

      Repay API configurations.

      Hide repay_config attributes Show repay_config attributes object

      • 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.

      Hide checkout_config attributes Show checkout_config attributes object

      • 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.

      Hide dwolla_config attributes Show dwolla_config attributes object

      • 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.

      Hide modern_treasury_config attributes Show modern_treasury_config attributes object

      • 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.

      Hide authorize_net_config attributes Show authorize_net_config attributes object

      • merchant_name string | null

        Your Authorize.net merchant name.

      • transaction_key string | null

        Your Authorize.net merchant transaction key.

  • credit_reporting object
    Hide credit_reporting attributes Show credit_reporting attributes 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.