Accept PayMaya payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add PayMaya to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your PayMaya integration:
- Make sure that you have set up your back end implementation.
- Add PayMaya in your test Customer Area.
Build your payment form for PayMaya
Include PayMaya in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for PayMaya which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: PH
- amount.currency: PHP
- amount.value: The value of the payment.
- channel: Specify Web, iOS, or Android.
The response contains paymentMethod.type
: paymaya_wallet.
Make a payment
From your server, make a /payments request, specifying:
paymentMethod.type
: paymaya_wallet
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
},
"paymentMethod":{
"type":"paymaya_wallet"
},
"returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# 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 => "https://your-company.com/checkout?shopperOrder=12xy..",
: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("https://your-company.com/checkout?shopperOrder=12xy..");
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" => "https://your-company.com/checkout?shopperOrder=12xy..",
"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': 'https://your-company.com/checkout?shopperOrder=12xy..',
'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 = @"https://your-company.com/checkout?shopperOrder=12xy..",
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: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);
The /payments response contains:
-
action.url
: Link to where you should redirect your shopper. -
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"
}
],
...
}
Handle the redirect
To complete a PayMaya payment, you need to redirect the shopper to PayMaya's website.
-
To complete the payment, redirect the shopper to the
action.url
returned in the /payments response.When using the HTTP GET method:
For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView. -
After the shopper is redirected back to your website or app, check the payment result by making a /payments/details request, specifying:
-
paymentData
: The value your received in the /payments response. -
details.redirectResult
: Object that was returned when the shopper was redirected back to your website or app.
-
resultCode
: Use this to present the 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. |
Recurring payments
PayMaya supports recurring transactions. To make recurring transactions, you need to:
Create a token
To create a token, include in your /payments request:
-
storePaymentMethod
: true - shopperReference: Your unique identifier for the shopper.
When the payment has been settled, you receive a notification webhook containing:
-
eventCode
: RECURRING_CONTRACT -
originalReference
: ThepspReference
of the initial payment. -
pspReference
: This is the token that you need to make recurring payments for this shopper.
Make a payment with a token
To make a payment with the token, include in your /payments request:
-
paymentMethod.storedPaymentMethodId
: ThepspReference
from the RECURRING_CONTRACT notification.You can also get this value by using the /listRecurringDetails endpoint. -
shopperReference
: The unique shopper identifier that you specified when creating the token. -
shopperInteraction
: ContAuth -
recurringProcessingModel
: Use Subscription for a series of transactions following a fixed time interval or UnscheduledCardOnFile for contracts with non-fixed time interval.curl https://checkout-test.adyen.com/v66/payments \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "amount":{ "value":1000, "currency":"PHP" }, "paymentMethod":{ "type":"paymaya_wallet", "storedPaymentMethodId":"7219687191761347" }, "reference":"YOUR_ORDER_NUMBER", "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "shopperReference":"YOUR_UNIQUE_SHOPPER_ID", "shopperInteraction":"ContAuth", "recurringProcessingModel": "Subscription" }'
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.