Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Bank account restrictions

Update bank account restriction

Updates a bank account restriction.

Allows you to change the restriction type, reason code, and/or legal status of an active restriction. Notes are always required to provide context for the change.

Only the fields you include in the request body will be updated. Omitted fields are left unchanged.

post/v0/bank/account-restrictions/{bank-account-restriction-id}/actions/update

Path parameters

bank-account-restriction-idstring required

Request body

restriction-type'block' | 'freeze'
restriction-reason-code'fraud-app-perpetrator' | 'customer-request' | 'dormant' | 'other' | 'terrorist-financing' | 'law-enforcement' | 'sanctions' | 'risk-appetite' | 'deceased' | 'fraud-app-victim' | 'fraud-3rd-party' | 'money-laundering' | 'fraud-1st-party'
restriction-legal-status'not-applicable' | 'conviction-confirmed' | 'formal-charge-filed' | 'suspected'
notesstring required

Response

OK

created-atstring date-time required

ISO 8601 formatted date-time.

Example response

{
  "restriction-applied-by": {
    "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
    "user-username": "user@example.com"
  }
}