# Create Merchant

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/business/:
    post:
      summary: Create Merchant
      deprecated: false
      description: >-
        Creates a merchant.


        Customer: has a direct business relationship with you — you onboard and
        transact on their behalf.

        Contact: someone your customers send money to or receive money from.


        Customer/Contact is determined by either passing or not passing a value
        to the `contactOwnerBusinessId` field.
      tags:
        - API Documentation/Merchants
      parameters:
        - name: x-api-key
          in: header
          description: ''
          required: true
          example: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed
          schema:
            type: string
        - name: x-api-secret
          in: header
          description: ''
          required: true
          example: >-
            CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The merchant's name
                contactOwnerBusinessId:
                  type: integer
                  description: >-
                    The Merchant ID of the merchant that owns this contact. Pass
                    this field only when creating a Contact (a party your
                    customer transacts with), not a Customer (a merchant you
                    onboard and transact on behalf of directly).
                localRegNumber:
                  type: string
                  description: Local registration number
                countryIso:
                  type: string
                  description: The merchant's country ISO2
                state:
                  type: string
                  description: The merchant's state ISO2
                city:
                  type: string
                  description: The merchant's address city
                address:
                  type: string
                  description: The merchant's street address
                streetNumber:
                  type: string
                  description: The merchant's address street number
                zipcode:
                  type: string
                  description: The merchant's address zipcode
                contactName:
                  type: string
                  description: The merchant's contact person full name
                contactEmail:
                  type: string
                  description: The merchant's contact person email
                contactPhonePrefix:
                  type: string
                  description: >-
                    The merchant's contact person telephone country code -
                    Digits only
                contactPhone:
                  type: string
                  description: The merchant's contact person telephone - Digits only
                industry:
                  type: string
                  enum:
                    - AGRICULTURE_FORESTRY_WILDLIFE
                    - BUSINESS_INFORMATION
                    - CONSTRUCTION_UTILITIES_CONTRACTING
                    - EDUCATION
                    - FINANCE_INSURANCE
                    - FOOD_HOSPITALITY
                    - GAMING
                    - HEALTH_SERVICES
                    - MOTOR_VEHICLE
                    - NATURAL_RESOURCES_ENVIRONMENTAL
                    - PERSONAL_SERVICES
                    - REAL_ESTATE_HOUSING
                    - SAFETY_SECURITY_LEGAL
                    - TRANSPORTATION
                    - GARMENTS
                    - PHARMACEUTICALS
                    - TECHNOLOGY
                    - MANUFACTURING
                    - ENTERTAINMENT
                    - TELECOMMUNICATIONS
                  x-apidog-enum:
                    - value: AGRICULTURE_FORESTRY_WILDLIFE
                      name: Agriculture Forestry Wildlife
                      description: 'Industry related to farming forestry and wildlife  '
                    - value: BUSINESS_INFORMATION
                      name: Business Information
                      description: 'Industry focused on business data and services  '
                    - value: CONSTRUCTION_UTILITIES_CONTRACTING
                      name: Construction Utilities Contracting
                      description: >-
                        Industry involving building infrastructure and
                        contracting  
                    - value: EDUCATION
                      name: Education
                      description: 'Industry related to teaching and learning  '
                    - value: FINANCE_INSURANCE
                      name: Finance Insurance
                      description: 'Industry covering financial services and insurance  '
                    - value: FOOD_HOSPITALITY
                      name: Food Hospitality
                      description: 'Industry related to food services and hospitality  '
                    - value: GAMING
                      name: Gaming
                      description: 'Industry focused on gaming and entertainment  '
                    - value: HEALTH_SERVICES
                      name: Health Services
                      description: 'Industry providing healthcare and medical services  '
                    - value: MOTOR_VEHICLE
                      name: Motor Vehicle
                      description: 'Industry related to automobiles and transportation  '
                    - value: NATURAL_RESOURCES_ENVIRONMENTAL
                      name: Natural Resources Environmental
                      description: >-
                        Industry focused on environment and resource
                        management  
                    - value: PERSONAL_SERVICES
                      name: Personal Services
                      description: 'Industry providing individual and consumer services  '
                    - value: REAL_ESTATE_HOUSING
                      name: Real Estate Housing
                      description: 'Industry covering property and housing  '
                    - value: SAFETY_SECURITY_LEGAL
                      name: Safety Security Legal
                      description: 'Industry related to law enforcement and legal services  '
                    - value: TRANSPORTATION
                      name: Transportation
                      description: 'Industry involving transport and logistics  '
                    - value: GARMENTS
                      name: Garments
                      description: 'Industry focused on clothing and apparel  '
                    - value: PHARMACEUTICALS
                      name: Pharmaceuticals
                      description: 'Industry related to medicine and drug production  '
                    - value: TECHNOLOGY
                      name: Technology
                      description: 'Industry involving innovation and digital solutions  '
                    - value: MANUFACTURING
                      name: Manufacturing
                      description: 'Industry focused on production and industrial goods  '
                    - value: ENTERTAINMENT
                      name: Entertainment
                      description: 'Industry related to media and performing arts  '
                    - value: TELECOMMUNICATIONS
                      name: Telecommunications
                      description: 'Industry focused on communication and networking  '
                  description: The merchant's industry
              required:
                - name
                - countryIso
              x-apidog-orders:
                - name
                - contactOwnerBusinessId
                - localRegNumber
                - countryIso
                - state
                - city
                - address
                - streetNumber
                - zipcode
                - contactName
                - contactEmail
                - contactPhonePrefix
                - contactPhone
                - industry
              x-apidog-ignore-properties: []
            example:
              name: Company Name
              contactOwnerBusinessId: null
              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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Merchant'
              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
          headers: {}
          x-apidog-name: OK
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API%20Error'
              examples:
                '2':
                  summary: IP Not Whitelisted
                  value:
                    exception:
                      errorCode: API_IP_NOT_WHITELISTED
                      message: Access Denied - IP not whitelisted
                '3':
                  summary: Resource Not Found
                  value:
                    exception:
                      errorCode: RESOURCE_NOT_FOUND
                      message: Business with id [1] not found
          headers: {}
          x-apidog-name: Error
      security: []
      x-apidog-folder: API Documentation/Merchants
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/669455/apis/api-14457250-run
components:
  schemas:
    Merchant:
      type: object
      properties:
        id:
          type: integer
          description: The merchant's ID
        creationTime:
          type: integer
          description: The entity creation time in UNIX timestamp
        lastUpdateTime:
          type: integer
          description: The entity last update time in UNIX timestamp
        name:
          type: string
          description: The merchant's name
        localRegNumber:
          type: string
          description: Local registration number
        countryIso:
          type: string
          description: The merchant's country ISO2
        state:
          type: string
          description: The merchant's state ISO2
        city:
          type: string
          description: The merchant's address city
        address:
          type: string
          description: The merchant's street address
        streetNumber:
          type: string
          description: The merchant's address street number
        zipcode:
          type: string
          description: The merchant's address zipcode
        kycStatus:
          type: string
          description: The current KYC verification status of the merchant
          enum:
            - NEW
            - VALID
            - PENDING
            - PENDING_REVIEW
            - FLAGGED
            - UNDER_REVIEW
            - ACTION_NEEDED
            - ABANDONED
          x-apidog-enum:
            - value: NEW
              name: New
              description: 'Recently created and not yet processed  '
            - value: VALID
              name: Valid
              description: 'Successfully verified and approved  '
            - value: PENDING
              name: Pending
              description: 'Awaiting verification or further action  '
            - value: PENDING_REVIEW
              name: Pending Review
              description: 'Waiting for manual review  '
            - value: FLAGGED
              name: Flagged
              description: 'Marked for potential issues or concerns  '
            - value: UNDER_REVIEW
              name: Under Review
              description: 'Currently being examined for verification  '
            - value: ACTION_NEEDED
              name: Action Needed
              description: 'Requires user or system intervention  '
            - value: ABANDONED
              name: Abandoned
              description: 'Left incomplete or not pursued further  '
        contactName:
          type: string
          description: The merchant's contact person full name
        contactEmail:
          type: string
          description: The merchant's contact person email
        contactPhonePrefix:
          type: string
          description: The merchant's contact person telephone country code
        contactPhone:
          type: string
          description: The merchant's contact person telephone
        industry:
          type: string
          enum:
            - AGRICULTURE_FORESTRY_WILDLIFE
            - BUSINESS_INFORMATION
            - CONSTRUCTION_UTILITIES_CONTRACTING
            - EDUCATION
            - FINANCE_INSURANCE
            - FOOD_HOSPITALITY
            - GAMING
            - HEALTH_SERVICES
            - MOTOR_VEHICLE
            - NATURAL_RESOURCES_ENVIRONMENTAL
            - PERSONAL_SERVICES
            - REAL_ESTATE_HOUSING
            - SAFETY_SECURITY_LEGAL
            - TRANSPORTATION
            - GARMENTS
            - PHARMACEUTICALS
            - TECHNOLOGY
            - MANUFACTURING
            - ENTERTAINMENT
            - TELECOMMUNICATIONS
          x-apidog-enum:
            - value: AGRICULTURE_FORESTRY_WILDLIFE
              name: Agriculture Forestry Wildlife
              description: 'Industry related to farming forestry and wildlife  '
            - value: BUSINESS_INFORMATION
              name: Business Information
              description: 'Industry focused on business data and services  '
            - value: CONSTRUCTION_UTILITIES_CONTRACTING
              name: Construction Utilities Contracting
              description: 'Industry involving building infrastructure and contracting  '
            - value: EDUCATION
              name: Education
              description: 'Industry related to teaching and learning  '
            - value: FINANCE_INSURANCE
              name: Finance Insurance
              description: 'Industry covering financial services and insurance  '
            - value: FOOD_HOSPITALITY
              name: Food Hospitality
              description: 'Industry related to food services and hospitality  '
            - value: GAMING
              name: Gaming
              description: 'Industry focused on gaming and entertainment  '
            - value: HEALTH_SERVICES
              name: Health Services
              description: 'Industry providing healthcare and medical services  '
            - value: MOTOR_VEHICLE
              name: Motor Vehicle
              description: 'Industry related to automobiles and transportation  '
            - value: NATURAL_RESOURCES_ENVIRONMENTAL
              name: Natural Resources Environmental
              description: 'Industry focused on environment and resource management  '
            - value: PERSONAL_SERVICES
              name: Personal Services
              description: 'Industry providing individual and consumer services  '
            - value: REAL_ESTATE_HOUSING
              name: Real Estate Housing
              description: 'Industry covering property and housing  '
            - value: SAFETY_SECURITY_LEGAL
              name: Safety Security Legal
              description: 'Industry related to law enforcement and legal services  '
            - value: TRANSPORTATION
              name: Transportation
              description: 'Industry involving transport and logistics  '
            - value: GARMENTS
              name: Garments
              description: 'Industry focused on clothing and apparel  '
            - value: PHARMACEUTICALS
              name: Pharmaceuticals
              description: 'Industry related to medicine and drug production  '
            - value: TECHNOLOGY
              name: Technology
              description: 'Industry involving innovation and digital solutions  '
            - value: MANUFACTURING
              name: Manufacturing
              description: 'Industry focused on production and industrial goods  '
            - value: ENTERTAINMENT
              name: Entertainment
              description: 'Industry related to media and performing arts  '
            - value: TELECOMMUNICATIONS
              name: Telecommunications
              description: 'Industry focused on communication and networking  '
          description: The merchant's industry
      required:
        - id
        - creationTime
        - lastUpdateTime
        - name
        - localRegNumber
        - countryIso
        - kycStatus
      x-apidog-orders:
        - id
        - creationTime
        - lastUpdateTime
        - name
        - localRegNumber
        - countryIso
        - state
        - city
        - address
        - streetNumber
        - zipcode
        - kycStatus
        - contactName
        - contactEmail
        - contactPhonePrefix
        - contactPhone
        - industry
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    API Error:
      type: object
      properties:
        exception:
          type: object
          properties:
            errorCode:
              type: string
              enum:
                - INTERNAL_SERVER_ERROR
                - RATE_LIMIT_EXCEEDED
                - URL_INVALID
                - MOCK
                - API_KEY_MISSING
                - API_KEY_INVALID
                - API_KEY_NO_ACCESS
                - API_SECRET_MISSING
                - API_SECRET_INVALID
                - API_IP_NOT_WHITELISTED
                - RESOURCE_NOT_FOUND
                - REQUIRED_FIELD_MISSING
                - BAD_REQUEST
                - BUSINESS_KYC_NOT_VALID
                - BUSINESS_NOT_ACTIVE
                - BUSINESS_CANNOT_UPDATE_VALID
                - BUSINESS_REQUEST_CANCEL_FAILED
                - BUSINESS_REQUEST_ACTION_UNAVAILABLE
                - BUSINESS_REQUEST_ACTION_FAILED
                - BUSINESS_REQUEST_INVALID_TO_AMOUNT
                - CREDENTIALS_NOT_FOUND
                - CURRENCY_NOT_FOUND
                - INVALID_CURRENCY
                - BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                - BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
              x-apidog-enum:
                - value: INTERNAL_SERVER_ERROR
                  name: Internal Server Error
                  description: 'Internal server error  '
                - value: RATE_LIMIT_EXCEEDED
                  name: Rate Limit Exceeded
                  description: 'Rate limit exceeded  '
                - value: URL_INVALID
                  name: URL Invalid
                  description: 'Invalid URL  '
                - value: MOCK
                  name: Sandbox Error
                  description: 'Error in sandbox service  '
                - value: API_KEY_MISSING
                  name: API Key Missing
                  description: 'API key missing  '
                - value: API_KEY_INVALID
                  name: API Key Invalid
                  description: 'API key invalid  '
                - value: API_KEY_NO_ACCESS
                  name: API Key No Access
                  description: 'Access Denied  '
                - value: API_SECRET_MISSING
                  name: API Secret Missing
                  description: 'API secret missing  '
                - value: API_SECRET_INVALID
                  name: API Secret Invalid
                  description: 'API secret invalid  '
                - value: API_IP_NOT_WHITELISTED
                  name: API IP Not Whitelisted
                  description: 'Access Denied - IP not whitelisted  '
                - value: RESOURCE_NOT_FOUND
                  name: Resource Not Found
                  description: 'Resource not found  '
                - value: REQUIRED_FIELD_MISSING
                  name: Required Field Missing
                  description: 'Required field missing  '
                - value: BAD_REQUEST
                  name: Bad Request
                  description: 'Request body is invalid  '
                - value: BUSINESS_KYC_NOT_VALID
                  name: Merchant KYC Not Valid
                  description: 'Merchant KYC not valid  '
                - value: BUSINESS_NOT_ACTIVE
                  name: Merchant Not Active
                  description: 'Merchant not active  '
                - value: BUSINESS_CANNOT_UPDATE_VALID
                  name: Merchant Cannot Update Valid
                  description: 'Cannot update merchant after KYC status is valid  '
                - value: BUSINESS_REQUEST_CANCEL_FAILED
                  name: Transaction Cancel Failed
                  description: 'Failed to cancel request  '
                - value: BUSINESS_REQUEST_ACTION_UNAVAILABLE
                  name: Transaction Action Unavailable
                  description: 'Action unavailable  '
                - value: BUSINESS_REQUEST_ACTION_FAILED
                  name: Transaction Action Failed
                  description: 'Failed to perform action  '
                - value: BUSINESS_REQUEST_INVALID_TO_AMOUNT
                  name: Transaction Invalid To Amount
                  description: 'Invalid to amount  '
                - value: CREDENTIALS_NOT_FOUND
                  name: Credentials Not Found
                  description: 'Failed to find credentials  '
                - value: CURRENCY_NOT_FOUND
                  name: Currency Not Found
                  description: 'Currency not found  '
                - value: INVALID_CURRENCY
                  name: Invalid Currency
                  description: 'Invalid currency  '
                - value: BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                  name: Receiver Account Cannot Update Non Pending Account
                  description: 'Cannot update non-pending account  '
                - value: BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
                  name: Invoice Failed To Download Invoice
                  description: 'Failed to download invoice from URL  '
              description: The API error code
            message:
              type: string
              description: Exception message with additional details
          required:
            - errorCode
            - message
          x-apidog-orders:
            - errorCode
            - message
          description: Exception details
          x-apidog-ignore-properties: []
      required:
        - exception
      x-apidog-orders:
        - exception
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://partners-api.service.cedar.money/mock/bpapi
    description: Sandbox Partners API
  - url: https://partners-api.service.cedar.money/bpapi
    description: Live Partners API
security: []

```
