Payment Links Error Reference
The table below describes the error codes returned by our Payment Links API. These codes help identify specific issues that may occur when creating, editing, or using payment links.
| Error Code | Description | Status Code |
|---|---|---|
| Key_AmountMustBeGreaterThanZero | The payment amount must be greater than zero. Provide a valid 'amount' to proceed. | 400 |
| Key_CanNotEditPaymentLinkInCurrentStatus | Cannot edit the payment link in its current status. Only payment links in editable states can be modified. | 400 |
| Key_CustomerRequired | The 'customers' object is required in your request. | 400 |
| Key_CustomersAddressRequired | The 'address' object is required for this request. Provide a valid address for the customer. | 400 |
| Key_CustomersCityRequired | The customer's city is required. Specify the 'city' in the 'address' object. | 400 |
| Key_CustomersCountryRequired | The customer's country is required. Include the 'country' in the 'address' object. | 400 |
| Key_CustomersEmailRequired | The customer's email address is required. Provide a valid 'email' address for the customer. | 400 |
| Key_CustomersFirstNameRequired | The customer's first name is required. Include the 'firstName' in the 'customers' object. | 400 |
| Key_CustomersLastNameRequired | The customer's last name is required. Include the 'lastName' in the 'customers' object. | 400 |
| Key_CustomersPhoneRequired | The customer's phone number is required. Provide a valid 'phone' number in the 'customers' object. | 400 |
| Key_CustomersPostalCodeRequired | The customer's postal code is required in the 'address' object. Provide a valid 'postalCode' in the 'address' object. | 400 |
| Key_CustomersStateRequired | The customer's 'state' is required in the 'address' object. | 400 |
| Key_DescriptionIsEmpty | The 'paymentDescription' parameter is empty. Provide a valid payment description. | 400 |
| Key_DescriptionIsTooLarge | The 'paymentDescription' parameter value is too long. Please shorten the description to meet the length requirements. | 400 |
| Key_ExpireInCannotBeLessThanOneHourOrGreaterThan70Days | The 'ExpireIn' value must be between one hour and 70 days. Adjust the expiration time accordingly. | 400 |
| Key_ExpireInRequired | The 'ExpireIn' parameter is required. Specify the expiration duration for the payment link. | 400 |
| Key_ExpireInUnitRequired | The 'ExpireInUnit' parameter is required. Specify the unit of time for the expiration (e.g., hours, days). | 400 |
| Key_IntentRequired | The 'intent' object is required. Include the 'intent' object and 'PaymentTypes' in your request. | 400 |
| Key_InvalidAdditionalDetailsPreference | The 'AdditionalDetailsPreference' provided is invalid. Please provide a valid preference setting. | 400 |
| Key_InvalidAmount | The 'amount' is invalid. Ensure the amount is a positive number and formatted correctly. | 400 |
| Key_InvalidInvoiceNumber | The invoice number provided is invalid. Verify the invoice number. | 400 |
| Key_InvalidMerchant | The merchant ID is invalid. Verify your merchant credentials. | 400 |
| Key_InvalidPaymentLink | The payment link ID provided is invalid. Verify the 'paymentLinkID' value. | 400 |
| Key_InvalidPaymentType | One or more of the values in the 'paymentTypes' object is invalid. Specify a supported payment type. | 400 |
| Key_InvalidProtectionMode | The protection mode specified is invalid. Please provide a valid protection mode setting. | 400 |
| Key_InvalidRequest | The request is invalid because it is empty. Ensure your request includes the necessary data. | 400 |
| Key_InvalidResponseType | The 'responseType' specified is invalid. Use a valid response type. | 400 |
| Key_LinkTitleRequired | The 'title' parameter is required. Provide a 'title' for the payment link. | 400 |
| Key_LinkTitleShouldBeLessThanOrEqualTo80Characters | The 'title' parameter should be 80 characters or fewer. Shorten the title and try again. | 400 |
| Key_LinkTitleShouldBeUnique | The link 'title' must be unique. Choose a different title for your payment link. | 400 |
| Key_MerchantInActive | The merchant account is inactive. Contact support to reactivate the merchant account. | 400 |
| Key_PaymentDescriptionRequired | The 'paymentDescription' parameter is required. Include a description for the payment. | 400 |
| Key_PaymentTypeRequired | The 'paymentTypes' parameter is required. Specify the accepted payment types in your request. | 400 |
| Key_RedirectionTimeCannotGreater999 | The 'redirectionTime' value cannot be greater than 999 seconds. | 400 |
| Key_RedirectionTimeCannotLess15 | The 'redirectionTime' value cannot be less than 15 seconds. Increase the redirection time. | 400 |
| Key_RequestBodyCannotBeEmpty | The request body cannot be empty. Include the required data in your request. | 400 |
| Key_SelectedCustomerFieldsRequired | The 'SelectedCustomerFields' parameter is required. Specify the customer fields to include in the payment link. | 400 |
| Key_SettingsRequired | The 'settings' object is required. Include the settings details in your request. | 400 |
| Key_ShouldBeAValidBooleanValue | An invalid boolean value was provided for the 'suppressTechnologyFee' or 'overrideTechnology' parameter. Use 'true' or 'false' and try again. | 400 |
| UnAuthorized | The Payment Link feature is disabled for this merchant. Contact support to enable this feature. | 401 |