Update card

patch https://api.privacy.com/v1/cards/{card_token}

Update the specified properties of the card. Unsupplied properties will remain unchanged. pin parameter only applies to physical cards.

Note: setting a card to a CLOSED state is a final action that cannot be undone.

Path Params

card_token

uuid

required

Body Params

account_token

uuid

Only required for multi-account users. Token identifying the account the card will be associated with. Only applicable if using account enrollment. See Managing Accounts for more information.

funding_token

uuid

The token for the desired FundingAccount to use when making transactions with this card.

memo

string

Friendly name to identify the card.

spend_limit

integer

Amount (in cents) to limit approved authorizations. Transaction requests above the spend limit will be declined.

spend_limit_duration

string

Spend limit duration values:

ANNUALLY - Card will authorize transactions up to spend limit in a calendar year.
FOREVER - Card will authorize only up to spend limit for the entire lifetime of the card.
MONTHLY - Card will authorize transactions up to spend limit for the trailing month. Month is calculated as this calendar date one month prior.
TRANSACTION - Card will authorizate multiple transactions if each individual transaction is under the spend limit.

auth_rule_token

string

Identifier for any Auth Rules that will be applied to transactions taking place with the card.

state

string

Card state values:

CLOSED - Card will no longer approve authorizations. Closing a card cannot be undone.
OPEN - Card will approve authorizations (if they match card and account parameters).
PAUSED - Card will decline authorizations, but can be resumed at a later time.

string

Encrypted PIN block (in base64). Only applies to cards of type PHYSICAL [beta], UNLOCKED, and DIGITAL_WALLET. See Encrypted PIN Block.

Responses

Response body

object

created

date-time

required

An ISO 8601 timestamp for when the card was created. UTC time zone.

cvv

string

length between 3 and 3

Three digit cvv printed on the back of the card.

funding

object

required

account_name

string

Account name identifying the funding source. This may be null.

created

date-time

required

An ISO 8601 string representing when this funding source was added to the Privacy account. This may be null. UTC time zone.

last_four

string

required

length between 4 and 4

The last 4 digits of the account (e.g. bank account, debit card) associated with this FundingAccount. This may be null.

nickname

string

length between 1 and 255

The nickname given to the FundingAccount or null if it has no nickname.

state

string

required

State of funding source.

Funding source states:

ENABLED - The funding account is available to use for card creation and transactions.
PENDING - The funding account is still being verified e.g. bank micro-deposits verification.

ENABLED PENDING

token

uuid

required

A globally unique identifier for this FundingAccount.

type

string

required

Types of funding source:

DEPOSITORY_CHECKING - Bank checking account.
DEPOSITORY_SAVINGS - Bank savings account.

DEPOSITORY_CHECKING DEPOSITORY_SAVINGS

exp_month

string

length between 2 and 2

Two digit (MM) expiry month.

exp_year

string

length between 4 and 4

Four digit (yyyy) expiry year.

hostname

string

Hostname of card’s locked merchant (will be empty if not applicable).

last_four

string

required

length between 4 and 4

Last four digits of the card number.

memo

string

Friendly name to identify the card.

pan

string

length between 16 and 16

Primary Account Number (PAN) (i.e. the card number). Customers must be PCI compliant to have PAN returned as a field in production. Please contact support@privacy.com for questions.

spend_limit

integer

required

Amount (in cents) to limit approved authorizations. Transaction requests above the spend limit will be declined.

spend_limit_duration

string

required

Spend limit duration values:

ANNUALLY - Card will authorize transactions up to spend limit in a calendar year.
FOREVER - Card will authorize only up to spend limit for the entire lifetime of the card.
MONTHLY - Card will authorize transactions up to spend limit for the trailing month. Month is calculated as this calendar date one month prior.
TRANSACTION - Card will authorizate multiple transactions if each individual transaction is under the spend limit.

ANNUALLY FOREVER MONTHLY TRANSACTION

state

string

required

Card state values:

CLOSED - Card will no longer approve authorizations. Closing a card cannot be undone.
OPEN - Card will approve authorizations (if they match card and account parameters).
PAUSED - Card will decline authorizations, but can be resumed at a later time.
PENDING_FULFILLMENT - The initial state for cards of type PHYSICAL. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for "Card Present" purchases where the physical card itself is present.
PENDING_ACTIVATION - Each business day at 2pm Eastern Time Zone (ET), cards of type PHYSICAL in state PENDING_FULFILLMENT are sent to the card production warehouse and updated to state PENDING_ACTIVATION . Similar to PENDING_FULFILLMENT, cards in this state can be used for e-commerce transactions. API clients should update the card's state to OPEN only after the cardholder confirms receipt of the card.

In sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured.

CLOSED OPEN PAUSED PENDING_ACTIVATION PENDING_FULFILLMENT

auth_rule_tokens

array of strings

List of identifiers for the Auth Rule(s) that are applied on the card.

auth_rule_tokens

token

uuid

required

Globally unique identifier.

type

string

required

Card types:

DIGITAL_WALLET - Cards that can be provisioned to a digital wallet like Google Pay or Apple Wallet.
MERCHANT_LOCKED - Card is locked to first merchant that successfully authorizes the card.
PHYSICAL - Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality. Contact api@privacy.com for more information.
SINGLE_USE - Card will close shortly after the first transaction.
UNLOCKED - Card will authorize at any merchant. Creating these cards requires additional privileges.

DIGITAL_WALLET MERCHANT_LOCKED PHYSICAL SINGLE_USE UNLOCKED


User has not been authenticated	Invalid or missing API key
API key is not active	The API key used is no longer active
Could not find API key	The API key provided is not associated with any user
Please provide API key in Authorization header	The Authorization header is not in the request
Please provide API key in the form Authorization: api-key [api-key]	The Authorization header is not formatted properly
Insufficient privileges. Issuing API key required	Write access requires an Issuing API key. Please contact api@privacy.com
Insufficient privileges to create unlocked cards.	Creating unlocked cards requires an additional privilege


Rate limited, too many requests per second	User has exceeded their per second rate limit
Rate limited, reached daily limit	User has exceeded their daily rate limit
Rate limited, too many keys tried	One IP has queried too many different API keys

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.privacy.com/v1/cards/card_token \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200OK

400A parameter in the query given in the request does not match the valid queries for the endpoint.

404The specified resource was not found.

422Unprocessable entity.