Update Payment Link

patch

https://sandbox.dev.business.mamopay.com/manage_api/v1/links/{linkId}

Allows a user to update payment link details

Path Params

linkId

string

required

Defaults to MB-LINK-6BB7CA8DC7

Payment link ID

Body Params

name

string

length between 1 and 75

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

Defaults to 1

The number of times a payment link can be used. 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

≥ 2

Defaults to 3

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

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 accepted payment methods, card always apart of default option. Example: ['card', 'wallet']

payment_methods

rules

object

Setting the rule for payment link

subscription

object

to be populated if this payment link is for a recurring payment. Otherwise, this property can be left out.

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.

external_id

string

hold_and_charge_later

boolean

Defaults to false

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

custom_data

object

payouts_share

object

Headers

Content-Type

string

Authorization

string

Responses

404

Invalid request

500

Unexpected error

200Successful response

403Unauthorised