Our Android Drop-in renders PayMaya in your payment form, and redirects the shopper to the PayMaya's website where they can complete the payment.
Before you begin
This page explains how to add PayMaya to your existing Android Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your PayMaya integration:
1.Make sure you have set up your back end implementation.
Show PayMaya in your payment form
Drop-in uses the countryCode
and the amount.currency
from your /paymentMethods request to show the available payment methods to your shopper.
To show PayMaya in your payment form, specify in your /paymentMethods request:
- countryCode: PH
- amount.currency: PHP
- amount.value: The value of the payment.
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod
.
-
Pass the
paymentComponentData.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
paymentMethod
: ThepaymentComponentData.paymentMethod
from your client app.returnUrl
: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in theRedirectComponent.getReturnUrl(context)
.
curl https://checkout-test.adyen.com/v66/payments \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "reference":"YOUR_ORDER_NUMBER", "amount":{ "currency":"PHP", "value":1000 }, "{hint:paymentComponentData.paymentMethod from app}paymentMethod{/hint}":{ "type":"paymaya_wallet"" }, "returnUrl":"adyencheckout://your.package.name" }'
# Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen::Client.new adyen.api_key = "YOUR_X-API-KEY" response = adyen.checkout.payments({ :amount => { :currency => "PHP", :value => 1000 }, :reference => "YOUR_ORDER_NUMBER", :paymentMethod => { :type => "paymaya_wallet" }, :returnUrl => "adyencheckout://your.package.name", :merchantAccount => "YOUR_MERCHANT_ACCOUNT" })
// Set YOUR_X-API-KEY with the API key from the Customer Area. // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments. Client client = new Client("YOUR_X-API-KEY", Environment.TEST); Checkout checkout = new Checkout(client); PaymentsRequest paymentsRequest = new PaymentsRequest(); String merchantAccount = "YOUR_MERCHANT_ACCOUNT"; paymentsRequest.setMerchantAccount(merchantAccount); Amount amount = new Amount(); amount.setCurrency("PHP"); amount.setValue(15000L); paymentsRequest.setAmount(amount); DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails(); paymentMethodDetails.setType("paymaya_wallet"); paymentsRequest.setPaymentMethod(paymentMethodDetails); paymentsRequest.setReference("YOUR_ORDER_NUMBER"); paymentsRequest.setReturnUrl("adyencheckout://your.package.name"); PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. $client = new \Adyen\Client(); $client->setXApiKey("YOUR_X-API-KEY"); $service = new \Adyen\Service\Checkout($client); $params = array( "amount" => array( "currency" => "PHP", "value" => 1000 ), "reference" => "YOUR_ORDER_NUMBER", "paymentMethod" => array( "type" => "paymaya_wallet" ), "returnUrl" => "adyencheckout://your.package.name", "merchantAccount" => "YOUR_MERCHANT_ACCOUNT" ); $result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen.Adyen() adyen.client.xapikey = 'YOUR_X-API-KEY' result = adyen.checkout.payments({ 'amount': { 'value': 1000, 'currency': 'PHP' }, 'reference': 'YOUR_ORDER_NUMBER', 'paymentMethod': { 'type': 'paymaya_wallet' }, 'returnUrl': 'adyencheckout://your.package.name', 'merchantAccount': 'YOUR_MERCHANT_ACCOUNT' })
// Set your X-API-KEY with the API key from the Customer Area. var client = new Client ("YOUR_X-API-KEY", Environment.Test); var checkout = new Checkout(client); var amount = new Model.Checkout.Amount("PHP", 1000); var details = new Model.Checkout.DefaultPaymentMethodDetails{ Type = "paymaya_wallet"" }; var paymentsRequest = new Model.Checkout.PaymentRequest { Reference = "YOUR_ORDER_NUMBER", Amount = amount, ReturnUrl = @"adyencheckout://your.package.name", MerchantAccount = "YOUR_MERCHANT_ACCOUNT", PaymentMethod = details }; var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. const {Client, Config, CheckoutAPI} = require('@adyen/api-library'); const config = new Config(); // Set your X-API-KEY with the API key from the Customer Area. config.apiKey = '[API_KEY]'; config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]'; const client = new Client({ config }); client.setEnvironment("TEST"); const checkout = new CheckoutAPI(client); checkout.payments({ amount: { currency: "PHP", value: 1000 }, paymentMethod: { type: 'paymaya_wallet' }, reference: "YOUR_ORDER_NUMBER", merchantAccount: config.merchantAccount, returnUrl: "adyencheckout://your.package.name" }).then(res => res);
The /payments response contains:
-
action.method
: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to yourreturnURL
using the same method.
{ "resultCode":"RedirectShopper", "action":{ "method":"GET", "paymentData":"Ab02b4c0!BQABAgCSZT7t...", "paymentMethodType":"paymaya_wallet", "type":"redirect", "url":"https://test.adyen.com/hpp/skipDetails.shtml?brandCode=paymaya_wallet..." }, "details":[ { "key":"redirectResult", "type":"text" } ], ... }
- Pass the
action
object to your client app.
Check the payment result
Drop-in redirects the shopper to PayMaya to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData
object.
-
From your server, make a POST /payments/details request providing:
-
paymentData
: The value your received in the /payments response. -
details
: TheactionComponentData.details
object from Drop-in.
-
resultCode
: Use this to present the payment result to your shopper. -
pspReference
: Our unique identifier for the transaction.
-
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode
values you can receive for PayMaya are:
resultCode | Description | Action to take |
---|---|---|
Authorised | The payment was successful. | Inform the shopper that the payment has been successful. |
Cancelled | The shopper cancelled the payment while on PayMaya's website. | Ask the shopper whether they want to continue with the order, or ask them to select a different payment method. |
Pending or Received |
The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you've received their order, and are waiting for the payment to be completed. To know the final result of the payment, wait for the AUTHORISATION notification webhook. |
Refused | The payment was refused by PayMaya. | Ask the shopper to try the payment again using a different payment method. |
If the shopper closed the browser and failed to return to your website, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for PayMaya are:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
OFFER_CLOSED | true | The shopper did not complete the payment. | Cancel the order and inform the shopper that the payment timed out. |
Test and go live
Use the following credentials to make PayMaya payments in the test environment:
Phone number | Password | One-time password |
---|---|---|
639280795154 | Password2410 | 123456 |
639212456051 | Password1 | 123456 |
639435231172 | Password1 | 123456 |
639206965816 | Password1 | 123456 |
Check the status of PayMaya test payments in your Customer Area > Transactions > Payments.
Before you can accept live PayMaya payments, you need to submit a request for PayMaya in your live Customer Area.