Update the fiat payout configuration for a customer

curl --request PATCH \
  --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fiat_payout_configuration": {
    "usd": {
      "wire": "customer"
    }
  }
}
'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"

payload = { "fiat_payout_configuration": { "usd": { "wire": "customer" } } }
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fiat_payout_configuration: {usd: {wire: 'customer'}}})
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration', 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}/fiat_payout_configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'fiat_payout_configuration' => [
        'usd' => [
                'wire' => 'customer'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"

	payload := strings.NewReader("{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}"

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

{
  "fiat_payout_configuration": {
    "usd": {
      "wire": "customer",
      "ach": "bridge"
    },
    "eur": {
      "sepa": "bridge"
    },
    "brl": {
      "pix": "payment_provider"
    },
    "mxn": {
      "spei": "payment_provider"
    }
  }
}

Fiat Payout Configuration

Update the fiat payout configuration for a customer

Update the fiat payout configuration for the given customer ID. This configuration determines which payout method (bridge, developer, payment_provider, or customer) is used for each currency and payment rail combination.

The configuration is a nested hash structure where:

Top-level keys are currency codes (e.g., “usd”, “eur”, “brl”, “mxn”)
Second-level keys are payment rail codes (e.g., “wire”, “ach”, “sepa”, “pix”, “spei”)
Values are payout names: bridge, developer, payment_provider, or customer

Currently, only the following values are supported for the payout method:

usd.wire: developer, customer
usd.ach: bridge
eur.sepa: bridge
brl.pix: payment_provider
mxn.spei: payment_provider

Only the currency/payment rail combinations provided will be updated. Other existing configurations will remain unchanged.

PATCH

customers

{customerID}

fiat_payout_configuration

Update the fiat payout configuration for a customer

curl --request PATCH \
  --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fiat_payout_configuration": {
    "usd": {
      "wire": "customer"
    }
  }
}
'

import requests

url = "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"

payload = { "fiat_payout_configuration": { "usd": { "wire": "customer" } } }
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fiat_payout_configuration: {usd: {wire: 'customer'}}})
};

fetch('https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration', 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}/fiat_payout_configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'fiat_payout_configuration' => [
        'usd' => [
                'wire' => 'customer'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"

	payload := strings.NewReader("{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fiat_payout_configuration\": {\n    \"usd\": {\n      \"wire\": \"customer\"\n    }\n  }\n}"

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

{
  "fiat_payout_configuration": {
    "usd": {
      "wire": "customer",
      "ach": "bridge"
    },
    "eur": {
      "sepa": "bridge"
    },
    "brl": {
      "pix": "payment_provider"
    },
    "mxn": {
      "spei": "payment_provider"
    }
  }
}

Authorizations

Api-Key

string

header

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

Body

application/json

Fiat payout configuration to update

Input payload for updating a customer's fiat payout configuration

fiat_payout_configuration

object

required

A nested hash structure representing the fiat payout configuration. The top-level keys are currency codes. Each currency maps to a hash where keys are payment rail codes and values are payout names.

Show child attributes

Example:

{
  "usd": { "wire": "developer", "ach": "bridge" },
  "eur": { "sepa": "bridge" },
  "brl": { "pix": "payment_provider" },
  "mxn": { "spei": "payment_provider" }
}

Response

Successful fiat payout configuration update response

fiat_payout_configuration

object

required

A nested hash structure representing the fiat payout configuration. The top-level keys are currency codes. Each currency maps to a hash where keys are payment rail codes and values are payout names.

Show child attributes

Example:

{
  "usd": { "wire": "developer", "ach": "bridge" },
  "eur": { "sepa": "bridge" },
  "brl": { "pix": "payment_provider" },
  "mxn": { "spei": "payment_provider" }
}

Get the fiat payout configuration for a customer Generate a Plaid Link token for a customer

⌘I