FX Rate
This endpoint is used to get FX rate locking using BRUID. The endpoint is as follows:
GET https://sandbox-api.veem.com/veem/v1.2/exchangerates/bruid
Headers
There are 2 headers necessary for the use of this endpoint:
- X-request-id: This is a number unique to the current API request, and follows the UUID format. Reusing this header without changing the value will result in a 500 (Internal Server Error) status. An example X-request-id is as follows:
>
- Authorization: This header holds the bearer token that belongs to the Stampli API client account. Failure to use a valid bearer token will result in a 403 (Forbidden) status. An example of a token is as follows:
>
Note: as of Jan 2025 this token does not work
Response Payload
When using the endpoint, one can expect to receive a response following the format below:
{
"rateTime": 1705603681000,
"bruid": "73b7c73f-bcb2-3120-bf85-854bf6f6ec91",
"expiryTime": 1705690081000
}
In the case where the ClientID does not match our records for allowed client IDs, you can expect the following error:
{
"code": 50009008,
"message": "The EP is not allowed for client id BoulevardSupercentre-e48e2850",
"timestamp": "2024-01-18T18:51:51.527",
"fileName": "ExchangeRateValidator.java",
"lineNumber": 43
}
Possible errors
When trying to access the FX rate, one may encounter several errors if an invalid parameter/header is used
- Invalid ClientID - Status 400 (Bad Request)
- The token is invalid or expired - Status 401 (Unauthorized)
- The token owner lacks permission to operate the current API - Status 403 (Forbidden)
- Resource not found - Status 404 (Not Found)
- Status 500 (Internal Server Error)
Updated 1 day ago
