Set PayChoice Credentials

PUT

/api/admin/merchants/{id}/paychoice

curl --request PUT \
  --url https://example.com/api/admin/merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/paychoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "paychoiceEnvironment": "Staging", "gatewayUsername": "example", "gatewayPassword": "example", "merchantGuid": "example" }'

Set a merchant’s PayChoice environment and credentials. Credential fields are write-only.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

Request Body

object

id

string format: uuid

paychoiceEnvironment

string

Allowed values: Staging Production

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

merchantGuid

string

nullable <= 64 characters

object

id

string format: uuid

paychoiceEnvironment

string

Allowed values: Staging Production

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

merchantGuid

string

nullable <= 64 characters

object

id

string format: uuid

paychoiceEnvironment

string

Allowed values: Staging Production

gatewayUsername

string

nullable <= 200 characters

gatewayPassword

string

nullable <= 500 characters

merchantGuid

string

nullable <= 64 characters

Responses

200

OK

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"
}

404

Not Found

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"
}