Update Merchant

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

Code	Display Name	Notes
`NEW`	New	Recently created and not yet processed – can submit onboarding
`PENDING`	Pending	Awaiting verification or further action – can submit onboarding
`PENDING_REVIEW`	Pending Review	Waiting for manual review
`UNDER_REVIEW`	Under Review	Currently being examined for verification
`ACTION_NEEDED`	Action Needed	Requires user or system intervention – can submit onboarding
`VALID`	Valid	Successfully verified and approved – can initiate transactions
`FLAGGED`	Flagged	Marked for potential issues or concerns
`ABANDONED`	Abandoned	Left 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

integer

required

The ID of the merchant to update

Example:

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

Body Params application/json

name

string

required

The merchant's name

localRegNumber

string

optional

Local registration number

countryIso

string

required

The merchant's country ISO2

state

string

optional

The merchant's state ISO2

city

string

required

The merchant's address city

address

string

required

The merchant's street address

streetNumber

string

required

The merchant's address street number

zipcode

string

required

The merchant's address zipcode

contactName

string

required

The merchant's contact person full name

contactEmail

string

required

The merchant's contact person email

contactPhonePrefix

string

required

The merchant's contact person telephone country code

contactPhone

string

required

The merchant's contact person telephone - Digits only

industry

enum<string>

required

The merchant's industry

Allowed values:

AGRICULTURE_FORESTRY_WILDLIFEBUSINESS_INFORMATIONCONSTRUCTION_UTILITIES_CONTRACTINGEDUCATIONFINANCE_INSURANCEFOOD_HOSPITALITYGAMINGHEALTH_SERVICESMOTOR_VEHICLENATURAL_RESOURCES_ENVIRONMENTALPERSONAL_SERVICESREAL_ESTATE_HOUSINGSAFETY_SECURITY_LEGALTRANSPORTATIONGARMENTSPHARMACEUTICALSTECHNOLOGYMANUFACTURINGENTERTAINMENTTELECOMMUNICATIONS

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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

integer

required

The merchant's ID

creationTime

integer

required

The entity creation time in UNIX timestamp

lastUpdateTime

integer

required

The entity last update time in UNIX timestamp

name

string

required

The merchant's name

localRegNumber

string

required

Local registration number

countryIso

string

required

The merchant's country ISO2

state

string

optional

The merchant's state ISO2

city

string

optional

The merchant's address city

address

string

optional

The merchant's street address

streetNumber

string

optional

The merchant's address street number

zipcode

string

optional

The merchant's address zipcode

kycStatus

enum<string>

required

The current KYC verification status of the merchant

Allowed values:

NEWVALIDPENDINGPENDING_REVIEWFLAGGEDUNDER_REVIEWACTION_NEEDEDABANDONED

contactName

string

optional

The merchant's contact person full name

contactEmail

string

optional

The merchant's contact person email

contactPhonePrefix

string

optional

The merchant's contact person telephone country code

contactPhone

string

optional

The merchant's contact person telephone

industry

enum<string>

optional

The merchant's industry

Allowed values:

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

Description#

Sandbox-Only Behavior: Simulate kycStatus Updates#

How it Works#

Example#

Supported kycStatus Values#

Request

Request samples

Responses

Description

Sandbox-Only Behavior: Simulate `kycStatus` Updates

How it Works

Example

Supported `kycStatus` Values