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

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:

Response Fields

invoiceSettingsInformation.merchantLogo string

Base64-encoded merchant logo.

invoiceSettingsInformation.merchantDisplayName string

Business name displayed on the invoice payment page.

invoiceSettingsInformation.customEmailMessage string

Custom message in invoice notification emails.

invoiceSettingsInformation.enableReminders boolean

Whether automated payment reminders are enabled.

invoiceSettingsInformation.headerStyle.backgroundColor string

Hex color code for the payment page header background.

invoiceSettingsInformation.headerStyle.fontColor string

Hex color code for the payment page header font.

invoiceSettingsInformation.deliveryLanguage string

Language for invoice emails.

invoiceSettingsInformation.defaultCurrencyCode string

Default currency code.

invoiceSettingsInformation.payerAuthentication3DSVersion string

Payer authentication status. Returned as "True" when enabled, "False" when disabled.

invoiceSettingsInformation.showVatNumber boolean

Whether the VAT number is displayed.

invoiceSettingsInformation.phoneNumber boolean

Whether the phone number field is displayed on the payment page.

invoiceSettingsInformation.shipTo boolean

Whether the shipping address field is displayed on the payment page.

invoiceSettingsInformation.email boolean

Whether the email field is displayed on the payment page.

invoiceSettingsInformation.enableMerchantEmailNotifications boolean

Whether merchant email notifications are enabled.

invoiceSettingsInformation.customLabels[] array

Custom payment page label configuration.

invoiceSettingsInformation.customRedirectUrls object

Redirect URLs for payment accepted, rejected, and pending states.

merchantInformation.name string

Merchant business name.

merchantInformation.phone string

Merchant phone number.

merchantInformation.addressDetails object

Merchant 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.

Endpoint

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

Field	Type	Description
`invoiceSettingsInformation.merchantDisplayName`	string	Business name displayed on the invoice payment page.
`invoiceSettingsInformation.defaultCurrencyCode`	string	Default currency code for invoices. Default: `USD`.
`invoiceSettingsInformation.headerStyle.backgroundColor`	string	Hex color code for the payment page header background.
`invoiceSettingsInformation.headerStyle.fontColor`	string	Hex color code for the payment page header font.
`invoiceSettingsInformation.merchantLogo`	string	Base64-encoded logo image. Maximum size: 1 MB. Supported formats: gif, jpg, png.
`invoiceSettingsInformation.vatRegistrationNumber`	string	VAT registration number to display on invoices.
`invoiceSettingsInformation.showVatNumber`	boolean	Set 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.

Field	Type	Description
`invoiceSettingsInformation.customLabels[].key`	string	The label to rename. Values: `billTo`, `companyName`, `customerId`, `description`, `discount`, `invoiceNumber`, `partialPayment`, `shipping`, `tax`.
`invoiceSettingsInformation.customLabels[].value`	string	The replacement label text to display.

Use these fields to remove labels from the payment page.

Field	Type	Description
`invoiceSettingsInformation.customLabels[].key`	string	The label to remove. Values: `customerId`, `description`, `discount`, `invoiceNumber`, `partialPayment`.
`invoiceSettingsInformation.customLabels[].hidden`	boolean	Set to `true` to remove the label from the payment page.

Use these fields to hide labels for specific product views.

Field	Type	Description
`invoiceSettingsInformation.customLabels[].key`	string	Values: `discount`, `tax`.
`invoiceSettingsInformation.customLabels[].hiddenForInvoice`	boolean	Set to `true` to remove the label from the invoice view.
`invoiceSettingsInformation.customLabels[].hiddenForItem`	boolean	Set to `true` to remove the label from the line item view.

Customer Data and Redirect URLs

Field	Type	Description
`invoiceSettingsInformation.shipTo`	boolean	Set to `true` to display the shipping address field on the payment page.
`invoiceSettingsInformation.phoneNumber`	boolean	Set to `true` to display the phone number field on the payment page.
`invoiceSettingsInformation.email`	boolean	Set to `true` to display the email field on the payment page.
`invoiceSettingsInformation.customRedirectUrls.paymentAccepted`	string	URL to redirect the customer after a successful payment.
`invoiceSettingsInformation.customRedirectUrls.paymentPending`	string	URL to redirect the customer when a payment is pending.
`invoiceSettingsInformation.customRedirectUrls.paymentRejected`	string	URL to redirect the customer after a failed payment.

Email Notifications

Field	Type	Description
`invoiceSettingsInformation.customEmailMessage`	string	Custom message to include in invoice notification emails.
`invoiceSettingsInformation.enableReminders`	boolean	Set to `true` to enable automated payment reminders. Reminders are sent five days before the due date and one day after the due date.
`invoiceSettingsInformation.enableMerchantEmailNotifications`	boolean	Set to `true` to receive merchant email notifications for invoice events.
`invoiceSettingsInformation.deliveryLanguage`	string	Language for invoice emails. Values: `de-DE`, `en-US`, `es-419`, `fr-FR`, `ja-JP`, `pt-BR`, `ru-RU`, `zh-CN`, `zh-TW`.

Payer Authentication

Field	Type	Description
`invoiceSettingsInformation.payerAuthenticationInInvoicing`	string	Set to `enable` to activate payer authentication for invoice payments. Set to `disable` to deactivate.

Was this page helpful?

Last published: October 28, 2026

Get Invoice Settings

Endpoint

Example

Update Invoice Settings

Endpoint

Example

Branding Identity

Payment Page Labels

Customer Data and Redirect URLs

Email Notifications

Payer Authentication

Not available for your audience