Download the PHP package globalpayments/php-sdk without Composer

GlobalPayments PHP SDK

This SDK makes it easy to integrate your PHP application with our Card Not Present and Card Present APIs.

Solutions

General / Omnichannel

• API Payment Processing
• Apple Pay & Google Pay
• Secure Card Storage & Customer Management
• Subscriptions / Recurring Billing Solutions
• Credit, Debit, Gift & Loyalty, and eCheck/ACH

Card Not Present (Ecommerce & MOTO) Specific

• Minimize PCI compliance requirements with Hosted Payment Solutions
• 140+ Authorization Currencies & 16 Settlement Currencies
• 150+ Local Payment Methods Worldwide
• Account Updater
• Inbuilt Fraud Prevention Rules
• 3D Secure, AVS and CVV Checks
• 260+ Global Enterprise Fraud Rules

Card Present (Terminal & POS) Specific

• Secure End-To-End Encryption

Requirements

• PHP 8.0.0+
• OpenSSL 1.0.1+
• PHP Curl extension
• PHP DOM extension
• PHP OpenSSL extension

Installation

Installing the SDK into your solution is usually be done by either using Composer/Packagist, or by adding the project to your solution and referencing it directly.

To install via Composer/Packagist:

To install via a direct download:

Download and unzip or, using Git, clone the repository from GitHub. See more on how to clone repositories.

Documentation and Examples

You can find the latest SDK documentation along with code examples and test cards on the GlobalPayments and GlobalPayments Developer Hubs.

In addition you can find working examples in the our example code repository.

Quick Tip: The included test suite can be a great source of code samples for using the SDK!

Process a Payment Example

GP-API Access Token

The SDK supports creating GP-API access tokens with full control over token configuration and complete response field mapping.

Generate an Access Token

GP-API 3DS Authentication Flow

The SDK supports the GP-API authentication /ucp/authentications.

Endpoint Sequence Covered

Flow 1 (create + initiate):

• POST /ucp/authentications
• POST /ucp/authentications/{id}/initiate

Flow 2 (list + result + single):

• GET /ucp/authentications
• GET /ucp/authentications/{id}/result
• GET /ucp/authentications/{id}

Account and Permission Notes

• Use an account with authentication permissions (for example account name transaction_processing).
• Required permissions typically include AUT_GET_List, AUT_GET_Single, AUT_POST_Initiate, and AUT_POST_Results.
• If permissions are missing, sandbox may return authorization errors such as ACTION_NOT_AUTHORIZED.

Integration Test Coverage

Authentication endpoint coverage is validated in integration tests:

• test/Integration/Gateways/GpApiConnector/GpApi3DSecureTest.php
• test/Integration/Gateways/GpApiConnector/GpApi3DS2Test.php

Run focused authentication tests:

Available Request Fields

Available Response Fields

GP-API Account Sync

The GP-API account reporting and edit flows now surface the full account list/detail envelope, including merchant context, paging metadata, and action metadata.

Supported account flows covered by this story:

• GET /accounts
• GET /accounts/{id}
• PATCH /accounts/{id}
• GET /merchants/{MER_id}/accounts/{FMA_id}

Newly surfaced request and response fields include:

• card_replacement_reason
• notifications.status_url
• processing_limits
• capabilities
• status_change_reason
• merchant_id
• merchant_name
• time_created
• time_last_updated
• email_id
• action

Implementation and coverage references:

• test/Integration/Gateways/GpApiConnector/GpApiMerchantAccountsTest.php
• gpapi-accounts-sync-report.html

Test Card Data

Testing Exceptions

During your integration you will want to test for specific issuer responses such as 'Card Declined'. Because our sandbox environments do not actually reach out to issuing banks for authorizations, there are specific transaction amounts and/or card numbers that will trigger gateway and issuing bank responses. Please contact your support representative for a complete listing of values used to simulate transaction AVS/CVV results, declines, errors, and other responses that can be caught in your code. Example error handling code:

GP-API Actions Reporting Example

Contributing

All our code is open sourced and we encourage fellow developers to contribute and help improve it!

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Ensure SDK tests are passing
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new Pull Request

License

This project is licensed under the GNU General Public License v2.0. Please see LICENSE.md located at the project's root for more details.