Get Invoice Settings

You can retrieve the invoice settings for your payment page by sending a get invoice request.

Endpoints

Send the API request to one of these endpoints:
Production:
GET
https://api.cybersource.com
/invoicing/v2/invoiceSettings
Test:
GET
https://apitest.cybersource.com
/invoicing/v2/invoiceSettings
Production in India:
GET https://api.in.cybersource.com/invoicing/v2/invoiceSettings

Successful Response

A successful request is indicated by a response message that includes this information:
  • Logo
  • Business name
  • Customized email message
  • Email reminder indicator
  • Color and font of the invoice
  • Language used in the invoice
  • Currency of the invoiced amount
  • Payer authentication enablement indicator

Example: Get Invoice Settings

REST Interactive Example: Get 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
1
{}
Response to a Successful Request
1234567891011121314151617
{"submitTimeUtc": "2024-07-27T23:42:03.522831275Z",
  "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
  }}