Install the iOS SDK library and start using components in your project.
Make sure you have Xcode 15.0 or later, iOS 14.0 or later as your deployment target, and Swift 5.9+.
To install using Swift Package Manager:
- Open your Xcode project.
- Go to File > Add Package Dependencies....
- Enter the repository URL:
https://github.com/PXP-IO/ios-components-sdk.git. - Select a version rule (e.g., Up to Next Major Version).
- Click Add Package.
- Select the PXPCheckoutSDK library and add it to your app target.
Add only the PXPCheckoutSDK library to your app target. Don't add other products from the same package — dependencies such as Kount, PayPal, and Aerosync are bundled inside PXPCheckoutSDK. Linking additional products can cause duplicate symbols and runtime crashes.
import PXPCheckoutSDKThe Paze and Aeropay button components are included in PXPCheckoutSDK. You don't need separate payment-method dependencies.
To initialise the SDK, you'll need to send authenticated requests to the PXP API.
To get your credentials:
- In the Unity Portal, go to Merchant setup > Merchant groups.
- Select a merchant group.
- Click the Inbound calls tab.
- Copy the Client ID in the top-right corner.
- Click New token.
- Choose a number of days before token expiry. For example,
30. - Click Save to confirm. Your token is now created.
- Copy the token ID and token value. Make sure to keep these confidential to protect the integrity of your authentication process.
As best practice, we recommend regularly generating and implementing new tokens.
Now that you have your credentials, you're ready to send an API request to the sessions endpoint. This allows you to retrieve the transaction session data from the back-end, so you can supply it when you initialise the SDK.
Our platform uses HMAC (Hash-based Message Authentication Code) with SHA256 for authentication to ensure secure communication and data integrity. This method involves creating a signature by hashing your request data with a secret key, which must then be included in the HTTP headers of your API request.
To create the HMAC signature, you need to prepare a string that includes four parts:
- A timestamp, in Unix format. For example,
1754701373. - A unique request ID, in GUID format. For example,
ce244054-b372-42c2-9102-f0d976db69f6. - The request path, which is
api/v1/sessions. - The request body. Include an
aeropayintent when Aeropay is enabled in the Unity Portal. UseUSDforamounts.currencyCode. Include only the payment-method intents you need. For example:{ "merchant": "MERCHANT-1", "site": "SITE-1", "sessionTimeout": 120, "merchantTransactionId": "0ce72cfd-014d-4256-a006-a56601b2ffc4", "amounts": { "currencyCode": "USD", "transactionValue": 20 }, "transactionMethod": { "intent": { "card": "Authorisation", "paypal": "Authorisation", "aeropay": "Authorisation" } } }
| Parameter | Description |
|---|---|
merchantstring (≤ 20 characters) required | Your unique merchant identifier, as assigned by PXP. You can find it in the Unity Portal, by going to Merchant setup > Merchants and checking the Merchant ID column or by clicking on a merchant and checking the General information section. |
sitestring (≤ 100 characters) required | Your unique site identifier, as assigned by PXP. You can find it in the Unity Portal, by going to Merchant setup > Sites and checking the Site ID column or by clicking on a site and checking the General information section. |
merchantTransactionIdstring (≤ 50 characters) required | A unique identifier of your choice that represents this transaction. |
sessionTimeoutnumber | Optional duration of the session, in minutes. If omitted, the server uses its default expiry. Values above 120 are ignored and the default is used instead. |
amountsobject required | Details about the transaction amount. |
amounts.currencyCodestring (3 characters) required | The currency code associated with the transaction, in ISO 4217 format. See Supported payment currencies. Use USD for Paze and Aeropay. |
amounts.transactionValuenumber required | The transaction amount. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent (e.g., GBP 1.234), or if a decimal is supplied when the currencyCode of the exponent does not require it (e.g., JPY 1.0). |
transactionMethodobject required | Details about the transaction method and intent. |
transactionMethod.intentobject required | The payment intent for each payment method type. |
transactionMethod.intent.cardstring | The intent for card, Apple Pay, or Paze transactions. Possible values:
|
transactionMethod.intent.paypalstring | The intent for PayPal transactions. Possible values:
|
transactionMethod.intent.aeropaystring | The intent for Aeropay transactions. Configure Aeropay in the Unity Portal first, then confirm the session response includes allowedFundingTypes.payByBanks.aeropay. See Aeropay onboarding.Possible values:
|
Put these four parts together following this format: "{timestamp}{requestId}{requestPath}{requestBody}". There are no separators between the parts. The {requestBody} portion must be the exact JSON bytes sent in the POST body (typically minified, with no extra whitespace or pretty-printing).
The resulting HMAC input is a single string. For example:
1754701373ce244054-b372-42c2-9102-f0d976db69f6api/v1/sessions{"merchant":"MERCHANT-1","site":"SITE-1","sessionTimeout":120,"merchantTransactionId":"0ce72cfd-014d-4256-a006-a56601b2ffc4","amounts":{"currencyCode":"USD","transactionValue":20},"transactionMethod":{"intent":{"card":"Authorisation","paypal":"Authorisation","aeropay":"Authorisation"}}}Compute an HMAC-SHA256 over that string using your token value (secret) as the key. Put the token ID, timestamp, and hex signature in the Authorization header as shown below. You can find your token ID and token value in the Unity Portal. Here's an example of an hmacSignature after you've signed the data:
1DE2DFC390D7CD746A972140F26846AFA81CF85F5A0BAABA95DBC95301795EA6You can now put together your Authorization header. It follows this format: PXP-UST1 {tokenId}:{timestamp}:{hmacSignature}. For example:
PXP-UST1 9aac6071-38d0-4545-9d2f-15b936af6d7f:1754701373:1DE2DFC390D7CD746A972140F26846AFA81CF85F5A0BAABA95DBC95301795EA6Lastly, send your request to the Sessions API. You'll need to add a request ID of your choice and include your client ID, which you can find in the Unity Portal.
Here's a full example of what your request might look like:
curl -i -X POST \
'https://api-services.pxp.io/api/v1/sessions' \
-H 'Authorization: PXP-UST1 9aac6071-38d0-4545-9d2f-15b936af6d7f:1754701373:1DE2DFC390D7CD746A972140F26846AFA81CF85F5A0BAABA95DBC95301795EA6' \
-H 'X-Request-Id: 550e8400-e29b-41d4-a716-446655440000' \
-H 'X-Client-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
-H 'Content-Type: application/json' \
-d '{
"merchant": "MERCHANT-1",
"site": "SITE-1",
"sessionTimeout": 120,
"merchantTransactionId": "0ce72cfd-014d-4256-a006-a56601b2ffc4",
"amounts": {
"currencyCode": "USD",
"transactionValue": 20
},
"transactionMethod": {
"intent": {
"card": "Authorisation",
"paypal": "Authorisation",
"aeropay": "Authorisation"
}
}
}'If your request is successful, you'll receive a 200 response containing the session data. After a successful request for Aeropay, confirm the response includes allowedFundingTypes.payByBanks.aeropay with non-empty externalMerchantId and configurationId (see the response table below).
{
"sessionId": "c5f0799b-0839-43ce-abc5-5b462a98f250",
"hmacKey": "904bc42395d4af634e2fd48ee8c2c7f52955a1da97a3aa3d82957ff12980a7bb",
"encryptionKey": "20d175a669ad3f8c195c9c283fc86155",
"sessionExpiry": "2025-05-19T13:39:20.3843454Z",
"allowedFundingTypes": {
"cards": [
"Visa",
"Diners",
"Mastercard",
"AmericanExpress"
],
"wallets": {
"paypal": {
"allowedFundingOptions": [
"paylater",
"paypal"
],
"merchantId": "ST9US6Q5XW2KN"
},
"applepay": {
"merchantId": "merchant.com.yourcompany.store"
},
"paze": {
"clientId": "your-paze-client-id",
"merchantCategoryCode": "5812"
}
},
"payByBanks": {
"aeropay": {
"externalMerchantId": "your-aeropay-merchant-id",
"configurationId": "your-aeropay-configuration-id"
}
}
},
"restrictions": {
"card": {
"ownerTypes": ["Consumer"],
"fundingSources": ["Credit", "Debit"]
}
}
}| Parameter | Description |
|---|---|
sessionIdstring (UUID) | The unique identifier for the newly-created session. |
hmacKeystring | The HMAC key generated for securing session communications. |
encryptionKeystring | A key used for encrypting sensitive session data during communication. |
sessionExpirystring | The timestamp indicating when the session will expire, in ISO 8601 format. |
allowedFundingTypesobject | Details about the funding types allowed for this session. Possible values:
|
allowedFundingTypes.cardsarray of strings or null | The list of supported card schemes. |
allowedFundingTypes.walletsobject or null | Details about the supported digital wallets. |
allowedFundingTypes.wallets.paypalobject or null | PayPal wallet configuration. |
allowedFundingTypes.wallets.paypal.allowedFundingOptionsarray of strings | The list of PayPal funding options available. Possible values:
|
allowedFundingTypes.wallets.paypal.merchantIdstring | The PayPal merchant ID associated with this session. |
allowedFundingTypes.wallets.applepayobject or null | Apple Pay wallet configuration. |
allowedFundingTypes.wallets.applepay.merchantIdstring | The Apple Pay merchant ID to be used for this session. |
allowedFundingTypes.wallets.pazeobject or null | Paze wallet configuration. Required for the Paze button component. Enable Paze in the Unity Portal first. See Paze onboarding. |
allowedFundingTypes.wallets.paze.clientIdstring | The Paze client ID from your Paze Account Settings in the Unity Portal. Missing or empty clientId causes SDK0118 at PxpCheckout.create(.pazeButton, …) (message: Paze is missing in allow funding types.). Validation during the Paze flow may also surface SDK1202 for the same field. |
allowedFundingTypes.wallets.paze.merchantCategoryCodestring | Merchant category code (MCC). Required when the SDK completes a Paze payment; missing values cause SDK1202A. |
allowedFundingTypes.payByBanksobject or null | Object containing pay-by-bank configurations. |
allowedFundingTypes.payByBanks.aeropayobject or null | Aeropay funding configuration. Required for the Aeropay button component. |
allowedFundingTypes.payByBanks.aeropay.externalMerchantIdstring | The Aeropay merchant ID from the Unity Portal. Missing or empty values cause SDK0113 when you create the component. The SDK message is generic (Aeropay is missing in allow funding types.), not field-specific. See Aeropay troubleshooting for distinguishing portal and session misconfiguration from missing intent, currency, or entry type (SDK0115, SDK0116, SDK0114). |
allowedFundingTypes.payByBanks.aeropay.configurationIdstring | The Aerosync configuration ID from the Unity Portal. Missing or empty values cause SDK0113 when you create the component, with the same generic funding-type message as for a missing aeropay block or empty externalMerchantId. |
restrictionsobject (optional) | Card restrictions such as ownerTypes and fundingSources. Pass through to SessionData when returned by your backend. |
Depending on which payment methods you plan to support, you'll need to configure your Xcode project accordingly.
- In Xcode, select your project target.
- Go to the
Signing & Capabilitiestab. - Click
+ Capabilityand add Apple Pay.
In the Apple Pay capability section, add your merchant ID:
- Click the
+button under Merchant IDs. - Enter your merchant ID (e.g.,
merchant.com.yourcompany.store). Ensure it matches exactly with your Apple Developer Console configuration.
Add the following entries to your Info.plist:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<false/>
<key>NSAllowsArbitraryLoadsInWebContent</key>
<false/>
</dict>To initialise the SDK, you need to pass the session data from Step 3 back to your iOS application, along with details about the environment, owner ID and type, merchant shopper ID, and transaction data.
Once the SDK is initialised, you can create payment components for your desired payment methods.
import UIKit
import SwiftUI
import PXPCheckoutSDK
class ViewController: UIViewController {
private var pxpCheckout: PxpCheckout?
private var applePayComponent: ApplePayButtonComponent?
override func viewDidLoad() {
super.viewDidLoad()
Task {
await initialiseTheSDK()
}
}
private func initialiseTheSDK() async {
do {
// 1. Get the session data from the back-end
let sessionData = try await getSessionDataFromBackend()
// 2. Create checkout configuration
let config = CheckoutConfig(
environment: .test,
session: sessionData,
transactionData: TransactionData(
amount: Decimal(25.00),
currency: "USD",
entryType: .ecom,
intent: TransactionIntentData(
card: .authorisation,
paypal: nil
),
merchantTransactionId: UUID().uuidString,
merchantTransactionDate: { Date() }
),
merchantShopperId: "Shopper_01",
ownerType: "merchantGroup",
ownerId: "Unity",
kountDisabled: false // OPTIONAL: Set to true to disable Kount fraud detection
)
// 3. Initialise the SDK
let pxpCheckoutSdk = try PxpCheckout.initialize(config: config)
self.pxpCheckout = pxpCheckoutSdk
setupApplePayComponent()
} catch {
showError("Failed to initialise SDK: \(error.localizedDescription)")
}
}
private func setupApplePayComponent() {
guard let pxpCheckout = pxpCheckout else { return }
// Create Apple Pay component configuration
let config = ApplePayButtonComponentConfig()
config.countryCode = "US"
config.currencyCode = "USD"
config.supportedNetworks = [.visa, .masterCard, .amex, .discover]
config.merchantCapabilities = [.threeDSecure]
config.buttonType = .buy
config.buttonStyle = .black
config.requiredBillingContactFields = [.postalAddress, .name, .emailAddress]
config.requiredShippingContactFields = [.postalAddress, .name, .phoneNumber]
// Required: Set the total payment amount
config.totalPaymentItem = ApplePayPaymentSummaryItem(
amount: Decimal(25.00),
type: .final,
label: "Your Store Name"
)
// Set up callbacks on config
config.onPreAuthorisation = { [weak self] in
self?.handlePreAuthorisation()
}
config.onPostAuthorisation = { [weak self] submitResult, applePayResult in
self?.handlePostAuthorisation(submitResult: submitResult, applePayResult: applePayResult)
}
config.onError = { [weak self] error in
self?.showError("Apple Pay error: \(error.errorMessage)")
}
config.onCancel = { [weak self] error in
print("Apple Pay cancelled: \(error.errorMessage)")
}
// Create the component and host the SwiftUI button in UIKit
do {
let component = try pxpCheckout.create(.applePayButton, componentConfig: config)
applePayComponent = component as? ApplePayButtonComponent
if let buttonView = applePayComponent?.buildContent() {
let host = UIHostingController(rootView: buttonView)
addChild(host)
view.addSubview(host.view)
host.view.translatesAutoresizingMaskIntoConstraints = false
NSLayoutConstraint.activate([
host.view.leadingAnchor.constraint(equalTo: view.leadingAnchor, constant: 16),
host.view.trailingAnchor.constraint(equalTo: view.trailingAnchor, constant: -16),
host.view.centerYAnchor.constraint(equalTo: view.centerYAnchor),
host.view.heightAnchor.constraint(equalToConstant: 50),
])
host.didMove(toParent: self)
}
} catch {
showError("Failed to create Apple Pay component: \(error.localizedDescription)")
}
}
private func handlePreAuthorisation() -> ApplePayTransactionInitData? {
return ApplePayTransactionInitData(
riskScreeningData: RiskScreeningData(
performRiskScreening: true,
userIp: "192.168.1.100",
account: RiskScreeningAccount(
id: "user_12345678",
creationDateTime: ISO8601DateFormatter().date(from: "2024-01-15T10:30:00Z")
),
items: [
RiskScreeningItem(
price: Decimal(25.00),
quantity: 1,
category: "General"
)
],
fulfillments: [
RiskScreeningFulfillment(
type: .shipped,
recipientPerson: RiskScreeningRecipientPerson(
phoneNumber: "+1234567890"
)
)
]
)
)
}
private func handlePostAuthorisation(submitResult: BaseSubmitResult, applePayResult: ApplePayResult) {
if let merchantResult = submitResult as? MerchantSubmitResult {
print("Payment success: \(merchantResult.systemTransactionId)")
// Handle successful payment
} else if let failedResult = submitResult as? FailedSubmitResult {
showError("Payment failed: \(failedResult.errorReason ?? "")")
}
}
private func getSessionDataFromBackend() async throws -> SessionData {
// Implement your backend session request here
// This should match the curl request shown above
fatalError("Implement session data retrieval from your backend")
}
private func showError(_ message: String) {
DispatchQueue.main.async {
let alert = UIAlertController(title: "Error", message: message, preferredStyle: .alert)
alert.addAction(UIAlertAction(title: "OK", style: .default))
self.present(alert, animated: true)
}
}
}The following table describes the CheckoutConfig parameters used when you initialise the SDK:
| Parameter | Description |
|---|---|
environmentEnvironment required | The environment type. Possible values:
|
sessionSessionData required | Details about the checkout session. |
transactionDataTransactionData required | Details about the transaction. |
transactionData.amountDecimal required | The transaction amount (for example, Decimal(25.00)). |
transactionData.currencyString required | The currency code associated with the transaction, in ISO 4217 format (for example, "USD", "EUR", "GBP"). Use "USD" for Paze and Aeropay. |
| The entry type.
Use |
transactionData.intentTransactionIntentData required | The transaction intents for each payment method. Set only the methods you need. Example: TransactionIntentData(aeropay: .authorisation). |
| The intent for card, Apple Pay, or Paze transactions.
For Paze, use |
transactionData.intent.paypalPayPalIntentType? | The intent for PayPal transactions. Possible values:
|
| The intent for Aeropay transactions.
See Aeropay intents. |
transactionData.merchantTransactionIdString required | A unique identifier for this transaction. |
transactionData.merchantTransactionDate() -> Date required | A closure that returns the date and time of the transaction. Use { Date() } for the current date. |
transactionData.cardAcceptorNameString? | Card acceptor name for the transaction. |
transactionData.recurringRecurringType? | Recurring payment configuration. Use RecurringType(frequencyInDays: Int?, frequencyExpiration: String?). |
transactionData.linkIdString? | Transaction link ID for linking related transactions. |
merchantShopperIdString required | A unique identifier for this shopper. |
ownerTypeString? | The type of owner. Possible values:
|
ownerIdString required | The identifier of the owner related to the ownerType. |
onGetShippingAddress(() async -> ShippingAddress?)? | Optional async callback that returns shipping address data when the SDK needs it. Example: onGetShippingAddress: { await fetchShippingAddressFromBackend() }.ShippingAddress fields:
|
localisationLocalisation? | Custom UI text overrides for localisation. |
localeString? | Locale for language/region (for example, "en-US", "es-ES", "el-GR"). |
paypalConfigPayPalConfig? | PayPal-specific configuration. Required for PayPal payout transactions. Learn more. |
restrictionsRestrictions? | Optional card restrictions for owner types (corporate or consumer) and funding sources (credit, debit, or prepaid). When both session and config restrictions are provided, they're merged as a union. |
kountDisabledBool | Disable Kount fraud detection. Default: false (fraud detection enabled). |
clientNameString? | Optional client display name forwarded to provider experiences that support it (used by Paze). |
siteNameString? | Optional brand-facing site name forwarded to provider experiences (used by Paze). |
onGetShopper(() async -> TransactionShopper?)? | Optional async callback that returns shopper information. |
analyticsEvent((BaseAnalyticsEvent) -> Void)? | Handler for analytics events. |
For PayPal payout integrations, you must configure paypalConfig with payout-specific settings. This is required when using .payout intent for PayPal transactions.
let config = CheckoutConfig(
environment: .test,
session: sessionData,
transactionData: TransactionData(
amount: Decimal(100.00),
currency: "USD",
entryType: .ecom,
intent: TransactionIntentData(
card: nil,
paypal: .payout // Must use .payout intent
),
merchantTransactionId: UUID().uuidString,
merchantTransactionDate: { Date() }
),
merchantShopperId: "customer-123",
ownerId: "merchant-id",
kountDisabled: false, // OPTIONAL: Set to true to disable Kount fraud detection
paypalConfig: PayPalConfig(
payout: PayPalPayoutConfig(
paypalWallet: PayPalWallet(
email: "recipient@example.com",
payerId: "PAYERID123", // Max 13 alphanumeric characters
proceedPayoutWithSdk: false // false = automatic payout
)
)
)
)Set proceedPayoutWithSdk: true on PayPalWallet or VenmoWallet to gate whether the payout submission component runs its approval callback before processing. Configure onPrePayoutSubmit on the payout submission component — not on CheckoutConfig:
let config = CheckoutConfig(
environment: .test,
session: sessionData,
transactionData: TransactionData(
amount: Decimal(100.00),
currency: "USD",
entryType: .ecom,
intent: TransactionIntentData(
card: nil,
paypal: .payout
),
merchantTransactionId: UUID().uuidString,
merchantTransactionDate: { Date() }
),
merchantShopperId: "customer-123",
ownerId: "merchant-id",
kountDisabled: false, // OPTIONAL: Set to true to disable Kount fraud detection
paypalConfig: PayPalConfig(
payout: PayPalPayoutConfig(
paypalWallet: PayPalWallet(
email: "recipient@example.com",
payerId: "PAYERID123",
proceedPayoutWithSdk: true
)
)
)
)
let pxpCheckout = try PxpCheckout.initialize(config: config)
let payoutConfig = PayoutSubmissionComponentConfig()
payoutConfig.onPrePayoutSubmit = {
// Return approval result before payout proceeds
PrePayoutSubmitResult(isApproved: true)
}
let payoutComponent = try pxpCheckout.create(
.payoutSubmission,
componentConfig: payoutConfig
)Use venmoWallet inside PayPalPayoutConfig when the payout should go to a Venmo recipient instead of a PayPal wallet:
let config = CheckoutConfig(
environment: .test,
session: sessionData,
transactionData: TransactionData(
amount: Decimal(50.00),
currency: "USD",
entryType: .ecom,
intent: TransactionIntentData(
card: nil,
paypal: .payout
),
merchantTransactionId: UUID().uuidString,
merchantTransactionDate: { Date() }
),
merchantShopperId: "customer-123",
ownerId: "merchant-id",
kountDisabled: false, // OPTIONAL: Set to true to disable Kount fraud detection
paypalConfig: PayPalConfig(
payout: PayPalPayoutConfig(
venmoWallet: VenmoWallet(
recipientType: .email, // or .phone, .userHandle
receiver: "user@example.com", // or phone number, or @username
proceedPayoutWithSdk: false
)
)
)
)- PayerId validation: Must be max 13 characters, alphanumeric only.
- Intent requirement: Must set
paypal: .payoutinTransactionIntentData. - proceedPayoutWithSdk flag:
false(default): SDK proceeds automatically with payout using provided Payer ID.true: configureonPrePayoutSubmiton the payout submission component, not onCheckoutConfig.
- Email vs PayerId: Provide either email or payerId (or both) for PayPal wallet identification.
For a complete guide on implementing PayPal payouts, see PayPal payouts.
You've successfully installed the SDK and created your first payment component! Here are some recommended next steps:
- For Apple Pay: Learn more about Apple Pay.
- For PayPal: Learn more about PayPal button component documentation.
- For Paze: Learn more about Paze for portal setup, URL callback scheme, and component integration.
- For Aeropay: Learn more about Aeropay for portal setup, Aerosync callback scheme, and component integration.
- Testing: Use the test environment to validate your integration before going live.
- Webhooks: Subscribe to webhooks in the Unity Portal for real-time payment notifications. Learn more about webhooks.