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.

Register / Create an App

Set up a free account and learn how to get your test credentials

We’re happy you’ve decided to join us! There are a couple things you need to do before you start your payments journey with us.

Get registered

To use our free Sandbox test environment, you must be a registered user of our developer portal. Once registered, you can manage app test credentials for your different projects and test your integration before going live. You can also try out new features, save your favorite pages to pick up where you left off, and join our Research Community to preview new features.

If you already have an account on our Reporting or Disputes tools for merchants, you can use the same login for our developer portal. You just need to add your company name and region.

To get registered, click Log In | Register in the top-right corner of any page or click below.

Apps and Testing Environments

We use the term app to describe a set of credentials that developers need to execute API actions on our gateway. Each app consists of an App ID and App Key, which together are used to create a bearer token that allows you to access our endpoints and transact using the REST API. Each app also includes permission settings that allow you to customize its capabilities, which in turn determine what API actions are allowed when sending requests.

App credentials (App ID and App Key) are specific to merchants and should never be shared with any unauthorized person.

Permissions define capabilities

Capabilities refer to our payment-processing solutions such as Transaction Processing, Tokenization, Dispute Management, Settlement Reporting, and so on. By default, all of these capabilities are enabled for any app you create. You can customize permissions simply by clearing the checkboxes for any capabilities you don't want. For more information on capabilities, see Account Capabilities in our API References.

You can further customize each capability by deciding which individual request types (GET, POST, PATCH) for transactions, verifications, and authentications you want to allow. For example, for dispute_management, you could allow only [GET] Disputes to run a certain test scenario.

We've made our test apps highly configurable to give you the flexibility you need for a wide variety of testing scenarios. For example, you can try a new capability to see how it works before adding it to your Production account. Or, maybe you have several merchants you’re developing for and each one has (or will need) different capabilities enabled. In that case, you could create a test app for each merchant.

Sandbox test environment

For Sandbox testing, you create your own apps from your account page here in the developer portal and configure them as needed for testing your integration. Each test app can serve as an individual project you’re working on — for example, one app to test your ecommerce website and a second to test your ecommerce mobile application. However, you really only need one test app to access the Sandbox endpoint.

https://apis.sandbox.globalpay.com

Production live environment

When you have a real Production account with us, an account manager will configure your app(s) based on the capabilities you sign up for and how many linked businesses you have. In Production, capabilities are referred to as accounts because the account_name and account_id fields are used to identify what data your API request can access when you're processing real payments with us. Your account manager can add new accounts for you at any time, not just during the onboarding process.

https://apis.globalpay.com

Create an app (generate keys)

Before you can start testing your integration, you need to create your first test app. This is necessary to generate the test credentials needed to access our Sandbox endpoint — the App ID and App Key described in the section on apps and testing environments.

To create an app:

Log into your account in the Developer Portal.
Click the Profile icon and select My Account to access your dashboard. Note: When you're logged in, you'll be able to access your dashboard through this menu from any page in the portal.
In the My Sandbox Credentials section of your dashboard, click the Create a New App arrow, and select Unified Payments. This will bring up the Create an App page.
On the Create an App page, enter a name for your test app in the Display Name field (for example: UK Website or US Mobile App Transaction Processing).
Note: The display name can be changed at any time. However, the machine-readable app_name can’t be changed once the app is saved.
Optional: By default, a new app has permissions enabled for all capabilities. If this is what you want, you can skip to the next step. However, if you want to limit them, just follow these steps:
1. For each capability you want to limit, click on the down arrow in the Permissions field to bring up the permission dialog for that capability.
2. To search for a certain request type (for example, GET), use the search box.
3. If you want to disable all the permissions, clear the Select All checkbox.
4. If you're not sure what permissions you want or want to familiarize yourself with those available for a given capability, you can simply scroll through the list.
Once you have configured the permissions you need, click down arrow in the Permissions field again to close the dialog. Any changes will be reflected in the blue "Enabled" number. Note: Your changes are not yet saved at this point.
When you're finished creating the app, scroll down to the bottom of the page and click Generate Keys.
Your app credentials will now appear on the left panel. You can copy them to use in the configuration section of your API request.
To return to your account, you can click the breadcrumb link at the top of the page or on your profile in the upper right corner.
Your new app will now appear in the My Sandbox Credentials table.

Manage your apps

You can create as many test apps as you need. We suggest giving them useful, intuitive names so that you can easily keep track of them. For example, you may want to indicate the location that your simulated transactions will originate from or the permissions that the test app will have. So, you might name it something like, US Apparel Online Transaction Processing.

Once you’ve created a test app, you can edit the app to change the display name, view (and copy your credentials, or reconfigure permissions at any time. You can’t delete a test app, but if you no longer want to use it, you can switch it off.

For more information on test apps, you can refer back to the section on working with apps in our testing environments.

To view your credentials:

Log into your account in the Developer Portal.
Click the Profile icon and select My Keys.
In the My Sandbox Credentials table, locate the app you want to view keys for in the app list.
Click View Credentials button to open a dialog box with your credentials.
To copy the credentials, click the copy icon. You can then paste the data into the configuration section of your API request. You’ll need to copy and paste both the App Key and App ID in the request.
When finished viewing, click Close.

To edit an app:

Log into your account in the Developer Portal.
Click the Profile icon and select My Keys.
In the My Sandbox Credentials section, locate the app you want to edit in the app list.
Click Edit App button to open the App Details page.
To edit your app’s name, click in the Display Name field and enter the new name. When finished, scroll down to click Save. Or, click **Cancel to cancel. Note: The machine-readable name for your app (App Name field) can’t be changed.
To configure capabilities and permissions for your app, use the App Permissions section. (For more information on capabilities, see Account Capabilities in API References.)
1. For each capability you want to limit, click on the down arrow in the Permissions field to bring up the permission dialog for that capability.
2. To search for a certain request type (for example, GET), use the search box.
3. If you want to disable all the permissions, clear the **Select All **checkbox.
4. If you're not sure what permissions you want or want to familiarize yourself with those available for a given capability, you can simply scroll through the list.
5. Once you have configured the permissions you need, click down arrow in the Permissions field again to close the dialog. Any changes will be reflected in the blue "Enabled" number. Note: Your changes are not yet saved at this point.
When you’re finished editing your app, scroll down to the bottom of the page and click Save.

Apps glossary

Here are some important terms related to app creation and management.

Term	Definition
Account(s)	Payment-processing capabilities that can be added when you sign up with us, the most fundamental of which is Transaction Processing. Others include Tokenization, Dispute Management, Settlement Reporting, Risk Assessment, etc. Each capability you add is considered an account. You can only execute API actions based on what accounts you have configured.
Account ID	Unique identification of a capability type (i.e., one of our payment-processing solutions) that allows certain data to be accessed through an API request. When you want to use a capability in an API call, you need to include its ID in the API request’s account_id field. The first three letters identify which account capability it is (see Account Name entry). For example, an Account ID for Transaction Processing (TRA) would look something like this: TRA_123456789a123456789b123456789c
Account Name	Standardized name of a capability type (i.e., one of our payment-processing solutions) that allows certain data to be accessed through an API request. When you want to use a capability in an API call, you need to include its name in the API request’s account_name field. Examples include: transaction_processing, dispute_management, risk_assessment, settlement_reporting, etc.
App	Set of credentials that you need to execute API actions on our server. Each app consists of an App ID and App Key, which together serve as a bearer token to access our endpoints. An app also includes customized capabilities, which in turn determine what API actions are allowed when sending requests. For more information, see the Apps and testing environments section.
App Name	Machine-readable version of the display name you give your app when you first create it (i.e., underscores replace blank spaces). It’s created automatically and can be edited before the app is first saved but not after. Allowed characters: `[a-z_0-9]`.
App ID & App Key	Set of credentials needed to access our server and execute API actions. To generate these credentials, you need to create a test app. Only one test app is necessary to access our Sandbox endpoint, but you might want to create several for different testing projects. Note: These credentials are specific to a merchant and should not be shared.
Capability	One of our payment-processing solutions, the most fundamental of which is Transaction Processing. Others include Tokenization, Dispute Management, Settlement Reporting, Risk Assessment, etc. In Production, capabilities are referred to as accounts.
Display Name (App)	Name that you give your test app. You can edit it at any time, but its associated machine-readable name (App Name field) cannot be edited once the test app has been created.

Next steps

Now that you have your test app credentials, there's one more thing you need to do before you can start building your integration: Create an access token.

Policies

Connect

Additional Resources