API Reference

Create Round-Up Enrollment

post
https://api.sb.spidrsrv.com/v1/roundup/create

Use /v1/roundup/create to create a round-up enrollment. The enrollment defines how round-ups are calculated for a user's tracked transactions, the cadence on which accumulated round-ups are swept, and the funding and receiving accounts used to move the money. At least one tracking, funding, and receiving account is required.

Body Params

POST /v1/roundup/create Request body

string
enum
required

How each round-up contribution is calculated: round_to_nearest_dollar, fixed_amount_per_transaction, or round_to_nearest_dollar_plus_boost.

Allowed:
double
≤ 10000000

For fixed_amount_per_transaction mode, the flat amount contributed per eligible transaction.

double
≤ 10000000

For round_to_nearest_dollar_plus_boost mode, the additional amount added to each round-to-nearest-dollar contribution.

string
Defaults to USD

ISO 4217 three-letter currency code for the enrollment. Defaults to USD.

eligibleCategories
array

Optional list of Spidr transaction categories or subcategories eligible for round-ups. When omitted, all categories are eligible.

eligibleCategories
eligibleMccCodes
array of strings

Optional list of merchant category codes (MCCs) eligible for round-ups. When omitted, all MCCs are eligible.

eligibleMccCodes
string
enum
required

How often accumulated round-ups are swept and transferred: daily, weekly, biweekly, or monthly.

Allowed:
int64
required
1 to 28

Day the sweep runs within the cadence period. For weekly and biweekly cadences this is the day of week (1-7); for monthly it is the day of month (1-28).

double
≤ 10000000

Optional cap on the total round-up amount swept per cadence period.

double
0 to 10000000

Optional minimum accumulated amount required before a sweep runs. Periods below this amount are skipped.

int64
≥ 0

Optional number of days to hold ACH-funded amounts before transferring to receiving accounts. Must be fewer than 90.

trackingAccounts
array of objects
required
length ≥ 1

Accounts whose transactions are monitored to accumulate round-ups. At least one is required.

trackingAccounts*
string
enum
required

Type of tracking account: spidr for a Spidr account, or linked_institution_account for an externally linked account.

Allowed:
string
required

ID of the account whose transactions are tracked for round-ups.

fundingAccounts
array of objects
required
length ≥ 1

Accounts debited to fund each sweep. At least one is required.

fundingAccounts*
string
enum
required

Type of funding account: spidr for a Spidr account, or ach_account for an external ACH account.

Allowed:
string
required

ID of the account debited to fund round-up sweeps.

double
≤ 10000000

Optional cap on the amount drawn from this funding account per cadence period.

double
0 to 10000000

Optional minimum balance that must remain in this funding account; sweeps will not draw the balance below this amount.

double
required
≤ 100

Percentage (greater than 0, up to 100) of each sweep funded from this account. Percentages across funding accounts should total 100.

receivingAccounts
array of objects
required
length ≥ 1

Accounts credited with the swept round-up funds. At least one is required.

receivingAccounts*
string
enum
required

Type of receiving account. Currently only spidr is supported.

Allowed:
string
required

ID of the account credited with swept round-up funds.

double
required
≤ 100

Percentage (greater than 0, up to 100) of each sweep allocated to this receiving account. Percentages across receiving accounts should total 100.

Responses

Updated 14 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago