Register a fiat bank account for a customer.
curl --request POST \
--url https://api.sandbox.iron.xyz/api/addresses/fiat \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'IDEMPOTENCY-KEY: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": {
"email": "john.doe@example.com"
},
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": {
"code": "DE"
},
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"currency": {
"code": "USD"
},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
'import requests
url = "https://api.sandbox.iron.xyz/api/addresses/fiat"
payload = {
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": { "code": "GB" },
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": None,
"email_address": { "email": "john.doe@example.com" },
"is_third_party": False,
"phone_number": "+49-30-12345678",
"provider_country": { "code": "DE" },
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"currency": { "code": "USD" },
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
headers = {
"IDEMPOTENCY-KEY": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json; charset=utf-8"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'IDEMPOTENCY-KEY': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify({
bank_details: {
account_identifier: {iban: 'DE89370400440532013000', type: 'SEPA'},
address: {
city: 'London',
country: {code: 'GB'},
postal_code: 'SW1A 2AA',
state: 'England',
street: '10 Downing Street'
},
bank_address: null,
email_address: {email: 'john.doe@example.com'},
is_third_party: false,
phone_number: '+49-30-12345678',
provider_country: {code: 'DE'},
provider_name: 'Iron Bank',
recipient: {name: 'Aperture Science', type: 'Business'}
},
currency: {code: 'USD'},
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>'
})
};
fetch('https://api.sandbox.iron.xyz/api/addresses/fiat', 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.sandbox.iron.xyz/api/addresses/fiat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bank_details' => [
'account_identifier' => [
'iban' => 'DE89370400440532013000',
'type' => 'SEPA'
],
'address' => [
'city' => 'London',
'country' => [
'code' => 'GB'
],
'postal_code' => 'SW1A 2AA',
'state' => 'England',
'street' => '10 Downing Street'
],
'bank_address' => null,
'email_address' => [
'email' => 'john.doe@example.com'
],
'is_third_party' => false,
'phone_number' => '+49-30-12345678',
'provider_country' => [
'code' => 'DE'
],
'provider_name' => 'Iron Bank',
'recipient' => [
'name' => 'Aperture Science',
'type' => 'Business'
]
],
'currency' => [
'code' => 'USD'
],
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json; charset=utf-8",
"IDEMPOTENCY-KEY: <idempotency-key>",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.iron.xyz/api/addresses/fiat"
payload := strings.NewReader("{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json; charset=utf-8")
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.sandbox.iron.xyz/api/addresses/fiat")
.header("IDEMPOTENCY-KEY", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json; charset=utf-8")
.body("{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/addresses/fiat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bank_account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": {
"email": "john.doe@example.com"
},
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": {
"code": "DE"
},
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"bank_name": "Iron Bank",
"country": "DE",
"created_at": "2024-01-15T10:30:00.000Z",
"currency": "EUR",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"is_third_party": false,
"label": "Primary Business Account",
"ownership_verified": true,
"status": "Registered",
"updated_at": "1970-01-01T00:00:00.000Z"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}{
"message": "<string>",
"trace_id": "<string>"
}Addresses
Register a fiat bank account for a customer.
Register a bank account address for a customer.
POST
/
addresses
/
fiat
Register a fiat bank account for a customer.
curl --request POST \
--url https://api.sandbox.iron.xyz/api/addresses/fiat \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'IDEMPOTENCY-KEY: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": {
"email": "john.doe@example.com"
},
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": {
"code": "DE"
},
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"currency": {
"code": "USD"
},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
'import requests
url = "https://api.sandbox.iron.xyz/api/addresses/fiat"
payload = {
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": { "code": "GB" },
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": None,
"email_address": { "email": "john.doe@example.com" },
"is_third_party": False,
"phone_number": "+49-30-12345678",
"provider_country": { "code": "DE" },
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"currency": { "code": "USD" },
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
headers = {
"IDEMPOTENCY-KEY": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json; charset=utf-8"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'IDEMPOTENCY-KEY': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify({
bank_details: {
account_identifier: {iban: 'DE89370400440532013000', type: 'SEPA'},
address: {
city: 'London',
country: {code: 'GB'},
postal_code: 'SW1A 2AA',
state: 'England',
street: '10 Downing Street'
},
bank_address: null,
email_address: {email: 'john.doe@example.com'},
is_third_party: false,
phone_number: '+49-30-12345678',
provider_country: {code: 'DE'},
provider_name: 'Iron Bank',
recipient: {name: 'Aperture Science', type: 'Business'}
},
currency: {code: 'USD'},
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>'
})
};
fetch('https://api.sandbox.iron.xyz/api/addresses/fiat', 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.sandbox.iron.xyz/api/addresses/fiat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bank_details' => [
'account_identifier' => [
'iban' => 'DE89370400440532013000',
'type' => 'SEPA'
],
'address' => [
'city' => 'London',
'country' => [
'code' => 'GB'
],
'postal_code' => 'SW1A 2AA',
'state' => 'England',
'street' => '10 Downing Street'
],
'bank_address' => null,
'email_address' => [
'email' => 'john.doe@example.com'
],
'is_third_party' => false,
'phone_number' => '+49-30-12345678',
'provider_country' => [
'code' => 'DE'
],
'provider_name' => 'Iron Bank',
'recipient' => [
'name' => 'Aperture Science',
'type' => 'Business'
]
],
'currency' => [
'code' => 'USD'
],
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json; charset=utf-8",
"IDEMPOTENCY-KEY: <idempotency-key>",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.iron.xyz/api/addresses/fiat"
payload := strings.NewReader("{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json; charset=utf-8")
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.sandbox.iron.xyz/api/addresses/fiat")
.header("IDEMPOTENCY-KEY", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json; charset=utf-8")
.body("{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.iron.xyz/api/addresses/fiat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n \"bank_details\": {\n \"account_identifier\": {\n \"iban\": \"DE89370400440532013000\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"city\": \"London\",\n \"country\": {\n \"code\": \"GB\"\n },\n \"postal_code\": \"SW1A 2AA\",\n \"state\": \"England\",\n \"street\": \"10 Downing Street\"\n },\n \"bank_address\": null,\n \"email_address\": {\n \"email\": \"john.doe@example.com\"\n },\n \"is_third_party\": false,\n \"phone_number\": \"+49-30-12345678\",\n \"provider_country\": {\n \"code\": \"DE\"\n },\n \"provider_name\": \"Iron Bank\",\n \"recipient\": {\n \"name\": \"Aperture Science\",\n \"type\": \"Business\"\n }\n },\n \"currency\": {\n \"code\": \"USD\"\n },\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bank_account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"bank_details": {
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": {
"code": "GB"
},
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": {
"email": "john.doe@example.com"
},
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": {
"code": "DE"
},
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
},
"bank_name": "Iron Bank",
"country": "DE",
"created_at": "2024-01-15T10:30:00.000Z",
"currency": "EUR",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"is_third_party": false,
"label": "Primary Business Account",
"ownership_verified": true,
"status": "Registered",
"updated_at": "1970-01-01T00:00:00.000Z"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}"<string>"{
"message": "<string>",
"trace_id": "<string>"
}{
"message": "<string>",
"trace_id": "<string>"
}Authorizations
API Key
Headers
a UUID ensuring an address is only registered once
Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner
Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.
Body
application/json; charset=utf-8
The fiat address registration request
Register Fiat Address Request
Request to register a fiat (bank) address
RecipientBankAccount
A recipient fiat bank account
Show child attributes
Show child attributes
Example:
{
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": { "code": "GB" },
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": { "email": "john.doe@example.com" },
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": { "code": "DE" },
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
}
A fiat currency
Show child attributes
Show child attributes
Example:
{ "code": "USD" }
The customer ID
Optional label for the address
Response
Registration successful
Fiat Address
Response containing fiat address details
- Iban
- BankAccountACHIdentifier
- BankAccountWireIdentifier
- BankAccountRTPIdentifier
- BankAccountFedNowIdentifier
- BankAccountSWIFTIdentifier
- BankAccountCHAPSIdentifier
- BankAccountFPSIdentifier
Show child attributes
Show child attributes
Example:
{ "iban": "DE89370400440532013000" }
RecipientBankAccount
A recipient fiat bank account
Show child attributes
Show child attributes
Example:
{
"account_identifier": {
"iban": "DE89370400440532013000",
"type": "SEPA"
},
"address": {
"city": "London",
"country": { "code": "GB" },
"postal_code": "SW1A 2AA",
"state": "England",
"street": "10 Downing Street"
},
"bank_address": null,
"email_address": { "email": "john.doe@example.com" },
"is_third_party": false,
"phone_number": "+49-30-12345678",
"provider_country": { "code": "DE" },
"provider_name": "Iron Bank",
"recipient": {
"name": "Aperture Science",
"type": "Business"
}
}
The bank name
The country code
When the address was created
The currency of the bank account
The customer ID
The ID of the address
Is this a third party fiat address
Has the customer verified their ownership of this account
Verification Status
The status of the verification of a fiat address
Available options:
AuthorizationRequired, AuthorizationFailed, RegistrationPending, RegistrationFailed, Registered When the address was last updated
Optional label for the address
Was this page helpful?
⌘I