Skip to main content
PUT
Set a user's spend limits
Replaces your limits on one user. A limit you leave out, or send as null, is no limit, so send every limit you want to keep.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Body

application/json
user_id
string
required

The connected user.

per_transaction_cents
integer | null

The most one movement may carry, in cents.

daily_cents
integer | null

The most that may leave in any 24 hours, in cents.

monthly_cents
integer | null

The most that may leave in any 30 days, in cents.

Response

The user's spend limits, as now set.

object
enum<string>
required

Always wallet_spend_limit.

Available options:
wallet_spend_limit
user_id
string
required

The connected user.

stricter_limit_applies
boolean
required

true when another company set a smaller figure for one of the three limits, or a limit you left unset. The user's balance obeys the smaller figure of each limit across every company; that company's figures are not shown.

spent
object | null
required

What left the user's balance onto their cards, in cents, across every company. A refunded purchase stops counting. null when you clear a limit on a user who disconnected from your company.

wallet_provider_policy
object
required

Whether the wallet provider that holds the user's balance refuses a transfer above the per-transaction limit that holds for the user.

per_transaction_cents
integer | null

Your most for one movement, in cents. null is no limit.

daily_cents
integer | null

Your most for any 24 hours, in cents.

monthly_cents
integer | null

Your most for any 30 days, in cents.

updated_at
string<date-time> | null

When you last set your limits.