| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Merchant's Service Acceptance
Retrieves the product setup and service acceptance configuration for a merchant application. The response indicates which card networks (Amex ESA, Amex OptBlue, Discover, PayPal, JCB, EBT, debit) are enabled, along with any associated program numbers. This data reflects what payment products the merchant is configured to accept through the processor.
Endpoint
GET /api/v1/merchant/productSetup
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint to read back the service acceptance configuration saved for a merchant application. This is typically called during application review or when verifying that the merchant's product enablements are correctly set before submission. The data corresponds to the "Product Setup" section of the merchant boarding form.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique internal ID of the merchant application |
Response
200 OK
The data object is of type TsysProductSetup.
| Field | Type | Description |
|---|---|---|
| amexESA | boolean | Whether the merchant accepts Amex through the ESA (Electronic Submission Agreement) program |
| amexOptBlue | boolean | Whether the merchant accepts Amex through the OptBlue program |
| discover | boolean | Whether Discover card acceptance is enabled |
| payPal | boolean | Whether PayPal acceptance is enabled |
| jcb | boolean | Whether JCB card acceptance is enabled |
| ebt | boolean | Whether Electronic Benefits Transfer (EBT/SNAP) acceptance is enabled |
| debitCard | boolean | Whether PIN debit card acceptance is enabled |
| amexNumber | string | 10-digit Amex ESA account number (required when amexESA is true) |
| fcsNumber | string | 7-digit Discover FCS (Franchise Code System) number (required when discover is true under certain programs) |
| status | string | HTTP status string (e.g., "OK") |
| error | string | Error message if the request failed |
| warning | string | Non-fatal warning message |
| validationResults | array | List of validation errors, each with memberNames and errorMessage |
| requestId | integer (int32) | Internal request tracking ID |
{
"data": {
"amexESA": false,
"amexOptBlue": true,
"discover": true,
"payPal": false,
"jcb": false,
"ebt": false,
"debitCard": true,
"amexNumber": null,
"fcsNumber": null
},
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 80145
}Error Codes
| Code | When it happens |
|---|---|
| 400 | The id query parameter is missing or not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No merchant application found for the given id |
| 500 | Internal server error |
Common Mistakes
- Setting both
amexESAandamexOptBluetotruesimultaneously — these are mutually exclusive Amex programs; only one should be active. - Providing
amexNumberwithoutamexESA: true— the Amex number field is only relevant when the ESA program is selected. amexNumbermust be exactly 10 digits;fcsNumbermust be exactly 7 digits — extra or missing digits will cause validation failures.- Forgetting that enabling
ebtmay require additional underwriting documentation depending on the ISO's agreement with the processor.
Related Endpoints
PUT /api/v1/merchant/productSetup— update the service acceptance configurationGET /api/v1/merchant/account— retrieve the merchant's sales and business profileGET /api/v1/merchant/parameters— retrieve the merchant's business and owner information
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/productSetup?id=10045" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Accept: application/json"