Loading...
We've compiled the most frequently asked questions we've received from our integrators who use the Unified Payments REST API (formerly known as GP-API or UCP). If you don't see your question below, contact Integration Support.
Yes. You can set the interval_to_expire or the seconds_to_expire in the access token create call. The default is 24 hours, or 86,399 seconds.
For steps on how to create an access token, see Access Tokens in API Definitions.
The default on our system is 24 hours. We recommend never to go over that.
The shorter the time period, the less risk associated with a compromised token being used to execute actions. Some merchant integrations use a per-transaction interval. Some replace it every 30 minutes for up to 24 hours. However, it's up to you to decide how long the access token should live.
Consider things like security requirements, customers, and the needs of your business. If you're unsure, we recommend setting it for 1 hour or less. Whatever interval you choose, it's important that your integration can automatically handle 401 Not Authenticated HTTP responses.
For specific steps using either direct API integration or our Hosted Fields solution, see our Browser Authentication for 3D Secure article.
Here's the basic flow:
Yes. Our Unified Payments REST API handles all versions of 3D Secure 2. This ensures that one integration works with whatever version is used in your region.
For more information, see our 3D Secure & SCA - Overview article.
An account defines a configured capability a merchant has when using our API. Some examples of capabilities include Transaction Processing, Tokenization, Dispute Management, and Settlement Reporting.
The account_name field defines the merchant's API configuration capability and identifies what data the API request can access.
Some examples of account_name field values include:
transaction_processingtokenizationdispute_managementsettlement_reportingHere's how we define the two:
You can implement Dispute Management actions via the API to challenge, accept, and report on all your disputes. For more information, see our Disputes Management article.
Settled disputes and active disputes originate from different accounts. Therefore, the API endpoint and response structure is slightly different.
We're happy to help you move from our Sandbox to Production. But first, there's some information we'll need from you:
Once you've provided us with the above information, we'll take a look at your Sandbox activity. If everything looks good on your side and passes our validation checks, we'll create API Production credentials for you and will be in touch to exchange them. In most cases, you'll hear back from us within 24 hours.
First, you'll need to fill out a Merchant Service Agreement with us, which will enable you to get paid for transactions successfully processed via the API.
To get started, visit our main website: https://www.globalpaymentsinc.com/
Your integration will be validated based on the features you need. Once validation passes, we'll contact you to exchange Production credentials. In most cases, you'll hear back from us within 24 hours.
If you're coding to implement customer-present transactions, please email certintake@globalpay.com to let us know.
First, congratulations on going live (or at least planning to)!
Second, you'll need to do a little testing in Production and process a real transaction. Confirm that your integration works as expected and also that the merchant's funds are deposited into the correct bank account.
No. It's not possible for us to retrieve settlement data from another bank. You'll need to use us as your Acquirer if you want to use this feature.
In Sandbox, the settlement data is delivered via a standalone test harness, and reporting doesn't generate from integration activity. In other words, the transactions you execute in Sandbox aren't batched and flagged for settlement. However, the data does reflect Production.
Here's how we define the two:
We've included a list of field definitions on this Developer Portal in the API Explorer (see API Definitions).
We've included a list of request and response parameters in the payload of each of the APIs in the API Explorer.
Most likely it's because you're using Sandbox and not Production. In Sandbox, the transactions are available via the Reporting API but not the portal. However, once an integration goes live, the transactions are available in the reporting portal.
See our answer in the Settlement Reporting section.