curl --request POST \
--url https://production.hifibridge.com/v2/users/{userId}/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rail": "onramp",
"type": "us",
"accountHolder": {
"type": "individual",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"address": {
"addressLine1": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addressLine2": "<string>"
},
"idType": "CC",
"idNumber": "<string>"
},
"us": {
"transferType": "ach",
"accountType": "Checking",
"bankName": "<string>",
"currency": "usd",
"accountNumber": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"bankAddress": {
"addressLine1": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addressLine2": "<string>"
}
},
"brazil": {
"pixKey": "<string>",
"currency": "brl"
},
"colombia": {
"accountNumber": "<string>",
"accountType": "checking",
"currency": "cop",
"bankName": "MOVII",
"bankCode": "<string>"
},
"argentina": {
"accountType": "CVU",
"accountNumber": "<string>",
"currency": "ars"
},
"mexico": {
"speiProtocol": "clabe",
"speiClabe": "<string>",
"currency": "mxn",
"speiInstitutionCode": "<string>"
},
"africa": {
"financialInstitute": "<string>",
"accountType": "momo",
"currency": "<string>",
"country": "<string>",
"accountNumber": "<string>"
},
"brazilGlobalNetwork": {
"currency": "brl",
"email": "[email protected]",
"phone": "<string>",
"pix": "<string>"
},
"nigeriaGlobalNetwork": {
"currency": "ngn",
"bankName": "<string>",
"accountNumber": "<string>"
},
"mexicoGlobalNetwork": {
"currency": "mxn",
"speiClabe": "<string>"
},
"hongKongGlobalNetwork": {
"bankName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>",
"currency": "hkd",
"bankCode": "<string>",
"transferType": "chats"
},
"singaporeGlobalNetwork": {
"currency": "usd",
"bankName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}
'{
"status": "ACTIVE",
"message": "Account created successfully",
"id": "583eb259-e78b-4f0c-a4b5-a8957876fa6f"
}Create an account
Create an onramp or offramp account for different account types by providing your bank account information.
curl --request POST \
--url https://production.hifibridge.com/v2/users/{userId}/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rail": "onramp",
"type": "us",
"accountHolder": {
"type": "individual",
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"address": {
"addressLine1": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addressLine2": "<string>"
},
"idType": "CC",
"idNumber": "<string>"
},
"us": {
"transferType": "ach",
"accountType": "Checking",
"bankName": "<string>",
"currency": "usd",
"accountNumber": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"bankAddress": {
"addressLine1": "<string>",
"city": "<string>",
"stateProvinceRegion": "<string>",
"postalCode": "<string>",
"country": "<string>",
"addressLine2": "<string>"
}
},
"brazil": {
"pixKey": "<string>",
"currency": "brl"
},
"colombia": {
"accountNumber": "<string>",
"accountType": "checking",
"currency": "cop",
"bankName": "MOVII",
"bankCode": "<string>"
},
"argentina": {
"accountType": "CVU",
"accountNumber": "<string>",
"currency": "ars"
},
"mexico": {
"speiProtocol": "clabe",
"speiClabe": "<string>",
"currency": "mxn",
"speiInstitutionCode": "<string>"
},
"africa": {
"financialInstitute": "<string>",
"accountType": "momo",
"currency": "<string>",
"country": "<string>",
"accountNumber": "<string>"
},
"brazilGlobalNetwork": {
"currency": "brl",
"email": "[email protected]",
"phone": "<string>",
"pix": "<string>"
},
"nigeriaGlobalNetwork": {
"currency": "ngn",
"bankName": "<string>",
"accountNumber": "<string>"
},
"mexicoGlobalNetwork": {
"currency": "mxn",
"speiClabe": "<string>"
},
"hongKongGlobalNetwork": {
"bankName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>",
"currency": "hkd",
"bankCode": "<string>",
"transferType": "chats"
},
"singaporeGlobalNetwork": {
"currency": "usd",
"bankName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}
'{
"status": "ACTIVE",
"message": "Account created successfully",
"id": "583eb259-e78b-4f0c-a4b5-a8957876fa6f"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the user
Body
- Account
- US Offramp Account
- Brazil Offramp Account
- Brazil Global Network Individual Account
- Brazil Global Network Business Account
- Colombia Offramp Account
- Argentina Offramp Account
- Mexico Offramp Account
- Mexico Global Network Individual Account
- Mexico Global Network Business Account
- Nigeria Global Network Individual Account
- Nigeria Global Network Business Account
- Hong Kong Global Network Individual Account
- Hong Kong Global Network Business Account
- China Global Network Individual Account
- China Global Network Business Account
- Singapore Global Network Individual Account
- Singapore Global Network Business Account
- Africa Onramp Account
- Africa Offramp Account
onramp, offramp The type of account.
us, brazil, colombia, argentina, mexico, africa, brazilGlobalNetwork, nigeriaGlobalNetwork, mexicoGlobalNetwork, hongKongGlobalNetwork, chinaGlobalNetwork, singaporeGlobalNetwork account holder information.
Show child attributes
Show child attributes
individual, business The name of the account holder.
individual: first name and last name seperated by space.
business: legal name of the business.
Address of the accountHolder.
Show child attributes
Show child attributes
The second part of the ISO 3166-2 subdivision code. This must be provided if the country has subdivisions.
An ISO 3166-2 code consists of two parts, separated by a hyphen (-):
- The first part is the ISO 3166-1 alpha-2 code of the country (e.g.,
US,CA,BR); - The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO.
Only provide the second part of the code (e.g., CA for California in US-CA, or SP for São Paulo in BR-SP).
Must be supplied for countries that use postal codes.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
The type of ID document provided by the account holder.
CC: Citizenship ID
CE: Foreign ID
NIT: National ID
PASS: Passport
PEP: Special Stay Permit
CC, CE, NIT, PASS, PEP The ID number of the account holder.
US account.
Show child attributes
Show child attributes
The type of transfer this account facilitates. rtp will come shortly.
ach, wire, swift The type of account.
Checking, Savings The name of the bank where the account is held.
The currency of the account.
usd The account number of the account.
The routing number of the account.
Only one of accountNumber or iban can be provided.
The SWIFT code of the bank where the account is held. Required if transferType is swift.
Address of the bank.
Show child attributes
Show child attributes
The second part of the ISO 3166-2 subdivision code. This must be provided if the country has subdivisions.
An ISO 3166-2 code consists of two parts, separated by a hyphen (-):
- The first part is the ISO 3166-1 alpha-2 code of the country (e.g.,
US,CA,BR); - The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO.
Only provide the second part of the code (e.g., CA for California in US-CA, or SP for São Paulo in BR-SP).
Must be supplied for countries that use postal codes.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
Colombia account.
Show child attributes
Show child attributes
The account number of the account.
The type of account.
checking, savings The currency of the account.
cop The name of the bank where the account is held. Required if bankCode is not provided.
MOVII, Banco de Bogotá, Banco Popular, Banco Corpbanca ITAU, Bancolombia, Citibank, Banco GNB Sudameris, BBVA, ITAU, Scotiabank Colpatria, Banco de Occidente, Bancoldex, Banco Caja Social, Banco Agrario, Jpmorgan Corporacion Financier, BNP PARIBAS, Davivienda, Banco AVVillas, Banco W, Banco Procredit Colombia, Bancamia, Inversora Pichincha S.A., Bancoomeva, Banco Falabella S.A., Banco Finandina S.A., Banco Santander Negocios, Banco Cooperativo Coopcentral, Serfinanza S.A, LULO BANK SA, Banco JP Morgan, Compensar, Gestion y Contacto S.A., Fedecajas, Simple S.A., Enlace Operativo, Corp. Financiera Colombiana, Financiera Juriscoop, Rappi, Coop. Financiera de Antioquia, Cotrafa Cooperativa Financiera, Confiar Cooperativa Financiera, Giros y Finanzas, COLTEFINANCIERA, Banco OLD Mutual, NEQUI, DECEVAL, Daviplata, Banco Credifinanciera, Financiera Dann (IRIS), DGCPTN The bank code of the bank where the account is held. Required if bankName is not provided. If provided, this will take precedence over bankName.
Mexico account.
Show child attributes
Show child attributes
The SPEI protocol of the account.
clabe, debitcard, phonenum The currency of the account.
mxn The institution code of the account. Required only if speiProtocol is debitcard or phonenum.
Africa account.
Show child attributes
Show child attributes
The financial institute of the account. Financial institue type has to match the accountType. eg. accountType of bank requires financialInstitute of bank.
Look at the list of supported combination of country, currency, and financialInstitute here.
Make sure the financialInstitute enum is supported under the country and currency.
The type of account.
momo, bank The account number of the account. Not required for rail: "onramp" with accountType: "bank". Required otherwise.
Brazil Global Network account.
Show child attributes
Show child attributes
The currency for the account
brl Provide when idNumber does not serve as offramp destination identifier At most one of the following fields can be provided: pix, email, phone.
Provide when idNumber does not serve as offramp destination identifier At most one of the following fields can be provided: pix, email, phone.
Provide when idNumber does not serve as offramp destination identifier At most one of the following fields can be provided: pix, email, phone.
Hong Kong Global Network account.
Show child attributes
Show child attributes
Bank name for the account
Bank account number
Bank code
The currency for the account
hkd, usd Bank code. Only required when transferType is chats or fps.
Transfer type of the account. swift is the default transfer type if not provided.
chats, fps, swift Singapore Global Network account.
Show child attributes
Show child attributes