Update Invoice Settings

Updating your invoice settings enables you to customize the checkout experience of the invoice payment page to match your branding:
  • Brand colors
  • Business name
  • Logo
  • VAT tax number
You can also choose to capture a customer's shipping information, phone number, and email during the checkout process.
To enable payer authentication, see Add Payer Authentication to Invoicing.

Endpoints

Send your API request message to one of these endpoints: 
Production:
PUT
https://api.cybersource.com
/invoicing/v2/invoiceSettings
Test:
PUT
https://apitest.cybersource.com
/invoicing/v2/invoiceSettings
Production in India:
PUT https://api.in,cybersource.com/invoicing/v2/invoiceSettings

Fields for Updating Invoice Settings

The update invoice 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.
Update Checkout Page Settings
Name
API Request Field
Description
Business Name
invoiceSettingsInformation.merchantDisplayName
The business name displayed on the invoice.
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 reference guide..
Header Background Color
invoiceSettingsInformation.headerStyle.backgroundColor
The background color of the displayed invoice.
Only hexadecimal code values with a prefixed
#
 are accepted.
Example:
#000000
Header Font Color
invoiceSettingsInformation.headerStyle.fontColor
The invoice font color.
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 in the invoice.
Possible values:
  • false
    : Do not display the VAT tax number.
  • true
    : Display the VAT tax number.
Update Email Communication Settings
Name
API Request Field
Description
Email Message
invoiceSettingsInformation.customEmailMessage
The custom message in the invoice email.
Email Reminder
invoiceSettingsInformation.enableReminders
The toggle for sending an email reminder to the customer five days before the invoice due and one day after it is past due.
Possible values:
  • False
    : No email reminder is sent.
  • True
    : Email reminders are sent.
Language
invoiceSettingsInformation.deliveryLanguage
The language of the email message sent to the customer.
Set to one of these possible values:
  • de-DE
    : German (Germany)
  • en-US
    : English (United States)
  • es-419
    : Spanish as used in Latin America and the Caribbean
  • fr-FR
    : French (France)
  • ja-JP
    : Japanese (Japan)
  • pt-BR
    : Portuguese (Brazil)
  • ru-RU
    : Russian (Russia)
  • zh-CN
    : Chinese (Simplified, People's Republic of China)
  • zh-TW
    : Chinese (Traditional, Taiwan)
Payer Authentication Enablement Settings
Name
API Request Field
Description
Payer Authentication Enablement
invoiceSettingsInformation.payerAuthenticationInInvoicing
The indicator for payer authentication enablement.
Possible values:
  • disable
    : Disable 3-D Secure
  • enable
    : Enable 3-D Secure payer authentication
For more information about including payer authentication to your invoices, see Add Payer Authentication to Invoicing.

Example: Update Invoice Settings

REST Interactive Example: Update Invoice Settings

Click this image to access the interactive code example for updating invoice settings.

Figure:

Update Invoice Settings in the Developer Center Sandbox
Image and link to the interactive code example for updating invoice settings.
Light Dark
Request
123456789101112131415
{"invoiceSettingsInformation": {
    "merchantLogo": "/9j/4AAQSkZJRgABAQEAYA",
    "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"
  }}
Response to a Successful Request
1234567891011121314151617
{"submitTimeUtc": "2024-07-27T22:20:52.238332595Z",
  "invoiceSettingsInformation": {
    "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
  }}