Update Round-Up Enrollment

patch

https://api.sb.spidrsrv.com/v1/roundup/{id}

Use /v1/roundup/:id (PATCH) to update the configuration of an existing round-up enrollment. Any subset of the configuration fields may be supplied; omitted fields are left unchanged. Use the update status endpoint to pause, resume, or close an enrollment.

Path Params

string

required

PATCH /v1/roundup/:id Parameter

Body Params

PATCH /v1/roundup/:id Request body

calculationMode

string

enum

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

Allowed:

fixedAmount

double

≤ 10000000

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

boostAmount

double

≤ 10000000

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

currencyCode

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

cadence

string

enum

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

Allowed:

cadenceKey

int64

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

cadenceMaxAmount

double

≤ 10000000

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

minimumSweepAmount

double

0 to 10000000

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

achHoldDays

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

length ≥ 1

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

trackingAccounts

type

string

enum

required

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

Allowed:

trackingAccountId

string

required

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

fundingAccounts

array of objects

length ≥ 1

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

fundingAccounts

type

string

enum

required

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

Allowed:

fundingAccountId

string

required

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

cadenceMaxAmount

double

≤ 10000000

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

minimumBalance

double

0 to 10000000

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

fundingPercentage

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

length ≥ 1

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

receivingAccounts

type

string

enum

required

Type of receiving account. Currently only spidr is supported.

Allowed:

receivingAccountId

string

required

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

allocationPercentage

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.

200PATCH /v1/roundup/:id Positive response

400PATCH /v1/roundup/:id Negative response