PHP download

Download the PHP package sunmi/sunbay-nexus-sdk-php without Composer

On this page you can find all versions of the php package sunmi/sunbay-nexus-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download sunmi/sunbay-nexus-sdk-php
More information about sunmi/sunbay-nexus-sdk-php
Files in sunmi/sunbay-nexus-sdk-php

Vendor sunmi
Package sunbay-nexus-sdk-php
Short Description Official PHP SDK for Sunbay Nexus Payment Platform
License MIT
Homepage https://github.com/sunbay-developer/sunbay-nexus-sdk-php

Keywords php payment sdk nexus sunbay

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of sunmi/sunbay-nexus-sdk-php

Informations about the package sunbay-nexus-sdk-php

Sunbay Nexus PHP SDK

Official PHP SDK for Sunbay Nexus Payment Platform

Current Version: 1.0.5

Features

✅ Simple and intuitive API
✅ PHP 8.1+ named arguments for clean, readable construction
✅ Fluent setter & Builder pattern also supported
✅ Automatic authentication
✅ Automatic retry for GET requests
✅ HTTP connection pool with configurable limits
✅ Comprehensive exception handling
✅ Minimal dependencies

Installation

Please visit https://packagist.org/packages/sunmi/sunbay-nexus-sdk-php to get the latest version.

Add the following to your composer.json:

Then run:

Quick Start

1. Initialize Client

The NexusClient is thread-safe and should be instantiated once and reused throughout your application's lifecycle. Each instance holds its own HTTP connection pool; creating a new client per request wastes connections and defeats connection reuse.

Builder pattern:

2. Sale Transaction

Important: All amount fields use the smallest currency unit (integer).
For example: 100.00 USD = 10000 cents.

API Methods

All request classes support named arguments (recommended), fluent setters, and Builder pattern.

Transaction APIs

sale(SaleRequest) - Sale transaction
auth(AuthRequest) - Authorization (pre-auth)
forcedAuth(ForcedAuthRequest) - Forced authorization
incrementalAuth(IncrementalAuthRequest) - Incremental authorization
postAuth(PostAuthRequest) - Post authorization (pre-auth completion)
refund(RefundRequest) - Refund
voidTransaction(VoidRequest) - Void transaction
abort(AbortRequest) - Abort transaction
tipAdjust(TipAdjustRequest) - Tip adjust

Query APIs

query(QueryRequest) - Query transaction

Settlement APIs

batchQuery(BatchQueryRequest) - Batch query
batchClose(BatchCloseRequest) - Batch close
batchCloseList(BatchCloseListRequest) - Query settled batch list

Merchant APIs

merchantQuery(MerchantQueryRequest) - Query merchant information
merchantTerminalsQuery(MerchantTerminalsQueryRequest) - Query merchant terminals (token-based pagination, max 100 per page)

Online Checkout APIs

createCheckoutSession(CreateCheckoutSessionRequest) - Create hosted payment page session
expireCheckoutSession(ExpireCheckoutSessionRequest) - Expire checkout session
checkoutSale(CheckoutSaleRequest) - Direct online checkout sale (Google Pay / Apple Pay)
onlineRefund(OnlineRefundRequest) - Online refund

Response Objects

All response objects extend BaseResponse and provide the following common methods:

isSuccess() - Check if the response is successful (code is "0"). Note: If code is not "0", a SunbayBusinessException will be thrown automatically, so you typically don't need to check this manually.
getCode() - Get response code
getMsg() - Get response message
getTraceId() - Get trace ID for troubleshooting

Important: The SDK automatically throws SunbayBusinessException when the API returns a non-zero code. If your code reaches the response handling without catching an exception, the response is guaranteed to be successful (code = "0").

Transaction responses (e.g., SaleResponse, AuthResponse) also provide:

getTransactionId() - Get transaction ID
getReferenceOrderId() - Get reference order ID
getTransactionRequestId() - Get transaction request ID

Exception Handling

The SDK throws two types of exceptions:

SunbayNetworkException: Network-related errors (connection timeout, network error, etc.)
SunbayBusinessException: Business logic errors (parameter validation, API business errors, etc.)

Always catch SunbayNetworkException before SunbayBusinessException:

Configuration

Logging

The SDK supports PSR-3 compatible loggers for recording HTTP requests and responses. You can use any PSR-3 compatible logging library:

Enums

The SDK provides type-safe enums for common payment-related values. These enums help prevent invalid values and provide better IDE support:

Available Enums

PaymentCategory - Payment method categories (CARD, CARD_CREDIT, CARD_DEBIT, QR_MPM, QR_CPM)
TransactionStatus - Transaction status codes returned by API (I=INITIAL, P=PROCESSING, S=SUCCESS, F=FAIL, C=CLOSED)
TransactionType - Transaction types (SALE, AUTH, FORCED_AUTH, INCREMENTAL, POST_AUTH, REFUND, VOID)
CardNetworkType - Card network types (CREDIT, DEBIT, EBT, EGC, UNKNOWN)
EntryMode - Card entry modes (MANUAL, SWIPE, FALLBACK_SWIPE, CONTACT, CONTACTLESS)
AuthenticationMethod - Authentication methods (NOT_AUTHENTICATED, PIN, OFFLINE_PIN, BY_PASS, SIGNATURE)
SignatureEntryLocation - Signature entry locations (ON_SCREEN, ON_RECEIPT)

Usage Example

Note:

While enums provide type safety, the SDK maintains backward compatibility with string values. You can continue using strings (e.g., "CARD") or use enums for better type safety.
For TransactionStatus, the API returns single-character codes (I, P, S, F, C) rather than full names. The enum values match these codes.

Requirements

PHP 8.1 or higher
Guzzle HTTP 7.5+
PSR-3 Logger (optional)

License

MIT License

All versions of sunbay-nexus-sdk-php with dependencies

PHP Build Version

Package Version

Version v1.0.6 Release 01. Sep 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of sunbay-nexus-sdk-php from vendor sunmi

Requires php Version ^8.1
guzzlehttp/guzzle Version ^7.5
psr/log Version ^3.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sunmi/sunbay-nexus-sdk-php contains the following files

Loading the files please wait ...