Retrieve bording settings based on API user's ISO

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Get Boarding Settings

Returns all boarding configuration profiles available to the ISO associated with the authenticated API user. Each settings record defines a distinct BIN/bank combination that controls how merchants are onboarded and processed, including card brand enablement, ICA numbers, ERG identifiers, and fee structure flags. The returned id values are used as boardingSettingsId when creating merchant applications.

Endpoint

GET /api/v1/GetBoardingSettings

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint alongside GET /api/v1/agentProfiles as part of the preparatory step before creating a new merchant. The boarding settings determine which processing platform and financial institution configuration the merchant will be boarded under. ISOs typically have one or more boarding settings profiles corresponding to their different BIN/bank relationships. Present these as options during merchant onboarding to allow the agent to select the correct processing configuration.

Response

200 OK

Field	Type	Description
data	array	List of `OnlineBoardingSettings` objects available to the ISO
data[].id	integer	Boarding settings ID — use as `boardingSettingsId` when creating a merchant
data[].name	string	Human-readable name for this boarding configuration (e.g., `FFB TSYS 423110`)
data[].bin	string	Bank Identification Number for this configuration
data[].bank	string	Bank code associated with this configuration
data[].group	string	Group code, if applicable
data[].association	string	Card association code (e.g., `999001`)
data[].agent	string	Agent code for this boarding configuration
data[].amexAccountNumber	string	Amex account number if Amex processing is enabled
data[].discoverEnabled	boolean	Whether Discover card acceptance is enabled for this configuration
data[].icaNumber	string	Interbank Card Association number
data[].ergId	string	ERG (Entity Reference Group) identifier used by the processor
data[].noFees	boolean	`true` if fee assignment is suppressed for merchants boarded under this setting
data[].allowSpecifyMIDBoardingAPI	boolean	`true` if the API user can specify a custom MID when boarding via API
status	string	HTTP status label (e.g., `OK`)
error	string	Error message if the request failed
warning	string	Non-fatal warning message, if any
validationResults	array	List of validation errors
requestId	integer	Unique identifier for this API request

{
  "data": [
    {
      "id": 1,
      "name": "9180 / 404955",
      "bin": "404955",
      "bank": "9180",
      "group": null,
      "association": "999001",
      "agent": "000000",
      "amexAccountNumber": null,
      "discoverEnabled": true,
      "icaNumber": "1996",
      "ergId": "Unified Payments 81716",
      "noFees": false,
      "allowSpecifyMIDBoardingAPI": false
    },
    {
      "id": 42,
      "name": "FFB TSYS 423110",
      "bin": "423110",
      "bank": "7421",
      "group": null,
      "association": "999003",
      "agent": "000000",
      "amexAccountNumber": null,
      "discoverEnabled": true,
      "icaNumber": "33610",
      "ergId": "FFB423110",
      "noFees": false,
      "allowSpecifyMIDBoardingAPI": false
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 91789
}

Error Codes

Code	When it happens
401	Invalid or missing Basic Auth credentials
403	User does not have permission to access boarding settings for this ISO
404	No boarding settings found for the ISO associated with this API user
500	Internal server error

Common Mistakes

Hard-coding the boarding settings id — this value is environment-specific and varies between staging and production; always fetch it dynamically.
Ignoring noFees — if true, fee records will not be created for merchants under this configuration; ensure your workflow accounts for this.
Selecting a boarding setting with discoverEnabled: false for a merchant that needs Discover acceptance — match the boarding setting to the merchant's card acceptance requirements.
Not refreshing the list when onboarding in different environments — boarding settings differ between staging and production.

Related Endpoints

GET /api/v1/agentProfiles — retrieve agent profiles (call alongside this endpoint before creating a merchant)
POST /api/v1/merchant/create — create a merchant using the boardingSettingsId returned here
POST /api/v2/merchant/create — the v2 create endpoint, which also accepts boardingSettingsId

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/GetBoardingSettings" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"