Body

• ach object

  ACH processing configuration.

  Hide ach attributes Show ach attributes object

  • payment_processor_name string Required

    Indicates the active payment processor whose configuration will be used for ACH/Debit card payments made from the account.

    Values are NONE, REPAY, DWOLLA, MODERN_TREASURY, or CANOPY_NACHA. Default value is NONE.

  • repay_config object

    Sensitive bank information will be stored as a secured token for payments in place of the raw account details.

    Hide repay_config attributes Show repay_config attributes object

    • repay_check_type string Required

      Type of checking account: Personal or Business.

      Values are PERSONAL or BUSINESS.

    • repay_account_type string Required

      Type of account: Savings or Checking.

      Values are SAVINGS or CHECKING.

    • repay_transit_number string Required

      Transit number is a nine-digit code based on the U.S. Bank location where your account was opened.

    • repay_account_number string Required

      Account number is an eight to ten digit number that identifies a specific account.

    • repay_name_on_check string Required

      Account holder's name as it appears on the account.

  • dwolla_config object

    Dwolla account verified and tokenized using Plaid.

    Hide dwolla_config attribute Show dwolla_config attribute object

    • dwolla_plaid_token string Required

      Plaid token generated for processing by Dwolla.

  • modern_treasury_config object

    Store bank details or a secured token for payments.

    Hide modern_treasury_config attributes Show modern_treasury_config attributes object

    • name string Required

      Account holder's name as it appears on the account.

    • account_number string

      Account number is an eight to ten digit number that identifies a specific account.

    • account_type string

      Type of account: Savings or Checking.

      Values are SAVINGS or CHECKING.

    • routing_number string

      Routing number is a nine-digit code based on the U.S. Bank location where your account was opened.

    • plaid_processor_token string

      Plaid processor token retrieved from Plaid Link.

  • canopy_nacha_config object

    Canopy will create a NACHA file for each borrower ACH payment to be sent to your bank for ACH execution.

    Hide canopy_nacha_config attributes Show canopy_nacha_config attributes object

    • bank_routing_number string Required

      Routing number is a nine-digit code based on the U.S. Bank location where your account was opened.

    • bank_account_number string Required

      Account number is an eight to ten digit number that identifies a specific account.

• debit_card object

  Debit processing configuration.

  Hide debit_card attributes Show debit_card attributes object

  • payment_processor_name string Required

    Indicates the active payment processor whose configuration will be used for payments made from the account. If NONE, Canopy will not trigger payments to an external payment processor when they occur.

    Values are NONE, REPAY, or AUTHORIZE_NET. Default value is NONE.

  • repay_config object

    Sensitive debit card information will be stored as a secured token for payments in place of the raw account details.

    Hide repay_config attributes Show repay_config attributes object

    • repay_card_number string Required

      16 digit debit card number.

      Minimum length is 16, maximum length is 16. Format should match the following pattern: ^[0-9]{16}$.

    • repay_exp_date string Required

      The card expiration date in the format MMYY.

      Minimum length is 4, maximum length is 4. Format should match the following pattern: ^[0-9]{4}$.

    • repay_name_on_card string Required

      The card holder's name as it appears on the card.

    • repay_street string Required

      The card holder's billing street address.

    • repay_zip string Required

      The card holder's billing zip code.

  • authorize_net_config object

    Sensitive credit or debit card information will be stored as a secured token for payments in place of the raw account details. Note: This leverages credit card payment gateways, and Canopy cannot differentiate between credit or debit cards used in this payment integration. See authorize.net payment profiles for further details.

    Hide authorize_net_config attributes Show authorize_net_config attributes object

    • card_number string Required

      16 digit debit card number.

      Minimum length is 16, maximum length is 16. Format should match the following pattern: ^[0-9]{16}$.

    • expiry_month string

      The card expiration month.

      Minimum length is 2, maximum length is 2. Format should match the following pattern: ^[0-9]{2}$.

    • expiry_year string

      The card expiration year.

      Minimum length is 4, maximum length is 4. Format should match the following pattern: ^[0-9]{4}$.

    • cvv string

      The card cvv, i.e. security code.

      Minimum length is 3, maximum length is 4.

• credit_card object

  Credit processing configuration.

  Hide credit_card attributes Show credit_card attributes object

  • payment_processor_name string Required

    Indicates the active payment processor whose configuration will be used for Credit card payments made from the account.

    Values are NONE or CHECKOUT. Default value is NONE.

  • checkout_config object
    Hide checkout_config attributes Show checkout_config attributes object

    • source_id string

      A Checkout.com payment source id or customer id.

    • card_token string

      The tokenized card number.

    • card_number string

      Card number.

    • expiry_month string

      The expiration month XX.

    • expiry_year string

      The expiration year XX.

    • cvv string

      The card cvv, i.e. security code.

      Minimum length is 3, maximum length is 4.

• autopay_enabled boolean

  Indicates whether autopay is enabled for this account. Currently, autopay is triggered 1 day prior to a payment due date. If default_payment_processor is set to NONE, autopay will not be triggered for account regardless of this field's value.

  Default value is false.

• default_payment_processor_method string

  Configures the payment processor to be used for manual or autopay payments. This cannot be set to a value different from NONE if no valid ACH or Debit Card configs are provided.

  Values are ACH, DEBIT_CARD, CREDIT_CARD, or NONE. Default value is NONE.