Create Payment Link

post

https://business.mamopay.com/manage_api/v1/links

API to generate vanilla and subscription payment links.

Payment Status

Once your customer completes a payment, the redirect URL will be appended with the following params

createdAt: The date the charge was captured at
paymentLinkId: The payment link id
status: indicates the payment status, whether captured or failed
transactionId: The transaction / charge id related to the payment

You may also get notified about a payment's status by setting up a webhook. Details here

A third approach to check the transaction status is by calling our transaction info API here

Sample redirect url after a successful payment

https://www.mamopay.com/?createdAt=2023-08-09-16-42-35&paymentLinkId=MB-LINK-3216D27C9D&status=captured&transactionId=MPB-CHRG-BEE56990A9

For Payment Testing

To make payments with different use cases on the test environment, you can use the card details below alongside the below CVV and expiry date.

CVV: 123
Expiry: 01/28

Card Number	Payment Status	3DS	Address Required	Country
4659 1055 6905 1157	Success	X	X	GB
4242 4242 4242 4242	Success	✓	X	GB
4111 1111 1111 1111	Success	✓	✓	US
4567 3613 2598 1788	Fail	X	X	GB
4095 2548 0264 2505	Fail	X	✓	US

3DS

If prompted for a password, enter Checkout1!

Subscriptions

To create a subscription payment link, create the subscription first using the Create Subscription API, then pass its identifier as subscription_id below with link_type set to inline. The inline subscription object is a legacy, backwards-compatible alternative — when setting it up, if both end_date and payment_quantity were defined, end_date takes precedence.

Body Params

title

string

required

length between 1 and 50

Defaults to Chocolate Box - Small

The title of the payment link

description

string

length ≤ 75

Defaults to 12pcs Chocolate Box

Payment description. This will appear on the payment checkout page.

capacity

integer

The number of times a payment link can be used, if null the link can be used indefinitely. The capacity will be ignored when the subscription params exist.

active

boolean

Defaults to true

return_url

uri

Defaults to https://myawesomewebsite.com/paymentSuccess

The URL which the customer will be redirected to after a successful payment.

failure_return_url

uri

Defaults to https://failureurl.com/paymentFailure

The URL which the customer will be redirected to after a failure payment.

terms_and_conditions_url

uri

The URL to the terms and conditions page, if provided, the customer will be required to accept the terms before proceeding to payment.

processing_fee_percentage

number

≥ 0

Defaults to 0

Processing fee that you as a merchant can impose on your customers

amount

number

≥ 2

Defaults to 119.99

amount could be 0 with save_card 'required' option for card verification

amount_currency

string

enum

Defaults to AED

Currency code for the payment amount. See examples for more details.

Allowed:

link_type

string

enum

Defaults to standalone

Type of link to be created.

Allowed:

enable_tabby

boolean

Defaults to false

Enables the ability for customers to buy now and pay later.

enable_message

boolean

Defaults to false

Enables the ability for customers to add a message during the checkout process.

enable_tips

boolean

Defaults to false

Enables the tips option. This will be displayed on the first screen.

save_card

string

enum

Defaults to off

Allows the merchant to enable the option to store card details to be used later on for Merchant Initiated Transactions.

Allowed:

enable_customer_details

boolean

Defaults to false

Enables adding customer details such as the name, email, and phone number. This screen will be displayed before the payment details screen.

enable_quantity

boolean

Defaults to false

When enabled, customers can specify the number of items they intend to purchase. This quantity will serve as a multiplier for the base amount.

enable_qr_code

boolean

Defaults to false

Adds the ability to verify a payment through a QR code.

send_customer_receipt

boolean

Defaults to false

Enables the sending of customer receipts.

payment_methods

array

An array of the accepted payment methods, with 'card' always included as the default option, and wallet for Apple Pay and Google Pay. Example to accept all: ['card', 'wallet']

payment_methods

rules

object

Setting the rule for payment link

subscription_id

string

The identifier of an existing subscription (created via the Create Subscription API) to attach to this payment link. This is the recommended way to create a subscription payment link — create the subscription first, then pass its identifier here. Requires link_type to be inline.

subscription

object

Legacy, backwards-compatible way to configure a subscription inline, to be populated if this payment link is for a subscription. Otherwise, this property can be left out. New integrations should use the subscription_id field instead, together with the Create Subscription API.

first_name

string

The first name of customer which will pre-populate in card info step.

last_name

string

The last name of customer which will pre-populate in card info step.

string

The email of customer which will pre-populate in card info step.

phone_number

string

The phone number of customer which will pre-populate in card info step.

custom_data

object

external_id

string

The external ID of your choice to associate with payments captured by this payment link.

hold_and_charge_later

boolean

Defaults to false

Indicates whether to place the payment on hold and charge it later using the "captures" API.

payouts_share

object

Responses

404

Invalid request

500

Unexpected error

200Successful response

403Unauthorised

422Unprocessable entity