Skip to main content

Basic Integration

This page will guide you to accept mada, Visa, Mastercard, American Express, and UnionPay payments using our Payment Form Javascript library.

Before Starting​

Before you start accepting credit/debit card payments, make sure you complete these steps first:

  1. Sign up for a Moyasar account on our dashboard.
  2. Get your publishable API key to authenticate your form payment requests.
  3. Review the Moyasar form configuration here.

Including Moyasar Form​

Moyasar Form is a lightweight Javascript library that will take care of creating the payment components within your website using a modern and responsive design.

You can start the integration by including the following tags within the <head> tag of your page:

Initiating the Payment Form​

Once you decide on a good place for the form, add an empty <div> tag and then invoke the init method on the global Moyasar class.

HTML
<div class="mysr-form"></div>
<script>
  Moyasar.init({
    element: '.mysr-form',
    // Amount in the smallest currency unit.
    // For example:
    // 10 SAR = 10 * 100 Halalas
    // 10 KWD = 10 * 1000 Fils
    // 10 JPY = 10 JPY (Japanese Yen does not have fractions)
    amount: 1000,
    currency: 'SAR',
    description: 'Coffee Order #1',
    publishable_api_key: 'pk_test_AQpxBV31a29qhkhUYFYUFjhwllaDVrxSq5ydVNui',
    callback_url: 'https://moyasar.com/thanks',
    supported_networks: ['visa', 'mastercard', 'mada', 'unionpay'],
    methods: ['creditcard'],
  });
</script>

Configuration Keys​

FieldDescription
amountPayment amount which should be positive integer representing the smallest currency unit (e.g., 100 Halala to charge 1.00 SAR or 100 to charge ¥100, a zero-decimal currency). The minimum value is 100.
currency3-letter ISO Code for currency. E.g., SAR, CAD.
descriptionAn arbitrary string that you can attach to a payment object. Payment description is only for your reference and it is not displayed to your users.
publishable_api_keyYour publishable API key, learn more on how to get the key here.
callback_urlURL of your website page to be redirected to after the customer completes a transaction. (e.g., https://example.com/orders).
methodsThis is used to enable and disable payment methods on the form. By default, all the methods are enabled creditcard, applepay and stcpay.

Learn more about available configuration keys here form configuration.

Payment Form​

Save Payment ID​

This step is optional but highly recommended to save the payment ID before redirecting the user to 3-D Secure, which grants you the ability to verify payment details in case your user's connection drops.

To save the payment ID you can provide the on_completed configuration option with an async function.

JS
Moyasar.init({
  element: '.mysr-form',
  amount: 1000,
  currency: 'SAR',
  description: 'Coffee Order #1',
  publishable_api_key: 'pk_test_AQpxBV31a29qhkhUYFYUFjhwllaDVrxSq5ydVNui',
  callback_url: 'https://moyasar.com/thanks',
  supported_networks: ['visa', 'mastercard', 'mada'],
  methods: ['creditcard'],
  on_completed: async function (payment) {
    await savePaymentOnBackend(payment);
  },
});

The method savePaymentOnBackend is a placeholder, and you must provide your own custom logic.

Step 4: Verify Payment​

After the user completes the payment and is redirected to your website or app via the previously provided callback_url, the id will be appended as an HTTP query parameter.

Here is an example:

Callback URL
https://www.my-store.com/payments_redirect?id=79cced57-9deb-4c4b-8f48-59c124f79688

Now fetch the payment using its id through our fetch API, and verify its status, amount, and currency before accepting your user's order or completing any business action.

Next, just show success or failure according to the previous validation.

Payment Flow​

Last updated on