Retrieve bording settings based on API user's ISO

GET /api/v1/GetBoardingSettings

Overview

The GET /api/v1/GetBoardingSettings endpoint retrieves the boarding settings configured for the Independent Sales Organization (ISO) associated with the authenticated API user's account.

These settings include onboarding rules, configurations, and preferences specific to the ISO’s merchant onboarding process. This allows ISOs to review and manage how merchants are onboarded in alignment with their business requirements and compliance needs.

Purpose

This endpoint provides detailed information on the ISO’s merchant boarding configuration, including:

• Merchant eligibility criteria
• Required documentation
• Onboarding workflow settings
• BIN, bank, and association information
• Feature flags (e.g., Discover support, fee settings)

It ensures that ISOs can verify and manage their merchant boarding process through the API.

HTTP Request

• Method: GET
• URL: /api/v1/GetBoardingSettings

Authentication

• Required: Yes

• Methods Supported:

  • Basic Token
  • API Key (in request header)

Request Headers

Query Parameters

• None. The response is based on the ISO associated with the authenticated user.

Success Response

• HTTP Status: 200 OK
• Response Body: JSON object containing a list of boarding settings

Example Response

{
  "data": [
    {
      "id": 1,
      "name": "9180 / 404955",
      "bin": "404955",
      "bank": "9180",
      "association": "999001",
      "agent": "000000",
      "discoverEnabled": true,
      "icaNumber": "1996",
      "ergId": "Unified Payments 81716",
      "noFees": false,
      "allowSpecifyMIDBoardingAPI": false
    },
    {
      "id": 42,
      "name": "FFB TSYS 423110",
      "bin": "423110",
      "bank": "7421",
      "association": "999003",
      "agent": "000000",
      "discoverEnabled": true,
      "icaNumber": "33610",
      "ergId": "FFB423110",
      "noFees": false,
      "allowSpecifyMIDBoardingAPI": false
    }
    // ... additional configurations
  ],
  "status": 200,
  "requestId": 18488
}

Error Responses

Notes

• The boarding settings returned are specific to the ISO linked to the API token.
• These settings control how merchants are onboarded to the payment platform, ensuring compliance with the ISO’s policies.