This page explains how to add PayMe to your existing iOS Drop-in integration.
Our iOS Drop-in renders PayMe in your payment form, and redirects the shopper to their PayMe app.
PayMe is supported from iOS Drop-in version 4.0.0.
Requirements
Select the server-side flow that your integration uses:
Requirement | Description |
---|---|
Integration type | Make sure that you have built a Sessions flow iOS Drop-in integration. |
Setup steps | Before you begin, add PayMe in your Customer Area. |
API reference
Select which endpoint you are using:
This is the default with Drop-in v5.0.0 or later.
Parameter name | Required | Description |
---|---|---|
channel
|
To determine whether the shopper is using a desktop, laptop or mobile. | |
lineItems.quantity
|
The number of items. Must be between 0 and 9999. | |
lineItems.sku
|
The stock keeping unit. Maximum length 200 characters. Available if you use Checkout API v70 and later. | |
lineItems.description
|
The order description to display to the shopper. Maximum length 200 characters. | |
lineItems.amountIncludingTax
|
Item amount including the tax, in minor units. Must be between 1 and 100000000. | |
lineItems.itemCategory
|
The item category. Maximum length 200 characters. |
// SET YOUR ADYEN_API_KEY with the API key from the Customer Area. const {Client, Config, CheckoutAPI} = require('@adyen/api-library'); const config = new Config(); // SET YOUR ADYEN_API_KEY with the API key from the Customer Area. config.apiKey = '[API_KEY]'; config.merchantAccount = '[MERCHANT_ACCOUNT]'; const client = new Client({ config }); client.setEnvironment("TEST"); const checkout = new CheckoutAPI(client); checkout.payments({ "paymentMethod": { "type": "payme" }, "amount": { "currency": "HKD", "value": 4200 }, "countryCode": "HK", "merchantAccount": "ADYEN_MERCHANT_ACCOUNT", "reference": "YOUR_ORDER_REFERENCE", "returnUrl": "https://your-company.com/...", "channel":"iOS", "lineItems": [ { "quantity": "1", "sku": "3232", "description": "Shoes", "amountIncludingTax": 4200, "itemCategory": "Fashion" } ] })
See the iOS Drop-in integration guide to get the payment outcome and show your shopper the result of the payment.
Drop-in configuration
There are no configuration steps specific to PayMe required for Drop-in.
Test and go live
Use the PayMe sandbox to test your integration. You do not need to use the PayMe app to test using the sandbox.
Use the amounts specified below to simulate different payment outcomes.
Amount ending in | Result | Description |
---|---|---|
30 or 81 | Authorised | Successful payment. |
77 or 90 | OfferCancelled | The payment request expired after PayMe's default expiry time of ten minutes. |
40 or 44 | Error | There was an error when creating the payment request. |