Skip to main content

Invoice Settings

The Invoice Settings API enables customization of the invoice payment page, email notifications, and payer authentication. Settings include branding identity, payment page label controls, customer data collection fields, redirect URLs, and email notification preferences.

Get Invoice Settings

The Get Invoice Settings endpoint retrieves the active settings configuration for invoice customization. The response includes branding, payment page labels, customer data field settings, email notification preferences, redirect URLs, and payer authentication status.

Endpoint

GET /invoicing/v2/invoiceSettings?productType=INVOICING

GET /invoicing/v2/invoiceSettings?productType=INVOICING

GET /invoicing/v2/invoiceSettings?productType=INVOICING

Example

This endpoint requires no request body.
{  "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"    }  }}

A successful response includes:

FieldDescription
invoiceSettingsInformation.merchantLogoBase64-encoded merchant logo.
invoiceSettingsInformation.merchantDisplayNameBusiness name displayed on the invoice payment page.
invoiceSettingsInformation.customEmailMessageCustom message in invoice notification emails.
invoiceSettingsInformation.enableRemindersWhether automated payment reminders are enabled.
invoiceSettingsInformation.headerStyle.backgroundColorHex color code for the payment page header background.
invoiceSettingsInformation.headerStyle.fontColorHex color code for the payment page header font.
invoiceSettingsInformation.deliveryLanguageLanguage for invoice emails.
invoiceSettingsInformation.defaultCurrencyCodeDefault currency code.
invoiceSettingsInformation.payerAuthentication3DSVersionPayer authentication status. Returned as "True" when enabled, "False" when disabled.
invoiceSettingsInformation.showVatNumberWhether the VAT number is displayed.
invoiceSettingsInformation.phoneNumberWhether the phone number field is displayed on the payment page.
invoiceSettingsInformation.shipToWhether the shipping address field is displayed on the payment page.
invoiceSettingsInformation.emailWhether the email field is displayed on the payment page.
invoiceSettingsInformation.enableMerchantEmailNotificationsWhether merchant email notifications are enabled.
invoiceSettingsInformation.customLabels[]Custom payment page label configuration.
invoiceSettingsInformation.customRedirectUrlsRedirect URLs for payment accepted, rejected, and pending states.
merchantInformation.nameMerchant business name.
merchantInformation.phoneMerchant phone number.
merchantInformation.addressDetailsMerchant address.

Update Invoice Settings

To reset a field to its default value, send the field with an empty value. This applies to all fields except payment page label controls.

Brand IdentityCustomize the checkout experience of your invoice payment to match your branding: » Brand colors » Business name » Logo » VAT tax numberCustomer Data and Redirect URLsCustomize how you save customer billing information and set custom redirect URLs after transaction completion.Email notification behaviorCustomize your email message, frequency of payment reminders, successful transaction notifications, and language settings.Payer Authentication enablementIf you are using Payer Authentication, you must send this request to enable it.Label ControlsRename certain labels that display on the payment page and remove certain labels from displaying.

Endpoint

PUT /invoicing/v2/invoiceSettings?productType=INVOICING

PUT /invoicing/v2/invoiceSettings?productType=INVOICING

PUT /invoicing/v2/invoiceSettings?productType=INVOICING

Example

{  "invoiceSettingsInformation": {    "merchantLogo": "/9j/4AWFhYW",    "merchantDisplayName": "Custom Merchant Display Name",    "customEmailMessage": "Custom merchant email message",    "enableReminders": true,    "headerStyle": {      "fontColor": "#000001",      "backgroundColor": "#FFFFFF"    },    "deliveryLanguage": "en-US",    "defaultCurrencyCode": "USD",    "payerAuthenticationInInvoicing": "enable",    "showVatNumber": false,    "vatRegistrationNumber": "Inv1234",    "shipTo": false,    "phoneNumber": false,    "email": false,    "enableMerchantEmailNotifications": false,    "customLabels": [      {        "key": "billTo",        "value": "Payee name"      }    ],    "customRedirectUrls": {      "paymentAccepted": "https://example.com/success",      "paymentRejected": "https://example.com/fail",      "paymentPending": "https://example.com/pending"    }  }}
{  "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"    }  }}

Branding Identity

FieldTypeDescription
invoiceSettingsInformation.merchantDisplayNamestringBusiness name displayed on the invoice payment page.
invoiceSettingsInformation.defaultCurrencyCodestringDefault currency code for invoices. Default: USD.
invoiceSettingsInformation.headerStyle.backgroundColorstringHex color code for the payment page header background.
invoiceSettingsInformation.headerStyle.fontColorstringHex color code for the payment page header font.
invoiceSettingsInformation.merchantLogostringBase64-encoded logo image. Maximum size: 1 MB. Supported formats: gif, jpg, png.
invoiceSettingsInformation.vatRegistrationNumberstringVAT registration number to display on invoices.
invoiceSettingsInformation.showVatNumberbooleanSet to true to display the VAT number on the payment page.

Payment Page Labels

Use these fields to rename labels visible on the payment page.

FieldTypeDescription
invoiceSettingsInformation.customLabels[].keystringThe label to rename. Values: billTo, companyName, customerId, description, discount, invoiceNumber, partialPayment, shipping, tax.
invoiceSettingsInformation.customLabels[].valuestringThe replacement label text to display.

Use these fields to remove labels from the payment page.

FieldTypeDescription
invoiceSettingsInformation.customLabels[].keystringThe label to remove. Values: customerId, description, discount, invoiceNumber, partialPayment.
invoiceSettingsInformation.customLabels[].hiddenbooleanSet to true to remove the label from the payment page.

Use these fields to hide labels for specific product views.

FieldTypeDescription
invoiceSettingsInformation.customLabels[].keystringValues: discount, tax.
invoiceSettingsInformation.customLabels[].hiddenForInvoicebooleanSet to true to remove the label from the invoice view.
invoiceSettingsInformation.customLabels[].hiddenForItembooleanSet to true to remove the label from the line item view.

Customer Data and Redirect URLs

FieldTypeDescription
invoiceSettingsInformation.shipTobooleanSet to true to display the shipping address field on the payment page.
invoiceSettingsInformation.phoneNumberbooleanSet to true to display the phone number field on the payment page.
invoiceSettingsInformation.emailbooleanSet to true to display the email field on the payment page.
invoiceSettingsInformation.customRedirectUrls.paymentAcceptedstringURL to redirect the customer after a successful payment.
invoiceSettingsInformation.customRedirectUrls.paymentPendingstringURL to redirect the customer when a payment is pending.
invoiceSettingsInformation.customRedirectUrls.paymentRejectedstringURL to redirect the customer after a failed payment.

Email Notifications

FieldTypeDescription
invoiceSettingsInformation.customEmailMessagestringCustom message to include in invoice notification emails.
invoiceSettingsInformation.enableRemindersbooleanSet to true to enable automated payment reminders. Reminders are sent five days before the due date and one day after the due date.
invoiceSettingsInformation.enableMerchantEmailNotificationsbooleanSet to true to receive merchant email notifications for invoice events.
invoiceSettingsInformation.deliveryLanguagestringLanguage for invoice emails. Values: de-DE, en-US, es-419, fr-FR, ja-JP, pt-BR, ru-RU, zh-CN, zh-TW.

Payer Authentication

FieldTypeDescription
invoiceSettingsInformation.payerAuthenticationInInvoicingstringSet to enable to activate payer authentication for invoice payments. Set to disable to deactivate.

Last published: September 29, 2026