Cedar Partners API
  1. End to End (Fiat-to-Fiat)
Cedar Partners API
  • Introduction
  • Getting Started
    • Data Model
    • Transaction Lifecycle
    • Authentication
    • API Environments
    • Webhooks Configuration
  • Development Tools
    • API Debugging
    • Error Codes
    • File URLs
  • API Documentation
    • Information
      • Get Countries
      • Get Currencies
    • Merchants
      • Create Merchant
      • Update Merchant
      • Get Merchant by ID
      • Get Merchants with Pagination
    • Onboarding
      • Onboarding Lifecycle
      • Get Legal Agreements
      • Accept Legal Agreements
      • Submit Merchant Onboarding
    • Receiver Accounts
      • Create Receiver Account
      • Update Receiver Account
      • Get Receiver Account by ID
      • Get Receiver Accounts with Pagination
    • Transactions
      • Payout (Crypto-to-Fiat)
        • Calculate FX Rate
        • Create Payout Transaction
        • Get Payout Transaction by ID
        • Get Payout Transactions with Pagination
        • Approve Payout Transaction Quote
        • Approve Payout Transaction Deposit
        • Cancel Payout Transaction
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
          POST
        • Create End to End Transaction
          POST
        • Get End to End Transaction by ID
          GET
        • Get End to End Transactions with Pagination
          GET
        • Approve End to End Transaction Quote
          POST
        • Approve End to End Transaction Deposit
          POST
        • Cancel End to End Transaction
          POST
      • Collections (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create Collections Transaction
        • Get Collections Transaction by ID
        • Get Collections Transactions with Pagination
        • Approve Collections Transaction Quote
        • Approve Collections Transaction Deposit
        • Cancel Collections Transaction
    • Utilities
      • Upload File
  1. End to End (Fiat-to-Fiat)

Calculate FX Rate

Live Partners API
Live Partners API
POST
https://partners-api.service.cedar.money/bpapi/v1/sendf2f/price
Calculate the amount required to deposit and the conversion rate in order to send 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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://partners-api.service.cedar.money/bpapi/v1/sendf2f/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 conversion rate between the from/to amounts
amount
string 
required
The from amount converted using the conversion rate
serviceRate
number 
required
The service rate between the from/to amounts including Cedar fees
serviceAmount
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",
  "serviceRate": 1603.1483,
  "serviceAmount": "160314835.6"
}
🟠400Error
Modified at 2025-03-06 09:09:25
Previous
Cancel Payout Transaction
Next
Create End to End Transaction
Built with