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 Original

Additional capabilities when onboarding merchants.

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-sandbox.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-sandbox.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."`

Full Data Capture & Submission Flow

In the guide above, we outlined how a Partner can use our REST API and Hosted Experience to submit and capture all the information necessary to board a Merchant and their locations. We discussed how a Partner can submit a minimum / recommended number of data points and the Global Payments Hosted Experience can take care of the rest, allowing the Merchant to fill out the rest of the details.

Our onboarding solution also allows Partners to capture and submit the full data from the Merchant. This may work for Partners who already have a detailed sign up experience for their customers and so are already capturing the majority of the data or wish to control the process end to end. For these types of Partners, the Full Data Capture & Submission Flow is available.
On the next page, we’ve provided a step by step diagram of how the flow works.

How does it work?

At a high level, the Full Data Capture & Submission Flow onboarding process works as detailed below.

Create a Boarding Application

The first step in onboarding a merchant is to create a Boarding Application. The application represents a particular merchant and a set of their locations. In this guide, we’re going to walk through an example where the Partner has captured and is submitting all of the data that is necessary to onboard the merchant and their locations. At a high-level this data includes:

Data Group	Examples
Company Level Information	1) Legal Name 2) Legal Address 3) Company History
Ownership Details	1) Owners Identities 2) Percentage Ownership 3) Owners Addresses
Merchant Locations	1) Address Information 2) Payment Processing Statistics 3) Bank Accounts Details 4) Software and Hardware to be used 5) Pricing

To initiate onboarding, send a create a Boarding Application to our REST API. If all the fields pass validation and the request is processed successfully the follow will occur:

A unique Boarding Application resource (BAP ID) is created on the REST API. This can be used to query the status of the application and will also receive webhook updates when the status of the application changes.
For each Merchant location attached to the Boarding Application, a unique Merchant resource (MER ID) is created on the REST API. If and when the location is successfully boarded, you can use this MER ID to access the location’s payment processing credentials.

We recommend that you retrieve and store the different MER IDs that are returned in the synchronous response to the Create Boarding Application request.

You can use the reference field in the request to assign your own unique ID to the Boarding Application. This identifier will be passed in all subsequent webhooks.

Sample Request

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

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

Body
{
    "application_type": "FULL",
    "reference": "6323c324-b01b-49e9-acb1-0cfe917eef5b",
    "legal_name": "Acme",
    "legal_entity": "LIMITED_COMPANY",
    "stock_symbol": "AME",
    "active_months": "12",
    "publicly_owned": "NO",
    "tax_id_reference": "153759426",
    "bankruptcy_history": "NO",
    "third_party_lender": "NO",
    "data_breach_history": "NO",
    "political_exposure_history": "NO",
    "cardholder_data_storage": "YES",
    "third_party_storage": "YES",
    "extended_services": "YES",
    "extended_services_weeks": "52",
    "third_party_management": "YES",
    "addresses": [
        {
            "functions": [
                "LEGAL"
            ],
            "line_1": "12202 Airport Way",
            "line_2": "Ste 100",
            "line_3": "1st Floor",
            "city": "Broomfield",
            "state": "CO",
            "postal_code": "80021",
            "country": "US",
            "contact_phone": {
                "country_code": "1",
                "subscriber_number": "745898521"
            }
        }
    ],
    "persons": [
        {
            "functions": [
                "PRIMARY_CONTACT"
            ],
            "first_name": "James",
            "last_name": "Mason",
            "email": "james.mason@example.com"
        },
        {
            "functions": [
                "REFERRING_EMPLOYEE"
            ],
            "first_name": "Liz",
            "last_name": "Norton",
            "email": "liz.norton@example.com",
            "contact_phone": {
                "country_code": "1",
                "subscriber_number": "800867531"
            }
        },
        {
            "functions": [
                "BENEFICIAL_OWNER",
                "APPLICANT",
                "DESIGNATED_SIGNER"
            ],
            "first_name": "Philip",
            "last_name": "Marlowe",
            "email": "philip.marlowe@example.com",
            "contact_phone": {
                "country_code": "1",
                "subscriber_number": "200596849"
            },
            "date_of_birth": "1988-01-31",
            "national_id_reference": "132435169",
            "job_title": "CPO",
            "equity_percentage": "60",
            "citizenship_country": "US",
            "addresses": [
                {
                    "functions": [
                        "PERSONAL"
                    ],
                    "line_1": "3550",
                    "line_2": "Lenox Rd",
                    "line_3": "NE Suite 3000",
                    "city": "Atlanta",
                    "state": "GA",
                    "postal_code": "30326",
                    "country": "US",
                    "months_at_address": "0"
                },
                {
                    "functions": [
                        "PREVIOUS_PERSONAL"
                    ],
                    "line_1": "5995",
                    "line_2": "Windward",
                    "line_3": "Pkwy",
                    "city": "Windward",
                    "state": "GA",
                    "postal_code": "30005",
                    "country": "US",
                    "months_at_address": "5"
                }
            ]
        }
    ],
    "merchants": [
        {
            "reference": "Acme NY-588",
            "dba": "Acme NY",
            "first_name": "Jay",
            "last_name": "Gatsby",
            "email": "jay.gatsby@example.com",
            "merchant_category_code": "5999",
            "industry": "CARWASH",
            "goods_or_services_description": "Car Washes",
            "payment_before_delivery": "YES",
            "payment_before_delivery_percentage": "60",
            "pricing_profile": "Pricing Profile Name",
            "software_name": "Genius T650P",
            "american_express_service_number": "888554477",
            "website": "https://www.example.com",
            "phone": {
                "country_code": "1",
                "subscriber_number": "855478988"
            },
            "payment_methods": [
                {
                    "functions": [
                        "TRANSACTION_PROCESSING"
                    ],
                    "card": {
                        "payment_processing_statistics": {
                            "acceptance_history": "YES",
                            "total_yearly_sales_amount": "3000000",
                            "average_ticket_sales_amount": "50000",
                            "american_express_percentage": "60",
                            "customer_present_percentage": "50",
                            "moto_percentage": "25",
                            "customer_not_present_percentage": "25"
                        }
                    }
                },
                {
                    "functions": [
                        "PRIMARY_PAYOUT"
                    ],
                    "bank_transfer": {
                        "account_number": "156423786",
                        "bank": {
                            "code": "124002971"
                        }
                    }
                },
                {
                    "functions": [
                        "TRANSACTION_PROCESSING"
                    ],
                    "bank_transfer": {
                        "pricing_profile": "Custom DCS Standard",
                        "services": [
                            "Check Verification Services"
                        ],
                        "disputes": {
                            "auto_challenge": "YES",
                            "auto_challenge_max_count": "1",
                            "auto_challenge_timing": "2 DAYS",
                            "auto_challenge_check21_timing": "2 DAYS"
                        },
                        "notifications": {
                            "returned_items": {
                                "primary_contact": "primaryreturns@example.com",
                                "secondary_contact": "secondaryreturns@example.com"
                            }
                        },
                        "payment_processing_statistics": {
                            "total_yearly_sales_amount": "3000000",
                            "highest_monthly_amount": "1000000",
                            "average_ticket_sales_amount": "50000",
                            "highest_ticket_amount": "60000",
                            "prearranged_card_percentage": "10",
                            "prearranged_deposits_percentage": "35",
                            "moto_percentage": "30",
                            "customer_not_present_percentage": "25"
                        }
                    }
                }
            ],
            "addresses": [
                {
                    "functions": [
                        "BUSINESS"
                    ],
                    "line_1": "29",
                    "line_2": "Liberty Street",
                    "line_3": "Warehouse",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10005"
                },
                {
                    "functions": [
                        "SHIPPING"
                    ],
                    "line_1": "28",
                    "line_2": "Liberty Street",
                    "line_3": "3rd Floor",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10005"
                }
            ],
            "products": [
                {
                    "device": {
                        "manufacturer_model": "VeriFone_P400",
                        "payment_description": "PURCHASE",
                        "quantity": "5"
                    }
                }
            ]
        }
    ],
    "notifications": {
        "status_url": "https://www.example.com/partnerStatusEndpoint"
    }
}

Sample Response

{
    "id": "BAP_N0rmJwbUwG78ju37yFe7YGbpbI6tpU",
    "application_type": "FULL",
    "reference": "37362ff4-d2c1-4e16-93ab-24957407ed06",
    "time_created": "2025-08-12T20:21:05.091Z",
    "time_last_updated": "2025-08-12T20:21:05.091Z",
    "status": "IN_PROGRESS",
    "status_description": "Application Started",
    "url": "https://apis.sandbox.globalpay.com/ucp/postback/boarding-applications/redirect/eyJHYXRld2F5X1VybCI6Imh0dHBzOi8vb24tZGVtYW5kLnN0Zy5obG1lLmhscHJkLmNvbS8/Y29udGludWU9aldiRWpvbG4xUWlPUklFWlFTcDRQVHloQkVLUkJZSUJZdVdCWkRDS0Q4alJrb0xRS3ZNTzRWRkQ3S0JTT0Jjb2VUOFMyUzJ2a2xTcGFTZUVSQXNHcHFsc0tOa0lmRUFTWmF3bDhiUCIsIlgtR1AtVmVyc2lvbiI6IjIwMjEtMDMtMjIifQ==",
    "merchants": [
        {
            "id": "MER_67e84fa1e9c741e6955433ecf16b22c6",
            "dba": "Acme NY",
            "addresses": {
                "line_1": "5995 Windward Pkwy",
                "city": "Alpharetta",
                "state": "GA",
                "postal_code": "30005"
            },
            "reference": "Acme NY-588",
            "time_last_updated": "2025-08-12T20:21:05.091Z",
            "status": "IN_PROGRESS",
            "status_description": "Awaiting Merchant Signature"
        }
    ],
    "action": {
        "id": "ACT_N0rmJwbUwG78ju37yFe7YGbpbI6tpU",
        "type": "BOARDING_APPLICATION_CREATE",
        "time_created": "2025-08-12T20:21:05.091Z"
        "result_code": "SUCCESS",
    }
}

Next Steps

In the Full Data Capture & Submission flow, the Merchant is brought straight to the Merchant Reviews and Signs the Agreement step. They cannot edit any of the Boarding Application data or add or delete locations. The rest of the flow remains the same, please refer to Steps 4-8 above..

Policies

Connect

Additional Resources

Additional Capabilities Original

Retrieve your Partner Profile

Sample Request

Sample Response

Get a List of Boarding Applications

Sample Request

Sample Response

Get the details of a single Boarding Application

Sample Request

Sample Response

Error Handling

Full Data Capture & Submission Flow

How does it work?

Create a Boarding Application

Sample Request

Sample Response

Next Steps