Cedar Partners API
  1. Merchants
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
        POST
      • Update Merchant
        PUT
      • Get Merchant by ID
        GET
      • Get Merchants with Pagination
        GET
    • 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. Merchants

Update Merchant

Live Partners API
https://partners-api.service.cedar.money/bpapi
Live Partners API
https://partners-api.service.cedar.money/bpapi
PUT
https://partners-api.service.cedar.money/bpapi
/v1/business/{id}
Updates the details of a specific merchant.

Description#

Use this endpoint to update one or more fields associated with an existing merchant.

Sandbox-Only Behavior: Simulate kycStatus Updates#

In sandbox mode only, you can simulate updates to the merchant’s kycStatus field by using a special pattern in the localRegNumber field.

How it Works#

If the localRegNumber value ends with a pipe character (|) followed by a valid KYC status, the merchant's kycStatus will be set to that value regardless of other verification steps. A webhook event will also be triggered to reflect the update.

Example#

To set the kycStatus to VALID:
{
  "localRegNumber": "123456789|VALID"
}
This will update the kycStatus to VALID and send the appropriate webhook notification.

Supported kycStatus Values#

CodeDisplay NameNotes
NEWNewRecently created and not yet processed – can submit onboarding
PENDINGPendingAwaiting verification or further action – can submit onboarding
PENDING_REVIEWPending ReviewWaiting for manual review
UNDER_REVIEWUnder ReviewCurrently being examined for verification
ACTION_NEEDEDAction NeededRequires user or system intervention – can submit onboarding
VALIDValidSuccessfully verified and approved – can initiate transactions
FLAGGEDFlaggedMarked for potential issues or concerns
ABANDONEDAbandonedLeft incomplete or not pursued further
ℹ️ This behavior is available only in sandbox environments for testing and development purposes. In production, the kycStatus is managed through the proper verification pipeline.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "name": "Company Name",
    "localRegNumber": "123456789",
    "countryIso": "NG",
    "state": "AB",
    "city": "Umuahia",
    "address": "Akanu Ibiam Rd",
    "streetNumber": "12",
    "zipcode": "12345",
    "contactName": "John Doe",
    "contactEmail": "john@company.com",
    "contactPhonePrefix": "234",
    "contactPhone": "1234567890",
    "industry": "AGRICULTURE_FORESTRY_WILDLIFE"
}

Request Code 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 PUT 'https://partners-api.service.cedar.money/bpapi/v1/business/1' \
--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 '{
    "name": "Company Name",
    "localRegNumber": "123456789",
    "countryIso": "NG",
    "state": "AB",
    "city": "Umuahia",
    "address": "Akanu Ibiam Rd",
    "streetNumber": "12",
    "zipcode": "12345",
    "contactName": "John Doe",
    "contactEmail": "john@company.com",
    "contactPhonePrefix": "234",
    "contactPhone": "1234567890",
    "industry": "AGRICULTURE_FORESTRY_WILDLIFE"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": 1,
    "creationTime": 1741003185214,
    "lastUpdateTime": 1741003185214,
    "name": "Company Name",
    "localRegNumber": "123456789",
    "countryIso": "NG",
    "address": "Akanu Ibiam Rd",
    "zipcode": "12345",
    "kycStatus": "PENDING",
    "contactName": "John Doe",
    "contactEmail": "john@company.com",
    "contactPhone": "1234567890",
    "contactPhonePrefix": "234",
    "streetNumber": "12",
    "city": "Umuahia",
    "state": "AB",
    "industry": "AGRICULTURE_FORESTRY_WILDLIFE"
}
🟠400Error
Modified at 2025-06-01 08:26:41
Previous
Create Merchant
Next
Get Merchant by ID
Built with