This resource is used to enquire quotes from different crossborder providers.
Please note, the additional optional params such as discount_fixed_amount, discount_variable_percentage, exchange_rate_markdown_viariable_percentage are added as placeholders for future implementation.
Header Parameters
X-Auth-User-IDstring Required
MatchMove provided ID for the user.
Authorizationstring
Body Parameters
amountstring Required
Sender amount or recipient amount
If quote_type is FORWARD, amount should be the sender amount. If REVERSE, amount should be the recipient amount.
To specify which party bears the bank fee. OUR means that the sender will pay the fee. SHA means that both the sender and the recipient will pay the fee.
Enum values:
OURSHA
quote_typestring Required
Quote type
Enum values:
FORWARDREVERSE
feesobject
Show child attributes
Response
200
Object
OK
Response Attributes
quotesarray
Represents array of quotes
Show child attributes
400
Object
Bad Request
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| invalid_model | Invalid Model | Request body is invalid. |
| user_not_active | User Not Active | User is not active. |
| invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user id. |
| validation_error | Validation Error | Validation errors. |
| | | Quote amount entered must be at least {currency} {min_amount} with precision {precision}. |
| | | Quote amount entered must be at most {currency} {max_amount} with precision {precision}. |
| | | Selected combinations of country, currency, receiving institution, payment rail, charge type, user type, and recipient type are invalid. Please check and try again. |
| | | Quote type REVERSE with fee included as TRUE is an invalid combination. Please try again with fee included as FALSE for quote type REVERSE. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
401
Object
Unauthorized
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| token_required | Token Required | Access denied due to invalid token on header. |
| invalid_tenant | Invalid Tenant | Access denied due to invalid tenant code. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
403
Object
Forbidden
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| restricted_resource | Restricted Resource | Access denied to the resource. If your access key and source IP is correct, it would be because of `X-Auth-User-ID` is not passed on header. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
404
Object
Not Found
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| resource_not_found | Resource Not Found | The requested URL was not found. |
Response Attributes
idstring Required
Unique hash-id for the error message
statusinteger Required
Error response status code
codestring Required
Error response code
titlestring Required
Error response title
detailstring Required
Error response detail
sourcearray,string
Source defines the multiple error messages
Show child attributes
timestampstring Required
Response timestamp
500
Object
Internal Server Error
| **Code** | **Title** | **Detail** |
| ---------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| generic_error | General Error | General application error. |
| | | Internal server error. |
| | | Unable to fetch quotes for the selected destination. |
