Bank Wires
List of all countries available for payout via bank wire
GET https://gateway.noxxo.com/v1/payout/bankwire/supportedcountries
Parameters
countryName (String)
productType (String) — "bankwire" is keyword to get list of countries where payout via bank wire is available
Responses
200: OK — list of supported countries for bank wires
401: Unauthorized
Add bank account details for user
POST https://gateway.noxxo.com/v1/partners/user/forensics/whitelist/bankAccount
Whitelisting of a bank account allows a user to confirm if the bank is supported, validate banking details for remittance, and save the account details for transactions.
Request body
accountHolderName*
String
full name of the beneficiary as registered with the bank and the KYC document provided
accountType
String
type of the bank account, supported account types: "Checking", "Savings"; default account type for p2p transactions is "Savings"
mobile
String
mobile number of account holder that is linked to the bank account
provider
String
mobile operator supporting the mobile number
accountHolderAddress*
String
full address of the beneficiary as registered with the bank and proof of address provided during KYC
beneficiaryBankName*
String
full name of the beneficiary bank
beneficiaryBankAddress
String
full address of the beneficiary bank
beneficiaryBankCountry*
String
country of the beneficiary bank
bankAccountNumber*
String
beneficiary bank account (A/C) or IBAN number as applicable and required in the destination country, e.g. 2365417895 or AT483200000012345864
bicSwift*
String
SWIFT/BIC required to identify beneficiary bank
bankcode*
String
bank code identifying beneficiary bank locally, e.g. IFSC code in India, routing number in Canada and USA, sort code in UK; or equal to BIC/SWIFT
banksubcode
String
code that indicates the branch code of the specific bank that A/C is registered. Note: mandatory info in Brazil
country*
String
ISO Alpha-2 country code of the destination country, e.g. BR for Brazil
fiatCurrency*
String
currency in ISO 4217 format that is supported by beneficiary bank and A/C, e.g. BRL
userEmail*
String
user email address used during onboarding
Responses
201: Created — Message: "bank account: 0000000000 was whitelisted successfully."
400: Bad Request
401: Unauthorized
500: Internal Server Error
Response data
accountHolderName
String
full name of the beneficiary as registered with the bank and the KYC document provided
accountHolderAddress
String
full address of the beneficiary as registered with the bank and proof of address provided during KYC
beneficiaryBankName
String
full name of the beneficiary bank
beneficiaryBankAddress
String
full address of the beneficiary bank
beneficiaryBankCountry
String
country of the beneficiary bank
bankAccountNumber
String
beneficiary bank account (A/C) or IBAN number
bicSwift
String
SWIFT/BIC required to identify beneficiary bank
fiatCurrency
String
currency in ISO 4217 format that is supported by beneficiary bank and A/C
whitelisted
String
"true" means that banking details provided are valid for remittance and the account details were saved
message
String
"bank account: [bankAccountNumber] was whitelisted successfully."
Display saved user bank account
GET https://gateway.noxxo.com/v1/partners/user/forensics/fetchAll/whitelisted/BankAccount
Request body
userEmail*
String
user email previously saved and linked to whitelisted bank account and KYC profile
Responses
200: OK — "Success, whitelisted bank accounts list associated to account: [email protected] was fetched successfully.”
400: Bad Request
Response data
fiatCurrency
string
currency in ISO 4217 format that is supported by beneficiary bank and A/C
bankAccountNumber
string
beneficiary bank account (A/C) or IBAN number
beneficiaryBankName
string
full name of the beneficiary bank
Estimate Quote - Stablecoin Payout (by Quantity)
POST https://gateway.noxxo.com/v1/payout/bankwire/estimatedquotebyquantity
Quote calculated when user selects cryptocurrency and its quantity.
Request body
coin*
String
selected cryptocurrency, options available: “USDT” or “USDC”
transferType*
String
type of service requested for quote, default value to be used: "BANK"
sendingCurrency*
String
base fiat currency, default is "USD"
receivingCurrency*
String
fiat currency code in ISO 4217 format for the receiving bank account, e.g. BRL for Brazil
receivingCountry*
String
ISO Alpha-2 country code of the destination country, e.g. BR for Brazil
sendingCountry*
String
ISO Alpha-2 country code of the sending country, default value is "US"
quantity*
Number
quantity of cryptocurrency (reference to "coin") selected for quote
Responses
201: Created — message: "Successfully created the quote!"
400: Bad Request
Quote response fields
quoteType
string
“fiat”
quoteID
string
unique ID generated for the quote
receivingAmount
number
amount in local fiat currency
coinQuantityCharged
string
quantity/amount of cryptocurrency including fees charged for quote
fxRate
number
exchange rate used for converting crypto to FIAT (local currency)
bankWireFee
string
transaction fee charged for local fund transfer
Estimate Quote - Target Fiat Amount
POST https://gateway.noxxo.com/v1/payout/bankwire/estimatedquotebyamount
Quote calculated based on target fiat (local currency) amount and returns stablecoin cost.
Request body
coin*
String
selected cryptocurrency, options available: “USDT” or “USDC”
transferType*
String
type of service requested for quote, default value to be used: "BANK"
sendingCurrency*
String
base fiat currency, default is "USD"
receivingCurrency*
String
fiat currency code in ISO 4217 format for the receiving bank account, e.g. BRL for Brazil
receivingCountry*
String
ISO Alpha-2 country code of the destination country, e.g. BR for Brazil
sendingCountry*
String
ISO Alpha-2 country code of the sending country, default value is "US"
amount*
Number
target amount of fiat (reference to "receivingCurrency") selected for quote
Responses
201: Created — message: "Successfully created the quote!"
400: Bad Request
Quote response fields (same as above)
quoteType
string
“fiat”
quoteID
string
unique ID generated for the quote
receivingAmount
number
amount in local fiat currency
coinQuantityCharged
string
quantity/amount of cryptocurrency including fees charged for quote
fxRate
number
exchange rate used for converting crypto to FIAT (local currency)
bankWireFee
string
transaction fee charged for local fund transfer
Create Stablecoin Payout (by Quantity)
POST https://gateway.noxxo.com/v1/payout/bankwire/quotebyquantity
Quote calculated when user selects cryptocurrency and its quantity.
Request body
userEmail*
String
user email previously saved and linked to whitelisted bank account and KYC profile
coin*
String
selected cryptocurrency, options available: “USDT” or “USDC”
recipientRelationship*
String
relationship between user and beneficiary, only pre-approved value from reference table is accepted
remittancePurpose*
String
purpose of transaction, only pre-approved value from reference table is accepted
transferType*
String
type of service requested for quote, default value to be used: "BANK"
msisdn*
String
beneficiary mobile number with country code in countries where it is mandatory for bank transfers, e.g. +91xxxxxxxxxx
accountNo*
String
bank account that was previously saved / whitelisted with userEmail
sendingCurrency*
String
base fiat currency, default is "USD"
receivingCurrency*
String
fiat currency code in ISO 4217 format for the receiving bank account, e.g. BRL for Brazil
receivingCountry*
String
ISO Alpha-2 country code of the destination country, e.g. BR for Brazil
sendingCountry*
String
ISO Alpha-2 country code of the sending country, default value is "US"
quantity*
Number
quantity of cryptocurrency (reference to "coin") selected for quote
transactionType
String
default transactions type is "p2p"
sourceOfFunds*
String
source of funds of sender, refer to table containing pre-approved values that will be accepted
sender_msisdn
String
sender mobile number with country code, e.g. +55xxxxxxxxxx
receiver_msisdn
String
beneficiary mobile number with country code, e.g. +55xxxxxxxxxx
receiver_firstName*
String
first name of the beneficiary as registered with the bank and the KYC document provided
receiver_lastName*
String
last name of the beneficiary as registered with the bank and the KYC document provided
Responses
201: Created — message: "Successfully created the quote!"
400: Bad Request
Quote response fields
userEmail
string
reference to user account requesting the quote
quoteType
string
“fiat”
quoteID
string
unique ID generated for the quote
receivingAmount
number
amount in local fiat currency
coinQuantityCharged
string
quantity/amount of cryptocurrency including fees charged for quote
fxRate
number
exchange rate used for converting crypto to FIAT (local currency)
bankWireFee
string
transaction fee charged for local fund transfer
Create Payout with Target Fiat Amount
POST https://gateway.noxxo.com/v1/payout/bankwire/quotebyamount
Quote calculated when user selects FIAT currency and its amount.
Request body
userEmail*
String
user email previously saved and linked to whitelisted bank account and KYC profile
coin*
String
selected cryptocurrency, options available: “USDT” or “USDC”
recipientRelationship*
String
relationship between user and beneficiary, only pre-approved value from reference table is accepted
remittancePurpose*
String
purpose of transaction, only pre-approved value from reference table is accepted
transferType*
String
type of service requested for quote, default value to be used: "BANK"
msisdn*
String
beneficiary mobile number with country code in countries where it is mandatory for bank transfers, e.g. +91xxxxxxxxxx
accountNo*
String
bank account that was previously saved / whitelisted with userEmail
sendingCurrency*
String
base fiat currency, default is "USD"
receivingCurrency*
String
fiat currency code in ISO 4217 format for the receiving bank account, e.g. BRL for Brazil
receivingCountry*
String
ISO Alpha-2 country code of the destination country, e.g. BR for Brazil
sendingCountry
String
ISO Alpha-2 country code of the sending country, default value is "AU"
amount*
Number
amount of FIAT Currency (reference to "receivingCurrency") selected for quote
transactionType
String
default transactions type is "p2p"
sourceOfFunds*
String
source of funds of sender, refer to table containing pre-approved values that will be accepted
sender_msisdn
String
sender mobile number with country code, e.g. +55xxxxxxxxxx
receiver_msisdn
String
beneficiary mobile number with country code, e.g. +55xxxxxxxxxx
receiver_firstName*
String
first name of the beneficiary as registered with the bank and the KYC document provided
receiver_lastName*
String
last name of the beneficiary as registered with the bank and the KYC document provided
Responses
201: Created — message: "Successfully created the quote!"
400: Bad Request
Quote response fields
userEmail
string
reference to user account requesting the quote
quoteType
string
“crypto”
quoteID
string
unique ID generated for the quote
receivingAmount
number
amount in local fiat currency
coinQuantityCharged
string
quantity/amount of cryptocurrency including fees charged for quote
fxRate
number
exchange rate used for converting crypto to FIAT (local currency)
bankWireFee
string
transaction fee charged for local fund transfer
Confirm Payout
POST https://gateway.noxxo.com/v1/payout/bankwire/submitOrder/bank
Request body
quoteId*
String
quoteId to be used for the transaction that is returned on the quote response
Responses
200: Created
400: Bad Request
500: Internal Server Error
Order response fields
encryptus_order_id
string
system generated unique transaction number for the executed quote
Get Payout Transaction Status
Initial status of a payout request is set to "Acknowledged" and statuses are screened in ~15-minute intervals. Possible transaction statuses:
"Pending" — the transaction is being processed and final status of transaction is not received
"Completed" — the payout was successful and accepted by the beneficiary bank
"Failed" — the payout was rejected by the beneficiary bank
GET https://gateway.noxxo.com/v1/payout/bankwire/transaction/{orderId}
Parameters
orderId* (String) — encryptus_order_id generated as unique transaction number received in response
Responses
200: OK — List of transactions
400: Bad Request
Approved values / reference lists
Approved Purpose for Person-to-Person (p2p) transactions (remittancePurpose)
Education Support
Home Improvement
Gift
Salary
Savings
Real Estate
Approved Relationship between Sender and Recipient for Person-to-Person (p2p) transactions (recipientRelationship)
Self
Spouse
Son
Daughter
Mother
Father (Note: third-party transactions are not allowed with the exception of a joint bank account)
Approved Source of Funds for Person-to-Person (p2p) transactions (sourceOfFunds)
Salary
Savings
Lottery
Loan
Business Income
Others
Last updated