Welcome to the givecard api

Getting Started

GiveCard APIs

auth
- Test Authget
cardLoadsTransfers
bankTransfers
orderCards
simulate
fundingAccount
reporting
merchantRulesDeprecated
superbusiness
- Create Programpost
- Get Programsget
webhooks
manageCard
spendRules

Welcome to the givecard api

Getting Started

GiveCard APIs

auth
- Test Authget
cardLoadsTransfers
bankTransfers
orderCards
simulate
fundingAccount
reporting
merchantRulesDeprecated
superbusiness
- Create Programpost
- Get Programsget
webhooks
manageCard
spendRules

Update Spend Rule

patch https://api.dev.givecard.dev/api/v1/spendRules/{spendRuleId}/

Updates a spend rule. The type can only be changed from merchant_allow to merchant_block or vice versa, type cannot be changed between velocity and merchant rules. To apply or un-apply the rule to all cards within a business or program, set the ApplyTo field.

URL Expired

The URL for this request expired after 30 days.

Path Params

spendRuleId

string

required

Body Params

applyTo

string

description

string

name

string

programId

string

Program ID is only required if you plan to change the applyTo field to program

restrictionsToAdd

array of objects

restrictionsToAdd

restrictionsToRemove

array of uuids

restrictionsToRemove

type

string

velocityCycle

string

Velocity cycle is required for velocity rules only
all_time VelocityCycleAllTime
monthly VelocityCycleMonthly
weekly VelocityCycleWeekly
daily VelocityCycleDaily
single_transaction VelocityCycleSingleTransaction

velocityValue

string

Headers

Idempotency-Key

string

Responses

Response body

object

spendRule

object

applyTo

string

business program cards

businessId

uuid

createdAt

date-time

description

string

uuid

metadata

array of objects

metadata

object

key

string

value

string

name

string

restrictions

array of objects

restrictions

object

createdAt

date-time

uuid

override

string

greenlight redlight

spendRuleId

uuid

type

string

merchant_category merchant_name merchant_id velocity

updatedAt

date-time

value

string

velocityCycle

string

all_time monthly weekly daily single_transaction

velocityType

string

currency_amount

velocityValue

string

a decimal representing dollars, for example: 11.23

type

string

velocity merchant_allow merchant_block

updatedAt

date-time

velocityCycle

string

all_time monthly weekly daily single_transaction

velocityType

string

currency_amount

velocityValue

string

a decimal representing dollars, for example: 11.23

Response body

object

badRequest

object

Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.

fieldViolations

array of objects

Describes all violations in a client request.

fieldViolations

object

description

string

A description of why the request element is bad.

field

string

A path leading to a field in the request body. The value will be a
sequence of dot-separated identifiers that identify a mesasge field.
E.g., "fieldViolations.field" would identify this field.

code

int64

errorInfo

object

Metadata

object

Has additional fields

Reason

string

The reason of the error. This is a constant value that identifies the
proximate cause of the error.
This should be at most 63 characters and match /[A-Z0-9_]+/.
UNKNOWN ReasonUnknown
OUTDATED_VERSION ReasonOutdatedVersion

UNKNOWN OUTDATED_VERSION

fieldErrors

object

Has additional fields

localizedMessage

object

Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.

locale

string

The locale used following the specification defined at
http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
Examples are: "en-US", "fr-CH", "es-MX"

message

string

The localized error message in the above locale.

msg

string

required

requestInfo

object

Contains metadata about the request that clients can attach when filing a bug
or providing other forms of feedback.

requestID

string

An opaque string that should only be interpreted by the service generating
it. For example, it can be used to identify requests in the service's logs.

servingData

string

Any data that was used to serve this request. For example, an encrypted
stack trace that can be sent back to the service provider for debugging.

Response body

object

badRequest

object

Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.

fieldViolations

array of objects

Describes all violations in a client request.

fieldViolations

object

description

string

A description of why the request element is bad.

field

string

A path leading to a field in the request body. The value will be a
sequence of dot-separated identifiers that identify a mesasge field.
E.g., "fieldViolations.field" would identify this field.

code

int64

errorInfo

object

Metadata

object

Has additional fields

Reason

string

UNKNOWN OUTDATED_VERSION

fieldErrors

object

Has additional fields

localizedMessage

object

Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.

locale

string

The locale used following the specification defined at
http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
Examples are: "en-US", "fr-CH", "es-MX"

message

string

The localized error message in the above locale.

msg

string

required

requestInfo

object

Contains metadata about the request that clients can attach when filing a bug
or providing other forms of feedback.

requestID

string

An opaque string that should only be interpreted by the service generating
it. For example, it can be used to identify requests in the service's logs.

servingData

string

Any data that was used to serve this request. For example, an encrypted
stack trace that can be sent back to the service provider for debugging.

Response body

object

badRequest

object

Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.

fieldViolations

array of objects

Describes all violations in a client request.

fieldViolations

object

description

string

A description of why the request element is bad.

field

string

A path leading to a field in the request body. The value will be a
sequence of dot-separated identifiers that identify a mesasge field.
E.g., "fieldViolations.field" would identify this field.

code

int64

errorInfo

object

Metadata

object

Has additional fields

Reason

string

UNKNOWN OUTDATED_VERSION

fieldErrors

object

Has additional fields

localizedMessage

object

Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.

locale

string

The locale used following the specification defined at
http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
Examples are: "en-US", "fr-CH", "es-MX"

message

string

The localized error message in the above locale.

msg

string

required

requestInfo

object

Contains metadata about the request that clients can attach when filing a bug
or providing other forms of feedback.

requestID

string

An opaque string that should only be interpreted by the service generating
it. For example, it can be used to identify requests in the service's logs.

servingData

string

Any data that was used to serve this request. For example, an encrypted
stack trace that can be sent back to the service provider for debugging.

Updated about 1 month ago

Delete Spend Rule

Add Spend Rule To Card(s)

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.dev.givecard.dev/api/v1/spendRules/spendRuleId/ \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

Updated about 1 month ago

Delete Spend Rule

Add Spend Rule To Card(s)

Did this page help you?

Welcome to the givecard api
Getting Started
FAQs
GiveCard Transfers: RTP, FedNow, ACH
Webhooks
Spend Rules
MerchantCategories
Greenlighting and Redlighting
Velocity Spend Rules
Merchant Spend Rules
SuperBusinesses and ProgramIds
Idempotency
Authentication
Quickstart

GiveCard APIs
auth
Test Authget
cardLoadsTransfers
Withdraw Funds From Cardpost
Load Cardspost
Card To Card Transferpost
Delete Cards From Autoloaddelete
Add Cards To Autoloadpost
Modify Autoload Profilepatch
Get Autoload Profileget
Get Business Autoload Profilesget
Create Autoload Profilepost
bankTransfers
Get Bank Transferget
Initiate Bank Transferpost
Get Bank Transfersget
Get Bank Transfers for Recipientget
Add Bank Account to Recipientpost
Get Bank Transfer Recipientget
Get Bank Transfer Recipientsget
Update Recipientpatch
Create Bank Transfer Recipientpost
Delete Bank Accountdelete
orderCards
Order And Ship Cardspost
Issue Virtual Card And Generate Linkpost
Issue Virtual Cardspost
Issue a Single Card Synchronouslypost
Get Individual Card Orderget
Get Business Card Ordersget
simulate
Simulate Transactionpost
Simulate Funding Account Depositpost
Simulate Card Order Shippedpost
fundingAccount
Get Funding Accountsget
Get Funding Account Depositsget
Transfer Between Funding Accountspost
Get Funding Account Balanceget
reporting
Get Cardsget
Get Business Transactionsget
Get Business Card Load Historyget
merchantRulesDeprecated
Add Merchant Rule To Cardpost
Remove Merchant Rule From Carddelete
Modify Merchant Rule (decommissioned)patch
Get Merchant Ruleget
Get Business Merchant Rulesget
Create Merchant Rule (decommissioned)post
superbusiness
Get Programsget
Create Programpost
webhooks
Get Webhook Endpoint Secretget
Create Webhook Endpointpost
Get Webhook Endpointsget
Get Webhook Portal Access Linkget
manageCard
Unlock Cardpost
Unfreeze Cardpost
Get Card Transactionsget
Delete Tag from Carddelete
Reissue Virtual Cardpost
Reissue And Ship Physical Cardpost
Reassociate Cardpost
Set Card Pinpost
Lock Cardpost
Get Card Load Historyget
Freeze Cardpost
Get Card Detailsget
Close Cardpost
Generate Card Client Tokenpost
Get Card Balanceget
Add Tag To Cardspost
spendRules
Remove Spend Rule From Card(s)delete
Add Spend Rule To Card(s)post
Update Spend Rulepatch
Delete Spend Ruledelete
Create Spend Rulepost
Get Spend Rulesget
Get Spend Rules On Cardget

Welcome to the givecard api
Getting Started
FAQs
GiveCard Transfers: RTP, FedNow, ACH
Webhooks
Spend Rules
MerchantCategories
Greenlighting and Redlighting
Velocity Spend Rules
Merchant Spend Rules
SuperBusinesses and ProgramIds
Idempotency
Authentication
Quickstart

GiveCard APIs
auth
Test Authget
cardLoadsTransfers
Withdraw Funds From Cardpost
Load Cardspost
Card To Card Transferpost
Delete Cards From Autoloaddelete
Add Cards To Autoloadpost
Modify Autoload Profilepatch
Get Autoload Profileget
Get Business Autoload Profilesget
Create Autoload Profilepost
bankTransfers
Get Bank Transferget
Initiate Bank Transferpost
Get Bank Transfersget
Get Bank Transfers for Recipientget
Add Bank Account to Recipientpost
Get Bank Transfer Recipientget
Get Bank Transfer Recipientsget
Update Recipientpatch
Create Bank Transfer Recipientpost
Delete Bank Accountdelete
orderCards
Order And Ship Cardspost
Issue Virtual Card And Generate Linkpost
Issue Virtual Cardspost
Issue a Single Card Synchronouslypost
Get Individual Card Orderget
Get Business Card Ordersget
simulate
Simulate Transactionpost
Simulate Funding Account Depositpost
Simulate Card Order Shippedpost
fundingAccount
Get Funding Accountsget
Get Funding Account Depositsget
Transfer Between Funding Accountspost
Get Funding Account Balanceget
reporting
Get Cardsget
Get Business Transactionsget
Get Business Card Load Historyget
merchantRulesDeprecated
Add Merchant Rule To Cardpost
Remove Merchant Rule From Carddelete
Modify Merchant Rule (decommissioned)patch
Get Merchant Ruleget
Get Business Merchant Rulesget
Create Merchant Rule (decommissioned)post
superbusiness
Get Programsget
Create Programpost
webhooks
Get Webhook Endpoint Secretget
Create Webhook Endpointpost
Get Webhook Endpointsget
Get Webhook Portal Access Linkget
manageCard
Unlock Cardpost
Unfreeze Cardpost
Get Card Transactionsget
Delete Tag from Carddelete
Reissue Virtual Cardpost
Reissue And Ship Physical Cardpost
Reassociate Cardpost
Set Card Pinpost
Lock Cardpost
Get Card Load Historyget
Freeze Cardpost
Get Card Detailsget
Close Cardpost
Generate Card Client Tokenpost
Get Card Balanceget
Add Tag To Cardspost
spendRules
Remove Spend Rule From Card(s)delete
Add Spend Rule To Card(s)post
Update Spend Rulepatch
Delete Spend Ruledelete
Create Spend Rulepost
Get Spend Rulesget
Get Spend Rules On Cardget

200

400

404

500