Rates - Freedom Pay

Request

Body Params application/json

rates

object

required

currency_from

string

required

Currency for conversion.
KZT, USD, EUR. Directory of currencies

currency_to

string

required

Convertible currency.
KZT, USD, EUR. Directory of currencies

rate

number

required

Conversion rate

rate_type

string

optional

Type is used if there is the same currency pair, but with a different exchange rate depending on the transactions. Example: p2p, retail

start_date

string

optional

Date and time of the start of the course in the format YYYY-MM-DD HH:MM:SS. If no date is specified or the specified date is less than the date of the request, then the date and time of receipt of the request to add the course is used as the start date.
Example: 2019-01-01 12:00:00

end_date

string

optional

Date and time of the end of the course in the format YYYY-MM-DD HH:MM:SS. If no end date is specified, the course will be used indefinitely until the next request to add a course.
Example: 2019-01-01 12:00:00

operation

string

optional

Currency Exchange Operation Type. Example: - sell, buy - Purchase/Sale - rate - Standard rates (National Bank)

Example

{
  "rates": {
    "currency_from": "string",
    "currency_to": "string",
    "rate": 0,
    "rate_type": "string",
    "start_date": "string",
    "end_date": "string",
    "operation": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kz/v5/partner/rates/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rates": {
        "currency_from": "string",
        "currency_to": "string",
        "rate": 0,
        "rate_type": "string",
        "start_date": "string",
        "end_date": "string",
        "operation": "string"
    }
}'

Responses

🟢200Success

application/json

Body

status

string

optional

Request execution status

ok: Request was successful.

error: Request passed with an error.

error_code

integer

optional

Error code ID

error_description

string

optional

Text description of the error

dt

string <date-time>

optional

Date and time of the request. Format: YYYY-MM-DDThh:mm:ss±hh:mm

Example

{
  "status": "string",
  "error_code": 0,
  "error_description": "string",
  "dt": "2019-08-24T14:15:22Z"
}