Get Merchant by ID - Cedar Partners API

Request

Path Params

id

string

required

The ID of the merchant to retrieve

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

curl --location --request GET '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'

Responses

🟢200OK

application/json

Body

id

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:

AGRICULTURE_FORESTRY_WILDLIFEBUSINESS_INFORMATIONCONSTRUCTION_UTILITIES_CONTRACTINGEDUCATIONFINANCE_INSURANCEFOOD_HOSPITALITYGAMINGHEALTH_SERVICESMOTOR_VEHICLENATURAL_RESOURCES_ENVIRONMENTALPERSONAL_SERVICESREAL_ESTATE_HOUSINGSAFETY_SECURITY_LEGALTRANSPORTATIONGARMENTSPHARMACEUTICALSTECHNOLOGYMANUFACTURINGENTERTAINMENTTELECOMMUNICATIONS

Example

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

🟠400Error