Prices
GET/prices
Allows you to retrieve real-time information about a conversion between two supported currencies, including the rate before and after the NOAH Fee is applied. During a NOAH Hosted Checkout session, real-time ‘/prices’ data is used to calculate the fees and thus the final amount a customer will pay. In case neither SourceAmount or DestinationAmount is defined the fee is not available.
Request
Query Parameters
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Only one of SourceAmount
or DestinationAmount
can be defined. When this amount is specified, the response DestinationAmount
field indicates how much you will get for this, after the deduction of any fees.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Only one of SourceAmount
or DestinationAmount
can be defined. When this amount is specified, the response SourceAmount
field indicates how much you will need to sell to get this and cover any fees.
Responses
- 200
- 400
- 401
- 500
Price estimate successful. Response includes the rate of currency exchange before and after fees are subtracted.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- Bank
- Card
- Identifier
Array [
- ChannelFee
- BusinessFee
]
]
Itemsobject[]required
Categorizes one or more PaymentMethodType
s into broader groups. Useful for listing channels, displaying payment methods:
Bank
Rate used to exchange currencies
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
2024-04-16T08:00:55Z
The total fee that will be charged for using the specific channel, always specified in the same currency as the requested fiat segment of the transaction.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
The fee applied on behalf of the business to customer transactions, always specified in the same currency as the requested fiat segment of the transaction.
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
CryptoFeeBreakdown
object[]
Total fee amount breakdown in cryptocurrency.
What fee the items refers to:
Possible values: non-empty
and <= 38 characters
, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
10.1
{
"Items": [
{
"PaymentMethodCategory": "Bank",
"Rate": "10.1",
"UpdatedAt": "2024-04-16T08:00:55Z",
"TotalFee": "10.1",
"BusinessFee": "10.1",
"SourceAmount": "10.1",
"DestinationAmount": "10.1",
"CryptoFeeBreakdown": [
{
"Type": "string",
"Amount": "10.1"
}
]
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}
- application/json
- Schema
- Example (from schema)
Schema
- InvalidMessage
- Unexpected
- ResourceNotFound
- Unauthorized
- Forbidden
- InsufficientBalance
Array [
]
Type of error:
InvalidMessage
A unique reference that identifies the specific occurrence of the problem
Action taking place which resulted in error.
Details about the error.
Extensionsobject
Additional information about the error.
Details about invalid request properties.
Featuresobject
Details about the disabled feature flags
property name*
string[]
List of reasons
string
{
"Type": "InvalidMessage",
"Instance": "string",
"Action": "string",
"Detail": "string",
"Extensions": {
"Request": {},
"Features": {}
}
}