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.

Body

Create a Temporary Promotion for an Account

Responses

  • Payment Processor Configuration Updated

    Hide response attributes Show response attributes object
    • 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 | null
        Hide repay_config attributes Show repay_config attributes 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
        Hide dwolla_config attributes Show dwolla_config attributes object | null
        • ach_token string | null

          The tokenized ACH details.

        • last_four string | null

          The last four digits of the account number

      • Hide modern_treasury_config attributes Show modern_treasury_config attributes object | null
        • ach_token string | null

          The tokenized ACH details.

        • last_four string | null

          The last four digits of the account number

      • 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 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 Debit card payments made from the account.

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

      • repay_config object | null
        Hide repay_config attributes Show repay_config attributes object | null
        • card_token string | null

          The tokenized card details.

        • last_four string | null

          The last four digits of the card number

      • 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
    • 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 | null
        Hide checkout_config attributes Show checkout_config attributes object | null
        • A Checkout.com payment source id or customer id.

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

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

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

  • Unauthorized.

  • Forbidden.

  • Invalid input

  • Too many requests.

  • Unexpected Error.

POST /accounts/{account_id}/temp_promos
curl \
 -X POST https://sandbox-api.canopyservicing.com/accounts/{account_id}/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
}
Request examples
{
  "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 examples (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"
    }
  },
  "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,
  "default_payment_processor_method": "ACH"
}
Response examples (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"
    }
  },
  "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,
  "default_payment_processor_method": "ACH"
}