Get the fiat payout configuration for a customer
curl --request GET \
--url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \
--header 'Api-Key: <api-key>'import requests
url = "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"
headers = {"Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Api-Key: <api-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}/fiat_payout_configuration"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration")
.header("Api-Key", "<api-key>")
.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::Get.new(url)
request["Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"fiat_payout_configuration": {
"usd": {
"wire": "developer",
"ach": "bridge"
},
"eur": {
"sepa": "bridge"
},
"brl": {
"pix": "payment_provider"
},
"mxn": {
"spei": "payment_provider"
}
}
}Fiat Payout Configuration
Get the fiat payout configuration for a customer
Retrieve 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, orcustomer
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
GET
/
customers
/
{customerID}
/
fiat_payout_configuration
Get the fiat payout configuration for a customer
curl --request GET \
--url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \
--header 'Api-Key: <api-key>'import requests
url = "https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration"
headers = {"Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Api-Key: <api-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}/fiat_payout_configuration"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration")
.header("Api-Key", "<api-key>")
.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::Get.new(url)
request["Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"fiat_payout_configuration": {
"usd": {
"wire": "developer",
"ach": "bridge"
},
"eur": {
"sepa": "bridge"
},
"brl": {
"pix": "payment_provider"
},
"mxn": {
"spei": "payment_provider"
}
}
}Authorizations
Path Parameters
A UUID that uniquely identifies a resource
Required string length:
1 - 42Pattern:
[a-z0-9]*Response
Successful fiat payout configuration response
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
Show child attributes
Example:
{
"usd": { "wire": "developer", "ach": "bridge" },
"eur": { "sepa": "bridge" },
"brl": { "pix": "payment_provider" },
"mxn": { "spei": "payment_provider" }
}
Was this page helpful?