Create Spend Rule

post

https://api.dev.givecard.dev/api/v1/spendRules/spendRule

Creates a spend rule that restricts spending by velocity or merchant.
For further description and examples, refer to the Spend Rules section of the docs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applyTo

string

enum

Allowed:

description

string

required

Plain-english description of what the spend rule restricts. Business-internal; not shown to cardholders.

displayDescription

string

Optional longer supporting text surfaced to cardholders. Max 500 chars after trim; empty/whitespace-only is treated as unset.

displayName

string

Optional short label surfaced to cardholders in their portal. Max 80 chars after trim; empty/whitespace-only is treated as unset.

metadata

array of objects

metadata

name

string

required

programId

string

Pass in a Program ID to make the spend rule within a program. Only cards within the program can have this spend rule applied.

restrictions

array of objects

restrictions

type

string

enum

required

velocity SpendRuleTypeVelocity
merchant_allow SpendRuleTypeMerchantAllow
merchant_block SpendRuleTypeMerchantBlock

Allowed:

velocityCycle

string

enum

Allowed:

velocityType

string

enum

Velocity type defaults to 'currency_amount' if not provided
currency_amount VelocityTypeCurrencyAmount Velocity type defaults to 'currency_amount' if not provided
authorization_count VelocityTypeAuthorizationCount

Allowed:

velocityValue

string

Headers

Idempotency-Key

string

Responses

200

400

404

500