@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
97 lines (96 loc) • 7.98 kB
TypeScript
/**
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
/**
*
* @export
* @interface Ptsv2paymentreferencesOrderInformationAmountDetails
*/
export interface Ptsv2paymentreferencesOrderInformationAmountDetails {
/**
* Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
totalAmount?: string;
/**
* Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
currency?: string;
/**
* Total discount amount applied to the order.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
discountAmount?: string;
/**
* Total tax amount for all the items in the order.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
taxAmount?: string;
/**
* Total charges for any import or export duties included in the order.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
dutyAmount?: string;
/**
* Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
exchangeRate?: string;
/**
* Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
exchangeRateTimeStamp?: string;
/**
* This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions.
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
settlementCurrency?: string;
/**
* giftwrap amount (RFU).
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
giftwrapAmount?: string;
/**
* handling amount (RFU)
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
handlingAmount?: string;
/**
* shipping amount (RFU)
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
shippingAmount?: string;
/**
* shipping discount amount (RFU)
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
shippingDiscountAmount?: string;
/**
* insurance amount (RFU)
* @type {string}
* @memberof Ptsv2paymentreferencesOrderInformationAmountDetails
*/
insuranceAmount?: string;
}