Create a new account

URL Expired

The URL for this request expired after 30 days.

Account Information

• effective_at: date-time

  • The Date-Time as of which this account is effective on the server.

• account_id: string

  • ^(?!can_).*$
  • This is the ID used to identify the account in your system. For most use-cases, we recommend using the ID from the system the account was originally created in. Both strings and integers are accepted.

• product_id: string (required)

  • The product ID that ties to the product onto which this account is being onboarded.

• partner_entity_id: string

  • The ID used to identify the partner entity associated with this account.

• external_fields: array | null | object | null

• payment_processor_config: object

• disbursements_config: object

• payouts_config: object

• cycle_type: object

• discounts: object

• summary: object

• promo_overview: object

• post_promo_overview: object

• associated_entities: object (to be deprecated)

• plaid_config: object

  • Plaid configurations.

• interest_management_policies: object

• originating_organization_name: string

  • The name of the organization originating the account. Defaults to the calling user's organization name if not provided.

• assign_customers: array of objects | null

  • Array of existing customer IDs to be added to the account. Canopy recommends assigning a customer to the account during account creation.

• metro2_config: object

Response Status Codes

• 200: Successful query of information for a specific account
• 401: Unauthorized.
• 403: Forbidden.
• 422: Invalid input.
• 429: Too many requests.
• default: Unexpected Error.

Example Request

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "payment_processor_config": {
    "autopay_enabled": false,
    "autopay_configs": {
      "autopay_method": "MIN_PAY"
    },
    "default_payment_processor_method": "NONE"
  },
  "summary": {
    "origination_fee_cents": 0,
    "origination_fee_percent": 0,
    "is_origination_fee_lesser_value": false,
    "annual_fee_cents": 0,
    "monthly_fee_cents": 0,
    "initial_principal_cents": 0,
    "interest_grace_method": "NONE",
    "min_pay_applicable_credit_type": "ALL"
  },
  "promo_overview": {
    "promo_min_pay_type": "NONE",
    "promo_min_pay_percent": 100
  },
  "plaid_config": {
    "check_balance_enabled": false
  },
  "interest_management_policies": {
    "missed_and_under_payment": "NONE",
    "over_and_early_payment": "NONE"
  }
}'

Notes

Click Try It! to start a request and see the response!