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

Data Model

Overview#

The system's primary building block is Merchants, which represent real-world businesses or companies. Transactions occur between two merchants, where one merchant sends funds to another. This can be done using either the Payout API or the End-to-End API.

Core Entities#

1. Merchants#

Merchants describe a business or company and act as the foundation of the system. Every transaction involves two merchants: the sender and the receiver.

2. Receiver Accounts#

Each merchant has one or more Receiver Accounts, which store bank account details that allow the system to process payouts to the merchant.

3. Transactions#

A. Payout / End-to-End Transactions#

Payout / End-to-End transactions involve the movement of funds from a source merchant to a target merchant receiver account. The source merchant deposits funds (fiat or crypto), and the target merchant receives the funds in its receiver account.

B. Collections Transactions#

Collections transactions involve the movement of funds from a target merchant to a source merchant receiver account. It's the opposite of the Payout / End-to-End transactions. The target merchant deposits funds (fiat only), and the source merchant receives the funds in its receiver account.

Data Model Diagram#

Below is a diagram that illustrates the relationships between these entities.

A. Payout / End-to-End Transactions#

B. Collections Transactions#

Transaction Flow#

A. Payout / End-to-End Transactions#

1.
Merchant A initiates a transaction, sending funds via the Payout API or End-to-End API to Merchant B Receiver Account.
2.
Funds are deposited by Merchant A (either fiat or crypto).
3.
Merchant B receives the funds in its associated Receiver Account.
4.
The transaction is completed successfully.

B. Collections Transactions#

1.
Merchant A initiates a transaction, receiving funds to its Receiver Account via the Collections API from Merchant B.
2.
Funds are deposited by Merchant B (fiat only).
3.
Merchant A receives the funds in its associated Receiver Account.
4.
The transaction is completed successfully.

Summary#

Merchants represent businesses conducting transactions.
Receiver Accounts store payout details for merchants.
Transactions move funds between merchants to a target receiver account.
The Payout API, End-to-End API and Collections API facilitate transactions.
Modified at 2025-03-20 13:06:37
Previous
Introduction
Next
Transaction Lifecycle
Built with