Canopy API - Latest

Create a temporary promotion for an account.

POST /accounts/{account_id}/temp_promos

Create a temporary promotion that will override the usual configuration for the account for a given time window.

Path parameters

account_id string Required

ID of the Account

Body

Create a Temporary Promotion for an Account

temp_promo_inclusive_start string(date-time)

The Date-Time as of which this temporary promo starts for the account.
temp_promo_exclusive_end string(date-time)

The Date-Time as of which this temporary promo ends for the account.
interest_rate_percent number

The percentage interest applied to the account during the temporary promotional period (i.e. 6.2%).

Default value is 0.
late_fee_cents integer

The late fee to be charged for late payments during the promotional period.

Default value is 0.
Additional properties are NOT allowed

Responses

• 401

Unauthorized.
• 403

Forbidden.
• 422

Invalid input
• 429

Too many requests.
• default

Unexpected Error.
• 200 object

Payment Processor Configuration Updated
- 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.
- 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.
  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
  
  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 null | string
  
  The last four digits of the card number

POST /accounts/{account_id}/temp_promos

curl \
 -X POST https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/temp_promos \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"temp_promo_inclusive_start":"2016-11-27T13:19:56+00:00","temp_promo_exclusive_end":"2016-11-27T13:19:56+00:00","interest_rate_percent":6.2,"late_fee_cents":50000}'

Request example

{
  "temp_promo_inclusive_start": "2016-11-27T13:19:56+00:00",
  "temp_promo_exclusive_end": "2016-11-27T13:19:56+00:00",
  "interest_rate_percent": 6.2,
  "late_fee_cents": 50000
}

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"
}