v1

latestOpenAPI 3.0.02026-07-1412068.2 KB

Payment Links

Fetch Payment Link Info

Allows a user to fetch payment link details<br><br>

get/links/{linkId}

Path parameters

linkIdstring required

Payment link ID

Headers

Content-Typestring

Authorizationstring

Response

Successful response

namestring

The title of the payment link

descriptionstring

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

capacityinteger

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

activeboolean

return_urlstring uri

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

terms_and_conditions_urlstring 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_percentagenumber

amountnumber

amount_currency'AED' | 'USD' | 'EUR' | 'GBP' | 'SAR'

link_type'standalone' | 'modal' | 'inline'

Type of link to be created.

enable_tabbyboolean

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

enable_messageboolean

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

enable_tipsboolean

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

enable_customer_detailsboolean

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

enable_quantityboolean

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_codeboolean

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

send_customer_receiptboolean

Enables the sending of customer receipts.

save_card'off' | 'optional' | 'required'

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

first_namestring

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

last_namestring

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

emailstring

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

custom_dataobject

idstring

titlestring

platformstring

prefilled_customerobject

external_idstring

hold_and_charge_laterboolean

internal_notestring

langstring

expiration_datestring

is_widgetboolean

max_amountnumber

processing_fee_amountnumber

payment_urlstring

Example response

{
  "id": "MB-LINK-37D90AAF51",
  "title": "Test Payment Link",
  "name": "Test Payment Link",
  "description": "Test description",
  "capacity": 1,
  "active": true,
  "return_url": "https://myawesomewebsite.com/paymentSuccess",
  "processing_fee_percentage": 0,
  "amount": 10,
  "amount_currency": "AED",
  "platform": "client",
  "prefilled_customer": {},
  "external_id": null,
  "hold_and_charge_later": false,
  "internal_note": null,
  "lang": "en",
  "expiration_date": null,
  "enable_message": false,
  "enable_tips": false,
  "enable_tabby": false,
  "link_type": "standalone",
  "enable_customer_details": false,
  "save_card": "off",
  "is_widget": false,
  "max_amount": null,
  "processing_fee_amount": null,
  "enable_quantity": false,
  "payment_methods": [
    "card",
    "wallet"
  ],
  "rules": {
    "allowed": []
  },
  "subscription": null,
  "first_name": null,
  "last_name": null,
  "email": null,
  "payouts_share": null,
  "custom_data": {},
  "payment_url": "https://sandbox.dev.business.mamopay.com/pay/mamo-c1f890",
  "send_customer_receipt": true,
  "terms_and_conditions_url": null,
  "charges": [
    {
      "status": "captured",
      "id": "MPB-CHRG-E0CE93E071",
      "amount": 100,
      "refund_amount": 0,
      "refund_status": "No refund",
      "billing_descriptor": "Mamo*Merchant",
      "custom_data": {
        "internal_customer_id": "0114120d-c394-4cce-9cdb-4ccbae605748",
        "val1": true,
        "val2": "custom value"
      },
      "created_date": "2023-05-31-11-18-57",
      "subscription_id": "MPB-SUB-B764EDCBA2",
      "settlement_amount": 356.42,
      "settlement_currency": "AED",
      "settlement_date": "05/06/2023",
      "customer_details": {
        "name": "Mamo User",
        "email": "email@mamopay.com",
        "phone_number": "+971551234567",
        "comment": "Dolore voluptate possimus et."
      },
      "payment_method": {
        "type": "CREDIT VISA",
        "card_holder_name": "Mamo User",
        "card_last4": "•••• 4242",
        "origin": "UAE card"
      }
    }
  ]
}