Merchant - API Reference
Merchant
POST
Try it
Create a new merchant within your Forter account. The response will include a Forter-assigned merchant subsite ID to be included in the API header on future requests.
Credentials
HTTP Basic basicAuth
Header Parameters
| Parameter | Type | Required |
|---|---|---|
| api-version | string | |
| x-forter-siteid | string |
Body Parameters
| Parameter | Type | Required |
|---|---|---|
| body | merchantCreationRequest | |
| defaultMerchantCategoryCode | string | |
| merchantAccountCreation | object | |
| name | string | |
| merchantId | string |
Responses
200
Example merchantCreationResponse
| Parameter | Type | Description |
|---|---|---|
| defaultMerchantCategoryCode | string | |
| id | string | |
| merchantAccountCreation | object | All Of MerchantAccountCreationFields + |
| merchantId | string | |
| name | string |
400 Bad Request (Often missing a required parameter)
401 Unauthorized (No valid API key provided)
404 Not Found (The requested item doesn't exist)
500 Server Error (Something went wrong on Forter's end)
Request
curl --request POST \
--url https://api.forter-secure.com/merchants \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'api-version: 10.1' \
--header 'x-forter-siteid: a1b2c3d4e5f6' \
--data '{ \
"defaultMerchantCategoryCode": "5655", \
"merchantAccountCreation": {}, \
"merchantId": "eh629dK9", \
"name": "T-Shirts Express" \
}'
Responses
200
{
"defaultMerchantCategoryCode": "5655",
"id": "aab42345bba2",
"merchantAccountCreation": {},
"merchantId": "eh629dK9",
"name": "T-Shirts Express"
}