Create Merchant

POST 
/v1/acquirer/merchants

Creates a new merchant with the specified details.

Request

application/json

Body

name stringrequired
arabic_name stringrequired
merchant_id stringrequired
mcc stringrequired
trading_name stringrequired
cr_number stringrequired
unified_number stringrequired
goods_description stringrequired
website urlrequired
timezone stringrequired
mada_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

visa_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

master_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

addressobjectrequired
line_1 stringrequired
line_2 stringrequired
city stringrequired
state stringrequired
country stringrequired
Possible values: Value must match regular expression ^[A-Z]{2}$
zip stringrequired
company stringrequired
visa_settingsobjectnullable
identifier string
Possible values: >= 8 characters and <= 8 characters
verification_value string
Possible values: >= 10 characters and <= 10 characters
market_indicator stringnullable
mastercard_settingsobjectnullable

assigned_id string

Possible values: >= 6 characters and <= 6 characters

Responses

200

Successfully created merchant

application/json

Schema

Schema

id stringrequired
name stringrequired
arabic_name stringrequired
merchant_id stringrequired
mcc stringrequired
trading_name stringrequired
cr_number stringrequired
unified_number stringrequired
goods_description stringrequired
website url
timezone stringrequired
mada_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

visa_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

master_terminal_id stringrequired

Possible values: >= 8 characters and <= 8 characters

vault_name stringnullable
card_auth_preference stringnullable
addressobjectrequired
line_1 stringrequired
line_2 stringrequired
city stringrequired
state stringrequired
country stringrequired
Possible values: Value must match regular expression ^[A-Z]{2}$
zip stringrequired
company stringrequired
visa_settingsobjectnullable
identifier string
Possible values: >= 8 characters and <= 8 characters
verification_value string
Possible values: >= 10 characters and <= 10 characters
market_indicator stringnullable

mastercard_settings

objectnullable

assigned_id string

Possible values: >= 6 characters and <= 6 characters

created_at stringrequired
updated_at stringrequired

Example (from schema)

{
  "id": "string",
  "name": "string",
  "arabic_name": "string",
  "merchant_id": "string",
  "mcc": "string",
  "trading_name": "string",
  "cr_number": "string",
  "unified_number": "string",
  "goods_description": "string",
  "website": "string",
  "timezone": "string",
  "mada_terminal_id": "string",
  "visa_terminal_id": "string",
  "master_terminal_id": "string",
  "vault_name": "string",
  "card_auth_preference": "string",
  "address": {
    "line_1": "string",
    "line_2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zip": "string",
    "company": "string"
  },
  "visa_settings": {
    "identifier": "string",
    "verification_value": "string",
    "market_indicator": "string"
  },
  "mastercard_settings": {
    "assigned_id": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

Example

{
  "id": "0194f9b2-a1b4-75da-8e43-a545839ab081",
  "name": "Merchant 4",
  "arabic_name": "الإسم العربي",
  "merchant_id": "5617654",
  "mcc": "3172",
  "trading_name": "Merchant 4",
  "cr_number": "2676042478",
  "unified_number": "375233311400",
  "goods_description": "voluptatem et deserunt culpa ab quaerat fuga et optio autem",
  "website": "http://hagenes.test/carmel",
  "timezone": "Asia/Riyadh",
  "mada_terminal_id": "MD274076",
  "visa_terminal_id": "VC341595",
  "master_terminal_id": "MC275190",
  "rule_precedence": "acquirer",
  "vault_name": "memory_vault",
  "card_auth_preference": "default",
  "address": {
    "line_1": "368 Samantha Junction",
    "line_2": "1184",
    "city": "Riyadh",
    "state": "Riyadh",
    "country": "SA",
    "zip": "42852-8567",
    "company": "Towne and Sons"
  },
  "acquirer": {
    "id": "0194f9b2-a039-7bf4-9010-409ba355c92c",
    "name": "ac4"
  },
  "visa_settings": {
    "identifier": null,
    "market_indicator": null,
    "verification_value": null
  },
  "mastercard_settings": {
    "assigned_id": null
  },
  "created_at": "2025-02-12T10:27:01Z",
  "updated_at": "2025-02-12T10:27:01Z"
}

403

returns forbidden

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

422

returns validation error

application/json

Schema

Schema

message stringrequired
errorsobjectrequired
name string[]required

Example (from schema)

{
  "message": "string",
  "errors": {
    "name": [
      "string"
    ]
  }
}

Example

{
  "message": "Data validation failed",
  "errors": {
    "name": [
      "This field is missing."
    ]
  }
}

Loading...