Cedar Partners API
  1. Payout (Crypto-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
          POST
        • Create Payout Transaction
          POST
        • Get Payout Transaction by ID
          GET
        • Get Payout Transactions with Pagination
          GET
        • Approve Payout Transaction Quote
          POST
        • Approve Payout Transaction Deposit
          POST
        • Cancel Payout Transaction
          POST
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create End to End Transaction
        • Get End to End Transaction by ID
        • Get End to End Transactions with Pagination
        • Approve End to End Transaction Quote
        • Approve End to End Transaction Deposit
        • Cancel End to End Transaction
      • 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. Payout (Crypto-to-Fiat)

Create Payout Transaction

Live Partners API
Live Partners API
POST
https://partners-api.service.cedar.money/bpapi/v1/sendc2f/
Creates a payout (crypto-to-fiat) transaction.

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
fromBusinessId
integer 
required
The ID of the merchant sending the transaction
toBusinessExternalAccountId
integer 
required
The ID of the receiver account for payout of the funds
fromCurrencySymbol
string 
required
The currency to deposit. Only currencies of type Crypto are supported.
toAmount
string 
required
The payout amount
purpose
enum<string> 
required
The purpose of the transaction
Allowed values:
GOODS_PURCHASEDPAYMENT_OF_GOODSPAYMENT_OF_SERVICESOTHER_SERVICES
invoiceUrl
string 
required
The URL of the transaction's invoice file. Supported file formats: PDF (preferred), PNG, JPG
depositConfirmationUrl
string 
required
The URL of the funds deposit confirmation. Supported file formats: PDF (preferred), PNG, JPG
Example
{
  "fromBusinessId": 1,
  "toBusinessExternalAccountId": 2,
  "fromCurrencySymbol": "USDC (ERC-20)",
  "toAmount": "100000.0",
  "purpose": "GOODS_PURCHASED",
  "invoiceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
  "depositConfirmationUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
}

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/sendc2f/' \
--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 '{
    "fromBusinessId": 1,
    "toBusinessExternalAccountId": 2,
    "fromCurrencySymbol": "USDC (ERC-20)",
    "toAmount": "100000.0",
    "purpose": "GOODS_PURCHASED",
    "invoiceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
    "depositConfirmationUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
}'

Responses

🟢200OK
application/json
Body
businessRequestId
integer 
required
The payout transaction's ID
creationTime
integer 
required
The entity creation time in UNIX timestamp
lastUpdateTime
integer 
required
The entity last update time in UNIX timestamp
toAmount
string 
required
Payout amount to receiver account
fromAmount
string  | null 
optional
Deposit amount
purpose
enum<string> 
required
Transaction's purpose
Allowed values:
GOODS_PURCHASEDPAYMENT_OF_GOODSPAYMENT_OF_SERVICESOTHER_SERVICES
quoteApprovedDate
number  | null 
optional
The time the quote was approved by the client in UNIX timestamp
depositApprovedDate
number  | null 
optional
The time the deposit was approved by the client in UNIX timestamp
depositReceivedDate
number  | null 
optional
The time the deposit was received in the system in UNIX timestamp
depositReceivedAmount
string  | null 
optional
Deposit amount received by the system
payout
string  | null 
optional
Payout amount sent
fromCurrencySymbol
string 
required
Deposit currency
toCurrencySymbol
string 
required
Payout currency
fromBusinessId
integer 
required
The ID of the merchant sending the transaction
toBusinessExternalAccountId
integer 
required
The ID of the receiver account for payout of the funds
toBusinessId
integer 
required
The ID of the merchant for payout of the funds
clientStatus
enum<string> 
required
The current status of the transaction
Allowed values:
NONEOnOff_PENDINGOnOff_AWAITING_QUOTE_APPROVALOnOff_AWAITING_DEPOSITOnOff_IN_PROGRESSOnOff_COMPLETEDOnOff_CANCELEDOnOff_EXPIRED
walletDetails
optional
The deposit details
Any of
walletAddress
string 
required
The wallet's blockchain address
Example
{
  "businessRequestId": 1,
  "creationTime": 1741020401272,
  "lastUpdateTime": 1741020401272,
  "toAmount": "100000.0",
  "fromAmount": null,
  "purpose": "GOODS_PURCHASED",
  "quoteApprovedDate": null,
  "depositApprovedDate": null,
  "depositReceivedDate": null,
  "depositReceivedAmount": null,
  "payout": null,
  "fromCurrencySymbol": "USDC (ERC-20)",
  "toCurrencySymbol": "USD",
  "fromBusinessId": 1,
  "toBusinessExternalAccountId": 2,
  "toBusinessId": 2,
  "clientStatus": "OnOff_PENDING",
  "walletDetails": null
}
🟠400Error
Modified at 2025-03-06 09:24:24
Previous
Calculate FX Rate
Next
Get Payout Transaction by ID
Built with