SDK White Label Overview
ApoloSdk class.What is the SDK White Label
ApoloSdk.Builder.The SDK handles three areas that would otherwise demand significant effort from you:
- Terminal operation — the SDK drives the terminal hardware needed for a transaction.
- Payment-service communication — authentication, authorization, capture, and availability checks run inside the SDK.
- Ready-made flows — screens, transitions, error states, and cardholder messages ship as a package, with defined extension points.
Because it depends on hardware and services that exist only on POS devices, the SDK does not run on emulators, virtual machines, or ordinary Android phones.
How it works
A typical integration moves through four moments:
- Initialization — you configure the SDK once, during your application's startup.
- Warm-up — the SDK loads the terminal configuration and authenticates with the payment services, reporting progress back to your app.
- Operation — after warm-up succeeds, your app starts a sale, refund, or print.
- Result — when the flow ends, the SDK returns a typed outcome through a callback.
Between the amount entry and the final result, the SDK runs the whole transaction internally.
A white-label experience
Each operation ships with the SDK's own screens, which guide the cardholder through the journey on the terminal. You can keep the ready-made screens or make them your own:
- Apply your brand colors through theme customization.
- Insert screens between existing steps of the flow.
- Replace the appearance of a screen while keeping its behavior.
- Customize the receipts printed for the establishment and the customer.
This lets the experience range from the SDK's default screens to a flow fully tailored to your application.
Where it fits
The SDK White Label runs on the terminal, on the client side. It depends on Getnet's terminal management service for two things: the configuration it loads during warm-up, and the credentials it authenticates with. Payments are then processed card-present through SEP.
Next steps
To start your integration, follow the path below:
- Prerequisites — confirm the environment, credentials, and terminal services you need before integrating.
- Add the SDK to your project — set up the dependency, permissions, and required terminal services.
- Quick Start — initialize the SDK and run your first sale.
- Process a sale — run each payment method and mode, then explore refunds, printing, and customization.
On this page