Opn Payments is a payment service provider operating in Thailand, Japan, and Singapore. Opn Payments provides a set of APIs that help merchants of any size accept payments online.
The Opn Payments iOS SDK provides bindings for tokenizing credit cards and accepting non-credit-card payments using the Opn Payments API, allowing developers to safely and easily accept payments within apps.
If you run into any issues regarding this SDK and the functionality it provides, consult the frequently asked questions in our comprehensive support documents. If you can't find an answer there, feel free to email our support team.
Please do NOT use Omise iOS SDK versions less than 3.2.0, as they are outdated and have security vulnerabilities.
Card data should never transit through your server. We recommend that you follow our guide on how to safely collect credit information.
To be authorized to create tokens on your server, you must have a currently valid PCI-DSS Attestation of Compliance (AoC) delivered by a certified QSA Auditor. This SDK provides the means to tokenize card data through the end user's mobile phone without this data having to go through your server.
To integrate the Opn Payments SDK into your Xcode project using the Swift Package Manager, proceed with the following steps:
File
> Swift Packages
> Add Package Dependency...
https://github.com/omise/omise-ios.git
v5.0.0
Frameworks, Libraries, and Embedded Content
, and set OmiseSDK to Embed & Sign
The Opn Payments iOS SDK provides an easy-to-use library for calling the Opn Payments API and presenting UI forms.
The main class and protocol for the Opn Payments iOS SDK are OmiseSDK
and ClientProtocol
through
which all requests to the Opn Payments API will be sent.
To start working with OmiseSDK, you must create a new instance of the OmiseSDK
class with an Opn Payments public key.
import OmiseSDK
let omiseSDK = OmiseSDK(publicKey: "omise_public_key")
You can also set up and use a shared
instance of OmiseSDK
in your code:
OmiseSDK.shared = omiseSDK
If you cloned this project to your local hard drive, you can check out ExampleApp.xcodeproj
.
The SDK currently supports two main categories of requests: Tokenizing a Card and Creating a Payment Source.
Normally, merchants must not send credit or debit card data to their own
servers. To collect a card payment from a
customer, merchants must first tokenize the card data using the
Opn Payments API and then use the generated token in place of the card
data. You can tokenize card data by creating and initializing
a CreateTokenPayload.Card
as follows:
let createTokenPayload = CreateTokenPayload.Card(
name: "JOHN DOE",
number: "4242424242424242",
expirationMonth: 11,
expirationYear: 2022,
securityCode: "123"
)
let createTokenPayloadWithAddress = CreateTokenPayload.Card(
name: "JOHN DOE",
number: "4242424242424242",
expirationMonth: 11,
expirationYear: 2022,
securityCode: "123",
phoneNumber: "0123456789",
countryCode: "TH",
city: "Bangkok",
state: "Bangkok",
street1: "Sukhumvit",
street2: "",
postalCode: "10110"
)
Opn Payments supports many payment methods other than cards. You
may request a payment with one of those supported payment methods from
a customer by calling the CreateSource
API. You need to specify
the parameters (e.g., payment amount and currency) of the source you
want to create by creating and initializing a CreateSourcePayload
with
the Payment Information
object:
let createSourcePayload = CreateSourcePayload(
amount: amount,
currency: currency,
details: .sourceType(.internetBankingBBL) // Bangkok Bank Internet Banking payment method
)
After creating the token or the payment source, create the completion handler, as follows:
A simple completion handler for a token, for example, is as follows:
func tokenCompletionHandler(tokenResult: Result<Token, Error>) -> Void {
switch tokenResult {
case .success(let token):
// do something with Token id
print(token.id)
case .failure(let error):
print(error)
}
}
Now, send the request:
Whether you are charging a source or a card, sending the
request is the same. Use the ClientProtocol
to perform one-off API calls
with the completion handler block.
let client = omiseSDK.client
client.createToken(payload: createTokenPayload, tokenCompletionHandler)
client.createSource(payload: createSourcePayload, sourceCompletionHandler)
client.capability(capabilityCompletionHandler)
client.token(tokenID: "tokenID", tokenInfoCompletionHandler)
client.observeChargeStatus(chargeStatusCompletionHandler)
Opn Payments iOS SDK provides easy-to-use drop-in UI forms for both Tokenizing a Card and Creating a Payment Source, which you can easily integrate into your application.
The omiseSDK.presentCreditCardPayment()
provides a pre-made card form that will automatically
tokenize card information for you.
To use the controller in your application, modify your view controller with the following additions:
import OmiseSDK
class ViewController: UIViewController {
private let omiseSDK = OmiseSDK("pkey_test_123")
@IBAction func displayCreditCardPayment() {
omiseSDK.presentCreditCardPayment(from: self, delegate: self)
}
}
You can provide extra parameters:
countryCode
to preselect the country in the UI formhandleErrors
to process and display errors (by default, is true
); if false
, then the delegate
method choosePaymentMethodDidComplete(with error: Error)
will be called instead.omiseSDK.presentCreditCardPayment(
from: self,
countryCode: "TH", // if `nil` it will use country from Capability API
handleErrors: true, // by default `true`
delegate: self
)
Then implement the delegate to receive the Token
object after the user has entered the card data:
extension ViewController: ChoosePaymentMethodDelegate {
func choosePaymentMethodDidComplete(with token: Token) {
// Send `Token` to your server to create a charge or a customer object.
print(token.id) // prints Token ID
}
func choosePaymentMethodDidComplete(with error: Error) {
// Only called if we set `handleErrors = false`.
// You can send errors to a logging service or display them here to the user.
}
}
You can call OmiseSDK.dismiss(animated:completion:)
to close UI form presented by OmiseSDK:
func choosePaymentMethodDidComplete(with token: Token) {
omiseSDK.dismiss {
// present another screen
}
}
You can create your card form, but please remember you must not send the card information to your server. Opn Payments iOS SDK provides the following built-in card UI components to make it easier to create your card form:
CardNumberTextField
- Provides basic number grouping as the user types.CardNameTextField
- Cardholder name field.CardExpiryDateTextField
- Provides card expiration date input and stylingCardExpiryDatePicker
- UIPickerView
implementation with a month and year column.CardCVVTextField
- CVV number field.Additionally, fields automatically turn red if their content fails basic validation (e.g., alphabetic characters in the number field, content with wrong length), and come in two supported styles: plain and border.
The presentChoosePaymentMethod
function of OmiseSDK
presents a pre-made form that lets customers choose how they want to make a payment.
Please note that the presented controller is designed to be used as-is, and you should not push your view controllers into its navigation controller stack.
You can configure it to display either specified payment method options or a default list based on your country.
To use the controller in your application, call presentChoosePaymentMethod
.
omiseSDK.presentChoosePaymentMethod(
from: self,
amount: paymentAmount,
currency: paymentCurrencyCode,
delegate: self
)
You can provide extra parameters:
allowedPaymentMethods
to display given payment methods (if presented in Capability API)forcePaymentMethods
to override payment methods from Capability and display only allowedPaymentMethods
isCardPaymentAllowed
to display or hide the Credit Card payment methodhandleErrors
to process and display errors (by default, is true
); if false
, then the delegate
method choosePaymentMethodDidComplete(with error: Error)
will be called instead.
let allowedPaymentMethods = SourceType.availableByDefaultInThailand
omiseSDK.presentChoosePaymentMethod(
from: self,
amount: paymentAmount,
currency: paymentCurrencyCode,
allowedPaymentMethods: allowedPaymentMethods,
forcePaymentMethods: true,
isCardPaymentAllowed: true,
handleErrors: true,
delegate: self
)
Then implement the delegate to receive the Source
or Token
object after the user has selected:
extension ProductDetailViewController: ChoosePaymentMethodDelegate {
func choosePaymentMethodDidComplete(with source: Source) {
omiseSDK.dismiss {
print(source.id) // prints Source ID
}
}
func choosePaymentMethodDidComplete(with token: Token) {
omiseSDK.dismiss {
print(token.id) // prints Token ID
}
}
func choosePaymentMethodDidComplete(with error: Error) {
// Only called if we set `handleErrors = false`.
let alertController = UIAlertController(title: "Error", message: error.localizedDescription, preferredStyle: .alert)
let okAction = UIAlertAction(title: "OK", style: .cancel, handler: nil)
alertController.addAction(okAction)
let vc = omiseSDK.presentedViewController ?? self
vc.present(alertController, animated: true, completion: nil)
}
func choosePaymentMethodDidCancel() {
omiseSDK.dismiss()
}
}
Some payment methods require customers to authorize the payment using an authorize URL. This includes 3-D Secure verification, Internet Banking payment, and Alipay. The Opn Payments iOS SDK provides a built-in class to authorize payments.
On payment methods that require opening the external application (e.g., mobile banking application) to authorize the transaction, set the return_uri to a deep link or app link to be able to open the merchant application. Otherwise, after the cardholder authorizes the transaction on the external application, the flow redirects to the normal link in the return_uri, and opens it on the browser application, resulting in the payment not being completed.
You can use the built-in authorizing payment view controller with the authorizeURL
provided with the charge and expected return URL
patterns you create.
omiseSDK.presentAuthorizingPayment(
from: self,
authorizeURL: url,
returnURLs: [returnURLs],
delegate: self
)
Then implement the delegate to receive the Source
or Token
object after the user has selected:
extension ViewController: AuthorizingPaymentViewControllerDelegate {
func authorizingPaymentViewController(_ viewController: AuthorizingPaymentViewController, didCompleteAuthorizingPaymentWithRedirectedURL redirectedURL: URL) {
// Handle the `redirected URL` here
omiseSDK.dismiss()
}
func authorizingPaymentViewControllerDidCancel(_ viewController: AuthorizingPaymentViewController) {
// Handle the case that the user taps cancel.
omiseSDK.dismiss()
}
}
This version of Opn Payments iOS SDK does not support Objective-C. For full Objective-C support, use this version.
Pull requests, issues, and bug fixes are welcome!
link |
Stars: 74 |
Last commit: 1 week ago |
Full Changelog: https://github.com/omise/omise-ios/compare/v4.27.1...v5.0.0
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics