Get merchant's service acceptance

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesThe unique internal ID of the merchant application

Response

200 OK

The data object is of type TsysProductSetup.

FieldTypeDescription
amexESAbooleanWhether the merchant accepts Amex through the ESA (Electronic Submission Agreement) program
amexOptBluebooleanWhether the merchant accepts Amex through the OptBlue program
discoverbooleanWhether Discover card acceptance is enabled
payPalbooleanWhether PayPal acceptance is enabled
jcbbooleanWhether JCB card acceptance is enabled
ebtbooleanWhether Electronic Benefits Transfer (EBT/SNAP) acceptance is enabled
debitCardbooleanWhether PIN debit card acceptance is enabled
amexNumberstring10-digit Amex ESA account number (required when amexESA is true)
fcsNumberstring7-digit Discover FCS (Franchise Code System) number (required when discover is true under certain programs)
statusstringHTTP status string (e.g., "OK")
errorstringError message if the request failed
warningstringNon-fatal warning message
validationResultsarrayList of validation errors, each with memberNames and errorMessage
requestIdinteger (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

CodeWhen it happens
400The id query parameter is missing or not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No merchant application found for the given id
500Internal server error

Common Mistakes

  • Setting both amexESA and amexOptBlue to true simultaneously — these are mutually exclusive Amex programs; only one should be active.
  • Providing amexNumber without amexESA: true — the Amex number field is only relevant when the ESA program is selected.
  • amexNumber must be exactly 10 digits; fcsNumber must be exactly 7 digits — extra or missing digits will cause validation failures.
  • Forgetting that enabling ebt may require additional underwriting documentation depending on the ISO's agreement with the processor.

Related Endpoints

  • PUT /api/v1/merchant/productSetup — update the service acceptance configuration
  • GET /api/v1/merchant/account — retrieve the merchant's sales and business profile
  • GET /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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json