Calculate FX Rate

Developing

Live Partners API

https://partners-api.service.cedar.money/bpapi

POST

/v1/receive/price

Calculate the amount required to deposit and the conversion rate in order to receive the payout amount.

Request

Header Params

x-api-key

string

required

Example:

CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed

x-api-secret

string

required

Example:

CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB

Body Params application/json

fromCurrencySymbol

string

required

Currency symbol the client deposits

toCurrencySymbol

string

required

Currency symbol for payout

toAmount

string

required

The payout amount

Example

{
    "fromCurrencySymbol": "NGN",
    "toCurrencySymbol": "USD",
    "toAmount": "100000.0"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partners-api.service.cedar.money/bpapi/v1/receive/price' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fromCurrencySymbol": "NGN",
    "toCurrencySymbol": "USD",
    "toAmount": "100000.0"
}'

Responses

🟢200OK

application/json

Body

fromCurrencySymbol

string

required

Currency symbol the client deposits

toCurrencySymbol

string

required

Currency symbol for payout

rate

number

required

The service rate between the from/to amounts including Cedar fees

amount

string

required

The amount required to deposit for payout of the "To Amount" including Cedar fees (From Amount)

Example

{
    "fromCurrencySymbol": "NGN",
    "toCurrencySymbol": "USD",
    "rate": 1603.1479,
    "amount": "160314798.7"
}

🟠400Error

Modified at 2025-06-08 07:22:20

Cancel End to End Transaction

Create Collections Transaction