On This Page {#jumplink-list} [Markdown](/docs/cybs/en-us/paybylink/developer/all/rest/paybylink/paybylink-services/paybylink-services-update-settings-intro.md) Filter FILTER BY TAG Update Payment Link Settings {#paybylink-services-update-settings-intro} ======================================================================== Use payment link settings to configure and manage the behavior and appearance of your payment page. You can update these payment link settings: ![Branding Identity: Customize the checkout experience of your payment page to match your branding, such as Brand colors, Business name, Logo, VAT tax number. Redirect URLs: Set custom redirect URLs that display after a customer completes a payment.](/content/dam/documentation/cybs/en-us/topics/payments-processing/payment-services/paybylink/images/paybylink-update-settings-600x160.svg/jcr:content/renditions/original) Reset to Default Settings {#paybylink-services-update-settings-intro_reset-settings} ------------------------------------------------------------------------------------ To reset your payment link settings to their default values, send the corresponding fields you want to reset with no value. Endpoints --------- Send your API request message to one of these endpoints: **Production:** `PUT ``https://api.cybersource.com``/invoicing/v2/invoiceSettings?productType=PAYBYLINK` **Test:** `PUT ``https://apitest.cybersource.com``/invoicing/v2/invoiceSettings?productType=PAYBYLINK` **India Production:** `PUT https://api.in,cybersource.com/invoicing/v2/invoiceSettings?productType=PAYBYLINK` Required Fields for Update Settings {#paybylink-services-update-settings-req-fields} ==================================================================================== The update payment link settings request does not require a specific set of fields. Instead, you can choose the fields to include in your request based on aspects of your checkout experience, email communications, and payer authentication enablement that you want to update. | Name | API Request Field | Description | |--------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Business Name | invoiceSettingsInformation. merchantDisplayName | The business name displayed on the payment page. | | Currency | invoiceSettingsInformation. defaultCurrencyCode | The currency of the billed amount. The currency code default value is set to `USD` when this field is not specified. Only three-character ISO Standard Currency Codes are accepted. For more information, see [ISO Standard Currency Codes](https://developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.md "") reference guide.. | | Header Background Color | invoiceSettingsInformation. headerStyle.backgroundColor | The background color of the displayed payment page. Only hexadecimal code values with a prefixed `#` are accepted. Example: `#000000` | | Logo | invoiceSettingsInformation. merchantLogo | The binary format of your logo that determines the image displayed to your customers. Image files are restricted to 1 MB and must be encoded in Base64 format. These are the supported file types: * gif * jpg * png | | VAT Tax Number | invoiceSettingsInformation. vatRegistrationNumber | The government-assigned tax identification number. | | VAT Tax Number Displayed | invoiceSettingsInformation. showVatNumber | The toggle for displaying the VAT tax number on the payment page. Possible values: * `false`: Do not display the VAT tax number. * `true`: Display the VAT tax number. | [Branding Identity Settings] | Name | API Request Field | Description | |-------------------------------------|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | Successful Transaction Redirect URL | invoiceSettingsInformation. customRedirectUrls. paymentAccepted | The URL that the customer is redirected to after completing a successful transaction in which the payment is processed. | | Pending Transaction Redirect URL | invoiceSettingsInformation. customRedirectUrls. paymentPending | The URL that the customer is redirected to after completing checkout and the payment is pending. | | Failed Transaction Redirect URL | invoiceSettingsInformation. customRedirectUrls. paymentRejected | The URL that the customer is redirected to after a transaction is rejected. | [Payment Page Redirect URL Settings] Example: Update Payment Link Settings {#paybylink-services-update-settings-ex-rest} =================================================================================== Request ``` { "invoiceSettingsInformation": { "merchantLogo": "/9j/4AWFhYW", "merchantDisplayName": "Custom Merchant Display Name", "headerStyle": { "fontColor": "#000001", "backgroundColor": "#FFFFFF" }, "defaultCurrencyCode": "USD", "showVatNumber": false, "vatRegistrationNumber": "Inv1234", "customRedirectUrls": { "paymentAccepted": "https://example.com/success", "paymentRejected": "https://example.com/fail", "paymentPending": "https://example.com/pending" } } } ``` Response to a Successful Request ``` { "submitTimeUtc": "2026-02-03T20:48:27.917947446Z", "invoiceSettingsInformation": { "merchantLogo": "data:image/JPEG;base64,/9j/4AWFhYW", "merchantDisplayName": "Custom Merchant Display Name", "customEmailMessage": "Custom merchant email message", "enableReminders": true, "headerStyle": { "fontColor": "#000001", "backgroundColor": "#FFFFFF" }, "deliveryLanguage": "en-US", "defaultCurrencyCode": "USD", "payerAuthentication3DSVersion": "True", "showVatNumber": false, "phoneNumber": false, "shipTo": false, "email": true, "enableMerchantEmailNotifications": false, "customLabels": [ { "key": "billTo", "value": "Payee name" } ], "customRedirectUrls": { "paymentAccepted": "https://example.com/success", "paymentRejected": "https://example.com/fail", "paymentPending": "https://example.com/pending" } }, "merchantInformation": { "name": "API Ref Sandbox", "phone": "4251231234", "addressDetails": { "address1": "123 Main St", "city": "Bellevue", "state": "WA", "country": "us", "postalCode": "98005" } } } ``` Response Statuses for Updating Payment Link Settings {#paybylink-services-update-settings-resp-status} ====================================================================================================== | Status | Description | |--------|-----------------------------------------------------------------| | `200` | The request is successful. | | `400` | The request not successful due to field validation errors. | | `502` | The request not successful due to an unexpected error occurred. | [Response Statuses for Updating Payment Link Settings] RELATED TO THIS PAGE * [Getting Started with REST](https://developer.cybersource.com/docs/cybs/en-us/platform/developer/all/rest/rest-getting-started/restgs-intro.md) * [Response Codes](https://developer.cybersource.com/api/reference/response-codes.md) * [API Field Reference Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/rest-api-fields-intro.md) * [API Reference Sandbox](https://developer.cybersource.com/api-reference-assets/index.md#static-home-section) * [Business Center Test](https://businesscentertest.cybersource.com/ebc2/) * [Business Center Production](https://businesscenter.cybersource.com/ebc2/) * [Customer Support](https://support.visaacceptance.com/)