Pivot Interest Rate Object
The pivot interest rate object represents the pivot interest rate (i.e., EFFR) on your platform. While there may be multiple pivot interest rate objects with different effective dates in your platform, only one rate will be effective for any given date (read more).
object parameters
created_at
string
The timestamp at which the pivot interest rate object was created.
effective_date
string
The date in Pacific Time Zone (inclusive) on which the pivot interest rate will become effective.
id
string
The ID of the pivot interest rate object.
idempotency_key
string
The idempotency key specified in the pivot interest rate.
product_type
string
The product type of the pivot interest rate. Currently only bank_account is supported.
rate
string
The rate of the pivot interest rate object (e.g., "0.045" means 4.50%).
updated_at
string
The timestamp at which the pivot interest rate object was last updated.
Pivot Interest Rate object
Create pivot interest rate
POST
/interests/pivot-rates
Create a pivot interest rate for your platform (read more).
body parameters
effective_date
string
Required
The date in Pacific Time Zone (inclusive) on which this pivot interest rate will become effective.
product_type
string
Required
The product type of the pivot interest rate. Currently only bank_account is supported.
rate
string
Required
The rate (as a decimal) of the pivot interest rate object.
e.g. 4.50% would be represented by "0.045"
Request
Response
Get pivot interest rate
GET
/interests/pivot-rates/<pivot_interest_rate_id>
Retrieve a single pivot interest rate by its ID.
path parameters
pivot_interest_rate_id
string
Required
ID of the pivot interest rate you are looking up.
Request
Response
Update pivot interest rate
POST
/interests/pivot-rates/<pivot_interest_rate_id>
Update a pivot interest rate before 4:00pm PST on its effective date (read more).
path parameters
pivot_interest_rate_id
string
Required
ID of the pivot interest rate you are updating.
body parameters
rate
string
Required
The new rate (as a decimal) of the pivot interest rate object.
e.g. 5.00% would be represented by "0.05"
Request
Response
List pivot interest rates
GET
/interests/pivot-rates
Retrieve multiple pivot interest rates.
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
effective.gt
string
Optional
Return pivot rates with effective dates greater than this date.
effective.gte
string
Optional
Return pivot rates with effective dates greater than or equal to this date.
effective.lt
string
Optional
Return pivot rates with effective dates less than this date.
effective.lte
string
Optional
Return pivot rates with effective dates less than or equal to this date.
product_type
string
Optional
Return pivot rates with the given product type. Currently only bank_account is supported.
Request
Response
Interest Config object
The interest config object contains the parameter details for interest accruals (read more).
object parameters
accrual_method
string
The accrual method of the current effective config snapshot. Possible values: actual_360, actual_365, and actual_actual.
ceiling_rate
string
The maximum value of the effective interest rate of the current effective config snapshot. (4.50% would be represented as "0.045", read more).
created_at
string
The timestamp when this interest config object was created.
description
string
The description of this interest config object.
effective_date
string
The date in Pacific Time Zone (inclusive) on which the current config snapshot is effective.
floor_rate
string
The minimum value of the effective interest rate of the current effective config snapshot. (0.50% would be represented as "0.005", read more).
history
array of objects
List of interest config snapshots in descending order of their effective dates. History is only populated if this interest config is queried with expand=history.
accrual_method
string
The accrual method by which an account will accrue interest. Possible values: actual_360, actual_365, and actual_actual.
ceiling_rate
string
The maximum value of the effective interest rate (4.50% would be represented by "0.045", read more).
effective_date
string
The date in Pacific Time Zone (inclusive) on which this interest config will become effective.
floor_rate
string
The minimum value of the effective interest rate (0.50% would be represented by "0.005", read more).
tiers
array of objects
Interest config tiers in ascending order of their thresholds.
fixed_rate
string
This tier uses a fixed interest rate (e.g., "0.045" means 4.50%, only zero or positive rates are allowed).
pivot_percentage
string
This tier uses a percentage of the pivot rate (e.g., "0.85" means 85% of the pivot rate, only zero or positive percentages are allowed).
pivot_relative
string
This tier uses a premium or discount to the pivot rate (e.g., "-0.015" means pivot rate minus 1.50%).
threshold
string
The threshold of this tier in the smallest unit of the account currency (e.g, 100,000 in USD would be represented as "10000000").
id
string
The ID of this interest config object.
idempotency_key
string
The idempotency key specified in the interest config.
is_not_waterfall
boolean
Indicates if a waterfall approach should be applied to calculate tier-based interest (read more).
pivot_rate
object
The pivot interest rate is used for the given accrual_date query parameter or today. Only populated if this interest config is queried with expand=pivot_rate.
product_type
string
The product type of the interest config. Currently only bank_account is supported.
tiers
array of objects
Interest config tiers of the current effective config snapshot in ascending order of their thresholds.
fixed_rate
string
This tier uses a fixed interest rate (e.g., "0.045" means 4.50%, only zero or positive rates are allowed).
pivot_percentage
string
This tier uses a percentage of the pivot rate (e.g., "0.85" means 85% of the pivot rate, only zero or positive percentages are allowed).
pivot_relative
string
This tier uses a premium or discount to the pivot rate (e.g., "-0.015" means pivot rate minus 1.50%).
threshold
string
The threshold of this tier in the smallest unit of the account currency (e.g, 100,000 in USD would be represented as "10000000").
updated_at
string
The timestamp at which this interest config object was last updated.
Interest Config object
Create interest config
POST
/interests/configs
Create an interest configuration for your platform (read more).
body parameters
accrual_method
string
Required
The accrual method by which an account will accrue interest. Possible values: actual_360, actual_365, and actual_actual.
ceiling_rate
string
Optional
The maximum value of the effective interest rate (4.50% would be represented by "0.045", read more).
description
string
Optional
The description of this interest config object.
effective_date
string
Required
The date in Pacific Time Zone (inclusive) on which this interest config will become effective. You must create a config and apply it to an account before 4:00pm PsT of the effective date for Column to accrue interest.
floor_rate
string
Optional
The minimum value of the effective interest rate (0.50% would be represented by "0.005", read more).
is_not_waterfall
boolean
Optional
Indicates if a waterfall approach should be applied to calculate tier-based interest (read more).
product_type
string
Required
The product type of the pivot interest rate. Currently only bank_account is supported.
tiers
array of objects
Required
Interest config tiers. For each tier, exactly one of the following: fixed_rate, pivot_percentage or pivot_relative may be populated. Tier thresholds must be different and there must be a tier with a $0 threshold.
fixed_rate
string
Optional
This tier uses a fixed interest rate (e.g., "0.045" means 4.50%, only zero or positive rates are allowed).
pivot_percentage
string
Optional
This tier uses a percentage of the pivot rate (e.g., "0.85" means 85% of the pivot rate, only zero or positive percentages are allowed).
pivot_relative
string
Optional
This tier uses a premium or discount to the pivot rate (e.g., "-0.015" means pivot rate minus 1.50%).
threshold
string
Required
The threshold of this tier in the smallest unit of the account currency (e.g, 100,000 in USD would be represented as "10000000").
Request
Response
Get interest config
GET
/interests/configs/<interest_config_id>
Retrieve a single interest config by its ID
path parameters
interest_config_id
string
Required
ID of the interest config you are looking up.
query parameters
accrual_date
string
Optional
If specified, returns the effective config snapshot for the given accrual date. Else, the effective config snapshot for today will be returned.
expand
string
Optional
List of fields to be expanded (format: expand=field_1&expand=field_2&expand=field_3).
history: return all config history for this interest configpivot_rate: return the pivot interest rate details used for the givenaccrual_dateor today
Request
Response
Update interest config
POST
/interests/configs/<interest_config_id>
Update an interest config (read more).
path parameters
interest_config_id
string
Required
ID of the interest config you are updating.
body parameters
accrual_method
string
Optional
The accrual method by which an account will accrue interest. Possible values: actual_360, actual_365, and actual_actual.
ceiling_rate
string
Optional
The maximum value of effective interest rate ("0.045" means 4.50%, read more).
description
string
Optional
The description of this interest config object.
effective_date
string
Optional
The date in Pacific Time Zone (inclusive) on which this interest config will become effective. You must create a config and apply it to an account before 4:00pm PST of the effective date for Column to accrue interest.
floor_rate
string
Optional
The minimum value of the effective interest rate (0.50% would be represented by "0.005", read more).
is_not_waterfall
boolean
Optional
Indicates if a waterfall approach should be applied to calculate tier-based interest (read more).
tiers
array of objects
Optional
Interest config tiers. For each tier, exactly one of the following: fixed_rate, pivot_percentage or pivot_relative may be populated. Tier thresholds must be different and there must be a tier with a $0 threshold.
fixed_rate
string
Optional
This tier uses a fixed interest rate (e.g., "0.045" means 4.50%, only zero or positive rates are allowed).
pivot_percentage
string
Optional
This tier uses a percentage of the pivot rate (e.g., "0.85" means 85% of the pivot rate, only zero or positive percentages are allowed).
pivot_relative
string
Optional
This tier uses a premium or discount to the pivot rate (e.g., "-0.015" means pivot rate minus 1.50%).
threshold
string
Required
The threshold of this tier in the smallest unit of the account currency (e.g, 100,000 in USD would be represented as "10000000").
Request
Response
List interest configs
GET
/interests/configs
Retrieve multiple interest configs on your platform.
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
is_default
bool
Optional
Return the platform default interest config by setting this to true.
product_type
string
Optional
Return interest configs with the given product type. Currently only bank_account is supported.
Request
Response
Interest Payout Object
The Interest Payout object contains interest payout details (read more).
object parameters
amount
string
Amount in the smallest unit of currency_code (e.g., cents in USD) that has been credited to or debited from a product_id.
currency_code
string
Currency of amount. The three-letter currency code defined in ISO 4217 (e.g. USD).
created_at
string
The timestamp at which the interest payout object was created.
description
string
The description of the interest payout object.
id
string
The ID of the interest payout object.
last_accrued_date
string
The last accrued date of interest included in the interest payout. For monthly payouts, it is the last day of the previous month.
product_id
string
ID of the product to which interest is paid out. This will be your customers' bank account IDs for interest your platform pays out to them or your interest revenue account ID for the interest spread your platform receives from Column (read more).
product_type
string
The product type of the interest config. Currently only bank_account is supported.
related_product_id
string
ID of the related interest-bearing product on which interest has been accrued. For interest your platform pays out to your customers' accounts, this field will be empty. For interest spread your platform receives from Column, this field will be your customers' bank account IDs (read more).
type
string
Type of the payout. Possible values: credit if interest has been credited to product_id, and debit if interest has been debited from product_id (read more).
updated_at
string
The timestamp at which the interest payout object was last updated.
Interest Payout object
Get interest payout
GET
/interests/payouts/<interest_payout_id>
Retrieve a single interest payout by its ID.
path parameters
interest_payout_id
string
Required
ID of the interest payout you are looking up.
Request
Response
List interest payouts
GET
/interests/payouts
Retrieve multiple interest payouts of your platform.
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
product_id
string
Optional
Return interest payouts with product_id as the given value.
related_product_id
string
Optional
Return interest payouts with related_product_id as the given value.
type
string
Optional
Return interest payouts with type as the given value.
last_accrued_date
string
Optional
Return interest payouts with last_accrued_date as the given value.
Request
Response
Simulate an interest payout
POST
/simulate/interests/payouts
Simulates an interest payout to the given interest bearing product.
body parameters
amount
string
Required
Amount in the smallest unit of currency_code (e.g., cents in USD) that will be credited to (amount is positive) or debited from (amount is negative) product_id. Maximum amount is USD 100.00.
currency_code
string
Required
Currency of amount. The three-letter currency code defined in ISO 4217 (e.g. USD).
product_id
string
Required
ID of the interest bearing product (e.g., bank account).