Skip to main content
Version: Lab (preview)

PaymentLinkInput

INPUT

Input for payment link.

Fields

accepted_payment_methods
AcceptedPaymentMethodsEnum
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
Account Code that will be passed in to every transaction made with this payment link.
amount
Int
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
If set to true the payor will be able to enter the amount they want to pay.
call_to_action
CallToActionType
The call to action that will be displayed on the button at the time of checkout.
Values
BOOKDONATEPAY
currency
String
The type of currency for the payment.
custom_success_message
String
The message that will be displayed to the payor after a successful payment.
fee_mode
FeeMode
The fee mode of the payments that will be made with the payment link.
Values
CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE
link_nameRequired
String
The name you give to the payment link for internal tracking purposes.
max_amount
Int
The maximum amount the payor can pay if amount_is_variable is set to true.
merchant_uidRequired
String
The Pay Theory unique identifier assigned to the merchant that the transaction belongs to.
min_amount
Int
The minimum amount the payor can pay if amount_is_variable is set to true.
payment_description
String
The description of the payment that will be displayed to the customer.
payment_nameRequired
String
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.
redirect_url
String
The url that the payor will be redirected to after a successful payment.
require_phone
Boolean
If set to true the payor will be required to enter their phone number before making the payment.