On This Page

REST API

Update Invoice Settings

To update your invoice settings, use the

invoiceSettings

resource.

Use the following resource to update your invoice settings:

Test:

PUT https://apitest.cybersource.com/invoicing/v2/invoiceSettings

Live:

PUT https://api.cybersource.com/invoicing/v2/invoiceSettings

Live in India:

PUT https://api.in,cybersource.com/invoicing/v2/invoiceSettings

For more details, see the Update Invoice Settings section of the interactive API Reference.

All Cybersource APIs require API authentication. See Getting Started with the REST API for details.

Request

To update your invoice settings, include the updated

invoiceSettingsInformation

object in the request body.

You can update these fields:

merchantLogo

The binary format of your logo. We display your logo image on the invoices we send to your customers.

merchantDisplayName

Your business name that we display on the invoices we send to your customers.

customEmailMessage

The custom message that we include on your invoices. This is different from the standard invoice text.

enableReminders

A boolean value indicating whether we send invoice email reminders to your customers. If set to

true

, we send a reminder twice. We send the first reminder five days before the invoice due date and a second reminder one day after the invoice due date.

headerStyle

Use this object to set the font and background color of the invoices sent to your customers.

deliveryLanguage

The five character locale code of the invoice language. You can choose one of the following languages:

zh-CN

zh-TW

en-US

fr-FR

de-DE

ja-JP

pt-BR

ru-RU

and

es-419

. The default value is

en-US

. This is the language of the standard invoice text.

defaultCurrencyCode

The three-letter ISO currency code of the default currency used in your invoices; for example,

USD

for US dollar.

See ISO Standard Currency Codes reference guide.

payerAuthenticationInInvoicing

For invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are:

disable

enable

, or

update

. See 3D Secure and Payer Authentication in Invoicing Additional Features to learn more about this feature.

Request example:

{
  "invoiceSettingsInformation": {
   "merchantLogo": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAQCAwMDAgQDAwMEBAQEBQk
                    GBQUFBQsICAYJDQsNDQ0LDAwOEBQRDg8TDwwMEhgSExUWFxcXDhEZGx
                    kWGhQWFxb/2wBDAQQEBAUFBQoGBgoWDwwPFhYWFhYWFhYWFhYWFhYWF
                    hYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhb/wAARCADH
                    AM0DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgc
                    ...<remainder-of-image-file-blob>...",
   "merchantDisplayName": "Art Supplies Co.",
   "customEmailMessage": "Please pay your invoice within 30 days.",
   "enableReminders": "true",
   "headerStyle": {
    "fontColor": "#FF0000",
    "backgroundColor": "#FFFFFF"
   }
   "deliveryLanguage": "en-US",
   "defaultCurrencyCode": "USD",
   "payerAuthenticationInInvoicing": "enable",
  }
}

Response

If the request is successful, the API returns your updated invoice settings.

Response example:

{
 "submitTimeUtc": "2020-02-25T22:27:11Z",
 "invoiceSettingsInformation": {
  "merchantLogo": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAQCAwMDAgQDAwMEBAQEBQk
                  GBQUFBQsICAYJDQsNDQ0LDAwOEBQRDg8TDwwMEhgSExUWFxcXDhEZGxk
                  WGhQWFxb/2wBDAQQEBAUFBQoGBgoWDwwPFhYWFhYWFhYWFhYWFhYWFhY
                  WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWF 
                  ...<remainder-of-image-file-blob>...",
  "merchantDisplayName": "Art Supplies Co.",
  "customEmailMessage": "Please pay your invoice within 30 days.",
  "enableReminders": "true",
  "headerStyle": {
   "fontColor": "#FF0000",
   "backgroundColor": "#FFFFFF"
  }
  "deliveryLanguage": "en-US",
  "defaultCurrencyCode": "USD",
  "payerAuthentication3DSVersion": "1"
 }
}