Canopy API - Latest

Edit the payment processor configuration

PUT /accounts/{account_id}/payment_processor_config

Toggle autopay or change the payment processor / bank information for a given account.

Path parameters

account_id string Required

ID of the Account

Body

Edit Payment Processor Config

debit_card object

Debit processing configuration.
- 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.
  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.
  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.
- 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
  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.
autopay_configs object

Governs the autopay policies to be applied
- autopay_method string
  
  Defines the calculation method for autopay.
  
  Values are MIN_PAY, TOTAL_BALANCE, FIXED_AMOUNT, or REMAINING_STATEMENT_BALANCE. Default value is MIN_PAY.
- autopay_fixed_amount_cents integer
  
  If using FIXED_AMOUNT autopay method, defines the fixed amount.
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.
ach object

ACH processing configuration.
- canopy_nacha_config object
  
  Canopy will create a NACHA file for each borrower ACH payment to be sent to your bank for ACH execution.
  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.
  
  bank_account_type string
  
  The type of bank account being used by the borrower.
  
  Values are CHECKING, SAVINGS, or GL.
- stripe_config object
  
  Stripe payment configuration. Use customer ID and source ID to enable payments.
  customer_id string Required
  
  Stripe generated customer ID associated with the customer making the payment. https://stripe.com/docs/api/customers
  
  source_id string Required
  
  Payment Source ID. The Stripe generated source ID, https://stripe.com/docs/api/sources
  
  external_fields object | null
  
  This is a raw json blob that is copied verbatim into stripe's metadata.
  
  Additional properties are allowed
- galileo_config object | null
  plaid_processor_token string | null Required
  
  Obtained from Plaid for Galileo ACH integration
- 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, CANOPY_NACHA, STRIPE, or GALILEO. 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.
  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.
  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.
  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.
  
  name string Required
  
  Account holder's name as it appears on the account.

Responses

• 200 object

Payment Processor Configuration Updated
- ach object
  
  ACH processing configuration.
  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, CANOPY_NACHA, STRIPE, or GALILEO. Default value is NONE.
  
  repay_config object | null
  
  ach_token string | null
  
  The tokenized ACH details.
  
  last_four string | null
  
  The last four digits of the account number
  
  dwolla_config object | null
  
  ach_token string | null
  
  The tokenized ACH details.
  
  last_four string | null
  
  The last four digits of the account number
  
  modern_treasury_config object | null
  
  ach_token string | null
  
  The tokenized ACH details.
  
  last_four string | null
  
  The last four digits of the account number
  
  canopy_nacha_config object | null
  
  Canopy will create a NACHA file for each borrower ACH payment to be sent to your bank for ACH execution.
  
  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.
  
  bank_account_type string
  
  The type of bank account being used by the borrower.
  
  Values are CHECKING, SAVINGS, or GL.
  
  stripe_config object
  
  Stripe payment configuration. Use customer ID and source ID to enable payments.
  
  customer_id string Required
  
  Stripe generated customer ID associated with the customer making the payment. https://stripe.com/docs/api/customers
  
  source_id string Required
  
  Payment Source ID. The Stripe generated source ID, https://stripe.com/docs/api/sources
  
  external_fields object | null
  
  This is a raw json blob that is copied verbatim into stripe's metadata.
  
  Additional properties are allowed
  
  galileo_config object | null
  
  plaid_processor_token string | null Required
  
  Obtained from Plaid for Galileo ACH integration
- debit_card object
  
  Debit processing configuration.
  payment_processor_name string Required
  
  Indicates the active payment processor whose configuration will be used for Debit card payments made from the account.
  
  Values are NONE, REPAY, or AUTHORIZE_NET. Default value is NONE.
  
  repay_config object | null
  
  card_token string | null
  
  The tokenized card details.
  
  last_four string | null
  
  The last four digits of the card number
  
  authorize_net_config object | null
  
  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.
  
  customer_profile_id string
  
  Customer profile ID created in Authorize.net
  
  customer_payment_profile_ids array[string]
  
  Customer payment profile ID created in Authorize.net
- credit_card object
  
  Credit processing configuration.
  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 | null
  
  source_id string
  
  A Checkout.com payment source id or customer id.
  
  card_token string
  
  The tokenized card number.
  
  last_four string | null
  
  The last 4 digits of the card number.
  
  expires_on string | null
  
  Expiration time for the card token.
- 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.
- autopay_configs object
  
  Governs the autopay policies to be applied
  autopay_method string
  
  Defines the calculation method for autopay.
  
  Values are MIN_PAY, TOTAL_BALANCE, FIXED_AMOUNT, or REMAINING_STATEMENT_BALANCE. Default value is MIN_PAY.
  
  autopay_fixed_amount_cents integer
  
  If using FIXED_AMOUNT autopay method, autopay_fixed_amount_cents defines the fixed amount of each autopayment.
- 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.
• 401

Unauthorized.
• 403

Forbidden.
• 422

Invalid input
• 429

Too many requests.
• default

Unexpected Error.

PUT /accounts/{account_id}/payment_processor_config

curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/payment_processor_config \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"ach":{"payment_processor_name":"REPAY","repay_config":{"repay_check_type":"PERSONAL","repay_account_type":"CHECKING","repay_transit_number":"999999992","repay_account_number":"987654321","repay_name_on_check":"Lucille Bluth"},"dwolla_config":{"dwolla_plaid_token":"processor-sandbox-161c86dd-d470-47e9-a741-d381c2b2cb6f"},"modern_treasury_config":{"name":"Lucille Bluth","account_number":"987654321","account_type":"CHECKING","routing_number":"999999992","plaid_processor_token":"processor-987654321"},"canopy_nacha_config":{"bank_routing_number":"999999992","bank_account_number":"987654321","bank_account_type":"CHECKING"},"stripe_config":{"customer_id":"cus_4QE4bx4C5BVSrC","source_id":"string","external_fields":{}},"galileo_config":{"plaid_processor_token":"processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"}},"debit_card":{"payment_processor_name":"REPAY","repay_config":{"repay_card_number":"4622941000000005","repay_exp_date":"0619","repay_name_on_card":"John Doe","repay_street":"1234 Main Street","repay_zip":"85281"},"authorize_net_config":{"card_number":"4622941000000005","expiry_month":"string","expiry_year":"string","cvv":"string"}},"credit_card":{"payment_processor_name":"CHECKOUT","checkout_config":{"source_id":"cus_6artgoevd77u7ojah2wled32s","card_token":"string","card_number":"string","expiry_month":"string","expiry_year":"string","cvv":"string"}},"autopay_enabled":true,"autopay_configs":{"autopay_method":"TOTAL_BALANCE","autopay_fixed_amount_cents":2500},"default_payment_processor_method":"ACH"}'

Request example

{
  "ach": {
    "payment_processor_name": "REPAY",
    "repay_config": {
      "repay_check_type": "PERSONAL",
      "repay_account_type": "CHECKING",
      "repay_transit_number": "999999992",
      "repay_account_number": "987654321",
      "repay_name_on_check": "Lucille Bluth"
    },
    "dwolla_config": {
      "dwolla_plaid_token": "processor-sandbox-161c86dd-d470-47e9-a741-d381c2b2cb6f"
    },
    "modern_treasury_config": {
      "name": "Lucille Bluth",
      "account_number": "987654321",
      "account_type": "CHECKING",
      "routing_number": "999999992",
      "plaid_processor_token": "processor-987654321"
    },
    "canopy_nacha_config": {
      "bank_routing_number": "999999992",
      "bank_account_number": "987654321",
      "bank_account_type": "CHECKING"
    },
    "stripe_config": {
      "customer_id": "cus_4QE4bx4C5BVSrC",
      "source_id": "string",
      "external_fields": {}
    },
    "galileo_config": {
      "plaid_processor_token": "processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"
    }
  },
  "debit_card": {
    "payment_processor_name": "REPAY",
    "repay_config": {
      "repay_card_number": "4622941000000005",
      "repay_exp_date": "0619",
      "repay_name_on_card": "John Doe",
      "repay_street": "1234 Main Street",
      "repay_zip": "85281"
    },
    "authorize_net_config": {
      "card_number": "4622941000000005",
      "expiry_month": "string",
      "expiry_year": "string",
      "cvv": "string"
    }
  },
  "credit_card": {
    "payment_processor_name": "CHECKOUT",
    "checkout_config": {
      "source_id": "cus_6artgoevd77u7ojah2wled32s",
      "card_token": "string",
      "card_number": "string",
      "expiry_month": "string",
      "expiry_year": "string",
      "cvv": "string"
    }
  },
  "autopay_enabled": true,
  "autopay_configs": {
    "autopay_method": "TOTAL_BALANCE",
    "autopay_fixed_amount_cents": 2500
  },
  "default_payment_processor_method": "ACH"
}

Response example (200)

{
  "ach": {
    "payment_processor_name": "REPAY",
    "repay_config": {
      "ach_token": "string",
      "last_four": "string"
    },
    "dwolla_config": {
      "ach_token": "string",
      "last_four": "string"
    },
    "modern_treasury_config": {
      "ach_token": "string",
      "last_four": "string"
    },
    "canopy_nacha_config": {
      "bank_routing_number": "999999992",
      "bank_account_number": "987654321",
      "bank_account_type": "CHECKING"
    },
    "stripe_config": {
      "customer_id": "cus_4QE4bx4C5BVSrC",
      "source_id": "string",
      "external_fields": {}
    },
    "galileo_config": {
      "plaid_processor_token": "processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"
    }
  },
  "debit_card": {
    "payment_processor_name": "REPAY",
    "repay_config": {
      "card_token": "string",
      "last_four": "string"
    },
    "authorize_net_config": {
      "customer_profile_id": "527262",
      "customer_payment_profile_ids": [
        "86"
      ]
    }
  },
  "credit_card": {
    "payment_processor_name": "CHECKOUT",
    "checkout_config": {
      "source_id": "cus_6artgoevd77u7ojah2wled32s",
      "card_token": "string",
      "last_four": "string",
      "expires_on": "string"
    }
  },
  "autopay_enabled": true,
  "autopay_configs": {
    "autopay_method": "TOTAL_BALANCE",
    "autopay_fixed_amount_cents": 2500
  },
  "default_payment_processor_method": "ACH"
}