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
    • Utilities
      • Upload File
  1. Getting Started

Transaction Lifecycle

Overview#

This guide outlines the complete process of creating and managing a transaction within the system. The flow involves setting up merchants, receiver accounts, and handling transaction approvals while leveraging the API or the Partners Platform.

Transaction Flow Steps#

1. Create the Source Merchant#

The source merchant can be created either via:
API
Partners Platform (by manually filling in the details)
Once created, the onboarding process must be completed using the Partners Platform.
In the Sandbox environment merchants will be approved automatically a few seconds after they are created.

2. Complete Onboarding & Approval#

The created source merchant undergoes an approval process within the Partners Platform. Once the merchant is approved, it becomes eligible for transactions.

3. Create the Target Merchant#

A target merchant must be created before transactions can be made. This can be done using:
API
Partners Platform

4. Create a Receiver Account for the relevant Merchant#

The relevant merchant (target merchant for Payout / End-to-End, source merchant for Collections) needs a Receiver Account, which stores bank or wallet details for receiving funds. The receiver account can be created via:
API
Partners Platform
Note: The receiver account must be approved before it can be used in transactions.
In the Sandbox environment receiver accounts will be approved automatically a few seconds after they are created.

5. Create a Transaction#

A transaction can be initiated through:
API - Payout API / End-to-End API / Collections API
Partners Platform

6. Quote Generation & Notifications#

Once the transaction is approved, a quote will be generated. Updates will be sent through:
Webhooks (to notify your system)
Emails (to keep you informed)

7. Approve the Quote#

The quote must be approved via:
API - Payout API / End-to-End API / Collections API
Partners Platform

8. Deposit Funds#

Based on the transaction type, the deposit details will be provided:
Fiat transactions: Bank account details
Crypto transactions: Wallet address
The source merchant must deposit funds accordingly.

9. Approve the Deposit#

After the deposit is made, it must be confirmed using:
API - Payout API / End-to-End API / Collections API
Partners Platform

10. Transaction Processing & Notifications#

Once the deposit is approved, the transaction will be processed. Updates will be sent through:
Webhooks (for system integration)
Emails (for manual tracking)

Transaction Flow Diagram#

Below is a diagram illustrating the full transaction lifecycle.

A. Payout / End-to-End Transactions#

B. Collections Transactions#

Summary#

Merchants and receiver accounts must be created and approved before transacting.
Transactions can be initiated via API or UI.
A quote is generated and must be approved.
Funds must be deposited and approved before processing.
Notifications are sent via webhooks and emails at each stage.
Modified at 2025-03-20 13:21:44
Previous
Data Model
Next
Authentication
Built with