Cedar Partners API
  1. Collections (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
        • 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
          POST
        • Create Collections Transaction
          POST
        • Get Collections Transaction by ID
          GET
        • Get Collections Transactions with Pagination
          GET
        • Approve Collections Transaction Quote
          POST
        • Approve Collections Transaction Deposit
          POST
        • Cancel Collections Transaction
          POST
      • Get Payout Confirmation by Transaction ID
        GET
    • Utilities
      • Upload File
  1. Collections (Fiat-to-Fiat)

Create Collections Transaction

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

Request

Header Params

Body Params application/json

Example
{
    "fromBusinessId": 1,
    "toBusinessExternalAccountId": 2,
    "fromCurrencySymbol": "NGN",
    "toAmount": "100000.0",
    "purpose": "GOODS_PURCHASED",
    "invoiceUrl": "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/receive/' \
--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": "NGN",
    "toAmount": "100000.0",
    "purpose": "GOODS_PURCHASED",
    "invoiceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
}'

Responses

🟢200OK
application/json
Body

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": "NGN",
    "toCurrencySymbol": "USD",
    "fromBusinessId": 1,
    "toBusinessExternalAccountId": 2,
    "toBusinessId": 2,
    "clientStatus": "Receive_PENDING",
    "bankDetails": null
}
🟠400Error
Modified at 2025-06-15 12:50:59
Previous
Calculate FX Rate
Next
Get Collections Transaction by ID
Built with