POST
/
customers
/
{customerID}
/
card_accounts
/
{cardAccountID}
/
freeze
Place a freeze on the card account
curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/freeze \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "initiator": "developer",
  "reason": "lost_or_stolen",
  "reason_detail": "<string>",
  "starting_at": "<string>",
  "ending_at": "<string>"
}'
{
  "card_account_id": "<string>",
  "initiator": "developer",
  "reason": "lost_or_stolen",
  "reason_detail": "<string>",
  "starting_at": "<string>",
  "ending_at": "<string>",
  "created_at": "<string>",
  "status": "freeze_created"
}

Authorizations

​
Api-Key
string
header
required

Headers

​
Idempotency-Key
string
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
​
cardAccountID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Body

application/json

The freeze to be placed on the card account

​
initiator
enum<string>
required

The party that initiated the freeze. A freeze can be initiated by either the customer or developer. Only one freeze per initiator can be active at a time. If a new freeze is initiated by the same party, it overwrites any existing freeze

Available options:
developer,
customer
​
reason
enum<string>
required

The reason of the freeze

Available options:
lost_or_stolen,
suspicious_activity,
planned_inactivity,
suspected_fraud,
other
​
reason_detail
string

A more detailed reason for the freeze

​
starting_at
string

An optional starting time in ISO8601 format. It defaults to the current date-time if unspecified

​
ending_at
string

An optional ending time in ISO8601 format. If this ending time is not specified, the card account will stay frozen indefinitely until it gets unfrozen by another request

Response

The successfully placed freeze

Card freeze

​
status
enum<string>
required

The processing status of the freeze request

Available options:
freeze_created,
freeze_replaced
​
card_account_id
string
required

Card account ID

Required string length: 1 - 42
​
initiator
enum<string>
required

The party that initiated the freeze. A freeze can be initiated by either the customer or developer. Only one freeze per initiator can be active at a time. If a new freeze is initiated by the same party, it overwrites any existing freeze

Available options:
developer,
customer
​
reason
enum<string>
required

The reason of the freeze

Available options:
lost_or_stolen,
suspicious_activity,
planned_inactivity,
suspected_fraud,
other
​
created_at
string
required

The creation time of the freeze, in ISO8601 format

​
reason_detail
string

A more detailed reason for the freeze

​
starting_at
string

The start time of the freeze, in ISO8601 format

​
ending_at
string

The end time of the freeze, in ISO8601 format