Create Merchant

POST

/api/admin/merchants

curl --request POST \
  --url https://example.com/api/admin/merchants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "paychoiceEnvironment": "Staging", "description": "example", "contactEmail": "hello@example.com", "contactPhone": "example", "country": "example", "timeZone": "example" }'

Establish a new merchant.

Authorizations

• Bearer

Request Body

object

name

required

string

>= 1 characters <= 200 characters

paychoiceEnvironment

string

Allowed values: Staging Production

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

object

name

required

string

>= 1 characters <= 200 characters

paychoiceEnvironment

string

Allowed values: Staging Production

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

object

name

required

string

>= 1 characters <= 200 characters

paychoiceEnvironment

string

Allowed values: Staging Production

description

string

nullable <= 2000 characters

contactEmail

string format: email

nullable <= 256 characters

contactPhone

string

nullable <= 30 characters

country

string

nullable <= 100 characters

timeZone

string

nullable <= 100 characters

Responses

201

Created

Media type application/json

object

id

string format: uuid

name

string

nullable

description

string

nullable

contactEmail

string

nullable

contactPhone

string

nullable

country

string

nullable

timeZone

string

nullable

isActive

boolean

gatewayConfigured

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

paychoiceEnvironment

string

Allowed values: Staging Production

merchantGuidConfigured

boolean

paychoiceMerchantProfileId

string

nullable

billingRetryOffsetsDays

string

nullable

billingTerminalAction

string

Allowed values: Cancel Suspend

bankSettlementWindowDays

integer format: int32

Example

{
  "paychoiceEnvironment": "Staging",
  "billingTerminalAction": "Cancel"
}

400

Bad Request

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}