SDK API Reference
This document describes the public API surface exposed by payrails-ui-compose, including payment methods, configuration, styling, translations, and event delegates. For setup and dependencies, see README.md.
Looking for guides? Quick Start | Styling Guide | Troubleshooting | SDK Concepts
Table of Contents
- Getting Started
- Core Concepts
- Logging
- Card Payments
- Card Tokenization
- Google Pay
- Stored Instruments
- Results and Errors
Compatibility Requirements
- JDK 17
- Android
minSdk21 - Android
compileSdk35
Public Artifact
- Distributed via Maven Central
- Maven coordinate:
com.payrails.android:checkout:<version> - Additional dependency:
com.payrails.android:cse:<version>
Getting Started
Create a Session
Use a Configuration built from InitData plus optional Options.
Kotlin
val initData = InitData(version = "...", data = "...")
val configuration = Configuration(initData = initData, option = Options())
// Suspend API
val session = Payrails.createSession(configuration)
// Callback API
Payrails.createSession(configuration) { result ->
result.onSuccess { /* session ready */ }
result.onFailure { /* initialization failed */ }
}Java
// Java — use the callback API (suspend functions are not callable from Java)
InitData initData = new InitData("...", "...");
Configuration configuration = new Configuration(initData, new Options());
Payrails.createSession(configuration, result -> {
if (result.isSuccess()) {
Session session = result.getOrNull();
// session ready
} else {
// initialization failed
}
return kotlin.Unit.INSTANCE;
});To enable automatic SDK-managed recovery when a redirect flow is abandoned or remains non-terminal, pass onSessionExpired in Options.redirectSessionLifecycle:
val configuration = Configuration(
initData = initData,
option = Options(
redirectSessionLifecycle = RedirectSessionLifecycle(
onSessionExpired = {
// Merchant callback: run your client-init call and return fresh init payload
val refreshed = fetchInitPayloadFromBackend()
InitData(version = refreshed.version, data = refreshed.data)
}
)
)
)Session-Scoped Helpers
// Keep the returned session reference from createSession(...)
val instruments = Payrails.getStoredInstruments()
val cardInstruments = Payrails.getStoredInstruments(forType = PaymentMethod.card)Breaking change: Payrails.getCurrentSession() has been removed. Keep and pass the Session returned by createSession(...) when direct session APIs are needed.
Querying Session Data
Use Payrails.query() to read data from the active session.
Payrails.query(key)
Payrails.query(key)fun <T> query(key: PayrailsQuery<T>): TReturns the value for key from the active session, or null if no session is active
or the requested data is not present. Never throws.
| Parameter | Type | Description |
|---|---|---|
key | PayrailsQuery<T> | A typed query key from the PayrailsQuery sealed class. |
Example
val executionId: String? = Payrails.query(PayrailsQuery.ExecutionId)
val amount: PayrailsAmount? = Payrails.query(PayrailsQuery.Amount)
val cardConfig: PayrailsPaymentMethodConfig? =
Payrails.query(PayrailsQuery.PaymentMethodConfig("card"))PayrailsQuery<T>
PayrailsQuery<T>Sealed class of typed query keys for Payrails.query().
| Key | Return type | Description |
|---|---|---|
PayrailsQuery.ExecutionId | String? | ID of the active payment execution. |
PayrailsQuery.HolderReference | String? | Holder reference for the active session. |
PayrailsQuery.Amount | PayrailsAmount? | Current checkout amount. |
PayrailsQuery.BinLookup | PayrailsLink? | BIN lookup action link. |
PayrailsQuery.InstrumentDelete | PayrailsLink? | Stored instrument delete action link. |
PayrailsQuery.InstrumentUpdate | PayrailsLink? | Stored instrument update action link. |
PayrailsQuery.PaymentMethodConfig(code) | PayrailsPaymentMethodConfig? | Config for the given payment method code. |
PayrailsQuery.PaymentMethodInstruments(code) | List<StoredInstrument>? | Stored instruments for the given payment method code. |
All keys return null when no session is active.
PayrailsAmount
PayrailsAmountdata class PayrailsAmount(
val value: String,
val currency: String
)Represents the current checkout amount. value is the amount in wire format (e.g.
"54.99"), consistent with AmountUpdate.value. currency is the ISO 4217 code
(e.g. "EUR").
PayrailsLink
PayrailsLinkdata class PayrailsLink(
val href: String?,
val method: String?
)A backend action link. href is the URL to call; method is the HTTP method (e.g.
"POST", "DELETE"). Either field may be null if not provided by the backend.
PayrailsPaymentMethodConfig
PayrailsPaymentMethodConfigdata class PayrailsPaymentMethodConfig(
val paymentMethodCode: String,
val description: String?,
val displayName: String?,
val flow: String?,
val supportsSaveInstrument: Boolean?,
val supportsBillingInfo: Boolean?
)Configuration for a payment method from the active session. All fields except
paymentMethodCode are optional and sourced from the session payload.
Updating Session State
Use Payrails.update() to change the checkout amount after createSession() has
completed, without reinitialising the session.
Payrails.update(changes)
Payrails.update(changes)fun update(changes: PayrailsUpdate)Updates in-memory session state. No network request is made. The updated values take
effect on the next pay() call.
| Parameter | Type | Description |
|---|---|---|
changes | PayrailsUpdate | Container of optional updates. Fields set to null are ignored. |
Throws
| Exception | When |
|---|---|
IllegalStateException | Called before createSession() completes or after the session is destroyed. |
IllegalArgumentException | changes.amount is non-null and AmountUpdate.value is not a valid positive number string. |
Example
Payrails.update(
PayrailsUpdate(
amount = AmountUpdate(value = "54.98", currency = "EUR")
)
)
cardPaymentButton.pay() // uses the updated amountPayrailsUpdate
PayrailsUpdatedata class PayrailsUpdate(
val amount: AmountUpdate? = null
)Container for session updates passed to Payrails.update(). Each field is optional —
null means "leave unchanged". Additional fields may be added in future SDK versions
without breaking existing call sites.
| Field | Type | Description |
|---|---|---|
amount | AmountUpdate? | New checkout amount, or null to leave unchanged. |
AmountUpdate
AmountUpdatedata class AmountUpdate(
val value: String,
val currency: String
)Represents a new checkout amount. Both fields are required when updating the amount.
| Field | Type | Description |
|---|---|---|
value | String | New amount as a numeric string (e.g. "49.99"). Must be a valid positive number. |
currency | String | ISO 4217 currency code (e.g. "EUR", "USD"). Passed to the backend without format validation — invalid codes cause payment errors at execution time. |
Note on
valueformat: The SDK validates thatvalueis parseable as a positive number but does not reformat it. Pass the string in the exact format expected by your backend (e.g."49.99", not"4999").
Core Concepts
Payment Methods
PaymentMethod supports:
PaymentMethod.cardPaymentMethod.googlePayPaymentMethod.payPalPaymentMethod.genericRedirect
Card and Google Pay flows are creatable via Payrails factories.
Options
Options configures SDK behavior:
env: Env—Env.PRODUCTION(default) orEnv.TESTcollectMetadata: Boolean— whether the SDK collects client context metadata (defaulttrue)redirectSessionLifecycle: RedirectSessionLifecycle— configures automatic session recovery
Redirect Session Lifecycle (onSessionExpired)
onSessionExpired)onSessionExpired is configured once through Options.redirectSessionLifecycle and is shared for redirect-capable flows (3DS now, other redirect methods in future). The callback should run the merchant client-init call and return fresh InitData.
Behavior:
- Triggered when redirect reconciliation is classified as abandoned or stuck non-terminal.
- If callback is configured and succeeds, SDK refreshes active session/execution state automatically.
- If callback is missing/fails/returns invalid data, SDK does not continue the stale execution.
- Current payment attempt still resolves through standard failure handling (
authorizationFailedpath).
Client Context Metadata
The SDK collects client context and attaches it to authorize requests under meta.clientContext by default.
Collected fields:
osType(android)userAgentacceptHeaderlanguagescreenHeightscreenWidthcolorDepthtimeZoneOffsetjavaEnabledjavaScriptEnabled
Opt-out:
val configuration = Configuration(
initData = initData,
option = Options(collectMetadata = false)
)Request Headers
The SDK attaches the following headers to every API request:
| Header | Value | Description |
|---|---|---|
x-client-version | SDK version (e.g. 2.1.0) | Automatically set from the version defined in gradle.properties |
x-client-type | android-sdk | Identifies the SDK platform |
x-idempotency-key | UUID | Unique per request, prevents duplicate processing |
Authorization | Bearer <token> | Session token from init data |
The x-client-version value is generated at build time from gradle.properties (sdk.version) and compiled into the SDK as an internal constant. Merchants do not need to configure it.
Logging
The SDK uses an internal logging system with two output channels:
- In-memory log store — Always active. The SDK maintains an in-memory buffer of the last 500 log entries (with timestamps). This is used by the built-in debug viewer (
DebugManager). - Logcat — Suppressed by default. Logcat output under the tag
PayrailsSDKis gated behindLog.isLoggable(), so it produces no Logcat output unless explicitly enabled.
Enabling Logcat Output
To enable SDK debug logs in Logcat, run:
adb shell setprop log.tag.PayrailsSDK DEBUGThis persists until the device reboots. After enabling, filter Logcat by the PayrailsSDK tag:
adb logcat -s PayrailsSDK:DTo disable again:
adb shell setprop log.tag.PayrailsSDK INFODefault State
| Channel | Default | When active |
|---|---|---|
In-memory (LogStore) | Always on | Used by debug viewer; last 500 entries |
Logcat (PayrailsSDK tag) | Off | Only when Log.isLoggable("PayrailsSDK", Log.DEBUG) returns true |
Security
The SDK never logs raw card data, tokens, or PII through its logging system. Log messages contain only operational information (e.g., payment flow steps, error descriptions).
Card Payments
CardForm + CardPaymentButton
Create a CardForm, then a CardPaymentButton. Elements are decoupled and composed explicitly.
Kotlin/Compose only. Element creation and
Render()calls require Kotlin and Jetpack Compose. The delegate callbacks below are Java-compatible.
Kotlin
val cardForm = Payrails.createCardForm(
config = CardFormConfig(
showCardHolderName = true,
showStoreInstrumentCheckbox = true
)
)
val payButton = Payrails.createCardPaymentButton(
translations = CardPaymenButtonTranslations(label = "Pay Now")
)
payButton.delegate = object : PayrailsCardPaymentButtonDelegate {
override fun onPaymentButtonClicked(button: CardPaymentButton) {}
override fun onAuthorizeSuccess(button: CardPaymentButton) {}
override fun onThreeDSecureChallenge(button: CardPaymentButton) {}
override fun onAuthorizeFailed(button: CardPaymentButton) {}
}
// In Compose
cardForm.Render()
payButton.Render()Java — setting the delegate
payButton.setDelegate(new PayrailsCardPaymentButtonDelegate() {
@Override
public void onPaymentButtonClicked(CardPaymentButton button) {}
@Override
public void onAuthorizeSuccess(CardPaymentButton button) {}
@Override
public void onThreeDSecureChallenge(CardPaymentButton button) {}
@Override
public void onAuthorizeFailed(CardPaymentButton button) {}
});Order does not matter. If CardPaymentButton is created before CardForm, creating CardForm later will auto-attach it to the current button (web-sdk-aligned behavior).
Behavior model (aligned with web-sdk):
- Form mode: if no stored instrument is selected, the button validates/collects card form data, then authorizes.
- Stored-instrument mode: if a stored instrument is selected, the button authorizes with that instrument and bypasses card form collection/validation.
- Form interaction reset: if the user focuses/edits card fields, the selected stored instrument is cleared and button behavior returns to form mode.
- Guardrail: if no stored instrument is selected and no card form is attached, payment does not proceed and the button emits authorization failure.
3DS redirect behavior:
- The SDK opens 3DS URLs in a Custom Tab when available, falling back to the system browser.
- On app return, the SDK polls execution status until terminal success/failure or expiry classification.
- If status remains non-terminal through reconciliation window, SDK emits authorization failure and runs
onSessionExpiredcallback (if configured). - On terminal success/failure, SDK performs best-effort Custom Tab close/return-to-app handling.
- Avoid using WebView for 3DS challenge pages (issuer/ACS compatibility issues, reduced isolation, unreliable deep-link returns).
CardForm Configuration
CardFormConfig controls visibility and behavior:
showCardHolderName: BooleanshowStoreInstrumentCheckbox: BooleanshowSingleExpiryDateField: Booleanlayout: List<List<CardFieldType>>?alwaysStoreInstrument: BooleandefaultStoreInstrumentState: DefaultStoreInstrumentState(checked|unchecked)events: CardFormEvents?(onFocus,onChange,onReady,onSaveInstrumentCheckboxChanged)showCardIcon: Boolean(renders built-in Payrails network icons and default field icons)cardIconAlignment: CardIconAlignment(leftorright)cardFieldIcons: CardFieldIcons?(custom icon URLs per field; overrides defaults when provided)styles: CardFormStylesConfig?translations: CardTranslations?
Use CardFormConfig.defaultConfig as a baseline.
Payrails.createCardForm(...) reads save-instrument visibility only from CardFormConfig.showStoreInstrumentCheckbox; there is no separate standalone visibility argument on createCardForm(...).
Migration rules:
defaultStoreInstrumentStatedefaults tounchecked. Visibility no longer implies a checked state.alwaysStoreInstrument = trueforces submission behavior to store the instrument regardless of toggle state.
Card Form Layout Options
CardFormConfig also supports label placement and field variant:
labelPlacement: LabelPlacement—FLOATING(default) orABOVE. WhenABOVE, labels render as separateTextcomposables above each field instead of floating inside the text field.labelSpacing: Dp?— spacing between label and field whenlabelPlacement = ABOVE. Default:4.dp.fieldVariant: FieldVariant—OUTLINED(default) orFILLED.OUTLINEDusesOutlinedTextField(full border);FILLEDusesTextField(background fill with bottom indicator).
Card Form Styles
CardFormStylesConfig lets you style the wrapper, fields, labels, and errors. Key types:
CardWrapperStyleCardFieldSpecificStylesCardStyle(alias ofStyle)
Card Form Spacing Tokens
CardFormStylesConfig exposes spacing tokens that replace previously hardcoded layout values:
| Property | Type | Default | Description |
|---|---|---|---|
rowSpacing | Dp? | 12.dp | Vertical spacing between form rows |
fieldSpacing | Dp? | 12.dp | Horizontal spacing between fields in a row |
errorSpacing | Dp? | 4.dp | Spacing between a field and its error message (only rendered when an error is present) |
contentPadding | PaddingValues? | PaddingValues(16.dp) | Outer padding of the card form |
fieldHeight | Dp? | wrap content | Explicit height for text fields |
All tokens are nullable. When null, the hardcoded default is used.
Card Translations
CardTranslations provides:
placeholders: CardTranslations.Placeholderslabels: CardTranslations.Labelserror: CardTranslations.ErrorMessages
Each map is keyed by CardFieldType (alias of ElementType).
Network-Aware State
The card form exposes network-aware metadata derived from the card number:
cardNetwork: CardNetwork(visa, mastercard, amex, discover, unknown)bin: String(policy-driven: first 6 or 8 digits based on card network and PAN length; empty until sufficient digits are entered)cvvMaxLength: Int
Field accessory behavior:
- Card number: when
showCardIconis enabled, the SDK shows the detected network icon (e.g., Visa, Mastercard). When no network is detected, a default card icon is shown (ic-card.png). Card number does not switch to the clear affordance. - CVV: when
showCardIconis enabled, the field shows a default CVV icon (ic-cvv.png) while empty. When populated, it shows a clear affordance regardless ofshowCardIcon. - Expiry date: when
showCardIconis enabled, the field shows a default expiration icon (ic-expiration.png) while empty. When populated, it shows a clear affordance regardless ofshowCardIcon. - Split expiry month/year: when
showCardIconis enabled, both fields show the default expiration icon while empty. When populated, each field switches to a clear affordance independently regardless ofshowCardIcon. - Cardholder name: has no default empty-state icon, but still shows a clear affordance while populated regardless of
showCardIcon. Merchants can add a custom empty-state icon viacardFieldIcons.cardholderNamewhenshowCardIconis enabled.
All default icons are loaded from the Payrails assets CDN. Merchants can override any default icon — or add a cardholder name icon — by providing custom URLs via cardFieldIcons:
CardFormConfig(
showCardIcon = true,
cardFieldIcons = CardFieldIcons(
cardholderName = "https://example.com/my-name.png", // adds a custom cardholder icon (no default)
cardNumber = "https://example.com/my-card.png", // replaces default card icon (network icons still show when detected)
cvv = "https://example.com/my-cvv.png", // replaces default CVV icon
expiryDate = "https://example.com/my-expiry.png" // replaces default expiry icon
)
)CardFieldIcons fields:
cardholderName: String?— custom icon URL for the empty cardholder name field whenshowCardIconis enabled. No default icon exists; when populated, the field shows the clear affordance instead.cardNumber: String?— custom icon URL for the card number field when no network is detected. Once a network is detected, the network icon takes precedence.cvv: String?— custom empty-state icon URL for the CVV field whenshowCardIconis enabled.expiryDate: String?— custom empty-state icon URL for the expiration date field(s), including split expiry month/year fields, whenshowCardIconis enabled.
Icon placement follows cardIconAlignment (left or right).
BIN length policy (PCI SSC FAQ 1091 aligned):
- 15-digit PANs (Amex): 6-digit BIN
- 16-digit PANs (Visa/Mastercard/Discover): 8-digit BIN
- 17–19 digit PANs or unknown networks: 6-digit BIN
Migration note: if your integration assumes a fixed 8-digit BIN, update routing/lookup logic to accept 6-digit BINs when provided. Do not infer or pad BIN length; rely on the SDK's bin value.
Card Payment Button Translations
CardPaymenButtonTranslations(label: String?) sets the pay button text.
Card Payment Button Styling
Button appearance is configured on the button component (for example via createCardPaymentButton(buttonStyle = ...)). CardFormStylesConfig no longer includes button styling.
Migration note: If you previously set CardFormStylesConfig.buttonStyle, move that styling to the button API (createCardPaymentButton(buttonStyle = ...)).
Migration note: CardPaymentButton no longer exposes instrument-specific style/translation buckets. Keep one button settings surface and configure stored-instrument list/item UI in StoredInstrumentsStyle / StoredInstrumentsTranslations.
CardButtonStyle is applied in CardPaymentButton.Render for:
backgroundColor,textColorcornerRadiusborderWidth,borderColorcontentPaddingfontheight,fillMaxWidthdisabledStyle,loadingStyle(state-variant styles)loadingIndicatorColor
Additional design tokens:
| Property | Type | Default | Description |
|---|---|---|---|
loadingIndicatorSize | Dp? | 20.dp | Diameter of the loading spinner |
loadingIndicatorStrokeWidth | Dp? | 2.dp | Stroke width of the loading spinner |
elevation | Dp? | Material3 default | Button elevation (shadow depth) |
opacity | Float? | 1.0f | Button opacity (0.0 = transparent, 1.0 = opaque) |
minHeight | Dp? | Material3 default (40.dp) | Minimum button height |
These tokens participate in state-variant merging (disabledStyle, loadingStyle).
Stored Instrument Card Button
Single instrument mapping:
val cardForm = Payrails.createCardForm()
val button = Payrails.createCardPaymentButton(
translations = CardPaymenButtonTranslations("Pay")
)
button.setStoredInstrument(instrument)Coupled Wrappers (Breaking Change)
CardPaymentFormhas been removed from the element API.StoredInstrumentPaymentButtonhas been removed. UseCardPaymentButton+setStoredInstrument(...).- The
createCardPaymentButton(storedInstrument = ...)overload has been removed. Create the button first, then callsetStoredInstrument(...). createStoredInstruments()andcreateStoredInstrumentView()have been removed. UsegetStoredInstruments()to retrieve instruments andCardPaymentButton.setStoredInstrument(...)to pay with them.- Migrate to explicit composition with
CardForm+CardPaymentButton.
Card Tokenization
Save a card to the Payrails vault without initiating a payment. The tokenize flow encrypts card data using CSE, POSTs it to the vault endpoint from vaultConfiguration.links.saveInstrument, and returns a SaveInstrumentResponse containing an instrument ID for future use.
Requires vault configuration. The session init payload must include
vaultConfigurationwith asaveInstrumentlink. Contact Payrails to enable this for your merchant account.
CardForm.tokenize(options?)
CardForm.tokenize(options?)Validates the card form, encrypts the card data, and saves the instrument to the vault.
suspend fun tokenize(options: TokenizeOptions = TokenizeOptions()): SaveInstrumentResponseParameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
options | TokenizeOptions | No | TokenizeOptions() | Controls storage behavior and signals intended future use to the card network |
Returns: SaveInstrumentResponse — the saved instrument record including id, status, and card metadata.
Throws
PayrailsError.invalidCardData— card form validation failed; field errors are shown automatically on the formPayrailsError.missingData("Session is required for tokenization.")—CardFormwas created without an active sessionPayrailsError.missingData("Vault configuration with providerConfigId is required...")— session init payload is missingvaultConfigurationPayrailsError.missingData("holderReference is required...")— session init payload is missingholderReference
Example
val response = cardForm.tokenize(
options = TokenizeOptions(
storeInstrument = true,
futureUsage = FutureUsage.CardOnFile
)
)
val instrumentId = response.idTokenizeOptions
TokenizeOptionsOptions controlling card vault behavior during tokenization.
data class TokenizeOptions(
val storeInstrument: Boolean = false,
val futureUsage: FutureUsage = FutureUsage.CardOnFile
)| Property | Type | Default | Description |
|---|---|---|---|
storeInstrument | Boolean | false | Whether to persist the instrument for repeated future use after tokenization |
futureUsage | FutureUsage | FutureUsage.CardOnFile | Signals the intended future use of this card to the card network |
FutureUsage
FutureUsageEnum signaling intended future card use to the card network. Sent as part of the vault request.
enum class FutureUsage(val value: String) {
CardOnFile("CardOnFile"),
Subscription("Subscription"),
UnscheduledCardOnFile("UnscheduledCardOnFile")
}| Value | Description |
|---|---|
CardOnFile | Customer-initiated payments where the cardholder is present at checkout |
Subscription | Recurring charges on a fixed schedule authorized by the cardholder |
UnscheduledCardOnFile | Merchant-initiated charges with no fixed schedule (e.g., top-ups, threshold billing) |
SaveInstrumentResponse
SaveInstrumentResponseResponse returned by tokenize(). Represents the saved instrument record from the vault.
@Serializable
data class SaveInstrumentResponse(
val id: String,
val createdAt: String,
val holderId: String,
val paymentMethod: String,
val status: String,
val data: InstrumentResponseData,
val fingerprint: String? = null,
val futureUsage: String? = null
)| Property | Type | Nullable | Description |
|---|---|---|---|
id | String | No | Instrument identifier; use for future payments and instrument management |
createdAt | String | No | ISO 8601 timestamp of instrument creation |
holderId | String | No | Payrails holder ID associated with this instrument |
paymentMethod | String | No | Always "card" for card tokenization |
status | String | No | Instrument lifecycle status (e.g., "active") |
data | InstrumentResponseData | No | Card presentation data (BIN, suffix, network, etc.) |
fingerprint | String? | Yes | Card fingerprint for deduplication across instruments |
futureUsage | String? | Yes | Future use value as recorded by the vault |
SaveInstrumentResponse.InstrumentResponseData
SaveInstrumentResponse.InstrumentResponseData| Property | Type | Nullable | Description |
|---|---|---|---|
bin | String? | Yes | Card BIN (first digits, per PCI SSC BIN length policy) |
binLookup | BinLookup? | Yes | Enriched BIN metadata including network, issuer, and issuer country when available |
suffix | String? | Yes | Card last digits |
network | String? | Yes | Card network identifier (e.g., "visa", "mastercard") |
holderName | String? | Yes | Cardholder name as entered in the card form |
expiryMonth | String? | Yes | Two-digit expiry month |
expiryYear | String? | Yes | Two or four-digit expiry year |
InstrumentAPIResponse.save
InstrumentAPIResponse.saveThe save variant of the InstrumentAPIResponse sealed class, returned when using lower-level instrument API calls. CardForm.tokenize() returns SaveInstrumentResponse directly rather than wrapping it.
sealed class InstrumentAPIResponse {
data class delete(val response: DeleteInstrumentResponse) : InstrumentAPIResponse()
data class update(val response: UpdateInstrumentResponse) : InstrumentAPIResponse()
data class save(val response: SaveInstrumentResponse) : InstrumentAPIResponse()
}Google Pay
GooglePayButton
Create a GooglePayButton after initializing a session. The button handles Google Pay availability checks, payment sheet presentation, and authorization automatically.
Kotlin/Compose only. Element creation and
Render()require Kotlin and Jetpack Compose. The delegate callbacks below are Java-compatible.
Kotlin
val googlePayButton = Payrails.createGooglePayButton(
style = GooglePayButtonStyle(),
translations = GooglePayButtonTranslations(),
showStoreInstrumentCheckbox = false
)
googlePayButton.delegate = object : PayrailsGooglePayButtonDelegate {
override fun onGooglePayAvailable(button: GooglePayButton) {
// Google Pay is supported on this device
}
override fun onPaymentButtonClicked(button: GooglePayButton) {
// User tapped the Google Pay button
}
override fun onAuthorizeSuccess(button: GooglePayButton) {
// Payment succeeded
}
override fun onThreeDSecureChallenge(button: GooglePayButton) {
// 3DS challenge started
}
override fun onAuthorizeFailed(button: GooglePayButton) {
// Payment failed
}
}
// In Compose
googlePayButton.Render()Java — setting the delegate
googlePayButton.setDelegate(new PayrailsGooglePayButtonDelegate() {
@Override
public void onGooglePayAvailable(GooglePayButton button) {}
@Override
public void onPaymentButtonClicked(GooglePayButton button) {}
@Override
public void onAuthorizeSuccess(GooglePayButton button) {}
@Override
public void onThreeDSecureChallenge(GooglePayButton button) {}
@Override
public void onAuthorizeFailed(GooglePayButton button) {}
});The button is hidden by default and becomes visible only after isReadyToPay() succeeds. The onGooglePayAvailable callback fires when the button becomes visible.
Google Pay Configuration
Google Pay configuration is provided by the Payrails backend through paymentCompositionOptions. The SDK reads clientConfig.additionalConfig for the Google Pay payment option, which contains:
apiVersion/apiVersionMinor— Google Pay API version (defaults to2/0)allowedPaymentMethods— Payment methods array includingtokenizationSpecification(gateway configuration)merchantInfo— Merchant identifier and name (required in production)emailRequired— Whether to request the payer's emailshippingAddressRequired/shippingAddressParameters— Shipping address collection
The countryCode for transactionInfo is extracted from meta.order.billingAddress.country.code in the execution metadata.
No client-side configuration of gateway credentials is needed. The PAYMENT_GATEWAY, gateway, and gatewayMerchantId values are provided by the backend.
GooglePayButtonStyle
GooglePayButtonStyle controls the button appearance:
| Property | Type | Default | Description |
|---|---|---|---|
buttonTheme | ButtonTheme | Dark | Google Pay button theme (Dark or Light) |
buttonType | ButtonType | Pay | Button label type (Buy, Pay, Checkout, Donate, Order, Plain, Subscribe) |
cornerRadius | Dp | 100.dp | Button corner radius |
containerPadding | PaddingValues? | null | Padding around the button container |
containerBackgroundColor | Color? | null | Background color behind the button |
GooglePayButtonTranslations
GooglePayButtonTranslations provides:
storeInstrument: String?— Checkbox label text whenshowStoreInstrumentCheckboxis enabled. Defaults to"Save this payment method".
PayrailsGooglePayButtonDelegate
| Callback | When it fires |
|---|---|
onGooglePayAvailable(button) | isReadyToPay() succeeded; button is now visible |
onPaymentButtonClicked(button) | User tapped the button; payment sheet is about to open |
onAuthorizeSuccess(button) | Payment authorized successfully |
onThreeDSecureChallenge(button) | 3DS challenge started (Custom Tab opened) |
onAuthorizeFailed(button) | Payment failed or was rejected |
onStateChanged(button, state) | Button state changed (ENABLED, DISABLED, LOADING). Optional — default no-op. |
Store Instrument Checkbox
Pass showStoreInstrumentCheckbox = true to createGooglePayButton(...) to render a checkbox below the Google Pay button. When checked, the payment token is stored as an instrument for future use.
val googlePayButton = Payrails.createGooglePayButton(
showStoreInstrumentCheckbox = true,
translations = GooglePayButtonTranslations(storeInstrument = "Save for next time")
)3DS for Google Pay
If the authorize response requires 3DS verification, the SDK opens the challenge URL in a Custom Tab and polls for the terminal result, following the same 3DS flow used for card payments. The onThreeDSecureChallenge delegate callback fires when this happens.
PayPal and Redirect Methods
PayPal and generic redirect button factories are not part of the current public Payrails API surface in this build.
Stored Instruments
StoredInstrument Interface
Each StoredInstrument exposes:
| Property | Type | Description |
|---|---|---|
id | String | Instrument identifier |
email | String? | Email (PayPal instruments) |
description | String? | Legacy display string ("bin***suffix" for cards, email for PayPal) |
type | PaymentMethod | Instrument payment method |
displayName | String? | Server-provided display name (cards: custom name; PayPal: email) |
isDefault | Boolean | Whether this is the holder's default instrument |
cardMetadata | CardInstrumentMetadata? | Typed card details (non-null for cards, null for other types) |
The SDK maps the backend instrument field default to StoredInstrument.isDefault.
CardInstrumentMetadata
Public data class with typed card presentation data:
| Property | Type | Description |
|---|---|---|
bin | String? | Card BIN (first digits) |
suffix | String? | Card last digits |
network | String? | Card network (e.g., "visa", "mastercard") |
issuerCountry | String? | Issuing country code |
Migration note: prefer displayName and cardMetadata over parsing the description string. description remains available for backwards compatibility.
Retrieving Stored Instruments
Use Payrails.getStoredInstruments() to retrieve available instruments, then set one on the button:
Kotlin
val instruments = Payrails.getStoredInstruments()
val cardInstruments = Payrails.getStoredInstruments(forType = PaymentMethod.card)
// Set a stored instrument on the card payment button
payButton.setStoredInstrument(cardInstruments.first())Java
List<StoredInstrument> instruments = Payrails.getStoredInstruments(null);
List<StoredInstrument> cardInstruments = Payrails.getStoredInstruments(PaymentMethod.card);
payButton.setStoredInstrument(cardInstruments.get(0));Instrument Management APIs
Use Payrails.api(...) to delete or update stored instruments:
// Delete an instrument
val deleteResult = Payrails.api("deleteInstrument", instrumentId)
// Update an instrument
val updateResult = Payrails.api(
"updateInstrument",
instrumentId,
UpdateInstrumentBody(default = true)
)The return type is InstrumentAPIResponse, a sealed class with delete, update, and save variants. See Card Tokenization for the save variant and the tokenize() methods.
Results and Errors
Payment results are surfaced through delegate interfaces:
Card payments — PayrailsCardPaymentButtonDelegate:
onAuthorizeSuccess— payment succeededonAuthorizeFailed— payment failed (includes session-expiry outcomes from redirect reconciliation)onThreeDSecureChallenge— 3DS challenge startedonPaymentButtonClicked— button was tapped
Google Pay — PayrailsGooglePayButtonDelegate:
onAuthorizeSuccess— payment succeededonAuthorizeFailed— payment failedonThreeDSecureChallenge— 3DS challenge startedonPaymentButtonClicked— button was tappedonGooglePayAvailable— Google Pay is ready on this device
authorizationFailed includes session-expiry outcomes from redirect reconciliation (for example browser abandoned/non-terminal timeout), including cases where automatic onSessionExpired recovery is attempted.
Errors are represented by PayrailsError (e.g., authenticationError, missingData).
Updated 8 days ago