On This Page
REST API
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:
- merchantLogoThe binary file format of your logo. We display your logo image on the invoices we send to your customers.
- merchantDisplayNameYour business name that we display on the invoices we send to your customers.
- customEmailMessageThe custom message that we include on your invoices. This is different from the standard invoice text.
- enableRemindersA boolean value indicating whether we send invoice email reminders to your customers. Iftrue, 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.
- headerStyleUse this object to set the font and background color of the invoices sent to your customers.
- deliveryLanguageThe 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, ores-419. The default value isen-US. This is the language of the standard invoice text.
- defaultCurrencyCodeThe three-letter ISO currency code of the default currency used in your invoices; for example,USDfor US dollar.
- payerAuthentication3DSVersionWhether 3D Secure payer authentication is disabled or the 3D Secure version for a merchant's invoice payments. Possible values are:1,2,None, orDisabled.Nonemeans you have never activated this feature.Disabledmeans 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.