Skip to main content
Version: Lab (preview)

updatePaymentLink

MUTATION

Updates payment link.

Arguments

inputRequired
UpdatePaymentLinkInput
This object contains all the details needed to update a payment link.

Response

PaymentLink
accepted_payment_methods
AcceptedPaymentMethodsEnum| null
The payment methods that will be available to a payor when making a payment.
Values
ALLNOT_ACHNOT_CARDNOT_CASHONLY_ACHONLY_CARDONLY_CASH
account_code
String| null
Account Code that will be passed in to every transaction made with this payment link.
amount
Int| null
The amount of the payment that the payor will be asked to pay or if amount_is_variable is set to the amount that will be the default amount.
amount_is_variable
Boolean| null
If set to true the payor will be able to enter the amount they want to pay.
call_to_action
CallToActionType| null
The call to action that will be displayed on the button at the time of checkout.
Values
BOOKDONATEPAY
created_date
AWSDateTime| null
The date and time the payment link was created.
currency
String| null
The type of currency for the payment.
custom_success_message
String| null
The message that will be displayed to the payor after a successful payment.
fee_mode
FeeMode| null
The fee mode of the payments that will be made with the payment link.
Values
CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE
is_active
Boolean| null
If set to true the payment link will be active and available to payors. If set to false the payment link will not be available to payors.
link_id
String| null
The unique id of the payment link.
link_name
String| null
The name you give to the payment link for internal tracking purposes.
link_url
String| null
The url of the payment link.
max_amount
Int| null
The maximum amount the payor can pay if amount_is_variable is set to true.
merchant_uid
String| null
The Pay Theory unique identifier assigned to the merchant that the transaction belongs to.
min_amount
Int| null
The minimum amount the payor can pay if amount_is_variable is set to true.
payment_name
String| null
The name of the payment that will be displayed to the customer. This will be passed in as the reference at the time of the transaction.
payment_description
String| null
The description of the payment that will be displayed to the customer.
redirect_url
String| null
The url that the payor will be redirected to after a successful payment.
require_phone
Boolean| null
If set to true the payor will be required to enter their phone number before making the payment.