No momento, esta página não está disponível em português
Payment-method icon

PayMe Drop-in integration

Add PayMe to an existing Drop-in integration.

On this page, you can find additional configuration for adding PayMe to your Drop-in integration.

Our Web Drop-in renders PayMe in your payment form.

Depending on whether your shopper is using a desktop or laptop, or the browser on their mobile device, Drop-in:

  • Shows the shopper a QR code which they can scan to pay using their PayMe app.
  • Redirects the shopper to the PayMe app on their mobile device.

Implement both flows to make sure that your shoppers can pay on different devices.

PayMe is supported from Web Drop-in version 5.56.0.

Before you begin

This page assumes you have already:

API reference

Select which endpoint you're integrating:

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.

See the Web 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
81 Authorised Successful payment.
77 OfferCancelled The payment request expired after PayMe's default expiry time of ten minutes.
44 Error There was an error when creating the payment request.