Menu

Get Invoice Settings

To get your invoice settings, send a GET request to the invoiceSettings resource.
Get your invoice settings from the following resource: 
Sandbox:
GET https://apitest.cybersource.com/invoicing/v2/invoiceSettings
Live:
GET https://api.cybersource.com/invoicing/v2/invoiceSettings
Live in India:
GET https://api.in.cybersource.com/invoicing/v2/invoiceSettings
For more details, see the Get Invoice Settings section of the interactive API Reference.
Note:
All CyberSource APIs require API authentication. See Authentication for details.

Request

To get your invoice settings, send a
GET
request to the
invoiceSettings
resource.
Request example:
GET https://api.cybersource.com/invoicing/v2/invoiceSettings

Response

If the request is successful, the API returns your invoice settings.
A successful response contains the following fields:
  • merchantLogo
    The binary file 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
    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
    , or
    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.
  • payerAuthentication3DSVersion
    Whether 3D Secure payer authentication is disabled or the 3D Secure version for a merchant's invoice payments. Possible values are:
    1
    ,
    2
    ,
    None
    , or
    Disabled
    .
    None
    means you have never activated this feature.
    Disabled
    means you activated and then disabled this feature. See 3D Secure and Payer Authentication in Invoicing Additional Features to learn more about this feature.
Response example:
{ "submitTimeUtc": "2020-02-25T22:27:11Z", "invoiceSettingsInformation": { "merchantLogo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAQCAwMDAgQDAwMEBAQEBQkGBQUFBQsICAYJDQsNDQ0LDAwOEBQRDg8TDwwMEhgSExUWFxcXDhEZGxkWGhQWFxb/2wBDAQQEBAUFBQoGBgoWDwwPFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhb/wAARCADHAM0DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAEC...<remainder-of-image-file-blob>...", "merchantDisplayName": "Art Supplies Co.", "customEmailMessage": "Thank you for your business. Please pay your invoice in a timely manner. You can contact us at 512-555-1212 to inquire about setting up a payment or financing plan.", "enableReminders": true, "headerStyle": { "fontColor": "#76448A", "backgroundColor": "#EBDEF0" }, "deliveryLanguage": "en-US", "defaultCurrencyCode": "USD", "payerAuthentication3DSVersion": "1" } }
For more details, see the Get Invoice Settings section of the interactive API Reference.
Back to top