cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
108 lines (72 loc) • 3.79 kB
Markdown
# CyberSource.InvoiceSettingsApi
All URIs are relative to *https://apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getInvoiceSettings**](InvoiceSettingsApi.md#getInvoiceSettings) | **GET** /invoicing/v2/invoiceSettings | Get Invoice Settings
[**updateInvoiceSettings**](InvoiceSettingsApi.md#updateInvoiceSettings) | **PUT** /invoicing/v2/invoiceSettings | Update Invoice Settings
<a name="getInvoiceSettings"></a>
# **getInvoiceSettings**
> InvoicingV2InvoiceSettingsGet200Response getInvoiceSettings(opts)
Get Invoice Settings
Allows you to retrieve the invoice settings for the payment page.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.InvoiceSettingsApi();
var opts = {
'productType': "productType_example" // String | Allows you to choose which product type settings you want to update.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInvoiceSettings(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**productType** | **String**| Allows you to choose which product type settings you want to update. | [optional]
### Return type
[**InvoicingV2InvoiceSettingsGet200Response**](InvoicingV2InvoiceSettingsGet200Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
<a name="updateInvoiceSettings"></a>
# **updateInvoiceSettings**
> InvoicingV2InvoiceSettingsGet200Response updateInvoiceSettings(invoiceSettingsRequest, opts)
Update Invoice Settings
Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.InvoiceSettingsApi();
var invoiceSettingsRequest = new CyberSource.InvoiceSettingsRequest(); // InvoiceSettingsRequest |
var opts = {
'productType': "productType_example" // String | Allows you to choose which product type settings you want to update.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateInvoiceSettings(invoiceSettingsRequest, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**invoiceSettingsRequest** | [**InvoiceSettingsRequest**](InvoiceSettingsRequest.md)| |
**productType** | **String**| Allows you to choose which product type settings you want to update. | [optional]
### Return type
[**InvoicingV2InvoiceSettingsGet200Response**](InvoicingV2InvoiceSettingsGet200Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8