- Home
- All APIs
- Access Worldpay
- Checkout SDK
- iOS SDK
- Create a session to pay with a card
Create a session to pay with a card
Use our iOS SDK to secure your customer's card details by creating a session
.
Full sample integration: You can see an example of the session generation
Reference your UI components
To display your checkout form, you must create your layout first using your storyboard.
Here's an example of how you would reference your UI components using unique identifiers.
import AccessCheckoutSDK
class ViewController: UIViewController {
@IBOutlet weak var panTextField: UITextField!
@IBOutlet weak var expiryDateTextField: UITextField!
@IBOutlet weak var cvcTextField: UITextField!
func submitButtonClickHandler() {
// code to generate your session
...
}
...
import AccessCheckoutSDK class ViewController: UIViewController { @IBOutlet weak var panTextField: UITextField! @IBOutlet weak var expiryDateTextField: UITextField! @IBOutlet weak var cvcTextField: UITextField! func submitButtonClickHandler() { // code to generate your session ... } ...
Validate card details
You can optionally validate your customer's card details. You can find instructions
Create a session
Initialize the AccessCheckoutClient
You must now initialize the SDK using the AccessCheckoutClientBuilder
.
To do this, you must provide your BaseURL
, merchantID
(checkout ID) and other parameters. See the table below for more information.
Here's an example of how you would initialize the SDK with the mandatory parameters.
// The AccessCheckoutClientBuilder throws an error if either the accessBaseUrl() or merchantId() calls are omitted
let accessCheckoutClient:AccessCheckoutClient? = try? AccessCheckoutClientBuilder().accessBaseUrl(<ACCESS_BASE_URL>)
.merchantId(<CHECKOUT_ID>)
.build()
// The AccessCheckoutClientBuilder throws an error if either the accessBaseUrl() or merchantId() calls are omitted let accessCheckoutClient:AccessCheckoutClient? = try? AccessCheckoutClientBuilder().accessBaseUrl(<ACCESS_BASE_URL>) .merchantId(<CHECKOUT_ID>) .build()
Placeholder | Descriptions |
---|---|
<ACCESS_BASE_URL> |
|
<CHECKOUT_ID> | Your unique checkout ID as provided by Worldpay. |
Retrieve the session
Submitting your customer's card details
The CardDetails
contains the customer's data that is submitted to retrieve a session
.
// The CardDetailsBuilder throws an error if the expiry date is provided in a format different from MM/YY or MMYY (which will not happen if you use the components with built-in validation provided by the SDK)
let cardDetails:CardDetails = try! CardDetailsBuilder().pan(panTextField.text!)
.expiryDate(expiryDateTextField.text!)
.cvc(cvcTextField.text!)
.build()
// The CardDetailsBuilder throws an error if the expiry date is provided in a format different from MM/YY or MMYY (which will not happen if you use the components with built-in validation provided by the SDK) let cardDetails:CardDetails = try! CardDetailsBuilder().pan(panTextField.text!) .expiryDate(expiryDateTextField.text!) .cvc(cvcTextField.text!) .build()
Specifying the session
You must specify [SessionType.card]
as the type of session
to generate.
try? accessCheckoutClient?.generateSessions(cardDetails: cardDetails, sessionTypes: [SessionType.card]) { result in
DispatchQueue.main.async {
switch result {
case .success(let sessions):
// The session is returned in a Dictionary[SessionType:String]
let session = sessions[SessionType.card]
...
case .failure(let error):
// The error returned is of type AccessCheckoutError
let errorMessage = error.message
...
}
}
}
try? accessCheckoutClient?.generateSessions(cardDetails: cardDetails, sessionTypes: [SessionType.card]) { result in DispatchQueue.main.async { switch result { case .success(let sessions): // The session is returned in a Dictionary[SessionType:String] let session = sessions[SessionType.card] ... case .failure(let error): // The error returned is of type AccessCheckoutError let errorMessage = error.message ... } } }
Note:
- The call to
generateSessions
takes a closure that returns a `Result<[SessionType: String], AccessCheckoutError>' - You must use the pattern of the main thread in the closure when handling the success/failure would lead to updating the UI
Full code sample
Here's the full code sample of the steps above.
import AccessCheckoutSDK
class MyViewController: UIViewController {
private let accessBaseUrl = "https://try.access.worldpay.com"
private let checkoutId = "your-checkout-id"
@IBOutlet weak var panTextField: UITextField!
@IBOutlet weak var expiryDateTextField: UITextField!
@IBOutlet weak var cvcTextField: UITextField!
@IBAction func submit(_ sender: Any) {
let cardDetails = try! CardDetailsBuilder().pan(panTextField.text!)
.expiryDate(expiryDateTextField.text!)
.cvc(cvcTextField.text!)
.build()
let accessCheckoutClient = try? AccessCheckoutClientBuilder().accessBaseUrl(accessBaseUrl)
.merchantId(checkoutId)
.build()
try? accessCheckoutClient?.generateSessions(cardDetails: cardDetails, sessionTypes: [SessionType.card]) { result in
DispatchQueue.main.async {
switch result {
case .success(let sessionsDictionary):
let session = sessionsDictionary[SessionType.card]
...
case .failure(let error):
...
}
}
}
}
}
Create a verified token
Once you've received the CARD session
you must create a
Important: The CARD session
has a lifespan of one minute and you can use it only once. If you do not create a token within that time, you must create a new CARD session
value.
Next steps
Create a