Recurring Wallet Payments

Reduce transaction disruption in making recurring payments by enabling your customer to create their Maya wallet link.

Implementing Maya Wallet Linking to your page

Step 1: Setup your Maya Business Manager Account

Before you could implement the Link Maya Wallet to your websites, you must register and setup your Maya Business Manager Account.

Step 2: Build your pages

A. Create a 'Link Maya Wallet' button

Create a Link Maya Wallet button on your website that will allow customers to initiate the wallet linking.

Sample code for Creating a button:
<html>
  <head>
    <title>Wear Vamos</title>
  </head>
  <body>
    <form action="/link-maya-wallet" method="POST">
      <button type="submit">Link Maya Wallet</button>
    </form>
  </body>
</html>

B. Create your Status Page

Host pages on your website that will reflect the payment status to customers.

Sample code for Successful Page:
<html>
  <head><title>Wallet linked</title></head>
  <body>
    <h1>Wallet linked</h1>
  </body>
</html>
Step 3: Complete the wallet linking

Handle the 'Link Maya Wallet' button event by calling the POST /payby/v2/paymaya/link endpoint to redirect user to the Maya Connect Login page for authentication and creation of the wallet link.


Your system must define the redirectURL when calling this endpoint.

The redirectUrl Object

Attributes
success (url) REQUIRED
URL of the page where your customers will be redirected after a successful payment.
failure (url) REQUIRED
URL of the page where your customers will be redirected to when the payment fails.
cancel (url) REQUIRED
URL of the page where your customer will be redirected when they cancel a payment.

ℹ️ When initiating payment as a Payment Facilitator, you need to provide the pf details. For more details see Payment Facilitator.

This endpoint will return a linkId – a unique identifier of a successful Maya Wallet link which you can use for managing the wallet link or execute the current and future payments on-behalf-of the user.

🧪 Quick Test

At this point you should be able to redirect session to Maya’s login page by clicking the button.

  1. Click "Link Maya Wallet" button
  2. You get redirected to Maya's Single Sign-on Page
  3. You will have to use a test Maya account Sandbox Credentials and Cards.
  4. On successful link, it will redirect to your success page.

Managing the Wallet Link

After acquiring the linkId, your system can use it to manage wallet link.

Get Wallet Link

Use this endpoint for your system to retrieve the details of a linked Maya wallet account.


Delete Wallet Link

Use this endpoint to deactivate a Maya wallet link.


Making a Transaction using a Linked Wallet


When user had successfully done the wallet link and linkId was generated, use the linkId to execute current and future payments on-behalf-of the user.


Useful Links