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
    • Utilities
      • Upload File
  1. Collections (Fiat-to-Fiat)

Cancel Collections Transaction

Developing
Live Partners API
Live Partners API
POST
https://partners-api.service.cedar.money/bpapi/v1/receivef2f/cancel/{id}
Cancel collections transaction by its ID. Cancellation is not available once the transaction has been processed.

Request

Path Params
id
string 
required
The ID of the end-to-end transaction
Example:
1
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

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/receivef2f/cancel/1' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB'

Responses

🟢200OK
application/json
Body
businessRequestId
integer 
required
The collections 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 for collection of funds
toBusinessExternalAccountId
integer 
required
The ID of the receiver account for payout of the funds
toBusinessId
integer 
required
The ID of the merchant depositing the funds
clientStatus
enum<string> 
required
The current status of the transaction
Allowed values:
NONEReceive_PENDINGReceive_AWAITING_QUOTE_APPROVALReceive_AWAITING_DEPOSITReceive_IN_PROGRESSReceive_COMPLETEDReceive_CANCELEDReceive_EXPIRED
bankDetails
optional
The deposit details
Any of
accountNumber
string 
required
The deposit bank account number
nameOnAccount
string 
required
The name of the deposit bank account
bankName
string 
required
The deposit bank name
bankAddress
string 
required
The deposit bank full address
reference
string 
required
The deposit reference number
Example
{
  "businessRequestId": 1,
  "creationTime": 1741253004225,
  "lastUpdateTime": 1741253579459,
  "toAmount": "100000.0",
  "fromAmount": "160881501.15",
  "purpose": "GOODS_PURCHASED",
  "quoteApprovedDate": 1741253321781,
  "depositApprovedDate": 1741253579459,
  "depositReceivedDate": 1741253579459,
  "depositReceivedAmount": "160881501.15",
  "payout": null,
  "fromCurrencySymbol": "NGN",
  "toCurrencySymbol": "USD",
  "fromBusinessId": 1,
  "toBusinessExternalAccountId": 2,
  "toBusinessId": 2,
  "clientStatus": "Receive_CANCELED",
  "bankDetails": {
    "bankName": "Test Bank",
    "accountNumber": "1234567890",
    "reference": "Test Reference",
    "bankAddress": "123 Test St",
    "nameOnAccount": "Test Name"
  }
}
🟠400Error
Modified at 2025-03-20 13:29:06
Previous
Approve Collections Transaction Deposit
Next
Upload File
Built with