Deactivate a Virtual Account

curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Api-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Api-Key': '<api-key>'}
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "status": "deactivated",
  "developer_fee_percent": "0.1",
  "fee_config": {
    "source": {
      "default": {
        "fee_percent": "0.5",
        "minimum_fee": "1.00"
      },
      "wire": {
        "fee_amount": "10.00",
        "fee_percent": "1.0"
      }
    }
  },
  "customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "source_deposit_instructions": {
    "currency": "usd",
    "payment_rails": [
      "ach_push",
      "fednow",
      "wire"
    ],
    "bank_name": "Lead Bank",
    "bank_address": "1801 Main St., Kansas City, MO 64108",
    "bank_beneficiary_name": "Customer Name",
    "bank_beneficiary_address": "1234 Main St., Kansas City, MO 64108",
    "bank_account_number": "123456789",
    "bank_routing_number": "87654321"
  },
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef"
  }
}

POST

customers

{customerID}

virtual_accounts

{virtualAccountID}

deactivate

Deactivate a Virtual Account

curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Api-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Api-Key': '<api-key>'}
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "status": "deactivated",
  "developer_fee_percent": "0.1",
  "fee_config": {
    "source": {
      "default": {
        "fee_percent": "0.5",
        "minimum_fee": "1.00"
      },
      "wire": {
        "fee_amount": "10.00",
        "fee_percent": "1.0"
      }
    }
  },
  "customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "source_deposit_instructions": {
    "currency": "usd",
    "payment_rails": [
      "ach_push",
      "fednow",
      "wire"
    ],
    "bank_name": "Lead Bank",
    "bank_address": "1801 Main St., Kansas City, MO 64108",
    "bank_beneficiary_name": "Customer Name",
    "bank_beneficiary_address": "1234 Main St., Kansas City, MO 64108",
    "bank_account_number": "123456789",
    "bank_routing_number": "87654321"
  },
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef"
  }
}

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

Pattern: [a-z0-9]*

virtualAccountID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

Response

200 - application/json

Deactivated Virtual Account object

string

read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

status

enum<string>

The activation status of the Virtual Account

Available options:

activated,

deactivated

Example:

"deactivated"

developer_fee_percent

string<number>

The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.

Example:

"0.1"

fee_config

object

Developer fee configuration. Available by request only and returned only for developers with this feature enabled.

Show child attributes

customer_id

string

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

created_at

string<date-time>

read-only

Time of creation of the virtual account

source_deposit_instructions

Virtual Account US · object

Show child attributes

Example:

{
  "currency": "usd",
  "payment_rails": ["ach_push", "fednow", "wire"],
  "bank_name": "Lead Bank",
  "bank_address": "1801 Main St., Kansas City, MO 64108",
  "bank_beneficiary_name": "Customer Name",
  "bank_beneficiary_address": "1234 Main St., Kansas City, MO 64108",
  "bank_account_number": "123456789",
  "bank_routing_number": "87654321"
}

destination

object

Show child attributes

Example:

{
  "currency": "usdc",
  "payment_rail": "polygon",
  "address": "0xdeadbeef"
}

Update a Virtual Account Reactivate a Virtual Account

⌘I