BRbridge
Cards

Place a freeze on the card account

Place a freeze on the card account

post/customers/{customerID}/card_accounts/{cardAccountID}/freeze

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/freeze
  • Auth
    API key in header Api-Key

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

cardAccountIDstring required

A UUID that uniquely identifies a resource

Headers

Idempotency-Keystring required

Request body

initiator'developer' | 'customer' 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

reason'lost_or_stolen' | 'suspicious_activity' | 'planned_inactivity' | 'suspected_fraud' | 'other' required

The reason of the freeze

reason_detailstring

A more detailed reason for the freeze

starting_atstring

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

ending_atstring

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_account_idstring required

A UUID that uniquely identifies a resource

initiator'developer' | 'customer' 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

reason'lost_or_stolen' | 'suspicious_activity' | 'planned_inactivity' | 'suspected_fraud' | 'other' required

The reason of the freeze

reason_detailstring

A more detailed reason for the freeze

starting_atstring

The start time of the freeze, in ISO8601 format

ending_atstring

The end time of the freeze, in ISO8601 format

created_atstring required

The creation time of the freeze, in ISO8601 format

Changes

No recorded changes to this operation across all 2 revisions of this API.