Add a new merchant to WRM

Request
Security:
st_portal_auth
(write:merchantread:merchant)
Request Body schema: application/json

Merchant object that needs to be added to WRM

sponsorId
integer <int64>

ID of merchant's sponsor

id
integer <int64>

Unique ID for merchant assigned by VikingCloud Portal

name
required
string (MerchantName) [ 1 .. 255 ] characters

Name of merchant

dba
string (DBA) <= 255 characters

DBA of merchant

mid
string (MID) <= 255 characters

Merchant ID (MID) of merchant assigned by sponsor

address1
string <= 255 characters

Merchant's street address

address2
string <= 255 characters

Merchant's street address second line

city
string <= 255 characters

Merchant's city

state
string <= 255 characters

Merchant's state/provence

postalCode
string <= 255 characters

Merchant's postal code

country
string <= 128 characters

Merchant's country (ISO-3166-2)

phone
string <= 255 characters
email
string <email> <= 255 characters
mcc
string <= 255 characters

Merchant Category Code

mccSegment
string <= 255 characters

Merchant Category Code Segment

mccDescription
string

Description of MCC code

Array of objects (MerchantUrlWithBoarding)
Array of objects (MerchantContactDetail)
Responses
200

successful operation

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

405

Method Not Allowed. The API was accessed with the wrong method

429

Too Many Requests. The API is rate-limited. Wait and try your request again.

500

Internal Server Error. An unexpected error has occurred. This may be due to a transient error. Retry the request and if the issue persists, please contact support.

503

Service Unavailable. The service is temporarily unavailable. Try your request later.

post/wrm/v1/merchants
Request samples
application/json
{
  • "sponsorId": 2,
  • "id": 762,
  • "name": "Preferred Merchant",
  • "dba": "Preferred Merchant Store",
  • "mid": 12345678,
  • "address1": "123 Anystreet",
  • "address2": "Suite 400",
  • "city": "Anytown",
  • "state": "Texas",
  • "postalCode": 75069,
  • "country": "US",
  • "phone": "+1-512-555-1212",
  • "email": "user@example.com",
  • "mcc": 5999,
  • "mccSegment": "Retail electronics",
  • "mccDescription": "Retail sales of electronics goods",
  • "urls": [],
  • "contacts": [
    ]
}
Response samples
application/json
{
  • "merchantId": 254,
  • "sponsorId": 2,
  • "id": 762,
  • "name": "Preferred Merchant",
  • "dba": "Preferred Merchant Store",
  • "mid": 12345678,
  • "address1": "123 Anystreet",
  • "address2": "Suite 400",
  • "city": "Anytown",
  • "state": "Texas",
  • "postalCode": 75069,
  • "country": "US",
  • "phone": "+1-512-555-1212",
  • "email": "user@example.com",
  • "mcc": 5999,
  • "mccSegment": "Retail electronics",
  • "mccDescription": "Retail sales of electronics goods",
  • "status": "Active",
  • "discovery": {
    },
  • "urls": [],
  • "contacts": [
    ]
}