Privacy Cards
Manage virtual cards via the Privacy.com API.
Setup
Getting API Access
- 1. Sign up for a Privacy.com account
- Email support@privacy.com to request API access
- Once approved, you'll receive your API key
Configuration
CODEBLOCK0
Environments:
- - Production: INLINECODE0
- Sandbox: INLINECODE1
All requests: Authorization: api-key $PRIVACY_API_KEY
Create a Card
CODEBLOCK1
Card Types
| Type | Behavior |
|---|
| INLINECODE3 | Closes after first transaction |
| INLINECODE4 |
Locks to first merchant, reusable there |
|
UNLOCKED | Works anywhere (requires issuing access) |
Create Parameters
| Parameter | Required | Description |
|---|
| INLINECODE6 | Yes | SINGLEUSE, MERCHANTLOCKED, UNLOCKED |
| INLINECODE7 |
No | Label/description |
|
spend_limit | No | Limit in cents |
|
spend_limit_duration | No | TRANSACTION, MONTHLY, ANNUALLY, FOREVER |
|
state | No | OPEN (default) or PAUSED |
|
funding_token | No | Specific funding source UUID |
Response
CODEBLOCK2
Note: pan, cvv, exp_month, exp_year require enterprise access in production. Always available in sandbox.
Lookup Transactions
All transactions for a card
CODEBLOCK3
Filter by date range
CODEBLOCK4
Filter by result
CODEBLOCK5
Query Parameters
| Parameter | Description |
|---|
| INLINECODE16 | Filter by card UUID |
| INLINECODE17 |
APPROVED or DECLINED |
|
begin | On or after date (YYYY-MM-DD) |
|
end | Before date (YYYY-MM-DD) |
|
page | Page number (default: 1) |
|
page_size | Results per page (1-1000, default: 50) |
Transaction Response
CODEBLOCK6
Transaction Statuses
PENDING →
SETTLING → INLINECODE24
Also: VOIDED, BOUNCED, DECLINED
Quick Reference
List all cards
CODEBLOCK7
Get single card
CODEBLOCK8
Pause a card
CODEBLOCK9
Close a card (permanent)
CODEBLOCK10
Update spend limit
curl -s -X PATCH "https://api.privacy.com/v1/cards/{card_token}" \
-H "Authorization: api-key $PRIVACY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spend_limit": 10000, "spend_limit_duration": "MONTHLY"}' | jq
Common Decline Reasons
| Code | Meaning |
|---|
| INLINECODE28 | Card is paused |
| INLINECODE29 |
Card is closed |
|
SINGLE_USE_RECHARGED | Single-use already used |
|
UNAUTHORIZED_MERCHANT | Wrong merchant for locked card |
|
USER_TRANSACTION_LIMIT | Spend limit exceeded |
|
INSUFFICIENT_FUNDS | Funding source issue |
See references/api.md for complete field documentation.
隐私卡
通过Privacy.com API管理虚拟卡。
设置
获取API访问权限
- 1. 注册Privacy.com账户
- 发送邮件至support@privacy.com申请API访问权限
- 获批后,您将收到API密钥
配置
bash
export PRIVACYAPIKEY=your-api-key
环境:
- - 生产环境:https://api.privacy.com/v1
- 沙箱环境:https://sandbox.privacy.com/v1
所有请求:Authorization: api-key $PRIVACYAPIKEY
创建卡片
bash
curl -s -X POST https://api.privacy.com/v1/cards \
-H Authorization: api-key $PRIVACYAPIKEY \
-H Content-Type: application/json \
-d {
type: SINGLE_USE,
memo: 一次性购买,
spend_limit: 5000,
spendlimitduration: TRANSACTION
} | jq
卡片类型
| 类型 | 行为 |
|---|
| SINGLEUSE | 首次交易后关闭 |
| MERCHANTLOCKED |
锁定至首个商户,可重复使用 |
| UNLOCKED | 任意场景可用(需授权发行) |
创建参数
| 参数 | 必填 | 描述 |
|---|
| type | 是 | SINGLEUSE、MERCHANTLOCKED、UNLOCKED |
| memo |
否 | 标签/描述 |
| spend_limit | 否 | 限额(单位:分) |
| spend
limitduration | 否 | TRANSACTION、MONTHLY、ANNUALLY、FOREVER |
| state | 否 | OPEN(默认)或PAUSED |
| funding_token | 否 | 指定资金来源UUID |
响应
json
{
token: card-uuid,
type: SINGLE_USE,
state: OPEN,
memo: 一次性购买,
last_four: 1234,
pan: 4111111111111234,
cvv: 123,
exp_month: 12,
exp_year: 2027,
spend_limit: 5000,
spend
limitduration: TRANSACTION,
created: 2024-01-15T10:30:00Z
}
注意: 生产环境中pan、cvv、expmonth、expyear需企业级访问权限。沙箱环境始终可用。
查询交易
查询卡片所有交易
bash
curl -s https://api.privacy.com/v1/transactions?card
token={cardtoken} \
-H Authorization: api-key $PRIVACY
APIKEY | jq
按日期范围筛选
bash
curl -s https://api.privacy.com/v1/transactions?card
token={cardtoken}&begin=2024-01-01&end=2024-01-31 \
-H Authorization: api-key $PRIVACY
APIKEY | jq
按结果筛选
bash
仅已批准
curl -s https://api.privacy.com/v1/transactions?result=APPROVED \
-H Authorization: api-key $PRIVACY
APIKEY | jq
仅已拒绝
curl -s https://api.privacy.com/v1/transactions?result=DECLINED \
-H Authorization: api-key $PRIVACY
APIKEY | jq
查询参数
| 参数 | 描述 |
|---|
| card_token | 按卡片UUID筛选 |
| result |
APPROVED或DECLINED |
| begin | 指定日期及之后(YYYY-MM-DD) |
| end | 指定日期之前(YYYY-MM-DD) |
| page | 页码(默认:1) |
| page_size | 每页结果数(1-1000,默认:50) |
交易响应
json
{
token: txn-uuid,
card_token: card-uuid,
amount: -2500,
status: SETTLED,
result: APPROVED,
merchant: {
descriptor: NETFLIX.COM,
mcc: 4899,
city: LOS GATOS,
state: CA,
country: USA
},
created: 2024-01-15T14:22:00Z
}
交易状态
PENDING → SETTLING → SETTLED
此外:VOIDED、BOUNCED、DECLINED
快速参考
列出所有卡片
bash
curl -s https://api.privacy.com/v1/cards \
-H Authorization: api-key $PRIVACY
APIKEY | jq
获取单张卡片
bash
curl -s https://api.privacy.com/v1/cards/{card_token} \
-H Authorization: api-key $PRIVACY
APIKEY | jq
暂停卡片
bash
curl -s -X PATCH https://api.privacy.com/v1/cards/{card_token} \
-H Authorization: api-key $PRIVACY
APIKEY \
-H Content-Type: application/json \
-d {state: PAUSED} | jq
关闭卡片(永久)
bash
curl -s -X PATCH https://api.privacy.com/v1/cards/{card_token} \
-H Authorization: api-key $PRIVACY
APIKEY \
-H Content-Type: application/json \
-d {state: CLOSED} | jq
更新消费限额
bash
curl -s -X PATCH https://api.privacy.com/v1/cards/{card_token} \
-H Authorization: api-key $PRIVACY
APIKEY \
-H Content-Type: application/json \
-d {spend
limit: 10000, spendlimit_duration: MONTHLY} | jq
常见拒绝原因
| 代码 | 含义 |
|---|
| CARDPAUSED | 卡片已暂停 |
| CARDCLOSED |
卡片已关闭 |
| SINGLE
USERECHARGED | 一次性卡片已被使用 |
| UNAUTHORIZED_MERCHANT | 锁定卡片的商户不匹配 |
| USER
TRANSACTIONLIMIT | 超出消费限额 |
| INSUFFICIENT_FUNDS | 资金来源问题 |
完整字段文档请参见references/api.md。