Privacy Developer API

Account
Account Holder
Card
Funding
Transaction
Status
- API status checkget

Privacy Developer API

Account
Account Holder
Card
Funding
Transaction
Status
- API status checkget

Update account

patch https://api.privacy.com/v1/accounts/{account_token}

Update account configuration such as spend limits and verification address. Can only be run on accounts that are part of the program managed by this API key.

Accounts that are in the PAUSED state will not be able to transact or create new cards.

Path Params

account_token

uuid

required

Body Params

daily_spend_limit

integer

≥ 0

Amount (in cents) for the account's new daily spend limit.

lifetime_spend_limit

integer

≥ 0

Amount (in cents) for the account's new lifetime limit. Once this limit is reached, no transactions will be accepted on any card created for this account until the limit is updated.

monthly_spend_limit

integer

≥ 0

Amount (in cents) for the account's new monthly spend limit.

verification_address

object

Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules.

state

string

Account states.

Responses

Response body

object

spend_limit

object

required

Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.

daily

integer

required

≥ 0

Daily spend limit (in cents).

monthly

integer

required

≥ 0

Monthly spend limit (in cents).

lifetime

integer

required

≥ 0

Total spend limit over account lifetime (in cents).

state

string

required

Account state:

ACTIVE - Active, account is able to transact and create new cards.
PAUSED - Paused, account will not be able to transact or create new cards.

ACTIVE PAUSED

token

uuid

required

Globally unique identifier for the account. This is the same as the account_token returned by the enroll endpoint. If using this parameter, do not include pagination.

auth_rule_tokens

array of strings

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

auth_rule_tokens

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.


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

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.


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

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Updated over 1 year ago

Get account

Account Holder

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.privacy.com/v1/accounts/account_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

Updated over 1 year ago

Get account

Account Holder

Did this page help you?

Privacy Developer API
Account
Update accountpatch
Get accountget
List accountsget
Account Holder
Create webhook for KYC/KYB eventspost
Check the current status of a KYC or KYB evaluationget
Resubmit account holder informationpost
Get account holder document upload statusget
Get account holder document uploadsget
Initiate account holder document uploadpost
Create an individual or business account holderpost
Card
Embedded card UIget
Reissue cardpost
Provision card (Digital Wallet)post
Update cardpatch
Get cardget
Create cardpost
List cardsget
Funding
Verify bank accountpost
Update bank accountpatch
Add funding sourcepost
List funding sourcesget
Transaction
Get transactionget
List transactionsget
Simulate void transactionpost
Simulate returnpost
Simulate clearing transactionpost
Simulate authorizationpost
Status
API status checkget

Privacy Developer API
Account
Update accountpatch
Get accountget
List accountsget
Account Holder
Create webhook for KYC/KYB eventspost
Check the current status of a KYC or KYB evaluationget
Resubmit account holder informationpost
Get account holder document upload statusget
Get account holder document uploadsget
Initiate account holder document uploadpost
Create an individual or business account holderpost
Card
Embedded card UIget
Reissue cardpost
Provision card (Digital Wallet)post
Update cardpatch
Get cardget
Create cardpost
List cardsget
Funding
Verify bank accountpost
Update bank accountpatch
Add funding sourcepost
List funding sourcesget
Transaction
Get transactionget
List transactionsget
Simulate void transactionpost
Simulate returnpost
Simulate clearing transactionpost
Simulate authorizationpost
Status
API status checkget

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.