For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Additional Capabilities

Additional capabilities when onboarding merchants.

These solutions are available in US and Canada only. For all other regions, please contact us for support.

Retrieve your Partner Profile

As a Partner, you can dynamically retrieve configuration values for relevant fields and objects to be passed during a Create Boarding Application request. This ensures that the Merchant onboarding process is accurate, up to date and compliant with the platform standards. Using the GET call, you are able to fetch details such as the

MCCs allowed to board
Available Pricing Profiles for Card Processing
Industries
List of Compatible Software Names
List of available devices, Manufacturer models
Bank Transfer / ACH Pricing Profiles

Sample Request

URL
https://apis-sandbox.globalpay.com/ucp/profiles // Sandbox

https://apis.globalpay.com/ucp/profiles // Production

Sample Response

{
    "total_record_count": 1,
    "current_page_size": 1,
    "merchant_id": "PAR_4279e1563cb244afbc01aa5dc37e4db8",
    "merchant_name": "Partner_Name",
    "account_id": "MMA_fc0f6ad5826b46c480dfdd459c174aea",
    "account_name": "Merchant_Management_Account",
    "filter": {
        "product_name": "NONPAYFAC_MERCHANT_BOARDING"
    },
    "paging": {
        "page": 1,
        "page_size": 1
    },
    "profiles": [
        {
            "merchant_category_code": [
                "742",
                "1520",
                "2741",
                "4011",
                "5999",
                "6513",
                "7230",
                "8931",
                "9402"
            ],
            "industry": [
                "Accounting",
                "Business Services",
                "Call Center Software",
                "Church Management",
                "Government",
                "Hospitality",
                "Logistics/Shipping Services",
                "Restaurant",
                "Retail",
                "Wholesale/Distributors/Suppliers"
            ],
            "pricing_profile": [
                "Partner Name 2.80",
                "Partner Name 3.40"
            ],
            "bank_transfer": {
                "pricing_profile": [
                    "Custom DCS Standard"
                ]
            },
             "software_compatibility": [
                {
                    "software_name": "Partner_Software_15.4",
                    "bank_transfer_available": "YES",
                    "device": [
                        {
                            "manufacturer_model": "VeriFone_P400",
                            "payment_description": "PAID_RENTAL"
                        },
                        {
                            "manufacturer_model": "VeriFone_P400",
                            "payment_description": "PURCHASE"
                        }
                    ]
                },
                {
                    "software_name": "Partner_Software_15.5",
                    "bank_transfer_available": "YES",
                    "device": [
                        {
                            "manufacturer_model": "VeriFone_P400",
                            "payment_description": "PURCHASE"
                        },
                        {
                            "manufacturer_model": "VeriFone_e285",
                            "payment_description": "PURCHASE"
                        },
                        {
                            "manufacturer_model": "VeriFone_V400m",
                            "payment_description": "PURCHASE"
                        }
                    ]
                }
            ]
        }
    ],
    "action": {
        "id": "ACT_UwVYLwCXsFejKOjZ9gpI9EZcaRfsTK",
        "type": "PROFILE_LIST",
        "time_created": "2025-08-12T17:25:48.101Z",
        "result_code": "SUCCESS"
    }
}

Get a List of Boarding Applications

As a Partner, you’re also able to retrieve a list of all the boarding applications submitted via the API. This allows you to monitor status, track progress and have clear visibility of all applications under your Partner account. This is particularly important for Partners that are managing multiple boarding applications concurrently.

Sample Request

URL
https://apis-sandbox.globalpay.com/ucp/boarding-applications // Sandbox

https://apis.globalpay.com/ucp/boarding-applications // Production

Sample Response

{
    "total_record_count": 16489,
    "current_page_size": 5,
    "merchant_id": "PAR_4279e1563cb244afbc01aa5dc37e4db8",
    "merchant_name": "Partner_Name",
    "paging": {
        "page": 1,
        "page_size": 5,
        "order_by": "TIME_CREATED",
        "order": "DESC"
    },
    "boarding_applications": [
        {
            "id": "BAP_N0rmJwbUwG78ju37yFe7YGbpbI6tpU",
            "legal_name": "Acme",
            "legal_entity": "GENERAL_PARTNERSHIP",
            "reference": "56613234-87f8-4fad-a476-296db45a97cc",
            "time_created": "2025-08-12T17:18:52",
            "time_last_updated": "2025-08-12T17:18:55",
            "status": "IN_PROGRESS",
            "status_description": "Application Started",
            "merchants": [
                {
                    "id": "MER_2056589163064925a502b84f90773a5d",
                    "name": "Acme NY",
                    "reference": "915750f9-bb66-4bb3-b5ca-f5cfa22b5abc"
                }
            ]
        },
        {
            "id": "BAP_hurvQKFOLEN7tz9B8VS4x7GhALnbR5",
            "legal_name": "Tyrell",
            "legal_entity": "GENERAL_PARTNERSHIP",
            "reference": "2cb98dee3-b96c-4d1f-b9c6-60f4b3ce62a1",
            "time_created": "2025-08-12T17:18:32",
            "time_last_updated": "2025-08-12T17:18:33",
            "status": "IN_PROGRESS",
            "status_description": "Application Started",
            "merchants": [
                {
                    "id": "MER_90fd032748df456d9b14bdb11d342b49",
                    "name": "Tyrell GA",
                    "reference": "62a692c9-eddc-4d04-a322-2393537fac13"
                }
            ]
        }
    ],
    "action": {
        "type": "BOARDING_APPLICATION_LIST",
        "id": "ACT_wUqmUsJiNqrvGvdZYzADuxqWv5sGRo",
        "time_created": "2025-08-12T17:18:57.838Z",
        "result_code": "SUCCESS"
    }
}

Get the details of a single Boarding Application

Use this request to retrieve all of the data associated with a particular Boarding Application. This will include the list of Merchant locations associated with the application and their individual statuses.

Sample Request

URL
https://apis-sandbox.globalpay.com/ucp/boarding-applications/BAP_fl19D9AKivp4oBte27Qlgo62kJuItz // Sandbox

https://apis.globalpay.com/ucp/boarding-applications/BAP_fl19D9AKivp4oBte27Qlgo62kJuItz // Production

Sample Response

{
    "id": "BAP_N0rmJwbUwG78ju37yFe7YGbpbI6tpU",
    "reference": "47362ff4-d2c1-4e17-93ab-24957407ed08",
    "time_created": "2025-08-05T15:06:38.825652",
    "time_last_updated": "2025-08-05T15:06:39.3634177",
    "status": "IN_PROGRESS",
    "status_description": "Application Started",
    "merchants": [
        {
            "id": "MER_67e84fa1e9c741e6955433ecf16b22c6",
            "reference": "ead50fc4-63a2-44e8-9786-637156f9da0e",
            "name": "Acme NY",
            "dba": "Acme NY",
            "addresses": {
                "line_1": "28",
                "line_2": "Liberty Street",
                "line_3": "3rd Floor",
                "city": "New York",
                "state": "NY",
                "postal_code": "10005"
            },
            "status": "In Progress",
            "status_description": "Application Started",
            "platform_configurations": [
                {}
            ]
        }
    ],
    "action": {
        "type": "BOARDING_APPLICATION_SINGLE",
        "id": "ACT_3HcFremgYKUf9xSASfsBDRqAfVRN2x",
        "time_created": "2025-08-05T15:08:05.110Z"
    }
}

Error Handling

HTTP Code	Description	Status
400	Bad Request	`"error_code": "INVALID_REQUEST_DATA",` `"detailed_error_code": "40213",` `"detailed_error_description": "field_name contains unexpected data"`
403	Forbidden	`"error_code": "ACTION_NOT_AUTHORIZED",` `"detailed_error_code": "40022",` `"detailed_error_description": "Permission not enabled to execute action"`
404	Not Found	`"error_code": "RESOURCE_NOT_FOUND",` `"detailed_error_code": "40008",` `"detailed_error_description": "RESOURCE RESOURCE_ID not found at this location."`
502	Bad Gateway	`"error_code": "SYSTEM_ERROR_DOWNSTREAM",` `"detailed_error_code": "50046",` `"detailed_error_description": "Unable to process your request due to an error with a system down stream."`