HIFI Docs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId

string

required

ID of the user

Body

application/json

Create an onramp or offramp account for different account types.

Note for fiat accounts: When type is fiat and rail is offramp, this adds an offramp beneficiary account to an existing fiat account. The user must have an active fiat account before adding a beneficiary.

rail

enum<string>

required

Available options:

onramp,

offramp

type

enum<string>

required

The type of account.

Available options:

us,

africa,

fiat,

recipient,

brazilGlobalNetwork,

nigeriaGlobalNetwork,

mexicoGlobalNetwork,

hongKongGlobalNetwork,

chinaGlobalNetwork,

singaporeGlobalNetwork,

italyGlobalNetwork,

spainGlobalNetwork,

germanyGlobalNetwork,

unitedArabEmiratesGlobalNetwork,

franceGlobalNetwork,

unitedKingdomGlobalNetwork,

lithuaniaGlobalNetwork,

netherlandsGlobalNetwork,

hungaryGlobalNetwork,

greeceGlobalNetwork,

austriaGlobalNetwork,

irelandGlobalNetwork,

portugalGlobalNetwork,

denmarkGlobalNetwork,

norwayGlobalNetwork,

croatiaGlobalNetwork,

slovakiaGlobalNetwork,

swedenGlobalNetwork,

polandGlobalNetwork,

sloveniaGlobalNetwork,

romaniaGlobalNetwork,

finlandGlobalNetwork,

latviaGlobalNetwork,

czechRepublicGlobalNetwork,

serbiaGlobalNetwork,

estoniaGlobalNetwork,

cyprusGlobalNetwork,

japanGlobalNetwork,

southAfricaGlobalNetwork,

chileGlobalNetwork,

belgiumGlobalNetwork,

thailandGlobalNetwork,

indonesiaGlobalNetwork,

bulgariaGlobalNetwork,

icelandGlobalNetwork,

luxembourgGlobalNetwork,

maltaGlobalNetwork,

liechtensteinGlobalNetwork,

southKoreaGlobalNetwork,

taiwanGlobalNetwork,

colombiaGlobalNetwork,

argentinaGlobalNetwork,

kenyaGlobalNetwork,

australiaGlobalNetwork,

newZealandGlobalNetwork,

israelGlobalNetwork,

turkeyGlobalNetwork,

canadaGlobalNetwork,

andorraGlobalNetwork,

albaniaGlobalNetwork,

switzerlandGlobalNetwork,

monacoGlobalNetwork,

moldovaGlobalNetwork,

montenegroGlobalNetwork,

northMacedoniaGlobalNetwork,

sanMarinoGlobalNetwork,

vaticanCityGlobalNetwork,

philippinesGlobalNetwork,

panamaGlobalNetwork

requestId

string<uuid>

Optional idempotency key (UUID). Reusing the same requestId for the same user returns the account created by the first request instead of creating a duplicate. Reusing the same requestId with a different request body returns 409 Conflict. If omitted, a new account is created on every request.

accountHolder

Account Holder · object

account holder information.

Show child attributes

Account Info · object

US account.

Show child attributes

africa

Account Info · object

Africa account.

Show child attributes

fiat

Account Info · object

Fiat account (uses us account schema).

Show child attributes

recipient

Account Info · object

Recipient account (uses us account schema).

Show child attributes

brazilGlobalNetwork

Brazil Global Network Account · object

Brazil Global Network account.

Show child attributes

nigeriaGlobalNetwork

Nigeria Global Network Account · object

Nigeria Global Network account.

Show child attributes

mexicoGlobalNetwork

Mexico Global Network Account · object

Mexico Global Network account.

Show child attributes

hongKongGlobalNetwork

Hong Kong Global Network Account · object

Hong Kong Global Network account.

Show child attributes

singaporeGlobalNetwork

Singapore Global Network Account · object

Singapore Global Network account.

Show child attributes

italyGlobalNetwork

Italy Global Network Account · object

Italy Global Network account.

Show child attributes

spainGlobalNetwork

Spain Global Network Account · object

Spain Global Network account.

Show child attributes

germanyGlobalNetwork

Germany Global Network Account · object

Germany Global Network account.

Show child attributes

franceGlobalNetwork

France Global Network Account · object

France Global Network account.

Show child attributes

unitedKingdomGlobalNetwork

United Kingdom Global Network Account · object

United Kingdom Global Network account.

Show child attributes

lithuaniaGlobalNetwork

Lithuania Global Network Account · object

Lithuania Global Network account.

Show child attributes

netherlandsGlobalNetwork

Netherlands Global Network Account · object

Netherlands Global Network account.

Show child attributes

hungaryGlobalNetwork

Hungary Global Network Account · object

Hungary Global Network account.

Show child attributes

greeceGlobalNetwork

Greece Global Network Account · object

Greece Global Network account.

Show child attributes

austriaGlobalNetwork

Austria Global Network Account · object

Austria Global Network account.

Show child attributes

irelandGlobalNetwork

Ireland Global Network Account · object

Ireland Global Network account.

Show child attributes

portugalGlobalNetwork

Portugal Global Network Account · object

Portugal Global Network account.

Show child attributes

denmarkGlobalNetwork

Denmark Global Network Account · object

Denmark Global Network account.

Show child attributes

norwayGlobalNetwork

Norway Global Network Account · object

Norway Global Network account.

Show child attributes

croatiaGlobalNetwork

Croatia Global Network Account · object

Croatia Global Network account.

Show child attributes

slovakiaGlobalNetwork

Slovakia Global Network Account · object

Slovakia Global Network account.

Show child attributes

swedenGlobalNetwork

Sweden Global Network Account · object

Sweden Global Network account.

Show child attributes

polandGlobalNetwork

Poland Global Network Account · object

Poland Global Network account.

Show child attributes

sloveniaGlobalNetwork

Slovenia Global Network Account · object

Slovenia Global Network account.

Show child attributes

romaniaGlobalNetwork

Romania Global Network Account · object

Romania Global Network account.

Show child attributes

finlandGlobalNetwork

Finland Global Network Account · object

Finland Global Network account.

Show child attributes

latviaGlobalNetwork

Latvia Global Network Account · object

Latvia Global Network account.

Show child attributes

czechRepublicGlobalNetwork

Czech Republic Global Network Account · object

Czech Republic Global Network account.

Show child attributes

serbiaGlobalNetwork

Serbia Global Network Account · object

Serbia Global Network account.

Show child attributes

estoniaGlobalNetwork

Estonia Global Network Account · object

Estonia Global Network account.

Show child attributes

cyprusGlobalNetwork

Cyprus Global Network Account · object

Cyprus Global Network account.

Show child attributes

japanGlobalNetwork

Japan Global Network Account · object

Japan Global Network account.

Show child attributes

southAfricaGlobalNetwork

South Africa Global Network Account · object

South Africa Global Network account.

Show child attributes

chileGlobalNetwork

Chile Global Network Account · object

Chile Global Network account.

Show child attributes

belgiumGlobalNetwork

Belgium Global Network Account · object

Belgium Global Network account.

Show child attributes

thailandGlobalNetwork

Thailand Global Network Account · object

Thailand Global Network account.

Show child attributes

indonesiaGlobalNetwork

Indonesia Global Network Account · object

Indonesia Global Network account.

Show child attributes

bulgariaGlobalNetwork

Bulgaria Global Network Account · object

Bulgaria Global Network account.

Show child attributes

icelandGlobalNetwork

Iceland Global Network Account · object

Iceland Global Network account.

Show child attributes

luxembourgGlobalNetwork

Luxembourg Global Network Account · object

Luxembourg Global Network account.

Show child attributes

maltaGlobalNetwork

Malta Global Network Account · object

Malta Global Network account.

Show child attributes

liechtensteinGlobalNetwork

Liechtenstein Global Network Account · object

Liechtenstein Global Network account.

Show child attributes

southKoreaGlobalNetwork

South Korea Global Network Account · object

South Korea Global Network account.

Show child attributes

taiwanGlobalNetwork

Taiwan Global Network Account · object

Taiwan Global Network account.

Show child attributes

colombiaGlobalNetwork

Colombia Global Network Account · object

Colombia Global Network account.

Show child attributes

argentinaGlobalNetwork

Argentina Global Network Account · object

Argentina Global Network account.

Show child attributes

kenyaGlobalNetwork

Kenya Global Network Account · object

Kenya Global Network account.

Show child attributes

australiaGlobalNetwork

Australia Global Network Account · object

Australia Global Network account.

Show child attributes

newZealandGlobalNetwork

New Zealand Global Network Account · object

New Zealand Global Network account.

Show child attributes

panamaGlobalNetwork

Panama Global Network Account · object

Panama Global Network account.

Show child attributes

israelGlobalNetwork

Israel Global Network Account · object

Israel Global Network account.

Show child attributes

turkeyGlobalNetwork

Turkey Global Network Account · object

Turkey Global Network account.

Show child attributes

canadaGlobalNetwork

Canada Global Network Account (USD SWIFT) · object

Canada Global Network (USD SWIFT) account.

Show child attributes

andorraGlobalNetwork

Andorra Global Network Account · object

Andorra Global Network account.

Show child attributes

albaniaGlobalNetwork

Albania Global Network Account · object

Albania Global Network account.

Show child attributes

switzerlandGlobalNetwork

Switzerland Global Network Account · object

Switzerland Global Network account.

Show child attributes

monacoGlobalNetwork

Monaco Global Network Account · object

Monaco Global Network account.

Show child attributes

moldovaGlobalNetwork

Moldova Global Network Account · object

Moldova Global Network account.

Show child attributes

montenegroGlobalNetwork

Montenegro Global Network Account · object

Montenegro Global Network account.

Show child attributes

northMacedoniaGlobalNetwork

North Macedonia Global Network Account · object

North Macedonia Global Network account.

Show child attributes

sanMarinoGlobalNetwork

San Marino Global Network Account · object

San Marino Global Network account.

Show child attributes

vaticanCityGlobalNetwork

Vatican City Global Network Account · object

Vatican City Global Network account.

Show child attributes

unitedArabEmiratesGlobalNetwork

United Arab Emirates Global Network Account · object

United Arab Emirates Global Network account.

Show child attributes

philippinesGlobalNetwork

Philippines Global Network Account · object

Philippines Global Network account.

Show child attributes

Response

Success

status

string

message

string