From 75d587c44d78c3280a05556184c7e3f720c83bba Mon Sep 17 00:00:00 2001
From: snavinch
- * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
- *
\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps\nthe standard AVS return codes for other types of payment cards, including American Express cards, to\nthe Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the\ncustomer's payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource\nand are not standard Visa codes. These AVS codes\ncan be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n",
"items": {
"type": "string",
"enum": [
@@ -684,7 +829,7 @@
},
"credentialStoredOnFile": {
"type": "boolean",
- "description": "Flag that indicates whether merchant intends to use this transaction to store payment credentials for follow-up\nmerchant-initiated transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nSee \"Merchant-Initiated Transactions,\" page 177.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n",
+ "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder\u2019s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant\u2019s file for future transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n",
"enum": [
true,
false
@@ -692,7 +837,7 @@
},
"storedCredentialUsed": {
"type": "boolean",
- "description": "Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up\nmerchant-initiated transactions or not.\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file.\n\nPossible values:\n- **true** means the merchant-initiated transaction came from a card that was already stored on file.\n- **false** means the merchant-initiated transaction came from a card that was not stored on file.\n",
"enum": [
true,
false
@@ -704,7 +849,7 @@
"reason": {
"type": "string",
"maxLength": 1,
- "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n**All Processors**\\\nSee \"Merchant-Initiated Transactions,\" page 196. For CyberSource through VisaNet, see also \"Incremental Authorizations,\" page 40.\n"
+ "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n#### All Processors\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"previousTransactionId": {
"type": "string",
@@ -717,11 +862,11 @@
},
"billPayment": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan. See \"Visa Bill Payments,\" page 220, and \"Visa Debt Repayments,\" page 221, for lists of processors that support these features.\n\nPossible values:\n- true: Bill payment or loan payment.\n- false (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
},
"billPaymentType": {
"type": "string",
- "description": "Reason for the payment.\n\nPossible values:\n- 001: Utility payment\n- 002: Government services\n- 003: Mobile phone top-up\n- 004: Coupon payment\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThis field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet.\nSee Mastercard Bill Payments.\n\nNote For information about bill payments with Visa, see Visa Bill Payments.\n"
+ "description": "Reason for the payment.\n\nPossible values:\n- 001: Utility payment\n- 002: Government services\n- 003: Mobile phone top-up\n- 004: Coupon payment\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThis field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet.\n\n**Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -732,13 +877,13 @@
"type": "number",
"minimum": 1,
"maximum": 99,
- "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"
+ "description": "Capture number when requesting multiple partial captures for one authorization.\nUsed along with `totalCaptureCount` to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber_ = 2`, and\n - `totalCaptureCount = 5`\n"
},
"totalCaptureCount": {
"type": "number",
"minimum": 1,
"maximum": 99,
- "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"
+ "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber = 2`, and\n - `totalCaptureCount = 5`\n"
},
"dateToCapture": {
"type": "string",
@@ -752,7 +897,7 @@
"properties": {
"loanPayment": {
"type": "boolean",
- "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n",
+ "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
true,
false
@@ -761,7 +906,7 @@
},
"firstRecurringPayment": {
"type": "boolean",
- "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - **true** Indicates this is the first payment in a series of recurring payments\n - **false** (default) Indicates this is not the first payment in a series of recurring payments.\n\nFor more details, see \"Recurring Payments,\" page 198.\n",
+ "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - `true` Indicates this is the first payment in a series of recurring payments\n - `false` (default) Indicates this is not the first payment in a series of recurring payments.\n\nFor more details, see \"Recurring Payments,\" page 198.\nFor details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in\n[Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
true,
false
@@ -776,12 +921,12 @@
"declineAvsFlags": {
"type": "string",
"maxLength": 15,
- "description": "List of AVS flags that cause the request to be declined for AVS reasons. Use a space to separate the flags in\nthe list. Important Make sure that you include the value N in the list if you want to receive declines for the\nAVS code N.\n"
+ "description": "Space-separated list of AVS flags that cause the request to be declined for AVS reasons.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list.\n\n### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing\n\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n|AVS Code|Description|\n|--- |--- |\n|D|Partial match: postal code and address match.|\n|E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.|\n|F|Partial match: postal code matches, but CPF and address do not match.*|\n|G|Not supported: AVS not supported or not verified.|\n|I|No match: AVS information is not available.|\n|K|Partial match: CPF matches, but postal code and address do not match.*|\n|L|Partial match: postal code and CPF match, but address does not match.*|\n|N|No match: postal code, CPF, and address do not match.*|\n|O|Partial match: CPF and address match, but postal code does not match.*|\n|R|Not supported: your implementation does not support AVS _or_ System unavailable.|\n|T|Partial match: address matches, but postal code and CPF do not match.*|\n|V|Match: postal code, CPF, and address match.*|\n|* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.||\n\n### AVS Codes for All Other Processors\n\n**Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes.\n\n#### American Express Cards\nFor American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes.\n\n**Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the customer\u2019s payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n"
},
"secCode": {
"type": "string",
"maxLength": 3,
- "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n"
+ "description": "Authorization method used for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `PPD`\n- `TEL`\n- `WEB`\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"terminalCity": {
"type": "string",
@@ -801,7 +946,7 @@
"partialPaymentId": {
"type": "string",
"maxLength": 25,
- "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n"
+ "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"customerMemo": {
"type": "string",
@@ -811,17 +956,17 @@
"paymentCategoryCode": {
"type": "string",
"maxLength": 1,
- "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments. See \"Deferred and Partial Payments,\" page 37.\n\nPossible values:\n- **0**: Standard debit with immediate payment (default).\n- **1**: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- **2**: For deferred payments, indicates notification to initiate payment.\n\nChase Paymentech Solutions and TeleCheck Use for deferred and partial payments.\n\nCyberSource ACH Service Not used.\n\nRBS WorldPay Atlanta Not used.\n"
+ "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\nFor details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible values:\n- `0`: Standard debit with immediate payment (default).\n- `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- `2`: For deferred payments, indicates notification to initiate payment.\n\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n"
},
"settlementMethod": {
"type": "string",
"maxLength": 1,
- "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n"
+ "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"fraudScreeningLevel": {
"type": "string",
"maxLength": 1,
- "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n"
+ "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
}
@@ -833,7 +978,7 @@
"discretionaryData": {
"type": "string",
"maxLength": 255,
- "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n"
+ "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -846,36 +991,36 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"useAs": {
"type": "string",
"maxLength": 20,
- "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n"
+ "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n#### Cielo and Comercio Latino\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n\n**Note** The value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 51\n- Field: Combination Card Transaction Identifier\n\nThis field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet.\n"
},
"sourceAccountType": {
"type": "string",
"maxLength": 20,
- "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note**\\\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - **CHECKING**: Checking account\n - **CREDIT**: Credit card account\n - **SAVING**: Saving account\n - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card\n - **PREPAID**: Prepaid card account or prepaid portion of combo card\n - **UNIVERSAL**: Universal account\n"
+ "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - `CHECKING`: Checking account\n - `CREDIT`: Credit card account\n - `SAVING`: Saving account\n - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card\n - `PREPAID`: Prepaid card account or prepaid portion of combo card\n - `UNIVERSAL`: Universal account\n"
},
"securityCode": {
"type": "string",
"maxLength": 4,
- "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect.\n"
+ "description": "Card Verification Number.\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator**`=recurring`.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n"
},
"securityCodeIndicator": {
"type": "string",
@@ -905,7 +1050,7 @@
"productName": {
"type": "string",
"maxLength": 15,
- "description": "Name of the card product.\n\nPossible value:\n- BNDES\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 115-120\n- Field: Brazil Country Data\n"
+ "description": "Name of the card product.\n\nPossible value:\n- BNDES\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. For details, see `card_product_name` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 115-120\n- Field: Brazil Country Data\n"
}
}
},
@@ -920,16 +1065,16 @@
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"cryptogram": {
"type": "string",
@@ -939,7 +1084,7 @@
"requestorId": {
"type": "string",
"maxLength": 11,
- "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
@@ -949,17 +1094,17 @@
"assuranceLevel": {
"type": "string",
"maxLength": 2,
- "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
},
"storageMethod": {
"type": "string",
"maxLength": 3,
- "description": "Type of technology used in the device to store token data. Possible values:\n\n - 001: Secure Element (SE)\n\nSmart card or memory with restricted access and encryption to prevent data tampering. For storing payment\ncredentials, a SE is tested against a set of requirements defined by the payment networks.\n\n`Note` This field is supported only for **FDC Compass**.\n\n- 002: Host Card Emulation (HCE)\n\nEmulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n`Note` This field is supported only for **FDC Compass**.\n"
+ "description": "Type of technology used in the device to store token data. Possible values:\n\n- `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment\n credentials, a SE is tested against a set of requirements defined by the payment networks.\n\n **Note** This field is supported only for _FDC Compass_.\n\n- 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n**Note** This field is supported only for _FDC Compass_.\n"
},
"securityCode": {
"type": "string",
"maxLength": 4,
- "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect. CVN.\n"
+ "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator**`=recurring`.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -968,17 +1113,17 @@
"properties": {
"key": {
"type": "string",
- "description": "The name of the merchant-defined data field. The range of this field starts at 1 and terminiates at 100."
+ "description": "The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html)\n"
},
"descriptor": {
"type": "string",
"maxLength": 128,
- "description": "The specific string for identifying the payment solution that is sending the encrypted payment data to CyberSource.\nValid values:\n- `Apple Pay`\n- `Samsung Pay`\n**NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n"
+ "description": "The identifier for a payment solution, which is sending the encrypted payment data to CyberSource for decryption.\nValid values:\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\n**NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor.\n\nFor details about the list of payment solution identifiers, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html).\n\nFor details about the encrypted payment data, see the `encrypted_payment_descriptor` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
},
"value": {
"type": "string",
"maxLength": 3072,
- "description": "Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses.\n\nValid values:\n- Apple Pay: `RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U`\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\n**NOTE**: For other payment solutions, the value of the descriptor may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n"
+ "description": "Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses.\n\nFor details, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) for the specific payment- solution entry.\n"
},
"encoding": {
"type": "string",
@@ -992,7 +1137,7 @@
"properties": {
"customerId": {
"type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -1047,12 +1192,12 @@
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
"discountAmount": {
"type": "string",
@@ -1097,17 +1242,17 @@
"foreignAmount": {
"type": "string",
"maxLength": 15,
- "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"foreignCurrency": {
"type": "string",
"maxLength": 5,
- "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exchangeRate": {
"type": "string",
"maxLength": 13,
- "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` 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)\n\nFor processor-specific information, see the `exchange_rate` field description in\n[Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"exchangeRateTimeStamp": {
"type": "string",
@@ -1146,7 +1291,7 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"amount": {
"type": "string",
@@ -1163,42 +1308,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -1211,12 +1357,12 @@
"originalAmount": {
"type": "string",
"maxLength": 15,
- "description": "Amount in your original local pricing currency.\n\nThis value cannot be negative. You can include a decimal point (.) in this field to denote the currency\nexponent, but you cannot include any other special characters.\n\nIf needed, CyberSource truncates the amount to the correct number of decimal places.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Amount in your original local pricing currency.\n\nThis value cannot be negative. You can include a decimal point (.) in this field to denote the currency\nexponent, but you cannot include any other special characters.\n\nIf needed, CyberSource truncates the amount to the correct number of decimal places.\n\nFor details, see the `original_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"originalCurrency": {
"type": "string",
"maxLength": 15,
- "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Your local pricing currency code.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about converting a foreign cardholder\u2019s purchase from your local pricing currency to the cardholder\u2019s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -1226,12 +1372,12 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"middleName": {
"type": "string",
@@ -1254,7 +1400,7 @@
"name": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address1": {
"type": "string",
@@ -1279,44 +1425,54 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n"
+ "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\n#### Example\n`12345-6789`\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\n#### Example\n`A1B 2C3`\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n"
+ "description": "Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
}
}
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "address3": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Additional address information (third line of the billing address)\n"
+ },
+ "address4": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Additional address information (fourth line of the billing address)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"district": {
"type": "string",
@@ -1331,12 +1487,12 @@
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
},
"phoneType": {
"type": "string",
@@ -1346,7 +1502,7 @@
"night",
"work"
],
- "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n"
+ "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n"
}
}
},
@@ -1423,7 +1579,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"productName": {
"type": "string",
@@ -1439,13 +1595,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"unitOfMeasure": {
"type": "string",
@@ -1455,7 +1611,7 @@
"totalAmount": {
"type": "string",
"maxLength": 13,
- "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n"
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
},
"taxAmount": {
"type": "string",
@@ -1465,7 +1621,7 @@
"taxRate": {
"type": "string",
"maxLength": 7,
- "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
+ "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
},
"taxAppliedAfterDiscount": {
"type": "string",
@@ -1480,7 +1636,7 @@
"taxTypeCode": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"amountIncludesTax": {
"type": "boolean",
@@ -1530,42 +1686,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -1620,21 +1777,21 @@
"purchaseOrderNumber": {
"type": "string",
"maxLength": 25,
- "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseOrderDate": {
"type": "string",
"maxLength": 10,
- "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseContactName": {
"type": "string",
"maxLength": 36,
- "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxable": {
"type": "boolean",
- "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
+ "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
"enum": [
true,
false
@@ -1643,12 +1800,12 @@
"vatInvoiceReferenceNumber": {
"type": "string",
"maxLength": 15,
- "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"commodityCode": {
"type": "string",
"maxLength": 4,
- "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"merchandiseCode": {
"type": "number",
@@ -1670,12 +1827,12 @@
"referenceDataCode": {
"type": "string",
"maxLength": 3,
- "description": "Code that identifies the value of the reference_data_number field. For the possible values, see Reference Data\nCodes.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n"
+ "description": "Code that identifies the value of the `referenceDataNumber` field.\n\nFor the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n"
},
"referenceDataNumber": {
"type": "string",
"maxLength": 30,
- "description": "Reference number. The meaning of this value is identified by the value of the referenceDataCode field.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n"
+ "description": "Reference number. The meaning of this value is identified by the value of the `referenceDataCode` field.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n"
}
}
},
@@ -1684,9 +1841,8 @@
"description": "Contains shipping information not related to address.",
"properties": {
"giftWrap": {
- "type": "string",
- "maxLength": 3,
- "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n\n- `yes`: The customer requested gift wrapping.\n- `no`: The customer did not request gift wrapping.\n"
+ "type": "boolean",
+ "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n- true: The customer requested gift wrapping.\n- false: The customer did not request gift wrapping.\n"
},
"shippingMethod": {
"type": "string",
@@ -1708,12 +1864,12 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"dateOfBirth": {
"type": "string",
"maxLength": 8,
- "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n"
+ "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"vatRegistrationNumber": {
"type": "string",
@@ -1723,7 +1879,7 @@
"companyTaxId": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used\n"
+ "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n"
},
"personalIdentification": {
"type": "array",
@@ -1732,7 +1888,7 @@
"properties": {
"type": {
"type": "string",
- "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n**ComercioLatino**\\\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\\\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n",
+ "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n",
"enum": [
"NATIONAL",
"CPF",
@@ -1745,11 +1901,11 @@
"id": {
"type": "string",
"maxLength": 26,
- "description": "The value of the identification type. This field is supported only on the following processors.\n\n**ComercioLatino**\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf type = PASSPORT, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n"
+ "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n"
},
"issuedBy": {
"type": "string",
- "description": "If type = DRIVER_LICENSE, this is the State or province where the customer\u2019s driver\u2019s license was issued.\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n\nIf type = PASSPORT, this is the Issuing country for the cardholder\u2019s passport.\nRecommended for Discover ProtectBuy.\n"
+ "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer\u2019s driver\u2019s license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder\u2019s passport. Recommended for Discover ProtectBuy.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -1757,7 +1913,7 @@
"hashedPassword": {
"type": "string",
"maxLength": 100,
- "description": "The description for this field is not available.\n"
+ "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
}
}
},
@@ -1767,17 +1923,17 @@
"accountId": {
"type": "string",
"maxLength": 10,
- "description": "Identifier for the recipient\u2019s account. Use the first six digits and last four digits of the recipient\u2019s account\nnumber. This field is a pass-through, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n"
+ "description": "Identifier for the recipient\u2019s account. Use the first six digits and last four digits of the recipient\u2019s account\nnumber. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor details, see the `recipient_account_id` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"lastName": {
"type": "string",
"maxLength": 6,
- "description": "Recipient\u2019s last name. This field is a passthrough, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n"
+ "description": "Recipient\u2019s last name. This field is a _passthrough_, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"postalCode": {
"type": "string",
"maxLength": 6,
- "description": "Partial postal code for the recipient\u2019s address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n"
+ "description": "Partial postal code for the recipient\u2019s address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -1787,17 +1943,17 @@
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -1809,79 +1965,79 @@
"properties": {
"name": {
"type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
"alternateName": {
"type": "string",
"maxLength": 13,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n"
},
"contact": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
"salesOrganizationId": {
"type": "string",
"maxLength": 11,
- "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Mastercard Independent Sales Organization ID\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\nFor processor-specific information, see the sales_organization_ID field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Mastercard Independent Sales Organization ID\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\nFor processor-specific information, see the `sales_organization_ID` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"categoryCode": {
"type": "integer",
"maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
"categoryCodeDomestic": {
"type": "integer",
"maximum": 9999,
- "description": "Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment\ncard industry uses to classify merchants into market segments. A payment card company assigned one or more of these\nvalues to your business when you started accepting the payment card company\u2019s cards. Including this field in a request\nfor a domestic transaction might reduce interchange fees.\n\nWhen you include this field in a request:\n- Do not include the merchantCategoryCode field.\n- The value for this field overrides the value in your CyberSource account.\n\nThis field is supported only for:\n- Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country.\n- Merchants enrolled in the OmniPay Direct interchange program.\n- First Data Merchant Solutions (Europe) on OmniPay Direct.\n"
+ "description": "Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment\ncard industry uses to classify merchants into market segments. A payment card company assigned one or more of these\nvalues to your business when you started accepting the payment card company\u2019s cards. Including this field in a request\nfor a domestic transaction might reduce interchange fees.\n\nWhen you include this field in a request:\n- Do not include the `merchant_category_code` field.\n- The value for this field overrides the value in your CyberSource account.\n\nThis field is supported only for:\n- Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country.\n- Merchants enrolled in the OmniPay Direct interchange program.\n- First Data Merchant Solutions (Europe) on OmniPay Direct.\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n"
+ "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"cardAcceptorReferenceNumber": {
"type": "string",
"maxLength": 25,
- "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"transactionLocalDateTime": {
"type": "string",
"maxLength": 14,
- "description": "Local date and time at your physical location. Include both the date and time in this field or leave it blank.\nThis field is supported only for **CyberSource through VisaNet**.\n\nFor processor-specific information, see the transaction_local_date_time field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n`Format: YYYYMMDDhhmmss`, where:\n\n - YYYY = year\n - MM = month\n - DD = day\n - hh = hour\n - mm = minutes\n - ss = seconds\n\n For processor-specific information, see the _transaction_local_date_time_ field in Credit Card Services Using the SCMP API.\n"
+ "description": "Local date and time at your physical location. Include both the date and time in this field or leave it blank.\nThis field is supported only for **CyberSource through VisaNet**.\n\nFor processor-specific information, see the `transaction_local_date_time` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFormat: `YYYYMMDDhhmmss`, where:\n\n - YYYY = year\n - MM = month\n - DD = day\n - hh = hour\n - mm = minutes\n - ss = seconds\n\n For processor-specific information, see the `transaction_local_date_time` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"serviceFeeDescriptor": {
"type": "object",
@@ -1911,7 +2067,7 @@
"aggregatorId": {
"type": "string",
"maxLength": 20,
- "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"name": {
"type": "string",
@@ -1934,12 +2090,12 @@
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n"
+ "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
@@ -1986,7 +2142,7 @@
"cavvAlgorithm": {
"type": "string",
"maxLength": 1,
- "description": "Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard Identity Check.\n"
+ "description": "Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check.\n"
},
"eciRaw": {
"type": "string",
@@ -2026,45 +2182,45 @@
"terminalId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n"
+ "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\n#### FDC Nashville Global\nTo have your account configured to support this field, contact CyberSource Customer Support. This value must be\na value that FDC Nashville Global issued to you.\n\nFor details, see the `terminal_id` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**For Payouts**: This field is applicable for CtV.\n"
},
"terminalSerialNumber": {
"type": "string",
"maxLength": 32,
- "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n"
+ "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n\nFor details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"laneNumber": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for an alternate terminal at your retail location. You define the value for this field.\n\nThis field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to\nidentify the main terminal at your retail location. If your retail location has multiple terminals, use this\n_alternateTerminalID_ field to identify the terminal used for the transaction.\n\nThis field is a pass-through, which means that CyberSource does not check the value or modify the value in any\nway before sending it to the processor.\n"
+ "description": "Identifier for an alternate terminal at your retail location. You define the value for this field.\n\nThis field is supported only for MasterCard transactions on FDC Nashville Global. Use the `terminalId` field to\nidentify the main terminal at your retail location. If your retail location has multiple terminals, use this\n`laneNumber` field to identify the terminal used for the transaction.\n\nThis field is a pass-through, which means that CyberSource does not check the value or modify the value in any\nway before sending it to the processor.\n"
},
"catLevel": {
"type": "integer",
"minimum": 1,
"maximum": 9,
- "description": "Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n * Applicable only for CTV for Payouts.\n"
+ "description": "Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n\n#### Chase Paymentech Solutions\nOnly values 1, 2, and 3 are supported.\n\n#### FDC Nashville Global\nOnly values 7, 8, and 9 are supported.\n\n#### GPN\nOnly values 6, 7, 8, and 9 are supported.\n\n#### TSYS Acquiring Solutions\nOnly value 6 is supported.\nFor details, see the `cat_level` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"entryMode": {
"type": "string",
"maxLength": 11,
- "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n"
+ "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - `contact`: Read from direct contact with chip card.\n - `contactless`: Read from a contactless interface using chip data.\n - `keyed`: Manually keyed into POS terminal.\n - `msd`: Read from a contactless interface using magnetic stripe data (MSD).\n - `swiped`: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n\nFor details, see the `pos_entry_mode` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"terminalCapability": {
"type": "integer",
"minimum": 1,
"maximum": 5,
- "description": "POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n"
+ "description": "POS terminal\u2019s capability. Possible values:\n\n - `1`: Terminal has a magnetic stripe reader only.\n - `2`: Terminal has a magnetic stripe reader and manual entry capability.\n - `3`: Terminal has manual entry capability only.\n - `4`: Terminal can read chip cards.\n - `5`: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n\nFor processor-specific details, see the `terminal_capability` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"pinEntryCapability": {
"type": "integer",
"minimum": 1,
"maximum": 1,
- "description": "A one-digit code that identifies the capability of terminal to capture PINs. \nThis code does not necessarily mean that a PIN was entered or is included in this message. \nFor Payouts: This field is applicable for CtV.\n"
+ "description": "A one-digit code that identifies the capability of terminal to capture PINs. \nThis code does not necessarily mean that a PIN was entered or is included in this message.\n\nPOS terminal\u2019s capability. Possible values:\n- `1`: Terminal has a magnetic stripe reader only.\n- `2`: Terminal has a magnetic stripe reader and manual entry capability.\n- `3`: Terminal has manual entry capability only.\n- `4`: Terminal can read chip cards.*\n- `5`: Terminal can read contactless chip cards.*\n* The values of 4 and 5 are supported only for EMV transactions.\n\nFor Payouts: This field is applicable for CtV.\n\nFor details, see the `terminal_capability` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"operatingEnvironment": {
"type": "string",
"maxLength": 1,
- "description": "Operating environment. Possible values:\n\n - 0: No terminal used or unknown environment.\n - 1: On merchant premises, attended.\n - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home\n computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for\n MasterCard transactions on **CyberSource through VisaNet**.\n - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in\n taxis.\n - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer,\n mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource\n through VisaNet**.\n - 5: On premises of cardholder, unattended.\n - 9: Unknown delivery mode.\n - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the\n internet.\n - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.\n\nThis field is supported only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**CyberSource through VisaNet**\\\nFor MasterCard transactions, the only valid values are 2 and 4.\n"
+ "description": "Operating environment.\n\nPossible values for all card types except Mastercard:\n- `0`: No terminal used or unknown environment.\n- `1`: On merchant premises, attended.\n- `2`: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA).\n- `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis.\n- `4`: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA.\n- `5`: On premises of cardholder, unattended.\n- `9`: Unknown delivery mode.\n- `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet.\n- `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.\n\n#### Possible values for Mastercard:\n- `2`: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet.\n- `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nThis field is supported only for American Express Direct and CyberSource through VisaNet.\n"
},
"emv": {
"type": "object",
@@ -2072,7 +2228,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
},
"cardholderVerificationMethodUsed": {
"type": "number",
@@ -2081,7 +2237,7 @@
"cardSequenceNumber": {
"type": "string",
"maxLength": 3,
- "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10.\n"
+ "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\nFor details, see `emv_request_card_sequence_number` field description in the [Card-Present Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"fallback": {
"type": "boolean",
@@ -2095,14 +2251,14 @@
},
"fallbackCondition": {
"type": "number",
- "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n"
+ "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card.\n\nFor details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
"amexCapnData": {
"type": "string",
"maxLength": 12,
- "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"
+ "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"trackData": {
"type": "string",
@@ -2127,7 +2283,7 @@
"terminalInputCapability": {
"type": "array",
"items": {
- "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n",
+ "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode (\"dipping a card\").\n- Contactless: Terminal can accept card data in EMV contactless mode (\"tapping a card\").\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read or scan QR codes.\n- OCR: Terminal can perform optical character recognition (OCT) on the card.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n\nFor details, see the `terminal_input_capabilities_#` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"type": "string"
},
"example": [
@@ -2187,12 +2343,12 @@
"key": {
"type": "string",
"maxLength": 50,
- "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n"
+ "description": "The name you assign for your merchant-defined data field.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"value": {
"type": "string",
"maxLength": 255,
- "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
+ "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
}
@@ -2203,52 +2359,52 @@
"amount": {
"type": "string",
"maxLength": 12,
- "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.\n"
+ "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n\nFor details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"frequency": {
"type": "string",
"maxLength": 1,
- "description": "Installment Frequency of the installment payments.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- B: Biweekly\n- M: Monthly\n- W: Weekly\n\nSee \"Installment Payments,\" page 127.\n"
+ "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nFor details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"planType": {
"type": "string",
"maxLength": 1,
- "description": "**American Express Direct, Cielo, and CyberSource Latin American Processing**\\\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- 1: Merchant-funded installment plan\n- 2: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service. See \"Installment Payments,\" page 136.\n\n**CyberSource through VisaNet and American Express**\\\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nSee \"Installment Payments,\" page 125.\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n**CyberSource through VisaNet with Visa or Mastercard**\\\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n"
+ "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\nFor details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n"
},
"sequence": {
"type": "integer",
"maximum": 99,
- "description": "Installment number when making payments in installments. Used along with _totalCount_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\nSee \"Installment Payments,\" page 125.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 142, and \"FDC Compass Merchant Descriptors,\" page 153.\n\n**CyberSource through VisaNet**\\\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
+ "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"totalAmount": {
"type": "string",
"maxLength": 12,
- "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet. See \"Installment Payments,\" page 127.\n"
+ "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n\nFor details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"totalCount": {
"type": "integer",
"maximum": 99,
- "description": "Total number of installments when making payments in installments. See \"Installment Payments,\" page 127.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 144, and \"FDC Compass Merchant Descriptors,\" page 155.\n\n**American Express Direct, Cielo, and Comercio Latino**\\\nThis value is the total number of installments you approved.\n\n**CyberSource Latin American Processing in Brazil**\\\nThis value is the total number of installments that you approved. The default is 1.\n\n**All Other Processors**\\\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n**CyberSource through VisaNet**\\\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
+ "description": "Total number of installments when making payments in installments.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"firstInstallmentDate": {
"type": "string",
"maximum": 6,
- "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n"
+ "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n"
},
"invoiceData": {
"type": "string",
"maximum": 20,
- "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n"
+ "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n"
},
"paymentType": {
"type": "string",
"maximum": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
},
"eligibilityInquiry": {
"type": "string",
"maximum": 9,
- "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n"
+ "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n"
}
}
}
@@ -2391,11 +2547,10 @@
"properties": {
"reason": {
"type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n",
+ "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n",
"enum": [
"AVS_FAILED",
"CONTACT_PROCESSOR",
- "CV_FAILED",
"EXPIRED_CARD",
"PROCESSOR_DECLINED",
"INSUFFICIENT_FUND",
@@ -2405,11 +2560,17 @@
"CVN_NOT_MATCH",
"EXCEEDS_CREDIT_LIMIT",
"INVALID_CVN",
+ "DECLINED_CHECK",
+ "BLACKLISTED_CUSTOMER",
+ "SUSPENDED_ACCOUNT",
"PAYMENT_REFUSED",
+ "CV_FAILED",
"INVALID_ACCOUNT",
"GENERAL_DECLINE",
+ "INVALID_MERCHANT_CONFIGURATION",
"DECISION_PROFILE_REJECT",
- "SCORE_EXCEEDS_THRESHOLD"
+ "SCORE_EXCEEDS_THRESHOLD",
+ "PENDING_AUTHENTICATION"
]
},
"message": {
@@ -2444,7 +2605,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -2453,7 +2614,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -2466,12 +2627,12 @@
"settlementMethod": {
"type": "string",
"maxLength": 1,
- "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n"
+ "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"fraudScreeningLevel": {
"type": "string",
"maxLength": 1,
- "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n"
+ "description": "Level of fraud screening.\n\nPossible values:\n- `1`: Validation \u2014 default if the field has not already been configured for your merchant ID\n- `2`: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
}
@@ -2492,7 +2653,7 @@
"transactionId": {
"type": "string",
"maxLength": 50,
- "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n"
+ "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"networkTransactionId": {
"type": "string",
@@ -2505,7 +2666,7 @@
"responseCode": {
"type": "string",
"maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
+ "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or\nresponse code received from the processor\nseparated by a colon.\nFormat: [status code]:E[error code] or\n[status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.\n"
},
"responseCodeSource": {
"type": "string",
@@ -2520,7 +2681,7 @@
"responseCategoryCode": {
"type": "string",
"maxLength": 32,
- "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"
+ "description": "Processor-defined response category code. The associated detail error code is in the `responseCode`\nfield of the service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"
},
"forwardedAcquirerCode": {
"type": "string",
@@ -2547,12 +2708,12 @@
"resultCode": {
"type": "string",
"maxLength": 1,
- "description": "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode`\nreply field. If ics_auth and ics_score are requested at the same time, the value is automatically\npassed from ics_auth to ics_score. For more information on using this field, see\n\"\"Sending the Results of Address and Card Verification Tests,\"\" page 16.\nThe field contains one of the following values:\n - `I`: Card verification number failed processor's data\n validation check.\n - `M`: Card verification number matched.\n - `N`: Card verification number not matched.\n - `P`: Card verification number not processed.\n - `S`: Card verification number is on the card but was not included in the request.\n - `U`: Card verification is not supported by the issuing bank.\n - `X`: Card verification is not supported by the payment card company.\n - Space Character: Deprecated. Ignore this value.\n - `1`: CyberSource does not support card verification for this processor or card type.\n - `2`: Processor returned value unrecognized for card verification response.\n - `3`: Processor did not return card verification result code.\n"
+ "description": "CVN result code.\n\nFor details, see the `auth_cv_result` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\nFor a description of the card verification check, see \"Card Verification Numbers (CVNs)\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\nFor a list of possible values, see \"CVN Codes\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"resultCodeRaw": {
"type": "string",
"maxLength": 10,
- "description": "CVN result code sent directly from the processor. Returned only when the processor returns this value.\n\n`Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only.\n"
+ "description": "CVN result code sent directly from the processor. Returned only when the processor returns this value.\n\n**Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only.\n"
}
}
},
@@ -2562,12 +2723,12 @@
"code": {
"type": "string",
"maxLength": 2,
- "description": "Reason the recurring payment transaction was declined. For some processors, this field is used only for\nMastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this\nfield is not implemented.\n\nPossible values:\n\n - **00**: Response not provided.\n - **01**: New account information is available. Obtain the new information.\n - **02**: Try again later.\n - **03**: Do not try again. Obtain another type of payment from the customer.\n - **04**: Problem with a token or a partial shipment indicator.\n - **21**: Recurring payment cancellation service.\n - **99**: An unknown value was returned from the processor.\n"
+ "description": "Reason the recurring payment transaction was declined. For some processors, this field is used only for\nMastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this\nfield is not implemented.\n\nPossible values:\n\n - `00`: Response not provided.\n - `01`: New account information is available. Obtain the new information.\n - `02`: Try again later.\n - `03`: Do not try again. Obtain another type of payment from the customer.\n - `04`: Problem with a token or a partial shipment indicator.\n - `21`: Recurring payment cancellation service.\n - `99`: An unknown value was returned from the processor.\n\nFor processor-specific information, see the `auth_merchant_advice_code` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"codeRaw": {
"type": "string",
"maxLength": 2,
- "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\nFor processor-specific information, see the auth_merchant_advice_code_raw field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n\nFor processor-specific information, see the `auth_merchant_advice_code_raw` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
@@ -2577,7 +2738,7 @@
"code": {
"type": "string",
"maxLength": 1,
- "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n"
+ "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n\nFor details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"codeRaw": {
"type": "string",
@@ -2587,7 +2748,7 @@
"email": {
"type": "string",
"maxLength": 1,
- "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n"
+ "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n\nFor details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"emailRaw": {
"type": "string",
@@ -2597,7 +2758,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 1,
- "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n"
+ "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n\nFor details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"phoneNumberRaw": {
"type": "string",
@@ -2607,7 +2768,7 @@
"postalCode": {
"type": "string",
"maxLength": 1,
- "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n"
+ "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n\nFor details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"postalCodeRaw": {
"type": "string",
@@ -2617,7 +2778,7 @@
"street": {
"type": "string",
"maxLength": 1,
- "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n"
+ "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n\nFor details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"streetRaw": {
"type": "string",
@@ -2642,12 +2803,12 @@
"resultCode": {
"type": "string",
"maxLength": 2,
- "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
},
"resultCodeRaw": {
"type": "string",
"maxLength": 10,
- "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -2657,7 +2818,7 @@
"personalIdResult": {
"type": "string",
"maxLength": 1,
- "description": "Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this\nvalue indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - **Y**: Match\n - **N**: No match\n - **K**: Not supported\n - **U**: Unknown\n - **Z**: No response returned\n"
+ "description": "Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included `buyerInformation.personalIdentification[].ID` in the request, this\nvalue indicates whether or not `buyerInformation.personalIdentification[].ID` matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - **Y**: Match\n - **N**: No match\n - **K**: Not supported\n - **U**: Unknown\n - **Z**: No response returned\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America.The information in this field description is for the specific processing\nconnection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n"
}
}
},
@@ -2667,29 +2828,29 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Mapped response code for Verified by Visa and American Express SafeKey:\n"
+ "description": "Mapped response code for Visa Secure and American Express SafeKey.\n\nFor processor-specific details, see `auth_cavv_response_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"codeRaw": {
"type": "string",
"maxLength": 3,
- "description": "Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey:\n"
+ "description": "Raw response code sent directly from the processor for Visa Secure and American Express SafeKey:\n\nFor processor-specific details, see `auth_cavv_response_code_raw` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n"
+ "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n#### American Express Direct\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n#### CyberSource through VisaNet\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"paymentAccountReferenceNumber": {
"type": "string",
"maxLength": 32,
- "description": "Visa-generated reference number that identifies a card-present transaction for which youprovided one of the\nfollowing:\n\n - Visa primary account number (PAN)\n - Visa-generated token for a PAN\n\nThis reference number serves as a link to the cardholder account and to all transactions for that account.\n"
+ "description": "Visa-generated reference number that identifies a card-present transaction for which you provided one of the\nfollowing:\n\n - Visa primary account number (PAN)\n - Visa-generated token for a PAN\n\nThis reference number serves as a link to the cardholder account and to all transactions for that account.\n"
},
"transactionIntegrityCode": {
"type": "string",
"maxLength": 2,
- "description": "Transaction integrity classification provided by Mastercard. This value specifies Mastercard\u2019s evaluation of\nthe transaction\u2019s safety and security. This field is returned only for **CyberSource through VisaNet**.\n\nFor card-present transactions, possible values:\n\n - **A1**: EMV or token in a secure, trusted environment\n - **B1**: EMV or chip equivalent\n - **C1**: Magnetic stripe\n - **E1**: Key entered\n - **U0**: Unclassified\n\nFor card-not-present transactions, possible values:\n\n - **A2**: Digital transactions\n - **B2**: Authenticated checkout\n - **C2**: Transaction validation\n - **D2**: Enhanced data\n - **E2**: Generic messaging\n - **U0**: Unclassified\n\nFor information about these values, contact Mastercard or your acquirer.\n"
+ "description": "Transaction integrity classification provided by Mastercard. This value specifies Mastercard\u2019s evaluation of\nthe transaction\u2019s safety and security. This field is returned only for **CyberSource through VisaNet**.\n\nFor card-present transactions, possible values:\n\n - `A1`: EMV or token in a secure, trusted environment\n - `B1`: EMV or chip equivalent\n - `C1`: Magnetic stripe\n - `E1`: Key entered\n - `U0`: Unclassified\n\nFor card-not-present transactions, possible values:\n\n - `A2`: Digital transactions\n - `B2`: Authenticated checkout\n - `C2`: Transaction validation\n - `D2`: Enhanced data\n - `E2`: Generic messaging\n - `U0`: Unclassified\n\nFor information about these values, contact Mastercard or your acquirer.\n\n#### CyberSource through VisaNet\n\nThe value for this field corresponds to the following data in the TC 33 capture file,1:\n- Record: CP01 TCR6\n- Position: 136-137\n- Field: Mastercard Transaction Integrity Classification\n\n1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.\nCyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses\nthis information to facilitate end-of-day clearing processing with payment networks.\n"
},
"amexVerbalAuthReferenceNumber": {
"type": "string",
@@ -2704,17 +2865,17 @@
"masterCardServiceCode": {
"type": "string",
"maxLength": 2,
- "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n"
+ "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for CyberSource through VisaNet.\n"
},
"masterCardServiceReplyCode": {
"type": "string",
"maxLength": 1,
- "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n"
+ "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - `C`: Service completed successfully.\n - `F`: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - `I`: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - `T`: Invalid combination of token requestor ID and token.\n - `U`: Expired token.\n - `W`: Primary account number (PAN) listed in electronic warning bulletin.\n\n**Note** This field is returned only for **CyberSource through VisaNet**.\n"
},
"masterCardAuthenticationType": {
"type": "string",
"maxLength": 1,
- "description": "Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **1**: Transaction qualifies for Mastercard authentication type 1.\n - **2**: Transaction qualifies for Mastercard authentication type 2.\n"
+ "description": "Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - `1`: Transaction qualifies for Mastercard authentication type 1.\n - `2`: Transaction qualifies for Mastercard authentication type 2.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 132\n- Field: Mastercard Member Defined service.\n**Note** This field is returned only for CyberSource through VisaNet.\n"
},
"name": {
"type": "string",
@@ -2727,17 +2888,17 @@
"network": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit\nnetwork.\n\nPossible values:\n- C: Credit network\n- D: Debit network (without signature)\n- S: STAR signature debit network\n\nThis field is supported only on FDC Nashville Global.\n"
+ "description": "Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit\nnetwork.\n\nPossible values:\n- `C`: Credit network\n- `D`: Debit network (without signature)\n- `S`: STAR signature debit network\n\nThis field is supported only on FDC Nashville Global.\n\nFor details, see the `routing_network_type` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"networkName": {
"type": "string",
"maxLength": 10,
- "description": "Name of the network on which the transaction was routed.\n\nThis field is supported only on FDC Nashville Global.\n"
+ "description": "Name of the network on which the transaction was routed.\n\nThis field is supported only on FDC Nashville Global.\n\nFor details, see the `routing_network_label` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"customerSignatureRequired": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether you need to obtain the cardholder's signature.\n\nPossible values:\n- Y: You need to obtain the cardholder's signature.\n- N: You do not need to obtain the cardholder's signature.\n\nThis field is supported only on FDC Nashville Global.\n"
+ "description": "Indicates whether you need to obtain the cardholder's signature.\n\nPossible values:\n- `Y`: You need to obtain the cardholder's signature.\n- `N`: You do not need to obtain the cardholder's signature.\n\nThis field is supported only on FDC Nashville Global.\n\nFor details, see the `routing_signature_cvm_required` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -2754,12 +2915,12 @@
"country": {
"type": "string",
"maxLength": 3,
- "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character ISO Standard Country Codes.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n"
+ "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character ISO Standard Country Codes.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n\nFor details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"discretionaryData": {
"type": "string",
"maxLength": 255,
- "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n"
+ "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"responseCode": {
"type": "string",
@@ -2776,7 +2937,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n"
+ "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n\n**Note** This field is returned only for CyberSource through VisaNet and FDC Nashville Global.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 85\n- Field: American Express last 4 PAN return indicator.\n"
}
}
},
@@ -2786,36 +2947,36 @@
"prefix": {
"type": "string",
"maxLength": 6,
- "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n"
+ "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n\nFor details, see `token_prefix` field description in [Google Pay Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"suffix": {
"type": "string",
"maxLength": 4,
- "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n"
+ "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n\nFor details, see `token_suffix` field description in [Google Pay Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"assuranceLevel": {
"type": "string",
"maxLength": 2,
- "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
},
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"requestorId": {
"type": "string",
"maxLength": 11,
- "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"
}
}
},
@@ -2825,12 +2986,12 @@
"accountType": {
"type": "string",
"maxLength": 2,
- "description": "Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - **00**: Not applicable or not specified\n - **10**: Savings account\n - **20**: Checking account\n - **30**: Credit card account\n - **40**: Universal account\n"
+ "description": "Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - `00`: Not applicable or not specified\n - `10`: Savings account\n - `20`: Checking account\n - `30`: Credit card account\n - `40`: Universal account\n"
},
"accountStatus": {
"type": "string",
"maxLength": 1,
- "description": "Possible values:\n\n - **N**: Nonregulated\n - **R**: Regulated\n\n`Note` This field is returned only for CyberSource through VisaNet.\n"
+ "description": "Possible values:\n\n - `N`: Nonregulated\n - `R`: Regulated\n\n**Note** This field is returned only for CyberSource through VisaNet.\n"
},
"balanceAmount": {
"type": "string",
@@ -2840,12 +3001,12 @@
"balanceAmountType": {
"type": "string",
"maxLength": 2,
- "description": "Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - **01**: Current ledger (posted) balance.\n - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - **01**: Credit amount remaining for customer (open to buy).\n - **02**: Credit limit.\n"
+ "description": "Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - `01`: Current ledger (posted) balance.\n - `02`: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - `01`: Credit amount remaining for customer (open to buy).\n - `02`: Credit limit.\n"
},
"currency": {
"type": "string",
"maxLength": 5,
- "description": "Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n"
+ "description": "Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `auth_account_balance_currency` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"balanceSign": {
"type": "string",
@@ -2864,12 +3025,12 @@
"category": {
"type": "string",
"maxLength": 7,
- "description": "**CyberSource through VisaNet**\n\nVisa product ID.\n\n**GPN**\n\nVisa or Mastercard product ID.\n\n**Litle**\n\nType of card used in the transaction. The only possible value is:\n\n - PREPAID: Prepaid Card\n\n**RBS WorldPay Atlanta**\n\nType of card used in the transaction. Possible values:\n\n - **B**: Business Card\n - **O**: Noncommercial Card\n - **R**: Corporate Card\n - **S**: Purchase Card\n - **Blank**: Purchase card not supported\n\n**Maximum length for processors**:\n\n - CyberSource through VisaNet: 3\n - GPN: 3\n - Litle: 7\n - RBS WorldPay Atlanta: 1\n"
+ "description": "#### CyberSource through VisaNet\nVisa or Mastercard product ID that is associated with the primary account number (PAN).\nFor descriptions of the Visa product IDs, see the Product ID table on the [Visa\nRequest & Response Codes web page.](https://developer.visa.com/guides/request_response_codes)\n\nData Length: String (3)\n\n#### GPN\nVisa or Mastercard product ID that is associated with the primary account number (PAN).\nFor descriptions of the Visa product IDs, seepag the Product ID table on the\nVisa Request & Response Codes web page at\nhttps://developer.visa.com/guides/request_response_codes. For descriptions of the\nMastercard product IDs, see \"Product IDs\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nData Length: String (3)\n\n#### Worldpay VAP\n**Important** Before using this field on Worldpay VAP,\nyou must contact CyberSource Customer Support to have\nyour account configured for this feature.\n\nType of card used in the transaction. The only possible value is:\n- `PREPAID`: Prepaid Card\n\nData Length: String (7)\n\n#### RBS WorldPay Atlanta\nType of card used in the transaction. Possible values:\n- `B`: Business Card\n- `O`: Noncommercial Card\n- `R`: Corporate Card\n- `S`: Purchase Card\n- `Blank`: Purchase card not supported\n\nData Length: String (1)\n"
},
"commercial": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n\nFor details, see `auth_card_commercial` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"group": {
"type": "string",
@@ -2879,37 +3040,37 @@
"healthCare": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_healthcare` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"payroll": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_payroll` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"level3Eligible": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_level_3_eligible` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"pinlessDebit": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_pinless_debit` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"signatureDebit": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a signature debit card. This information enables you to alter the way an order is\nprocessed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a signature debit card.\n\nThis information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_signature_debit` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"prepaid": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see the `auth_card_prepaid` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"regulated": {
"type": "string",
"maxLength": 1,
- "description": "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes (assets greater than 10B USD)\n - **N**: No (assets less than 10B USD)\n - **X**: Not applicable / Unknown\n"
+ "description": "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\nFor details, see `auth_card_regulated` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -2922,7 +3083,7 @@
"correctedAccountNumber": {
"type": "string",
"maxLength": 17,
- "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n"
+ "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -2954,7 +3115,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -2963,7 +3124,7 @@
"properties": {
"level3TransmissionStatus": {
"type": "boolean",
- "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the `bill_purchasing_level3_enabled` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
"enum": [
true,
false
@@ -2982,14 +3143,14 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
}
}
},
"amexCapnData": {
"type": "string",
"maxLength": 12,
- "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"
+ "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -2999,77 +3160,77 @@
"additionalCosts": {
"type": "string",
"maximum": 12,
- "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n"
+ "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n"
},
"additionalCostsPercentage": {
"type": "string",
"maximum": 4,
- "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n"
+ "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n"
},
"amountFunded": {
"type": "string",
"maximum": 12,
- "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n"
+ "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n"
},
"amountRequestedPercentage": {
"type": "string",
"maximum": 4,
- "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n"
+ "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n"
},
"annualFinancingCost": {
"type": "string",
"maximum": 7,
- "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n"
+ "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n"
},
"annualInterestRate": {
"type": "string",
"maximum": 7,
- "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n"
+ "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n"
},
"expenses": {
"type": "string",
"maximum": 12,
- "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n"
+ "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n"
},
"expensesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n"
+ "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n"
},
"fees": {
"type": "string",
"maximum": 12,
- "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n"
+ "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n"
},
"feesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n"
+ "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n"
},
"insurance": {
"type": "string",
"maximum": 12,
- "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n"
+ "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n"
},
"insurancePercentage": {
"type": "string",
"maximum": 4,
- "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n"
+ "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n"
},
"monthlyInterestRate": {
"type": "string",
"maximum": 7,
- "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n"
+ "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n"
},
"taxes": {
"type": "string",
"maximum": 12,
- "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n"
+ "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n"
},
"taxesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n"
+ "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n"
}
}
}
@@ -3787,7 +3948,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -3799,12 +3960,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -3819,18 +3980,18 @@
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
"reason": {
"type": "string",
- "description": "Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n"
+ "description": "Reason for the authorization reversal. Possible value:\n\n - `34`: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n\nFor details, see `auth_reversal_reason` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -3840,7 +4001,7 @@
"paymentSolution": {
"type": "string",
"maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
+ "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n"
},
"reconciliationId": {
"type": "string",
@@ -3850,17 +4011,17 @@
"linkId": {
"type": "string",
"maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
+ "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"reportGroup": {
"type": "string",
"maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
+ "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"visaCheckoutId": {
"type": "string",
"maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
+ "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"issuer": {
"type": "object",
@@ -3868,7 +4029,7 @@
"discretionaryData": {
"type": "string",
"maxLength": 255,
- "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n"
+ "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -3896,13 +4057,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -3918,7 +4079,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
}
}
}
@@ -3991,7 +4152,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -4000,7 +4161,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -4010,17 +4171,17 @@
"reversedAmount": {
"type": "string",
"maxLength": 15,
- "description": "Total reversed amount."
+ "description": "Total reversed amount.\n\nFor details, see `auth_reversal_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"originalTransactionAmount": {
"type": "string",
"maxLength": 15,
- "description": "Amount of the original transaction."
+ "description": "Amount of the original transaction.\n\nFor details, see `original_transaction_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -4035,12 +4196,12 @@
"responseCode": {
"type": "string",
"maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
+ "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or\nresponse code received from the processor\nseparated by a colon.\nFormat: [status code]:E[error code] or\n[status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.\n"
},
"responseCategoryCode": {
"type": "string",
"maxLength": 32,
- "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"
+ "description": "Processor-defined response category code. The associated detail error code is in the `responseCode`\nfield of the service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"
},
"forwardedAcquirerCode": {
"type": "string",
@@ -4050,12 +4211,12 @@
"masterCardServiceCode": {
"type": "string",
"maxLength": 2,
- "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n"
+ "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for CyberSource through VisaNet.\n"
},
"masterCardServiceReplyCode": {
"type": "string",
"maxLength": 1,
- "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n"
+ "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - `C`: Service completed successfully.\n - `F`: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - `I`: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - `T`: Invalid combination of token requestor ID and token.\n - `U`: Expired token.\n - `W`: Primary account number (PAN) listed in electronic warning bulletin.\n\n**Note** This field is returned only for **CyberSource through VisaNet**.\n"
}
}
},
@@ -4098,7 +4259,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
}
}
}
@@ -4162,7 +4323,10 @@
"INVALID_DATA",
"DUPLICATE_REQUEST",
"INVALID_MERCHANT_CONFIGURATION",
+ "PROCESSOR_UNAVAILABLE",
"AUTH_ALREADY_REVERSED",
+ "TRANSACTION_ALREADY_SETTLED",
+ "INVALID_AMOUNT",
"MISSING_AUTH",
"TRANSACTION_ALREADY_REVERSED_OR_SETTLED"
]
@@ -4263,20 +4427,20 @@
}
}
},
- "/pts/v2/reversals/": {
+ "/pts/v2/payments/{id}/captures": {
"post": {
- "summary": "Merchant Initiated Reversal",
- "description": "This is to reverse a previous payment that merchant does not receive a reply.",
+ "summary": "Capture a Payment",
+ "description": "Include the payment ID in the POST request to capture the payment amount.",
"tags": [
- "reversal"
+ "capture"
],
- "operationId": "mitReversal",
+ "operationId": "capturePayment",
"x-devcenter-metaData": {
"categoryTag": "Payments"
},
"parameters": [
{
- "name": "mitReversalRequest",
+ "name": "capturePaymentRequest",
"in": "body",
"required": true,
"schema": {
@@ -4288,11 +4452,11 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"transactionId": {
"type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
+ "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"comments": {
"type": "string",
@@ -4309,38 +4473,14 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
- }
- }
- }
- }
- },
- "reversalInformation": {
- "type": "object",
- "properties": {
- "amountDetails": {
- "type": "object",
- "properties": {
- "totalAmount": {
- "type": "string",
- "maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
- },
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
- },
- "reason": {
- "type": "string",
- "description": "Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n"
}
}
},
@@ -4350,7 +4490,7 @@
"paymentSolution": {
"type": "string",
"maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
+ "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n"
},
"reconciliationId": {
"type": "string",
@@ -4360,17 +4500,22 @@
"linkId": {
"type": "string",
"maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
+ "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"reportGroup": {
"type": "string",
"maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
+ "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"visaCheckoutId": {
"type": "string",
"maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
+ "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "purchaseLevel": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "Set this field to 3 to indicate that the request includes Level III data."
},
"issuer": {
"type": "object",
@@ -4378,553 +4523,95 @@
"discretionaryData": {
"type": "string",
"maxLength": 255,
- "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n"
+ "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
- }
- }
- },
- "orderInformation": {
- "type": "object",
- "properties": {
- "amountDetails": {
+ },
+ "authorizationOptions": {
"type": "object",
"properties": {
- "serviceFeeAmount": {
+ "authType": {
"type": "string",
"maxLength": 15,
- "description": "Service fee. Required for service fee transactions.\n"
+ "description": "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\nFor more information, see \"Forced Captures\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n\nFor processor-specific information, see the `auth_type` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "verbalAuthCode": {
+ "type": "string",
+ "maxLength": 7,
+ "description": "Authorization code.\n\n#### Forced Capture\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n#### Verbal Authorization\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n"
+ },
+ "verbalAuthTransactionId": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Transaction ID (TID).\n\n#### FDMS South\nThis field is required for verbal authorizations\nand forced captures with the American\nExpress card type to comply with the CAPN\nrequirements:\n- Forced capture: Obtain the value for this\nfield from the authorization response.\n- Verbal authorization: You cannot obtain a\nvalue for this field so CyberSource uses the\ndefault value of `000000000000000` (15\nzeros).\n\nFor more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
- "lineItems": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "quantity": {
- "type": "number",
- "minimum": 1,
- "maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
- "default": 1
- },
- "unitPrice": {
- "type": "string",
- "maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
- }
+ "captureOptions": {
+ "type": "object",
+ "properties": {
+ "captureSequenceNumber": {
+ "type": "number",
+ "minimum": 1,
+ "maximum": 99,
+ "description": "Capture number when requesting multiple partial captures for one authorization.\nUsed along with `totalCaptureCount` to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber_ = 2`, and\n - `totalCaptureCount = 5`\n"
+ },
+ "totalCaptureCount": {
+ "type": "number",
+ "minimum": 1,
+ "maximum": 99,
+ "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber = 2`, and\n - `totalCaptureCount = 5`\n"
}
}
}
}
},
- "pointOfSaleInformation": {
+ "paymentInformation": {
"type": "object",
"properties": {
- "emv": {
+ "customer": {
"type": "object",
"properties": {
- "tags": {
+ "customerId": {
"type": "string",
- "maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
}
- }
- },
- "example": {
- "clientReferenceInformation": {
- "code": "TC50171_3",
- "transactionId": "496301552302618"
},
- "reversalInformation": {
- "reason": "testing",
- "amountDetails": {
- "totalAmount": "102.21"
- }
- }
- }
- }
- }
- ],
- "responses": {
- "201": {
- "description": "Successful response.",
- "schema": {
- "type": "object",
- "properties": {
- "_links": {
+ "orderInformation": {
"type": "object",
"properties": {
- "self": {
+ "amountDetails": {
"type": "object",
"properties": {
- "href": {
+ "totalAmount": {
"type": "string",
- "description": "This is the endpoint of the resource that was created by the successful request."
+ "maxLength": 19,
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
- "method": {
+ "currency": {
"type": "string",
- "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource."
- }
- }
- }
- }
- },
- "id": {
- "type": "string",
- "maxLength": 26,
- "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource."
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - REVERSED\n",
- "enum": [
- "REVERSED"
- ]
- },
- "reconciliationId": {
- "type": "string",
- "maxLength": 60,
- "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"
- },
- "clientReferenceInformation": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
- },
- "submitLocalDateTime": {
- "type": "string",
- "maxLength": 14,
- "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n"
- },
- "ownerMerchantId": {
- "type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
- }
- }
- },
- "reversalAmountDetails": {
- "type": "object",
- "properties": {
- "reversedAmount": {
- "type": "string",
- "maxLength": 15,
- "description": "Total reversed amount."
- },
- "originalTransactionAmount": {
- "type": "string",
- "maxLength": 15,
- "description": "Amount of the original transaction."
- },
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
- }
- }
- },
- "processorInformation": {
- "type": "object",
- "properties": {
- "transactionId": {
- "type": "string",
- "maxLength": 18,
- "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"
- },
- "responseCode": {
- "type": "string",
- "maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
- },
- "responseCategoryCode": {
- "type": "string",
- "maxLength": 32,
- "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"
- },
- "forwardedAcquirerCode": {
- "type": "string",
- "maxLength": 32,
- "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"
- },
- "masterCardServiceCode": {
- "type": "string",
- "maxLength": 2,
- "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n"
- },
- "masterCardServiceReplyCode": {
- "type": "string",
- "maxLength": 1,
- "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n"
- }
- }
- },
- "issuerInformation": {
- "type": "object",
- "properties": {
- "responseCode": {
- "type": "string",
- "maxLength": 6,
- "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n"
- }
- }
- },
- "authorizationInformation": {
- "type": "object",
- "properties": {
- "approvalCode": {
- "type": "string",
- "maxLength": 6,
- "description": "The authorization code returned by the processor."
- },
- "reasonCode": {
- "type": "string",
- "maxLength": 50,
- "description": "Reply flag for the original transaction."
- },
- "reversalSubmitted": {
- "type": "string",
- "maxLength": 1,
- "description": "Flag indicating whether a full authorization reversal was successfully submitted.\n\nPossible values:\n- Y: The authorization reversal was successfully submitted.\n- N: The authorization reversal was not successfully submitted. You must send a credit request for a refund.\n\nThis field is supported only for **FDC Nashville Global**.\n"
- }
- }
- },
- "pointOfSaleInformation": {
- "type": "object",
- "properties": {
- "emv": {
- "type": "object",
- "properties": {
- "tags": {
+ "maxLength": 3,
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
+ },
+ "discountAmount": {
"type": "string",
- "maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
- }
- }
- }
- }
- }
- },
- "example": {
- "_links": {
- "self": {
- "href": "/pts/v2/reversals/4963015523026180001545",
- "method": "GET"
- }
- },
- "id": "4963015523026180001545",
- "submitTimeUtc": "2017-06-01T071912Z",
- "status": "200",
- "statusInformation": {
- "reason": "SUCCESS",
- "message": "Successful transaction."
- },
- "clientReferenceInformation": {
- "code": "TC50171_3"
- },
- "orderInformation": {
- "amountDetails": {
- "currency": "USD"
- }
- },
- "processorInformation": {
- "responseCode": "100"
- },
- "reversalAmountDetails": {
- "reversedAmount": "102.21",
- "currency": "USD"
- }
- }
- }
- },
- "400": {
- "description": "Invalid request.",
- "schema": {
- "type": "object",
- "properties": {
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n",
- "enum": [
- "INVALID_REQUEST"
- ]
- },
- "reason": {
- "type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n",
- "enum": [
- "MISSING_FIELD",
- "INVALID_DATA",
- "DUPLICATE_REQUEST",
- "INVALID_MERCHANT_CONFIGURATION",
- "AUTH_ALREADY_REVERSED",
- "MISSING_AUTH",
- "TRANSACTION_ALREADY_REVERSED_OR_SETTLED"
- ]
- },
- "message": {
- "type": "string",
- "description": "The detail message related to the status and reason listed above."
- },
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid."
- },
- "reason": {
- "type": "string",
- "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
- "enum": [
- "MISSING_FIELD",
- "INVALID_DATA"
- ]
- }
- }
- }
- }
- }
- }
- },
- "502": {
- "description": "Unexpected system error or system timeout.",
- "schema": {
- "type": "object",
- "properties": {
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n",
- "enum": [
- "SERVER_ERROR"
- ]
- },
- "reason": {
- "type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n",
- "enum": [
- "SYSTEM_ERROR",
- "SERVER_TIMEOUT",
- "SERVICE_TIMEOUT",
- "INVALID_OR_MISSING_CONFIG",
- "PROCESSOR_TIMEOUT"
- ]
- },
- "message": {
- "type": "string",
- "description": "The detail message related to the status and reason listed above."
- }
- }
- }
- }
- }
- }
- },
- "/pts/v2/payments/{id}/captures": {
- "post": {
- "summary": "Capture a Payment",
- "description": "Include the payment ID in the POST request to capture the payment amount.",
- "tags": [
- "capture"
- ],
- "operationId": "capturePayment",
- "x-devcenter-metaData": {
- "categoryTag": "Payments"
- },
- "parameters": [
- {
- "name": "capturePaymentRequest",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object",
- "properties": {
- "clientReferenceInformation": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
- },
- "transactionId": {
- "type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
- },
- "comments": {
- "type": "string",
- "description": "Comments"
- },
- "partner": {
- "type": "object",
- "properties": {
- "originalTransactionId": {
+ "maxLength": 15,
+ "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ },
+ "dutyAmount": {
"type": "string",
- "maxLength": 32,
- "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n"
+ "maxLength": 15,
+ "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
- "developerId": {
+ "taxAmount": {
"type": "string",
- "maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "maxLength": 12,
+ "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
- "solutionId": {
- "type": "string",
- "maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
- }
- }
- }
- }
- },
- "processingInformation": {
- "type": "object",
- "properties": {
- "paymentSolution": {
- "type": "string",
- "maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
- },
- "reconciliationId": {
- "type": "string",
- "maxLength": 60,
- "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"
- },
- "linkId": {
- "type": "string",
- "maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
- },
- "reportGroup": {
- "type": "string",
- "maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
- },
- "visaCheckoutId": {
- "type": "string",
- "maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
- },
- "purchaseLevel": {
- "type": "string",
- "maxLength": 1,
- "description": "Set this field to 3 to indicate that the request includes Level III data."
- },
- "issuer": {
- "type": "object",
- "properties": {
- "discretionaryData": {
- "type": "string",
- "maxLength": 255,
- "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n"
- }
- }
- },
- "authorizationOptions": {
- "type": "object",
- "properties": {
- "authType": {
- "type": "string",
- "maxLength": 15,
- "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "verbalAuthCode": {
- "type": "string",
- "maxLength": 7,
- "description": "Authorization code.\n\n**Forced Capture**\\\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\\\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "verbalAuthTransactionId": {
- "type": "string",
- "maxLength": 15,
- "description": "Transaction ID (TID)."
- }
- }
- },
- "captureOptions": {
- "type": "object",
- "properties": {
- "captureSequenceNumber": {
- "type": "number",
- "minimum": 1,
- "maximum": 99,
- "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"
- },
- "totalCaptureCount": {
- "type": "number",
- "minimum": 1,
- "maximum": 99,
- "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"
- }
- }
- }
- }
- },
- "paymentInformation": {
- "type": "object",
- "properties": {
- "customer": {
- "type": "object",
- "properties": {
- "customerId": {
- "type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
- }
- }
- }
- }
- },
- "orderInformation": {
- "type": "object",
- "properties": {
- "amountDetails": {
- "type": "object",
- "properties": {
- "totalAmount": {
- "type": "string",
- "maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
- },
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
- },
- "discountAmount": {
- "type": "string",
- "maxLength": 15,
- "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
- },
- "dutyAmount": {
- "type": "string",
- "maxLength": 15,
- "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
- },
- "taxAmount": {
- "type": "string",
- "maxLength": 12,
- "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
- },
- "nationalTaxIncluded": {
+ "nationalTaxIncluded": {
"type": "string",
"maxLength": 1,
"description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
@@ -4952,17 +4639,17 @@
"foreignAmount": {
"type": "string",
"maxLength": 15,
- "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"foreignCurrency": {
"type": "string",
"maxLength": 5,
- "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exchangeRate": {
"type": "string",
"maxLength": 13,
- "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` 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)\n\nFor processor-specific information, see the `exchange_rate` field description in\n[Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"exchangeRateTimeStamp": {
"type": "string",
@@ -4977,7 +4664,7 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"amount": {
"type": "string",
@@ -4994,42 +4681,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -5042,7 +4730,7 @@
"originalCurrency": {
"type": "string",
"maxLength": 15,
- "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Your local pricing currency code.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about converting a foreign cardholder\u2019s purchase from your local pricing currency to the cardholder\u2019s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -5052,12 +4740,12 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"company": {
"type": "object",
@@ -5065,7 +4753,7 @@
"name": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address1": {
"type": "string",
@@ -5090,54 +4778,54 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n"
+ "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\n#### Example\n`12345-6789`\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\n#### Example\n`A1B 2C3`\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n"
+ "description": "Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
}
}
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
}
}
},
@@ -5169,7 +4857,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"productName": {
"type": "string",
@@ -5185,13 +4873,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"unitOfMeasure": {
"type": "string",
@@ -5201,7 +4889,7 @@
"totalAmount": {
"type": "string",
"maxLength": 13,
- "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n"
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
},
"taxAmount": {
"type": "string",
@@ -5211,7 +4899,7 @@
"taxRate": {
"type": "string",
"maxLength": 7,
- "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
+ "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
},
"taxAppliedAfterDiscount": {
"type": "string",
@@ -5226,7 +4914,7 @@
"taxTypeCode": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"amountIncludesTax": {
"type": "boolean",
@@ -5276,42 +4964,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -5354,21 +5043,21 @@
"purchaseOrderNumber": {
"type": "string",
"maxLength": 25,
- "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseOrderDate": {
"type": "string",
"maxLength": 10,
- "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseContactName": {
"type": "string",
"maxLength": 36,
- "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxable": {
"type": "boolean",
- "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
+ "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
"enum": [
true,
false
@@ -5377,12 +5066,12 @@
"vatInvoiceReferenceNumber": {
"type": "string",
"maxLength": 15,
- "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"commodityCode": {
"type": "string",
"maxLength": 4,
- "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"transactionAdviceAddendum": {
"type": "array",
@@ -5417,7 +5106,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"vatRegistrationNumber": {
"type": "string",
@@ -5432,17 +5121,17 @@
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -5454,59 +5143,59 @@
"properties": {
"name": {
"type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
"alternateName": {
"type": "string",
"maxLength": 13,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n"
},
"contact": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
"cardAcceptorReferenceNumber": {
"type": "string",
"maxLength": 25,
- "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"categoryCode": {
"type": "integer",
"maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"serviceFeeDescriptor": {
"type": "object",
@@ -5531,7 +5220,7 @@
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n"
+ "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -5541,7 +5230,7 @@
"aggregatorId": {
"type": "string",
"maxLength": 20,
- "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"name": {
"type": "string",
@@ -5559,12 +5248,12 @@
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n"
+ "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
@@ -5604,7 +5293,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
},
"fallback": {
"type": "boolean",
@@ -5621,7 +5310,7 @@
"amexCapnData": {
"type": "string",
"maxLength": 12,
- "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"
+ "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -5634,12 +5323,12 @@
"key": {
"type": "string",
"maxLength": 50,
- "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n"
+ "description": "The name you assign for your merchant-defined data field.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"value": {
"type": "string",
"maxLength": 255,
- "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
+ "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
}
@@ -5650,92 +5339,92 @@
"firstInstallmentDate": {
"type": "string",
"maximum": 6,
- "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n"
+ "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n"
},
"invoiceData": {
"type": "string",
"maximum": 20,
- "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n"
+ "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n"
},
"paymentType": {
"type": "string",
"maximum": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
},
"additionalCosts": {
"type": "string",
"maximum": 12,
- "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n"
+ "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n"
},
"additionalCostsPercentage": {
"type": "string",
"maximum": 4,
- "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n"
+ "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n"
},
"amountFunded": {
"type": "string",
"maximum": 12,
- "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n"
+ "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n"
},
"amountRequestedPercentage": {
"type": "string",
"maximum": 4,
- "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n"
+ "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n"
},
"annualFinancingCost": {
"type": "string",
"maximum": 7,
- "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n"
+ "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n"
},
"annualInterestRate": {
"type": "string",
"maximum": 7,
- "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n"
+ "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n"
},
"expenses": {
"type": "string",
"maximum": 12,
- "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n"
+ "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n"
},
"expensesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n"
+ "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n"
},
"fees": {
"type": "string",
"maximum": 12,
- "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n"
+ "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n"
},
"feesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n"
+ "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n"
},
"insurance": {
"type": "string",
"maximum": 12,
- "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n"
+ "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n"
},
"insurancePercentage": {
"type": "string",
"maximum": 4,
- "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n"
+ "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n"
},
"monthlyInterestRate": {
"type": "string",
"maximum": 7,
- "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n"
+ "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n"
},
"taxes": {
"type": "string",
"maximum": 12,
- "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n"
+ "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n"
},
"taxesPercentage": {
"type": "string",
"maximum": 4,
- "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n"
+ "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n"
}
}
}
@@ -5877,7 +5566,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -5886,7 +5575,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -5914,7 +5603,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -5923,7 +5612,7 @@
"properties": {
"level3TransmissionStatus": {
"type": "boolean",
- "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the `bill_purchasing_level3_enabled` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
"enum": [
true,
false
@@ -6129,11 +5818,11 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"transactionId": {
"type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
+ "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"comments": {
"type": "string",
@@ -6150,12 +5839,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -6167,7 +5856,7 @@
"paymentSolution": {
"type": "string",
"maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
+ "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n"
},
"reconciliationId": {
"type": "string",
@@ -6177,17 +5866,17 @@
"linkId": {
"type": "string",
"maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
+ "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"reportGroup": {
"type": "string",
"maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
+ "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"visaCheckoutId": {
"type": "string",
"maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
+ "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"purchaseLevel": {
"type": "string",
@@ -6199,7 +5888,7 @@
"properties": {
"loanPayment": {
"type": "boolean",
- "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n",
+ "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
true,
false
@@ -6219,21 +5908,21 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"accountEncoderId": {
"type": "string",
@@ -6302,7 +5991,7 @@
"properties": {
"customerId": {
"type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -6317,12 +6006,12 @@
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
"discountAmount": {
"type": "string",
@@ -6367,17 +6056,17 @@
"foreignAmount": {
"type": "string",
"maxLength": 15,
- "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"foreignCurrency": {
"type": "string",
"maxLength": 5,
- "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exchangeRate": {
"type": "string",
"maxLength": 13,
- "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` 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)\n\nFor processor-specific information, see the `exchange_rate` field description in\n[Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"exchangeRateTimeStamp": {
"type": "string",
@@ -6392,7 +6081,7 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"amount": {
"type": "string",
@@ -6409,42 +6098,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -6457,7 +6147,7 @@
"originalCurrency": {
"type": "string",
"maxLength": 15,
- "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Your local pricing currency code.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about converting a foreign cardholder\u2019s purchase from your local pricing currency to the cardholder\u2019s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -6467,12 +6157,12 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"company": {
"type": "object",
@@ -6480,7 +6170,7 @@
"name": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address1": {
"type": "string",
@@ -6505,54 +6195,54 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n"
+ "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\n#### Example\n`12345-6789`\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\n#### Example\n`A1B 2C3`\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n"
+ "description": "Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
}
}
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
}
}
},
@@ -6584,7 +6274,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"productName": {
"type": "string",
@@ -6600,13 +6290,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"unitOfMeasure": {
"type": "string",
@@ -6616,7 +6306,7 @@
"totalAmount": {
"type": "string",
"maxLength": 13,
- "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n"
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
},
"taxAmount": {
"type": "string",
@@ -6626,7 +6316,7 @@
"taxRate": {
"type": "string",
"maxLength": 7,
- "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
+ "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
},
"taxAppliedAfterDiscount": {
"type": "string",
@@ -6641,7 +6331,7 @@
"taxTypeCode": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"amountIncludesTax": {
"type": "boolean",
@@ -6691,42 +6381,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -6740,21 +6431,21 @@
"purchaseOrderNumber": {
"type": "string",
"maxLength": 25,
- "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseOrderDate": {
"type": "string",
"maxLength": 10,
- "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseContactName": {
"type": "string",
"maxLength": 36,
- "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxable": {
"type": "boolean",
- "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
+ "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
"enum": [
true,
false
@@ -6763,12 +6454,12 @@
"vatInvoiceReferenceNumber": {
"type": "string",
"maxLength": 15,
- "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"commodityCode": {
"type": "string",
"maxLength": 4,
- "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"transactionAdviceAddendum": {
"type": "array",
@@ -6803,7 +6494,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"vatRegistrationNumber": {
"type": "string",
@@ -6818,17 +6509,17 @@
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -6840,64 +6531,64 @@
"properties": {
"name": {
"type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
"alternateName": {
"type": "string",
"maxLength": 13,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n"
},
"contact": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
"categoryCode": {
"type": "integer",
"maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"cardAcceptorReferenceNumber": {
"type": "string",
"maxLength": 25,
- "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n"
+ "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -6907,7 +6598,7 @@
"aggregatorId": {
"type": "string",
"maxLength": 20,
- "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"name": {
"type": "string",
@@ -6925,12 +6616,12 @@
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n"
+ "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
@@ -6970,7 +6661,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
},
"fallback": {
"type": "boolean",
@@ -6995,12 +6686,12 @@
"key": {
"type": "string",
"maxLength": 50,
- "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n"
+ "description": "The name you assign for your merchant-defined data field.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"value": {
"type": "string",
"maxLength": 255,
- "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
+ "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
}
@@ -7092,7 +6783,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -7101,7 +6792,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -7116,7 +6807,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -7141,7 +6832,7 @@
"responseCode": {
"type": "string",
"maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
+ "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or\nresponse code received from the processor\nseparated by a colon.\nFormat: [status code]:E[error code] or\n[status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.\n"
},
"achVerification": {
"type": "object",
@@ -7149,12 +6840,12 @@
"resultCode": {
"type": "string",
"maxLength": 2,
- "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
},
"resultCodeRaw": {
"type": "string",
"maxLength": 10,
- "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
}
@@ -7168,7 +6859,7 @@
"properties": {
"level3TransmissionStatus": {
"type": "boolean",
- "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the `bill_purchasing_level3_enabled` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
"enum": [
true,
false
@@ -7239,6 +6930,7 @@
"DUPLICATE_REQUEST",
"INVALID_CARD",
"INVALID_MERCHANT_CONFIGURATION",
+ "INVALID_AMOUNT",
"CAPTURE_ALREADY_VOIDED",
"ACCOUNT_NOT_ALLOWED_CREDIT"
]
@@ -7349,11 +7041,11 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"transactionId": {
"type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
+ "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"comments": {
"type": "string",
@@ -7370,12 +7062,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -7387,7 +7079,7 @@
"paymentSolution": {
"type": "string",
"maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
+ "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n"
},
"reconciliationId": {
"type": "string",
@@ -7397,17 +7089,17 @@
"linkId": {
"type": "string",
"maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
+ "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"reportGroup": {
"type": "string",
"maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
+ "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"visaCheckoutId": {
"type": "string",
"maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
+ "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"purchaseLevel": {
"type": "string",
@@ -7419,7 +7111,7 @@
"properties": {
"loanPayment": {
"type": "boolean",
- "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n",
+ "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
true,
false
@@ -7439,21 +7131,21 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"accountEncoderId": {
"type": "string",
@@ -7522,7 +7214,7 @@
"properties": {
"customerId": {
"type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -7537,12 +7229,12 @@
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
"discountAmount": {
"type": "string",
@@ -7587,17 +7279,17 @@
"foreignAmount": {
"type": "string",
"maxLength": 15,
- "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"foreignCurrency": {
"type": "string",
"maxLength": 5,
- "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exchangeRate": {
"type": "string",
"maxLength": 13,
- "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` 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)\n\nFor processor-specific information, see the `exchange_rate` field description in\n[Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"exchangeRateTimeStamp": {
"type": "string",
@@ -7612,7 +7304,7 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"amount": {
"type": "string",
@@ -7629,42 +7321,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -7677,7 +7370,7 @@
"originalCurrency": {
"type": "string",
"maxLength": 15,
- "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Your local pricing currency code.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about converting a foreign cardholder\u2019s purchase from your local pricing currency to the cardholder\u2019s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -7687,12 +7380,12 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"company": {
"type": "object",
@@ -7700,7 +7393,7 @@
"name": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address1": {
"type": "string",
@@ -7725,54 +7418,54 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n"
+ "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\n#### Example\n`12345-6789`\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\n#### Example\n`A1B 2C3`\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n"
+ "description": "Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
}
}
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
}
}
},
@@ -7804,7 +7497,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"productName": {
"type": "string",
@@ -7820,13 +7513,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"unitOfMeasure": {
"type": "string",
@@ -7836,7 +7529,7 @@
"totalAmount": {
"type": "string",
"maxLength": 13,
- "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n"
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
},
"taxAmount": {
"type": "string",
@@ -7846,7 +7539,7 @@
"taxRate": {
"type": "string",
"maxLength": 7,
- "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
+ "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
},
"taxAppliedAfterDiscount": {
"type": "string",
@@ -7861,7 +7554,7 @@
"taxTypeCode": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"amountIncludesTax": {
"type": "boolean",
@@ -7911,42 +7604,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -7960,21 +7654,21 @@
"purchaseOrderNumber": {
"type": "string",
"maxLength": 25,
- "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseOrderDate": {
"type": "string",
"maxLength": 10,
- "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseContactName": {
"type": "string",
"maxLength": 36,
- "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxable": {
"type": "boolean",
- "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
+ "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
"enum": [
true,
false
@@ -7983,12 +7677,12 @@
"vatInvoiceReferenceNumber": {
"type": "string",
"maxLength": 15,
- "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"commodityCode": {
"type": "string",
"maxLength": 4,
- "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"transactionAdviceAddendum": {
"type": "array",
@@ -8023,7 +7717,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"vatRegistrationNumber": {
"type": "string",
@@ -8038,17 +7732,17 @@
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -8060,64 +7754,64 @@
"properties": {
"name": {
"type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
"alternateName": {
"type": "string",
"maxLength": 13,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n"
},
"contact": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
"categoryCode": {
"type": "integer",
"maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"cardAcceptorReferenceNumber": {
"type": "string",
"maxLength": 25,
- "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n"
+ "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -8127,7 +7821,7 @@
"aggregatorId": {
"type": "string",
"maxLength": 20,
- "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"name": {
"type": "string",
@@ -8145,12 +7839,12 @@
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n"
+ "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
@@ -8190,7 +7884,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
},
"fallback": {
"type": "boolean",
@@ -8215,12 +7909,12 @@
"key": {
"type": "string",
"maxLength": 50,
- "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n"
+ "description": "The name you assign for your merchant-defined data field.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"value": {
"type": "string",
"maxLength": 255,
- "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
+ "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
}
@@ -8312,7 +8006,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -8321,7 +8015,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -8336,7 +8030,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -8361,7 +8055,7 @@
"responseCode": {
"type": "string",
"maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
+ "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or\nresponse code received from the processor\nseparated by a colon.\nFormat: [status code]:E[error code] or\n[status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.\n"
},
"achVerification": {
"type": "object",
@@ -8369,12 +8063,12 @@
"resultCode": {
"type": "string",
"maxLength": 2,
- "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
},
"resultCodeRaw": {
"type": "string",
"maxLength": 10,
- "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
}
@@ -8388,7 +8082,7 @@
"properties": {
"level3TransmissionStatus": {
"type": "boolean",
- "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the `bill_purchasing_level3_enabled` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
"enum": [
true,
false
@@ -8459,6 +8153,7 @@
"DUPLICATE_REQUEST",
"INVALID_CARD",
"INVALID_MERCHANT_CONFIGURATION",
+ "INVALID_AMOUNT",
"CAPTURE_ALREADY_VOIDED",
"ACCOUNT_NOT_ALLOWED_CREDIT"
]
@@ -8569,11 +8264,11 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"transactionId": {
"type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
+ "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"comments": {
"type": "string",
@@ -8590,12 +8285,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -8617,7 +8312,7 @@
"paymentSolution": {
"type": "string",
"maxLength": 12,
- "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n"
+ "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n"
},
"reconciliationId": {
"type": "string",
@@ -8627,17 +8322,17 @@
"linkId": {
"type": "string",
"maxLength": 26,
- "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n"
+ "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n- Partial authorizations\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"reportGroup": {
"type": "string",
"maxLength": 25,
- "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n"
+ "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"visaCheckoutId": {
"type": "string",
"maxLength": 48,
- "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n"
+ "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"purchaseLevel": {
"type": "string",
@@ -8649,7 +8344,7 @@
"properties": {
"loanPayment": {
"type": "boolean",
- "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n",
+ "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
true,
false
@@ -8669,7 +8364,7 @@
"secCode": {
"type": "string",
"maxLength": 3,
- "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n"
+ "description": "Authorization method used for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `PPD`\n- `TEL`\n- `WEB`\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"terminalCity": {
"type": "string",
@@ -8689,12 +8384,12 @@
"partialPaymentId": {
"type": "string",
"maxLength": 25,
- "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n"
+ "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"settlementMethod": {
"type": "string",
"maxLength": 1,
- "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n"
+ "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -8709,21 +8404,21 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"accountEncoderId": {
"type": "string",
@@ -8792,7 +8487,7 @@
"properties": {
"customerId": {
"type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -8807,12 +8502,12 @@
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
"discountAmount": {
"type": "string",
@@ -8857,17 +8552,17 @@
"foreignAmount": {
"type": "string",
"maxLength": 15,
- "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"foreignCurrency": {
"type": "string",
"maxLength": 5,
- "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Set this field to the converted amount that was returned by the DCC provider.\nFor processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exchangeRate": {
"type": "string",
"maxLength": 13,
- "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see `exchange_rate` 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)\n\nFor processor-specific information, see the `exchange_rate` field description in\n[Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"exchangeRateTimeStamp": {
"type": "string",
@@ -8882,7 +8577,7 @@
"code": {
"type": "string",
"maxLength": 3,
- "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the `additional_amount_type` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"amount": {
"type": "string",
@@ -8899,42 +8594,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -8947,7 +8643,7 @@
"originalCurrency": {
"type": "string",
"maxLength": 15,
- "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n"
+ "description": "Your local pricing currency code.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about converting a foreign cardholder\u2019s purchase from your local pricing currency to the cardholder\u2019s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
},
@@ -8957,12 +8653,12 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"company": {
"type": "object",
@@ -8970,7 +8666,7 @@
"name": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `company_name` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address1": {
"type": "string",
@@ -8995,54 +8691,54 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n"
+ "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\n#### Example\n`12345-6789`\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\n#### Example\n`A1B 2C3`\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n"
+ "description": "Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
}
}
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
}
}
},
@@ -9074,7 +8770,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"productName": {
"type": "string",
@@ -9090,13 +8786,13 @@
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"unitOfMeasure": {
"type": "string",
@@ -9106,7 +8802,7 @@
"totalAmount": {
"type": "string",
"maxLength": 13,
- "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n"
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
},
"taxAmount": {
"type": "string",
@@ -9116,7 +8812,7 @@
"taxRate": {
"type": "string",
"maxLength": 7,
- "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
+ "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"
},
"taxAppliedAfterDiscount": {
"type": "string",
@@ -9131,7 +8827,7 @@
"taxTypeCode": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"amountIncludesTax": {
"type": "boolean",
@@ -9181,42 +8877,43 @@
"properties": {
"type": {
"type": "string",
- "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n",
+ "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"enum": [
"alternate",
"local",
"national",
- "vat"
+ "vat",
+ "other"
]
},
"amount": {
"type": "string",
"maxLength": 13,
- "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n"
+ "description": "Indicates the amount of tax based on the `type` field as described in the table below:\n\n| type | type description |\n|-----------|--------------------|\n| `alternate` | Total amount of alternate tax for the order. |\n| `local` | Sales tax for the order. |\n| `national` | National tax for the order. |\n| `vat` | Total amount of Value Added Tax (VAT) included in the order. |\n| `other` | Other tax. |\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"rate": {
"type": "string",
"maxLength": 6,
- "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"
+ "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"code": {
"type": "string",
"maxLength": 4,
- "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n"
+ "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"
+ "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"applied": {
"type": "boolean",
- "description": "The tax is applied. Valid value is `true` or `false`."
+ "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"exemptionCode": {
"type": "string",
"maxLength": 1,
- "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n"
+ "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -9230,21 +8927,21 @@
"purchaseOrderNumber": {
"type": "string",
"maxLength": 25,
- "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseOrderDate": {
"type": "string",
"maxLength": 10,
- "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"purchaseContactName": {
"type": "string",
"maxLength": 36,
- "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxable": {
"type": "boolean",
- "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
+ "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n",
"enum": [
true,
false
@@ -9253,12 +8950,12 @@
"vatInvoiceReferenceNumber": {
"type": "string",
"maxLength": 15,
- "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"commodityCode": {
"type": "string",
"maxLength": 4,
- "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"transactionAdviceAddendum": {
"type": "array",
@@ -9293,7 +8990,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"vatRegistrationNumber": {
"type": "string",
@@ -9308,17 +9005,17 @@
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -9330,64 +9027,64 @@
"properties": {
"name": {
"type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
"alternateName": {
"type": "string",
"maxLength": 13,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n"
},
"contact": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
"categoryCode": {
"type": "integer",
"maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"cardAcceptorReferenceNumber": {
"type": "string",
"maxLength": 25,
- "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
},
"taxId": {
"type": "string",
"maxLength": 15,
- "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n"
+ "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -9397,7 +9094,7 @@
"aggregatorId": {
"type": "string",
"maxLength": 20,
- "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"name": {
"type": "string",
@@ -9415,12 +9112,12 @@
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n"
+ "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
@@ -9460,7 +9157,7 @@
"tags": {
"type": "string",
"maxLength": 1998,
- "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
+ "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"
},
"fallback": {
"type": "boolean",
@@ -9474,7 +9171,7 @@
},
"fallbackCondition": {
"type": "number",
- "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n"
+ "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card.\n\nFor details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -9502,7 +9199,7 @@
"terminalInputCapability": {
"type": "array",
"items": {
- "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n",
+ "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode (\"dipping a card\").\n- Contactless: Terminal can accept card data in EMV contactless mode (\"tapping a card\").\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read or scan QR codes.\n- OCR: Terminal can perform optical character recognition (OCT) on the card.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n\nFor details, see the `terminal_input_capabilities_#` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n",
"type": "string"
},
"example": [
@@ -9515,7 +9212,7 @@
"terminalSerialNumber": {
"type": "string",
"maxLength": 32,
- "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n"
+ "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n\nFor details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"terminalCardCaptureCapability": {
"type": "string",
@@ -9547,12 +9244,12 @@
"key": {
"type": "string",
"maxLength": 50,
- "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n"
+ "description": "The name you assign for your merchant-defined data field.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"value": {
"type": "string",
"maxLength": 255,
- "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
+ "description": "The value you assign for your merchant-defined data field.\n\nFor details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
}
@@ -9656,7 +9353,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -9665,7 +9362,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -9680,7 +9377,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
},
@@ -9693,7 +9390,7 @@
"settlementMethod": {
"type": "string",
"maxLength": 1,
- "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n"
+ "description": "Method used for settlement.\n\nPossible values:\n- `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- `F`: Facsimile draft (U.S. dollars only)\n- `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -9720,7 +9417,7 @@
"responseCode": {
"type": "string",
"maxLength": 10,
- "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"
+ "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or\nresponse code received from the processor\nseparated by a colon.\nFormat: [status code]:E[error code] or\n[status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.\n"
},
"achVerification": {
"type": "object",
@@ -9728,12 +9425,12 @@
"resultCode": {
"type": "string",
"maxLength": 2,
- "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Results from the ACH verification service.\nFor details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
},
"resultCodeRaw": {
"type": "string",
"maxLength": 10,
- "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n"
+ "description": "Raw results from the ACH verification service.\nFor details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n"
}
}
}
@@ -9751,7 +9448,7 @@
"correctedAccountNumber": {
"type": "string",
"maxLength": 17,
- "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n"
+ "description": "Corrected account number from the ACH verification service.\n\nFor details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -9772,7 +9469,7 @@
"properties": {
"level3TransmissionStatus": {
"type": "boolean",
- "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
+ "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the `bill_purchasing_level3_enabled` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n",
"enum": [
true,
false
@@ -9843,6 +9540,7 @@
"DUPLICATE_REQUEST",
"INVALID_CARD",
"INVALID_MERCHANT_CONFIGURATION",
+ "INVALID_AMOUNT",
"CAPTURE_ALREADY_VOIDED",
"ACCOUNT_NOT_ALLOWED_CREDIT"
]
@@ -10043,7 +9741,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -10055,12 +9753,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -10129,7 +9827,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -10138,7 +9836,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -10156,7 +9854,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
}
@@ -10278,11 +9976,12 @@
}
},
"x-example": {
- "example0": null,
- "summary": "Void a Payment",
- "value": {
- "clientReferenceInformation": {
- "code": "test_void"
+ "example0": {
+ "summary": "Void a Payment",
+ "value": {
+ "clientReferenceInformation": {
+ "code": "test_void"
+ }
}
}
}
@@ -10313,7 +10012,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -10325,12 +10024,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -10399,7 +10098,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -10408,7 +10107,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -10426,7 +10125,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
}
@@ -10548,11 +10247,12 @@
}
},
"x-example": {
- "example0": null,
- "summary": "Void a Capture",
- "value": {
- "clientReferenceInformation": {
- "code": "test_void"
+ "example0": {
+ "summary": "Void a Capture",
+ "value": {
+ "clientReferenceInformation": {
+ "code": "test_void"
+ }
}
}
}
@@ -10583,7 +10283,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -10595,12 +10295,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -10669,7 +10369,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -10678,7 +10378,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -10696,7 +10396,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
}
@@ -10854,7 +10554,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -10866,12 +10566,12 @@
"developerId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
+ "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
},
"solutionId": {
"type": "string",
"maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
+ "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
}
}
}
@@ -10940,7 +10640,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -10949,7 +10649,7 @@
},
"ownerMerchantId": {
"type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -10967,7 +10667,7 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
}
}
}
@@ -11100,78 +10800,95 @@
}
}
},
- "/pts/v2/voids/": {
- "post": {
- "summary": "Merchant Initiated Void",
- "description": "This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply.",
+ "/pts/v1/transaction-batches": {
+ "get": {
+ "summary": "Gets a list of batch files",
+ "description": "Provide the search range",
"tags": [
- "void"
+ "TransactionBatches"
],
- "operationId": "mitVoid",
+ "operationId": "getTransactionBatches",
"x-devcenter-metaData": {
- "categoryTag": "Payments"
+ "categoryTag": "Transaction_Batches"
+ },
+ "x-queryParameterDefaults": {
+ "startTime": "2018-10-01T00:00:00.000Z",
+ "endTime": "2018-10-30T23:59:59.000Z"
},
+ "produces": [
+ "application/hal+json"
+ ],
"parameters": [
{
- "name": "mitVoidRequest",
- "in": "body",
+ "name": "startTime",
+ "in": "query",
+ "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n",
"required": true,
- "schema": {
- "type": "object",
- "properties": {
- "clientReferenceInformation": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
- },
- "transactionId": {
- "type": "string",
- "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n"
- },
- "comments": {
- "type": "string",
- "description": "Comments"
- },
- "partner": {
- "type": "object",
- "properties": {
- "originalTransactionId": {
- "type": "string",
- "maxLength": 32,
- "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n"
- },
- "developerId": {
- "type": "string",
- "maxLength": 8,
- "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n"
- },
- "solutionId": {
- "type": "string",
- "maxLength": 8,
- "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n"
- }
- }
- }
- }
- }
- },
- "example": {
- "clientReferenceInformation": {
- "code": "test_void"
- }
- }
- }
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n",
+ "required": true,
+ "type": "string",
+ "format": "date-time"
}
],
"responses": {
- "201": {
- "description": "Successful response.",
+ "200": {
+ "description": "OK",
"schema": {
+ "title": "ptsV1TransactionBatchesGet200Response",
"type": "object",
"properties": {
+ "transactionBatches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier assigned to the batch file.",
+ "example": "psy8s1d",
+ "pattern": "^[a-zA-Z0-9_+-]*$",
+ "minLength": 1,
+ "maxLength": 8
+ },
+ "uploadDate": {
+ "type": "string",
+ "description": "Date when the batch template was update.",
+ "example": "2018-01-01"
+ },
+ "completionDate": {
+ "type": "string",
+ "description": "The date when the batch template processing completed.",
+ "example": "2018-01-01"
+ },
+ "transactionCount": {
+ "type": "integer",
+ "description": "Number of transactions in the transaction.",
+ "example": 7534
+ },
+ "acceptedTransactionCount": {
+ "type": "integer",
+ "description": "Number of transactions accepted.",
+ "example": 50013
+ },
+ "rejectedTransactionCount": {
+ "type": "string",
+ "description": "Number of transactions rejected.",
+ "example": 2508
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of you batch template processing.",
+ "example": "Completed"
+ }
+ }
+ }
+ },
"_links": {
"type": "object",
"properties": {
@@ -11180,179 +10897,205 @@
"properties": {
"href": {
"type": "string",
- "description": "This is the endpoint of the resource that was created by the successful request."
+ "example": "/pts/v1/transaction-batches"
},
"method": {
"type": "string",
- "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource."
+ "example": "GET"
}
}
}
}
},
- "id": {
- "type": "string",
- "maxLength": 26,
- "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource."
- },
"submitTimeUtc": {
"type": "string",
"description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n",
- "enum": [
- "VOIDED"
- ]
- },
- "clientReferenceInformation": {
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "title": "ptsV1TransactionBatchesGet400Response",
+ "type": "object",
+ "properties": {
+ "errorInformation": {
"type": "object",
"properties": {
- "code": {
- "type": "string",
- "maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "reason": {
+ "type": "string"
},
- "submitLocalDateTime": {
- "type": "string",
- "maxLength": 14,
- "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n"
+ "message": {
+ "type": "string"
},
- "ownerMerchantId": {
- "type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed message related to the status and reason listed above.\n"
+ }
+ }
+ }
}
}
},
- "voidAmountDetails": {
+ "submitTimeUtc": {
+ "type": "string",
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Not Authorized",
+ "schema": {
+ "title": "ptsV1TransactionBatchesGet401Response",
+ "type": "object",
+ "properties": {
+ "errorInformation": {
"type": "object",
"properties": {
- "voidAmount": {
- "type": "string",
- "description": "Total amount of the void."
+ "reason": {
+ "type": "string"
},
- "originalTransactionAmount": {
- "type": "string",
- "description": "Amount of the original transaction."
+ "message": {
+ "type": "string"
},
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed message related to the status and reason listed above.\n"
+ }
+ }
+ }
}
}
- }
- },
- "example": {
- "_links": {
- "self": {
- "href": "/pts/v2/voids/4963015122056179201545",
- "method": "GET"
- }
- },
- "id": "4963015122056179201545",
- "submitTimeUtc": "2017-06-01T071832Z",
- "status": "VOIDED",
- "clientReferenceInformation": {
- "code": "test_void"
- },
- "orderInformation": {
- "amountDetails": {
- "currency": "USD"
- }
},
- "voidAmountDetails": {
- "currency": "usd",
- "voidAmount": "102.21"
+ "submitTimeUtc": {
+ "type": "string",
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
}
}
}
},
- "400": {
- "description": "Invalid request.",
+ "403": {
+ "description": "No Authenticated",
"schema": {
+ "title": "ptsV1TransactionBatchesGet403Response",
"type": "object",
"properties": {
+ "errorInformation": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed message related to the status and reason listed above.\n"
+ }
+ }
+ }
+ }
+ }
+ },
"submitTimeUtc": {
"type": "string",
"description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n",
- "enum": [
- "INVALID_REQUEST"
- ]
- },
- "reason": {
- "type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n",
- "enum": [
- "MISSING_FIELD",
- "INVALID_DATA",
- "DUPLICATE_REQUEST",
- "INVALID_MERCHANT_CONFIGURATION",
- "NOT_VOIDABLE"
- ]
- },
- "message": {
- "type": "string",
- "description": "The detail message related to the status and reason listed above."
- },
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid."
- },
- "reason": {
- "type": "string",
- "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
- "enum": [
- "MISSING_FIELD",
- "INVALID_DATA"
- ]
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No Reports Found",
+ "schema": {
+ "title": "ptsV1TransactionBatchesGet404Response",
+ "type": "object",
+ "properties": {
+ "errorInformation": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed message related to the status and reason listed above.\n"
+ }
+ }
}
}
}
+ },
+ "submitTimeUtc": {
+ "type": "string",
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
}
}
}
},
- "502": {
- "description": "Unexpected system error or system timeout.",
+ "500": {
+ "description": "Bad Gateway",
"schema": {
+ "title": "ptsV1TransactionBatchesGet500Response",
"type": "object",
"properties": {
+ "errorInformation": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason of status"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed message related to the status and reason listed above."
+ }
+ }
+ },
"submitTimeUtc": {
"type": "string",
"description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n",
- "enum": [
- "SERVER_ERROR"
- ]
- },
- "reason": {
- "type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n",
- "enum": [
- "SYSTEM_ERROR",
- "SERVER_TIMEOUT",
- "SERVICE_TIMEOUT",
- "INVALID_OR_MISSING_CONFIG",
- "PROCESSOR_TIMEOUT"
- ]
- },
- "message": {
- "type": "string",
- "description": "The detail message related to the status and reason listed above."
}
}
}
@@ -11360,118 +11103,96 @@
}
}
},
- "/pts/v1/transaction-batches": {
+ "/pts/v1/transaction-batches/{id}": {
"get": {
- "summary": "Get a list of batch files",
+ "summary": "Get individual batch file",
"description": "Provide the search range",
"tags": [
"TransactionBatches"
],
- "operationId": "getTransactionBatches",
+ "operationId": "getTransactionBatchId",
"x-devcenter-metaData": {
"categoryTag": "Transaction_Batches"
},
- "x-queryParameterDefaults": {
- "startTime": "2018-10-01T00:00:00.000Z",
- "endTime": "2018-10-30T23:59:59.000Z"
- },
"produces": [
"application/hal+json"
],
"parameters": [
{
- "name": "startTime",
- "in": "query",
- "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n",
- "required": true,
- "type": "string",
- "format": "date-time"
- },
- {
- "name": "endTime",
- "in": "query",
- "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n",
+ "name": "id",
+ "in": "path",
+ "description": "The batch id assigned for the template.",
"required": true,
- "type": "string",
- "format": "date-time"
+ "type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "title": "ptsV1TransactionBatchesGet200Response",
- "type": "object",
+ "title": "ptsV1TransactionBatchesIdGet200Response",
"properties": {
- "transactionBatches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier assigned to the batch file.",
- "example": "psy8s1d",
- "pattern": "^[a-zA-Z0-9_+-]*$",
- "minLength": 1,
- "maxLength": 8
- },
- "uploadDate": {
- "type": "string",
- "description": "Date when the batch template was update.",
- "example": "2018-01-01"
- },
- "completionDate": {
- "type": "string",
- "description": "The date when the batch template processing completed.",
- "example": "2018-01-01"
- },
- "transactionCount": {
- "type": "integer",
- "description": "Number of transactions in the transaction.",
- "example": 7534
- },
- "acceptedTransactionCount": {
- "type": "integer",
- "description": "Number of transactions accepted.",
- "example": 50013
- },
- "rejectedTransactionCount": {
- "type": "string",
- "description": "Number of transactions rejected.",
- "example": 2508
- },
- "status": {
- "type": "string",
- "description": "The status of you batch template processing.",
- "example": "Completed"
- }
- }
- }
+ "id": {
+ "type": "string",
+ "description": "Unique identifier assigned to the batch file.",
+ "example": "psy8s1d",
+ "pattern": "^[a-zA-Z0-9_+-]*$",
+ "minLength": 1,
+ "maxLength": 8
+ },
+ "uploadDate": {
+ "type": "string",
+ "description": "Date when the batch template was update.",
+ "example": "2018-01-01"
+ },
+ "completionDate": {
+ "type": "string",
+ "description": "The date when the batch template processing completed.",
+ "example": "2018-01-01"
+ },
+ "transactionCount": {
+ "type": "integer",
+ "description": "Number of transactions in the transaction.",
+ "example": 7534
+ },
+ "acceptedTransactionCount": {
+ "type": "integer",
+ "description": "Number of transactions accepted.",
+ "example": 50013
+ },
+ "rejectedTransactionCount": {
+ "type": "string",
+ "description": "Number of transactions rejected.",
+ "example": 2508
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of you batch template processing.",
+ "example": "Completed"
},
"_links": {
"type": "object",
"properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "example": "/pts/v1/transaction-batches"
- },
- "method": {
- "type": "string",
- "example": "GET"
+ "transactions": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "Self link for this request",
+ "example": "/tss/v2/transactions/5289798134206292501013"
+ },
+ "method": {
+ "type": "string"
+ }
}
}
}
}
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
}
- }
+ },
+ "type": "object"
}
},
"400": {
@@ -11634,10 +11355,10 @@
}
}
},
- "500": {
+ "502": {
"description": "Bad Gateway",
"schema": {
- "title": "ptsV1TransactionBatchesGet500Response",
+ "title": "ptsV1TransactionBatchesGet502Response",
"type": "object",
"properties": {
"errorInformation": {
@@ -11663,1238 +11384,726 @@
}
}
},
- "/pts/v1/transaction-batches/{id}": {
- "get": {
- "summary": "Get individual batch file",
- "description": "Provide the search range",
+ "/pts/v2/payouts": {
+ "post": {
+ "summary": "Process a Payout",
+ "description": "Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using\nan Original Credit Transaction (OCT).\n",
"tags": [
- "TransactionBatches"
+ "Payouts"
],
- "operationId": "getTransactionBatchId",
+ "operationId": "octCreatePayment",
"x-devcenter-metaData": {
- "categoryTag": "Transaction_Batches"
+ "categoryTag": "Payouts"
},
- "produces": [
- "application/hal+json"
- ],
"parameters": [
{
- "name": "id",
- "in": "path",
- "description": "The batch id assigned for the template.",
+ "name": "octCreatePaymentRequest",
+ "in": "body",
"required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "title": "ptsV1TransactionBatchesIdGet200Response",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier assigned to the batch file.",
- "example": "psy8s1d",
- "pattern": "^[a-zA-Z0-9_+-]*$",
- "minLength": 1,
- "maxLength": 8
- },
- "uploadDate": {
- "type": "string",
- "description": "Date when the batch template was update.",
- "example": "2018-01-01"
- },
- "completionDate": {
- "type": "string",
- "description": "The date when the batch template processing completed.",
- "example": "2018-01-01"
- },
- "transactionCount": {
- "type": "integer",
- "description": "Number of transactions in the transaction.",
- "example": 7534
- },
- "acceptedTransactionCount": {
- "type": "integer",
- "description": "Number of transactions accepted.",
- "example": 50013
- },
- "rejectedTransactionCount": {
- "type": "string",
- "description": "Number of transactions rejected.",
- "example": 2508
- },
- "status": {
- "type": "string",
- "description": "The status of you batch template processing.",
- "example": "Completed"
- },
- "_links": {
- "type": "object",
- "properties": {
- "transactions": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "description": "Self link for this request",
- "example": "/tss/v2/transactions/5289798134206292501013"
- },
- "method": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
"schema": {
- "title": "ptsV1TransactionBatchesIdGet400Response",
"type": "object",
"properties": {
- "errorInformation": {
+ "clientReferenceInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
- }
- }
+ "code": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "401": {
- "description": "Not Authorized",
- "schema": {
- "title": "ptsV1TransactionBatchesIdGet401Response",
- "type": "object",
- "properties": {
- "errorInformation": {
+ "orderInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
+ "amountDetails": {
+ "type": "object",
+ "properties": {
+ "totalAmount": {
+ "type": "string",
+ "maxLength": 19,
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
+ },
+ "surcharge": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer.\\\nIf the amount is negative, then it is a credit for the customer.\n\n**NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8.\n\nFor processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ }
}
}
}
- }
- }
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "403": {
- "description": "No Authenticated",
- "schema": {
- "title": "ptsV1TransactionBatchesIdGet403Response",
- "type": "object",
- "properties": {
- "errorInformation": {
- "type": "object",
- "properties": {
- "reason": {
- "type": "string"
- },
- "message": {
- "type": "string"
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
+ "billTo": {
+ "type": "object",
+ "properties": {
+ "firstName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "address1": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "address2": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ },
+ "phoneType": {
+ "type": "string",
+ "enum": [
+ "day",
+ "home",
+ "night",
+ "work"
+ ],
+ "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n"
}
}
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "404": {
- "description": "No Reports Found",
- "schema": {
- "title": "ptsV1TransactionBatchesIdGet404Response",
- "type": "object",
- "properties": {
- "errorInformation": {
+ "merchantInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
+ "categoryCode": {
+ "type": "integer",
+ "maximum": 9999,
+ "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
},
- "message": {
- "type": "string"
+ "submitLocalDateTime": {
+ "type": "string",
+ "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n"
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
+ "vatRegistrationNumber": {
+ "type": "string",
+ "maxLength": 21,
+ "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
+ },
+ "merchantDescriptor": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 13,
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 14,
+ "description": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "contact": {
+ "type": "string",
+ "maxLength": 14,
+ "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n"
}
}
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "502": {
- "description": "Bad Gateway",
- "schema": {
- "title": "ptsV1TransactionBatchesIdGet502Response",
- "type": "object",
- "properties": {
- "errorInformation": {
+ "recipientInformation": {
"type": "object",
"properties": {
- "reason": {
+ "firstName": {
"type": "string",
- "description": "The reason of status"
+ "maxLength": 35,
+ "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"
},
- "message": {
+ "middleInitial": {
"type": "string",
- "description": "The detailed message related to the status and reason listed above."
+ "maxLength": 1,
+ "description": "Middle Initial of recipient. Required only for FDCCompass.\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 35,
+ "description": "Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"
+ },
+ "address1": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Recipient address information. Required only for FDCCompass."
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "Recipient city. Required only for FDCCompass."
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Recipient State. Required only for FDCCompass."
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Recipient country code. Required only for FDCCompass."
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Recipient postal code. Required only for FDCCompass."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Recipient phone number. Required only for FDCCompass."
+ },
+ "dateOfBirth": {
+ "type": "string",
+ "minLength": 8,
+ "maxLength": 8,
+ "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass."
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- }
- }
- }
- },
- "/pts/v1/transaction-batch-details": {
- "get": {
- "tags": [
- "TransactionBatches"
- ],
- "summary": "Filters batch response.\n",
- "description": "Filters batch response.\n",
- "operationId": "getTransactionBatchDetails",
- "x-devcenter-metaData": {
- "categoryTag": "Transaction_Batches"
- },
- "produces": [
- "text/vnd.cybersource.map-csv"
- ],
- "parameters": [
- {
- "name": "transactionBatchId",
- "in": "query",
- "description": "Transaction Batch Id, this is unique.",
- "required": true,
- "type": "string"
- },
- {
- "name": "uploadDate",
- "in": "query",
- "description": "Date in which the original batch file was uploaded. Date must be in ISO-8601 format.",
- "required": false,
- "type": "string",
- "format": "date"
- },
- {
- "name": "status",
- "in": "query",
- "description": "Allows you to filter by rejected response.\n",
- "required": false,
- "type": "string",
- "enum": [
- "Rejected"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "type": "object",
- "properties": {
- "errorInformation": {
+ "senderInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
- },
- "message": {
- "type": "string"
+ "referenceNumber": {
+ "type": "string",
+ "maxLength": 19,
+ "description": "Reference number generated by you that uniquely identifies the sender."
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
+ "account": {
+ "type": "object",
+ "properties": {
+ "fundsSource": {
+ "type": "string",
+ "minLength": 2,
+ "maxLength": 2,
+ "description": "Source of funds. Possible values:\n\n Paymentech, CTV, FDC Compass:\n - 01: Credit card\n - 02: Debit card\n - 03: Prepaid card\n\n Paymentech, CTV -\n - 04: Cash\n - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings\n accounts, and proprietary debit or ATM cards.\n - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines\n of credit.\n\n FDCCompass -\n - 04: Deposit Account\n\n**Funds Disbursement**\n\nThis value is most likely 05 to identify that the originator used a deposit account to fund the\ndisbursement.\n\n**Credit Card Bill Payment**\n\nThis value must be 02, 03, 04, or 05.\n"
+ },
+ "number": {
+ "type": "string",
+ "maxLength": 34,
+ "description": "The account number of the entity funding the transaction. It is the sender\u2019s account number. It can\nbe a debit/credit card account number or bank account number.\n\n**Funds disbursements**\n\nThis field is optional.\n\n**All other transactions**\n\nThis field is required when the sender funds the transaction with a financial instrument, for example\ndebit card.\nLength:\n* FDCCompass (<= 19)\n* Paymentech (<= 16)\n"
}
}
- }
- }
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "401": {
- "description": "Not Authorized",
- "schema": {
- "type": "object",
- "properties": {
- "errorInformation": {
- "type": "object",
- "properties": {
- "reason": {
- "type": "string"
},
- "message": {
- "type": "string"
+ "firstName": {
+ "type": "string",
+ "maxLength": 35,
+ "description": "First name of sender (Optional).\n* CTV (14)\n* Paymentech (30)\n"
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
- }
- }
+ "middleInitial": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "Recipient middle initial (Optional).\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 35,
+ "description": "Recipient last name (Optional).\n* CTV (14)\n* Paymentech (30)\n"
+ },
+ "name": {
+ "type": "string",
+ "maxLength": 24,
+ "description": "Name of sender.\n\n**Funds Disbursement**\n\nThis value is the name of the originator sending the funds disbursement.\n* CTV, Paymentech (30)\n"
+ },
+ "address1": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Street address of sender.\n\n**Funds Disbursement**\n\nThis value is the address of the originator sending the funds disbursement.\n"
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "City of sender.\n\n**Funds Disbursement**\n\nThis value is the city of the originator sending the funds disbursement.\n"
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n"
+ },
+ "countryCode": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n"
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Sender\u2019s postal code. Required only for FDCCompass."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Sender\u2019s phone number. Required only for FDCCompass."
+ },
+ "dateOfBirth": {
+ "type": "string",
+ "minLength": 8,
+ "maxLength": 8,
+ "description": "Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass."
+ },
+ "vatRegistrationNumber": {
+ "type": "string",
+ "maxLength": 13,
+ "description": "Customer's government-assigned tax identification number.\n"
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "403": {
- "description": "No Authenticated",
- "schema": {
- "type": "object",
- "properties": {
- "errorInformation": {
+ "processingInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
+ "businessApplicationId": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Payouts transaction type.\n\nApplicable Processors: FDC Compass, Paymentech, CtV\n\nPossible values:\n\n**Credit Card Bill Payment**\n\n - **CP**: credit card bill payment\n\n**Funds Disbursement**\n\n - **FD**: funds disbursement\n - **GD**: government disbursement\n - **MD**: merchant disbursement\n\n**Money Transfer**\n\n - **AA**: account to account. Sender and receiver are same person.\n - **PP**: person to person. Sender and receiver are different.\n\n**Prepaid Load**\n\n - **TU**: top up\n"
},
- "message": {
- "type": "string"
+ "networkRoutingOrder": {
+ "type": "string",
+ "maxLength": 30,
+ "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer\u2019s routing priorities. \n\nSee https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values\n"
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
+ "commerceIndicator": {
+ "type": "string",
+ "maxLength": 13,
+ "description": "Type of transaction.\n\nSome payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here.\n\nFor details, see the `e_commerce_indicator` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible value for Payouts:\n- internet\n\n#### Ingenico ePayments\nIngenico ePayments was previously called _Global Collect_.\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Other Types of Transactions\nFor details, see \"Commerce Indicators\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "reconciliationId": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"
+ },
+ "payoutsOptions": {
+ "type": "object",
+ "properties": {
+ "acquirerMerchantId": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. \nDepending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal.\nAcquiring Institution Identification Code uniquely identifies the merchant.\nThe value from the original is required in any subsequent messages, including reversals, chargebacks, and representments.\n* Applicable only for CTV for Payouts.\n"
+ },
+ "acquirerBin": {
+ "type": "string",
+ "maxLength": 11,
+ "description": "This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. \nThis number is usually Visa-assigned.\n* Applicable only for CTV for Payouts.\n"
+ },
+ "retrievalReferenceNumber": {
+ "type": "string",
+ "maxLength": 12,
+ "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n* Applicable only for CTV for Payouts.\n"
+ },
+ "accountFundingReferenceId": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n* Applicable only for CTV for Payouts.\n"
}
}
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- },
- "404": {
- "description": "No Reports Found",
- "schema": {
- "type": "object",
- "properties": {
- "errorInformation": {
+ "paymentInformation": {
"type": "object",
"properties": {
- "reason": {
- "type": "string"
- },
- "message": {
- "type": "string"
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "number": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationMonth": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationYear": {
+ "type": "string",
+ "maxLength": 4,
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "sourceAccountType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - `CHECKING`: Checking account\n - `CREDIT`: Credit card account\n - `SAVING`: Saving account\n - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card\n - `PREPAID`: Prepaid card account or prepaid portion of combo card\n - `UNIVERSAL`: Universal account\n"
+ }
+ }
},
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n"
- },
- "message": {
- "type": "string",
- "description": "The detailed message related to the status and reason listed above.\n"
- }
+ "customer": {
+ "type": "object",
+ "properties": {
+ "customerId": {
+ "type": "string",
+ "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
}
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
}
- }
- }
- },
- "502": {
- "description": "Bad Gateway",
- "schema": {
- "type": "object",
- "properties": {
- "errorInformation": {
+ },
+ "example": {
+ "clientReferenceInformation": {
+ "code": "33557799"
+ },
+ "senderInformation": {
+ "referenceNumber": "1234567890",
+ "address1": "900 Metro Center Blvd.900",
+ "countryCode": "US",
+ "locality": "Foster City",
+ "name": "Thomas Jefferson",
+ "administrativeArea": "CA",
+ "account": {
+ "number": "1234567890123456789012345678901234",
+ "fundsSource": "01"
+ }
+ },
+ "processingInformation": {
+ "commerceIndicator": "internet",
+ "businessApplicationId": "FD",
+ "networkRoutingOrder": "ECG"
+ },
+ "payoutsOptions": {
+ "retrievalReferenceNumber": "123456789012",
+ "acquirerBin": "567890124"
+ },
+ "reconciliationId": "1087488702VIAQNSPQ",
+ "orderInformation": {
+ "amountDetails": {
+ "totalAmount": "100.00",
+ "currency": "USD"
+ }
+ },
+ "merchantInformation": {
+ "merchantCategoryCode": "123",
+ "merchantDescriptor": {
+ "country": "US",
+ "postalCode": "94440",
+ "locality": "FC",
+ "name": "Thomas",
+ "administrativeArea": "CA"
+ }
+ },
+ "paymentInformation": {
+ "card": {
+ "expirationYear": "2025",
+ "number": "4111111111111111",
+ "expirationMonth": "12",
+ "type": "001",
+ "sourceAccountType": "CH"
+ }
+ },
+ "recipientInformation": {
+ "firstName": "John",
+ "lastName": "Doe",
+ "address1": "Paseo Padre Boulevard",
+ "locality": "Foster City",
+ "administrativeArea": "CA",
+ "postalCode": "94400",
+ "phoneNumber": "6504320556",
+ "dateOfBirth": "19801009",
+ "country": "US"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Successful response.",
+ "schema": {
+ "title": "ptsV2PayoutsPost201Response",
+ "example": {
+ "_links": {
+ "self": {
+ "href": "/pts/v2/payouts/5287556536256000401540",
+ "method": "GET"
+ }
+ },
+ "clientReferenceInformation": {
+ "code": "1528755653559"
+ },
+ "id": "5287556536256000401540",
+ "orderInformation": {
+ "amountDetails": {
+ "totalAmount": "100.00",
+ "currency": "USD"
+ }
+ },
+ "processorInformation": {
+ "systemTraceAuditNumber": "897596",
+ "approvalCode": "831000",
+ "transactionId": "016153570198200",
+ "responseCode": "00",
+ "responseCodeSource": "5"
+ },
+ "reconciliationId": "1087488702VIAQNSPQ",
+ "status": "ACCEPTED",
+ "submitTimeUtc": "2018-06-11T222054Z"
+ },
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "This is the endpoint of the resource that was created by the successful request."
+ },
+ "method": {
+ "type": "string",
+ "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource."
+ }
+ }
+ }
+ }
+ },
+ "id": {
+ "type": "string",
+ "maxLength": 26,
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource."
+ },
+ "submitTimeUtc": {
+ "type": "string",
+ "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n - DECLINED\n - INVALID_REQUEST\n",
+ "enum": [
+ "ACCEPTED",
+ "DECLINED",
+ "INVALID_REQUEST"
+ ]
+ },
+ "reconciliationId": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is\nThis value is used for reconciliation purposes.\n"
+ },
+ "errorInformation": {
"type": "object",
"properties": {
"reason": {
"type": "string",
- "description": "The reason of status"
+ "description": "The reason of the status.\n\nPossible values:\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - STOLEN_LOST_CARD\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - INVALID_CVN\n - BLACKLISTED_CUSTOMER\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - RISK_CONTROL_DECLINE\n - PROCESSOR_RISK_CONTROL_DECLINE\n",
+ "enum": [
+ "EXPIRED_CARD",
+ "PROCESSOR_DECLINED",
+ "STOLEN_LOST_CARD",
+ "UNAUTHORIZED_CARD",
+ "CVN_NOT_MATCH",
+ "INVALID_CVN",
+ "BLACKLISTED_CUSTOMER",
+ "INVALID_ACCOUNT",
+ "GENERAL_DECLINE",
+ "RISK_CONTROL_DECLINE",
+ "PROCESSOR_RISK_CONTROL_DECLINE"
+ ]
},
"message": {
"type": "string",
- "description": "The detailed message related to the status and reason listed above."
+ "description": "The detail message related to the status and reason listed above."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid."
+ },
+ "reason": {
+ "type": "string",
+ "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
+ "enum": [
+ "MISSING_FIELD",
+ "INVALID_DATA"
+ ]
+ }
+ }
+ }
}
}
},
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
- }
- }
- }
- }
- }
- }
- },
- "/pts/v2/payouts": {
- "post": {
- "summary": "Process a Payout",
- "description": "Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using\nan Original Credit Transaction (OCT).\n",
- "tags": [
- "Payouts"
- ],
- "operationId": "octCreatePayment",
- "x-devcenter-metaData": {
- "categoryTag": "Payouts"
- },
- "parameters": [
- {
- "name": "octCreatePaymentRequest",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object",
- "properties": {
"clientReferenceInformation": {
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ },
+ "submitLocalDateTime": {
+ "type": "string",
+ "maxLength": 14,
+ "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n"
+ },
+ "ownerMerchantId": {
+ "type": "string",
+ "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
- "orderInformation": {
+ "merchantInformation": {
"type": "object",
"properties": {
- "amountDetails": {
- "type": "object",
+ "merchantDescriptor": {
"properties": {
- "totalAmount": {
+ "name": {
"type": "string",
- "maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n"
},
- "currency": {
+ "locality": {
"type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "maxLength": 13,
+ "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
- "surcharge": {
- "type": "object",
- "properties": {
- "amount": {
- "type": "string",
- "maxLength": 15,
- "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer.\\\nIf the amount is negative, then it is a credit for the customer.\n\n**NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8.\n\nFor processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- }
- }
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
- },
- "billTo": {
+ }
+ }
+ },
+ "orderInformation": {
+ "type": "object",
+ "properties": {
+ "amountDetails": {
"type": "object",
"properties": {
- "firstName": {
+ "totalAmount": {
"type": "string",
- "maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "maxLength": 19,
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
},
- "lastName": {
+ "currency": {
"type": "string",
- "maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "maxLength": 3,
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
- "address1": {
+ "settlementAmount": {
"type": "string",
- "maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "maxLength": 12,
+ "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n"
},
- "address2": {
- "type": "string",
- "maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "country": {
- "type": "string",
- "maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "locality": {
- "type": "string",
- "maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "administrativeArea": {
- "type": "string",
- "maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "postalCode": {
- "type": "string",
- "maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "phoneNumber": {
- "type": "string",
- "maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
- },
- "phoneType": {
- "type": "string",
- "enum": [
- "day",
- "home",
- "night",
- "work"
- ],
- "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n"
- }
- }
- }
- }
- },
- "merchantInformation": {
- "type": "object",
- "properties": {
- "categoryCode": {
- "type": "integer",
- "maximum": 9999,
- "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n"
- },
- "submitLocalDateTime": {
- "type": "string",
- "maxLength": 6,
- "minLength": 6,
- "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n"
- },
- "vatRegistrationNumber": {
- "type": "string",
- "maxLength": 21,
- "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"
- },
- "merchantDescriptor": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
- },
- "locality": {
- "type": "string",
- "maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "country": {
- "type": "string",
- "maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "administrativeArea": {
+ "settlementCurrency": {
"type": "string",
"maxLength": 3,
- "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "postalCode": {
- "type": "string",
- "maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "contact": {
- "type": "string",
- "maxLength": 14,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"
+ "description": "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.\n"
}
}
}
}
},
- "recipientInformation": {
+ "processorInformation": {
"type": "object",
"properties": {
- "firstName": {
- "type": "string",
- "maxLength": 35,
- "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"
- },
- "middleInitial": {
- "type": "string",
- "maxLength": 1,
- "description": "Middle Initial of recipient. Required only for FDCCompass.\n"
- },
- "lastName": {
- "type": "string",
- "maxLength": 35,
- "description": "Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"
- },
- "address1": {
- "type": "string",
- "maxLength": 50,
- "description": "Recipient address information. Required only for FDCCompass."
- },
- "locality": {
- "type": "string",
- "maxLength": 25,
- "description": "Recipient city. Required only for FDCCompass."
- },
- "administrativeArea": {
- "type": "string",
- "maxLength": 3,
- "description": "Recipient State. Required only for FDCCompass."
- },
- "country": {
+ "approvalCode": {
"type": "string",
- "maxLength": 2,
- "description": "Recipient country code. Required only for FDCCompass."
+ "maxLength": 6,
+ "description": "Issuer-generated approval code for the transaction."
},
- "postalCode": {
+ "responseCode": {
"type": "string",
"maxLength": 10,
- "description": "Recipient postal code. Required only for FDCCompass."
- },
- "phoneNumber": {
- "type": "string",
- "maxLength": 20,
- "description": "Recipient phone number. Required only for FDCCompass."
+ "description": "Transaction status from the processor."
},
- "dateOfBirth": {
- "type": "string",
- "minLength": 8,
- "maxLength": 8,
- "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass."
- }
- }
- },
- "senderInformation": {
- "type": "object",
- "properties": {
- "referenceNumber": {
+ "transactionId": {
"type": "string",
- "maxLength": 19,
- "description": "Reference number generated by you that uniquely identifies the sender."
- },
- "account": {
- "type": "object",
- "properties": {
- "fundsSource": {
- "type": "string",
- "minLength": 2,
- "maxLength": 2,
- "description": "Source of funds. Possible values:\n\n Paymentech, CTV, FDC Compass:\n - 01: Credit card\n - 02: Debit card\n - 03: Prepaid card\n\n Paymentech, CTV -\n - 04: Cash\n - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings\n accounts, and proprietary debit or ATM cards.\n - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines\n of credit.\n\n FDCCompass -\n - 04: Deposit Account\n\n**Funds Disbursement**\n\nThis value is most likely 05 to identify that the originator used a deposit account to fund the\ndisbursement.\n\n**Credit Card Bill Payment**\n\nThis value must be 02, 03, 04, or 05.\n"
- },
- "number": {
- "type": "string",
- "maxLength": 34,
- "description": "The account number of the entity funding the transaction. It is the sender\u2019s account number. It can\nbe a debit/credit card account number or bank account number.\n\n**Funds disbursements**\n\nThis field is optional.\n\n**All other transactions**\n\nThis field is required when the sender funds the transaction with a financial instrument, for example\ndebit card.\nLength:\n* FDCCompass (<= 19)\n* Paymentech (<= 16)\n"
- }
- }
+ "maxLength": 15,
+ "description": "Network transaction identifier (TID). This value can be used to identify a specific transaction when\nyou are discussing the transaction with your processor.\n"
},
- "firstName": {
+ "systemTraceAuditNumber": {
"type": "string",
- "maxLength": 35,
- "description": "First name of sender (Optional).\n* CTV (14)\n* Paymentech (30)\n"
+ "maxLength": 6,
+ "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n#### American Express Direct\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n#### CyberSource through VisaNet\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
- "middleInitial": {
+ "responseCodeSource": {
"type": "string",
"maxLength": 1,
- "description": "Recipient middle initial (Optional).\n"
- },
- "lastName": {
- "type": "string",
- "maxLength": 35,
- "description": "Recipient last name (Optional).\n* CTV (14)\n* Paymentech (30)\n"
- },
- "name": {
- "type": "string",
- "maxLength": 24,
- "description": "Name of sender.\n\n**Funds Disbursement**\n\nThis value is the name of the originator sending the funds disbursement.\n* CTV, Paymentech (30)\n"
- },
- "address1": {
- "type": "string",
- "maxLength": 50,
- "description": "Street address of sender.\n\n**Funds Disbursement**\n\nThis value is the address of the originator sending the funds disbursement.\n"
- },
- "locality": {
- "type": "string",
- "maxLength": 25,
- "description": "City of sender.\n\n**Funds Disbursement**\n\nThis value is the city of the originator sending the funds disbursement.\n"
- },
- "administrativeArea": {
- "type": "string",
- "maxLength": 2,
- "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n"
- },
- "countryCode": {
- "type": "string",
- "maxLength": 2,
- "description": "Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n"
- },
- "postalCode": {
- "type": "string",
- "maxLength": 10,
- "description": "Sender\u2019s postal code. Required only for FDCCompass."
- },
- "phoneNumber": {
- "type": "string",
- "maxLength": 20,
- "description": "Sender\u2019s phone number. Required only for FDCCompass."
- },
- "dateOfBirth": {
- "type": "string",
- "minLength": 8,
- "maxLength": 8,
- "description": "Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass."
- },
- "vatRegistrationNumber": {
- "type": "string",
- "maxLength": 13,
- "description": "Customer's government-assigned tax identification number.\n"
+ "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n"
}
}
},
- "processingInformation": {
+ "recipientInformation": {
"type": "object",
"properties": {
- "businessApplicationId": {
- "type": "string",
- "maxLength": 2,
- "description": "Payouts transaction type.\n\nApplicable Processors: FDC Compass, Paymentech, CtV\n\nPossible values:\n\n**Credit Card Bill Payment**\n\n - **CP**: credit card bill payment\n\n**Funds Disbursement**\n\n - **FD**: funds disbursement\n - **GD**: government disbursement\n - **MD**: merchant disbursement\n\n**Money Transfer**\n\n - **AA**: account to account. Sender and receiver are same person.\n - **PP**: person to person. Sender and receiver are different.\n\n**Prepaid Load**\n\n - **TU**: top up\n"
- },
- "networkRoutingOrder": {
- "type": "string",
- "maxLength": 30,
- "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer\u2019s routing priorities. \n\nSee https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values\n"
- },
- "commerceIndicator": {
- "type": "string",
- "maxLength": 13,
- "description": "Type of transaction.\n\nSome payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here.\n\nPossible value for Fast Payments transactions:\n - internet\n\n**Ingenico ePayments**\\\nIngenico ePayments was previously called _Global Collect_.\n\n**Payer Authentication Transactions**\\\nFor the possible values and requirements, see \"Payer Authentication,\" page 180.\n\n**Other Types of Transactions**\\\nSee Appendix G, \"Commerce Indicators,\" on page 353.\n"
- },
- "reconciliationId": {
- "type": "string",
- "maxLength": 60,
- "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"
- },
- "payoutsOptions": {
+ "card": {
"type": "object",
"properties": {
- "acquirerMerchantId": {
- "type": "string",
- "maxLength": 15,
- "description": "This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. \nDepending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal.\nAcquiring Institution Identification Code uniquely identifies the merchant.\nThe value from the original is required in any subsequent messages, including reversals, chargebacks, and representments.\n* Applicable only for CTV for Payouts.\n"
- },
- "acquirerBin": {
- "type": "string",
- "maxLength": 11,
- "description": "This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. \nThis number is usually Visa-assigned.\n* Applicable only for CTV for Payouts.\n"
- },
- "retrievalReferenceNumber": {
+ "balance": {
"type": "string",
"maxLength": 12,
- "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n* Applicable only for CTV for Payouts.\n"
+ "description": "This field shows the available balance in the prepaid account. \nAcquirers always receive the available balance in the transaction currency.\n"
},
- "accountFundingReferenceId": {
+ "currency": {
"type": "string",
- "maxLength": 15,
- "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n* Applicable only for CTV for Payouts.\n"
- }
- }
- }
- }
- },
- "paymentInformation": {
- "type": "object",
- "properties": {
- "card": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
- },
- "number": {
- "type": "string",
- "maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "expirationMonth": {
- "type": "string",
- "maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "expirationYear": {
- "type": "string",
- "maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "sourceAccountType": {
- "type": "string",
- "maxLength": 20,
- "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note**\\\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - **CHECKING**: Checking account\n - **CREDIT**: Credit card account\n - **SAVING**: Saving account\n - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card\n - **PREPAID**: Prepaid card account or prepaid portion of combo card\n - **UNIVERSAL**: Universal account\n"
- }
- }
- },
- "customer": {
- "type": "object",
- "properties": {
- "customerId": {
- "type": "string",
- "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n"
+ "maxLength": 3,
+ "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer.\n"
}
}
}
}
}
},
- "example": {
- "clientReferenceInformation": {
- "code": "33557799"
- },
- "senderInformation": {
- "referenceNumber": "1234567890",
- "address1": "900 Metro Center Blvd.900",
- "countryCode": "US",
- "locality": "Foster City",
- "name": "Thomas Jefferson",
- "administrativeArea": "CA",
- "account": {
- "number": "1234567890123456789012345678901234",
- "fundsSource": "01"
- }
- },
- "processingInformation": {
- "commerceIndicator": "internet",
- "businessApplicationId": "FD",
- "networkRoutingOrder": "ECG"
- },
- "payoutsOptions": {
- "retrievalReferenceNumber": "123456789012",
- "acquirerBin": "567890124"
- },
- "reconciliationId": "1087488702VIAQNSPQ",
- "orderInformation": {
- "amountDetails": {
- "totalAmount": "100.00",
- "currency": "USD"
- }
- },
- "merchantInformation": {
- "merchantCategoryCode": "123",
- "merchantDescriptor": {
- "country": "US",
- "postalCode": "94440",
- "locality": "FC",
- "name": "Thomas",
- "administrativeArea": "CA"
- }
- },
- "paymentInformation": {
- "card": {
- "expirationYear": "2025",
- "number": "4111111111111111",
- "expirationMonth": "12",
- "type": "001",
- "sourceAccountType": "CH"
- }
- },
- "recipientInformation": {
- "firstName": "John",
- "lastName": "Doe",
- "address1": "Paseo Padre Boulevard",
- "locality": "Foster City",
- "administrativeArea": "CA",
- "postalCode": "94400",
- "phoneNumber": "6504320556",
- "dateOfBirth": "19801009",
- "country": "US"
- }
- }
- }
- }
- ],
- "responses": {
- "201": {
- "description": "Successful response.",
- "schema": {
- "title": "ptsV2PayoutsPost201Response",
- "type": "object",
- "properties": {
- "_links": {
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "description": "This is the endpoint of the resource that was created by the successful request."
- },
- "method": {
- "type": "string",
- "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource."
- }
- }
- }
- }
- },
- "id": {
- "type": "string",
- "maxLength": 26,
- "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource."
- },
- "submitTimeUtc": {
- "type": "string",
- "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"
- },
- "status": {
- "type": "string",
- "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n - DECLINED\n - INVALID_REQUEST\n",
- "enum": [
- "ACCEPTED",
- "DECLINED",
- "INVALID_REQUEST"
- ]
- },
- "reconciliationId": {
- "type": "string",
- "maxLength": 25,
- "description": "Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is\nThis value is used for reconciliation purposes.\n"
- },
- "errorInformation": {
- "type": "object",
- "properties": {
- "reason": {
- "type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - STOLEN_LOST_CARD\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - INVALID_CVN\n - BLACKLISTED_CUSTOMER\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - RISK_CONTROL_DECLINE\n - PROCESSOR_RISK_CONTROL_DECLINE\n",
- "enum": [
- "EXPIRED_CARD",
- "PROCESSOR_DECLINED",
- "STOLEN_LOST_CARD",
- "UNAUTHORIZED_CARD",
- "CVN_NOT_MATCH",
- "INVALID_CVN",
- "BLACKLISTED_CUSTOMER",
- "INVALID_ACCOUNT",
- "GENERAL_DECLINE",
- "RISK_CONTROL_DECLINE",
- "PROCESSOR_RISK_CONTROL_DECLINE"
- ]
- },
- "message": {
- "type": "string",
- "description": "The detail message related to the status and reason listed above."
- },
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "This is the flattened JSON object field name/path that is either missing or invalid."
- },
- "reason": {
- "type": "string",
- "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
- "enum": [
- "MISSING_FIELD",
- "INVALID_DATA"
- ]
- }
- }
- }
- }
- }
- },
- "clientReferenceInformation": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
- },
- "submitLocalDateTime": {
- "type": "string",
- "maxLength": 14,
- "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n"
- },
- "ownerMerchantId": {
- "type": "string",
- "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n"
- }
- }
- },
- "merchantInformation": {
- "type": "object",
- "properties": {
- "merchantDescriptor": {
- "properties": {
- "name": {
- "type": "string",
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"
- },
- "locality": {
- "type": "string",
- "maxLength": 13,
- "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- },
- "country": {
- "type": "string",
- "maxLength": 2,
- "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
- }
- }
- }
- }
- },
- "orderInformation": {
- "type": "object",
- "properties": {
- "amountDetails": {
- "type": "object",
- "properties": {
- "totalAmount": {
- "type": "string",
- "maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
- },
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
- },
- "settlementAmount": {
- "type": "string",
- "maxLength": 12,
- "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n"
- },
- "settlementCurrency": {
- "type": "string",
- "maxLength": 3,
- "description": "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.\n"
- }
- }
- }
- }
- },
- "processorInformation": {
- "type": "object",
- "properties": {
- "approvalCode": {
- "type": "string",
- "maxLength": 6,
- "description": "Issuer-generated approval code for the transaction."
- },
- "responseCode": {
- "type": "string",
- "maxLength": 10,
- "description": "Transaction status from the processor."
- },
- "transactionId": {
- "type": "string",
- "maxLength": 15,
- "description": "Network transaction identifier (TID). This value can be used to identify a specific transaction when\nyou are discussing the transaction with your processor.\n"
- },
- "systemTraceAuditNumber": {
- "type": "string",
- "maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n"
- },
- "responseCodeSource": {
- "type": "string",
- "maxLength": 1,
- "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n"
- }
- }
- },
- "recipientInformation": {
- "type": "object",
- "properties": {
- "card": {
- "type": "object",
- "properties": {
- "balance": {
- "type": "string",
- "maxLength": 12,
- "description": "This field shows the available balance in the prepaid account. \nAcquirers always receive the available balance in the transaction currency.\n"
- },
- "currency": {
- "type": "string",
- "maxLength": 3,
- "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer.\n"
- }
- }
- }
- }
- }
- },
- "example": {
- "_links": {
- "self": {
- "href": "/pts/v2/payouts/5287556536256000401540",
- "method": "GET"
- }
- },
- "clientReferenceInformation": {
- "code": "1528755653559"
- },
- "id": "5287556536256000401540",
- "orderInformation": {
- "amountDetails": {
- "totalAmount": "100.00",
- "currency": "USD"
- }
- },
- "processorInformation": {
- "systemTraceAuditNumber": "897596",
- "approvalCode": "831000",
- "transactionId": "016153570198200",
- "responseCode": "00",
- "responseCodeSource": "5"
- },
- "reconciliationId": "1087488702VIAQNSPQ",
- "status": "ACCEPTED",
- "submitTimeUtc": "2018-06-11T222054Z"
- }
+ "type": "object"
}
},
"400": {
@@ -12905,8 +12114,6 @@
"properties": {
"submitTimeUtc": {
"type": "string",
- "maxLength": 6,
- "minLength": 6,
"description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"
},
"status": {
@@ -16462,429 +15669,429 @@
"description": "Ok",
"schema": {
"title": "reportingV3PurchaseRefundDetailsGet200Response",
- "type": "object",
- "properties": {
- "offset": {
- "type": "integer"
- },
- "limit": {
- "type": "integer"
- },
- "pageResults": {
- "type": "integer"
- },
- "requestDetails": {
- "type": "array",
- "description": "List of Request Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "cybersourceMerchantId": {
- "type": "string",
- "example": "Cybersource Merchant Id",
- "description": "Cybersource Merchant Id"
- },
- "processorMerchantId": {
- "type": "string",
- "example": "Processor Merchant Id",
- "description": "Cybersource Processor Merchant Id"
- },
- "groupName": {
- "type": "string",
- "example": "996411990498708810001",
- "description": "Group Name"
- },
- "transactionReferenceNumber": {
- "type": "string",
- "example": "RZ3J9WCS9J33",
- "description": "Transaction Reference Number"
- },
- "merchantReferenceNumber": {
- "type": "string",
- "example": "47882339",
- "description": "Merchant Reference Number"
- }
- },
- "description": "Request Info Section"
- }
- },
- "settlements": {
- "type": "array",
- "description": "List of Settlement Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "transactionType": {
- "type": "string",
- "example": "Purchases",
- "description": "Transaction Type"
- },
- "submissionTime": {
- "type": "string",
- "example": "2017-10-01T10:10:10+05:00",
- "description": "Submission Date",
- "format": "date-time"
- },
- "amount": {
- "type": "string",
- "example": "23.00",
- "description": "Amount"
- },
- "currencyCode": {
- "type": "string",
- "example": "USD",
- "description": "Valid ISO 4217 ALPHA-3 currency code"
- },
- "paymentMethod": {
- "type": "string",
- "example": "VISA",
- "description": "payment method"
- },
- "walletType": {
- "type": "string",
- "example": "V.me",
- "description": "Solution Type (Wallet)"
- },
- "paymentType": {
- "type": "string",
- "example": "credit card",
- "description": "Payment Type"
- },
- "accountSuffix": {
- "type": "string",
- "example": "0004",
- "description": "Account Suffix"
- },
- "cybersourceBatchTime": {
- "type": "string",
- "example": "2017-10-01T10:10:10+05:00",
- "description": "Cybersource Batch Time",
- "format": "date-time"
- },
- "cybersourceBatchId": {
- "type": "string",
- "example": "123123123123123",
- "description": "Cybersource Batch Id"
- },
- "cardType": {
- "type": "string",
- "example": "null",
- "description": "Card Type"
- },
- "debitNetwork": {
- "type": "string",
- "example": "",
- "description": "Debit Network"
- }
- }
- }
- },
- "authorizations": {
- "type": "array",
- "description": "List of Authorization Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "transactionReferenceNumber": {
- "type": "string",
- "example": "RZ3J9WCS9J27",
- "description": "Authorization Transaction Reference Number"
- },
- "time": {
- "type": "string",
- "example": "2017-10-01T10:10:10+05:00",
- "description": "Authorization Date",
- "format": "date-time"
- },
- "authorizationRequestId": {
- "type": "string",
- "example": "12345678901234567890123459",
- "description": "Authorization Request Id"
- },
- "amount": {
- "type": "string",
- "example": "2.50",
- "description": "Authorization Amount"
- },
- "currencyCode": {
- "type": "string",
- "example": "USD",
- "description": "Valid ISO 4217 ALPHA-3 currency code"
- },
- "code": {
- "type": "string",
- "example": "160780",
- "description": "Authorization Code"
- },
- "rcode": {
- "type": "string",
- "example": "1",
- "description": "Authorization RCode"
- }
- },
- "description": "Authorization Info Values"
- }
- },
- "feeAndFundingDetails": {
- "type": "array",
- "description": "List of Fee Funding Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "maxLength": 26,
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "interchangePerItemFee": {
- "type": "string",
- "example": "2.7",
- "description": "interchange Per Item Fee"
- },
- "discountPercentage": {
- "type": "string",
- "example": "2.39",
- "description": "Discount Percentage"
- },
- "discountAmount": {
- "type": "string",
- "example": "0.429",
- "description": "Discount Amount"
- },
- "discountPerItemFee": {
- "type": "string",
- "example": "0.002",
- "description": "Discount Per Item Fee"
- },
- "totalFee": {
- "type": "string",
- "example": "0.429",
- "description": "Total Fee"
- },
- "feeCurrency": {
- "type": "string",
- "example": "1",
- "description": "Fee Currency"
- },
- "duesAssessments": {
- "type": "string",
- "example": "0",
- "description": "Dues Assessments"
- },
- "fundingAmount": {
- "type": "string",
- "example": "2.50",
- "description": "Funding Amount"
- },
- "fundingCurrency": {
- "type": "string",
- "example": "USD",
- "description": "Funding Currency (ISO 4217)"
- }
- },
- "description": "Fee Funding Section"
- }
- },
- "others": {
- "type": "array",
- "description": "List of Other Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "maxLength": 26,
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "merchantData1": {
- "type": "string",
- "example": "Merchant Defined Data",
- "description": "Merchant Defined Data"
- },
- "merchantData2": {
- "type": "string",
- "example": "Merchant Defined Data",
- "description": "Merchant Defined Data"
- },
- "merchantData3": {
- "type": "string",
- "example": "Merchant Defined Data",
- "description": "Merchant Defined Data"
- },
- "merchantData4": {
- "type": "string",
- "example": "Merchant Defined Data",
- "description": "Merchant Defined Data"
- },
- "firstName": {
- "type": "string",
- "example": "First Name",
- "description": "First Name"
- },
- "lastName": {
- "type": "string",
- "example": "Last Name",
- "description": "Last Name"
- }
- },
- "description": "Other Merchant Details Values."
- }
- },
- "settlementStatuses": {
- "type": "array",
- "description": "List of Settlement Status Info values",
- "items": {
- "type": "object",
- "properties": {
- "requestId": {
- "type": "string",
- "maxLength": 26,
- "example": "12345678901234567890123456",
- "description": "An unique identification number assigned by CyberSource to identify the submitted request."
- },
- "status": {
- "type": "string",
- "example": "Settlement Status",
- "description": "Settlement Status"
- },
- "settlementTime": {
- "type": "string",
- "example": "2017-10-01T10:10:10+05:00",
- "format": "date-time",
- "description": "Settlement Date"
- },
- "reasonCode": {
- "example": "reasonCode",
- "type": "string",
- "description": "ReasonCode"
- },
- "errorText": {
- "example": "errorText",
- "type": "string",
- "description": "errorText"
- }
- },
- "description": "Settlement Status Section Values."
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid request",
- "schema": {
- "title": "reportingV3PurchaseRefundDetailsGet400Response",
- "type": "object",
- "required": [
- "submitTimeUtc",
- "reason",
- "message",
- "details"
- ],
"properties": {
- "submitTimeUtc": {
- "type": "string",
- "format": "date-time",
- "description": "Time of request in UTC. \n",
- "example": "2016-08-11T22:47:57Z"
+ "offset": {
+ "type": "integer"
},
- "reason": {
- "type": "string",
- "description": "Documented reason code\n",
- "example": "INVALID_DATA"
+ "limit": {
+ "type": "integer"
},
- "message": {
- "type": "string",
- "description": "Short descriptive message to the user.\n",
- "example": "One or more fields contains invalid data"
+ "pageResults": {
+ "type": "integer"
},
- "details": {
+ "requestDetails": {
"type": "array",
- "description": "Error field list\n",
+ "description": "List of Request Info values",
"items": {
"type": "object",
"properties": {
- "field": {
+ "requestId": {
"type": "string",
- "description": "Field in request that caused an error\n"
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
},
- "reason": {
+ "cybersourceMerchantId": {
"type": "string",
- "description": "Documented reason code\n"
+ "example": "Cybersource Merchant Id",
+ "description": "Cybersource Merchant Id"
+ },
+ "processorMerchantId": {
+ "type": "string",
+ "example": "Processor Merchant Id",
+ "description": "Cybersource Processor Merchant Id"
+ },
+ "groupName": {
+ "type": "string",
+ "example": "996411990498708810001",
+ "description": "Group Name"
+ },
+ "transactionReferenceNumber": {
+ "type": "string",
+ "example": "RZ3J9WCS9J33",
+ "description": "Transaction Reference Number"
+ },
+ "merchantReferenceNumber": {
+ "type": "string",
+ "example": "47882339",
+ "description": "Merchant Reference Number"
}
},
- "description": "Provides failed validation input field detail\n"
+ "description": "Request Info Section"
}
- }
- },
- "description": "HTTP status code for client application"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "title": "reportingV3PurchaseRefundDetailsGet401Response",
- "type": "object",
- "required": [
- "submitTimeUtc",
- "reason",
- "message",
- "details"
- ],
- "properties": {
- "submitTimeUtc": {
- "type": "string",
- "format": "date-time",
- "description": "Time of request in UTC. \n",
- "example": "2016-08-11T22:47:57Z"
- },
- "reason": {
- "type": "string",
- "description": "Documented reason code\n",
- "example": "INVALID_DATA"
- },
- "message": {
- "type": "string",
- "description": "Short descriptive message to the user.\n",
- "example": "One or more fields contains invalid data"
},
- "details": {
+ "settlements": {
"type": "array",
- "description": "Error field list\n",
+ "description": "List of Settlement Info values",
"items": {
"type": "object",
"properties": {
- "field": {
+ "requestId": {
"type": "string",
- "description": "Field in request that caused an error\n"
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
},
- "reason": {
+ "transactionType": {
"type": "string",
- "description": "Documented reason code\n"
+ "example": "Purchases",
+ "description": "Transaction Type"
+ },
+ "submissionTime": {
+ "type": "string",
+ "example": "2017-10-01T10:10:10+05:00",
+ "description": "Submission Date",
+ "format": "date-time"
+ },
+ "amount": {
+ "type": "string",
+ "example": "23.00",
+ "description": "Amount"
+ },
+ "currencyCode": {
+ "type": "string",
+ "example": "USD",
+ "description": "Valid ISO 4217 ALPHA-3 currency code"
+ },
+ "paymentMethod": {
+ "type": "string",
+ "example": "VISA",
+ "description": "payment method"
+ },
+ "walletType": {
+ "type": "string",
+ "example": "V.me",
+ "description": "Solution Type (Wallet)"
+ },
+ "paymentType": {
+ "type": "string",
+ "example": "credit card",
+ "description": "Payment Type"
+ },
+ "accountSuffix": {
+ "type": "string",
+ "example": "0004",
+ "description": "Account Suffix"
+ },
+ "cybersourceBatchTime": {
+ "type": "string",
+ "example": "2017-10-01T10:10:10+05:00",
+ "description": "Cybersource Batch Time",
+ "format": "date-time"
+ },
+ "cybersourceBatchId": {
+ "type": "string",
+ "example": "123123123123123",
+ "description": "Cybersource Batch Id"
+ },
+ "cardType": {
+ "type": "string",
+ "example": "null",
+ "description": "Card Type"
+ },
+ "debitNetwork": {
+ "type": "string",
+ "example": "",
+ "description": "Debit Network"
}
- },
- "description": "Provides failed validation input field detail\n"
+ }
}
- }
- },
- "description": "HTTP status code for client application"
+ },
+ "authorizations": {
+ "type": "array",
+ "description": "List of Authorization Info values",
+ "items": {
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
+ },
+ "transactionReferenceNumber": {
+ "type": "string",
+ "example": "RZ3J9WCS9J27",
+ "description": "Authorization Transaction Reference Number"
+ },
+ "time": {
+ "type": "string",
+ "example": "2017-10-01T10:10:10+05:00",
+ "description": "Authorization Date",
+ "format": "date-time"
+ },
+ "authorizationRequestId": {
+ "type": "string",
+ "example": "12345678901234567890123459",
+ "description": "Authorization Request Id"
+ },
+ "amount": {
+ "type": "string",
+ "example": "2.50",
+ "description": "Authorization Amount"
+ },
+ "currencyCode": {
+ "type": "string",
+ "example": "USD",
+ "description": "Valid ISO 4217 ALPHA-3 currency code"
+ },
+ "code": {
+ "type": "string",
+ "example": "160780",
+ "description": "Authorization Code"
+ },
+ "rcode": {
+ "type": "string",
+ "example": "1",
+ "description": "Authorization RCode"
+ }
+ },
+ "description": "Authorization Info Values"
+ }
+ },
+ "feeAndFundingDetails": {
+ "type": "array",
+ "description": "List of Fee Funding Info values",
+ "items": {
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "maxLength": 26,
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
+ },
+ "interchangePerItemFee": {
+ "type": "string",
+ "example": "2.7",
+ "description": "interchange Per Item Fee"
+ },
+ "discountPercentage": {
+ "type": "string",
+ "example": "2.39",
+ "description": "Discount Percentage"
+ },
+ "discountAmount": {
+ "type": "string",
+ "example": "0.429",
+ "description": "Discount Amount"
+ },
+ "discountPerItemFee": {
+ "type": "string",
+ "example": "0.002",
+ "description": "Discount Per Item Fee"
+ },
+ "totalFee": {
+ "type": "string",
+ "example": "0.429",
+ "description": "Total Fee"
+ },
+ "feeCurrency": {
+ "type": "string",
+ "example": "1",
+ "description": "Fee Currency"
+ },
+ "duesAssessments": {
+ "type": "string",
+ "example": "0",
+ "description": "Dues Assessments"
+ },
+ "fundingAmount": {
+ "type": "string",
+ "example": "2.50",
+ "description": "Funding Amount"
+ },
+ "fundingCurrency": {
+ "type": "string",
+ "example": "USD",
+ "description": "Funding Currency (ISO 4217)"
+ }
+ },
+ "description": "Fee Funding Section"
+ }
+ },
+ "others": {
+ "type": "array",
+ "description": "List of Other Info values",
+ "items": {
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "maxLength": 26,
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
+ },
+ "merchantData1": {
+ "type": "string",
+ "example": "Merchant Defined Data",
+ "description": "Merchant Defined Data"
+ },
+ "merchantData2": {
+ "type": "string",
+ "example": "Merchant Defined Data",
+ "description": "Merchant Defined Data"
+ },
+ "merchantData3": {
+ "type": "string",
+ "example": "Merchant Defined Data",
+ "description": "Merchant Defined Data"
+ },
+ "merchantData4": {
+ "type": "string",
+ "example": "Merchant Defined Data",
+ "description": "Merchant Defined Data"
+ },
+ "firstName": {
+ "type": "string",
+ "example": "First Name",
+ "description": "First Name"
+ },
+ "lastName": {
+ "type": "string",
+ "example": "Last Name",
+ "description": "Last Name"
+ }
+ },
+ "description": "Other Merchant Details Values."
+ }
+ },
+ "settlementStatuses": {
+ "type": "array",
+ "description": "List of Settlement Status Info values",
+ "items": {
+ "type": "object",
+ "properties": {
+ "requestId": {
+ "type": "string",
+ "maxLength": 26,
+ "example": "12345678901234567890123456",
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request."
+ },
+ "status": {
+ "type": "string",
+ "example": "Settlement Status",
+ "description": "Settlement Status"
+ },
+ "settlementTime": {
+ "type": "string",
+ "example": "2017-10-01T10:10:10+05:00",
+ "format": "date-time",
+ "description": "Settlement Date"
+ },
+ "reasonCode": {
+ "example": "reasonCode",
+ "type": "string",
+ "description": "ReasonCode"
+ },
+ "errorText": {
+ "example": "errorText",
+ "type": "string",
+ "description": "errorText"
+ }
+ },
+ "description": "Settlement Status Section Values."
+ }
+ }
+ },
+ "type": "object"
+ }
+ },
+ "400": {
+ "description": "Invalid request",
+ "schema": {
+ "title": "reportingV3PurchaseRefundDetailsGet400Response",
+ "type": "object",
+ "required": [
+ "submitTimeUtc",
+ "reason",
+ "message",
+ "details"
+ ],
+ "properties": {
+ "submitTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time of request in UTC. \n",
+ "example": "2016-08-11T22:47:57Z"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Documented reason code\n",
+ "example": "INVALID_DATA"
+ },
+ "message": {
+ "type": "string",
+ "description": "Short descriptive message to the user.\n",
+ "example": "One or more fields contains invalid data"
+ },
+ "details": {
+ "type": "array",
+ "description": "Error field list\n",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "Field in request that caused an error\n"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Documented reason code\n"
+ }
+ },
+ "description": "Provides failed validation input field detail\n"
+ }
+ }
+ },
+ "description": "HTTP status code for client application"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "title": "reportingV3PurchaseRefundDetailsGet401Response",
+ "type": "object",
+ "required": [
+ "submitTimeUtc",
+ "reason",
+ "message",
+ "details"
+ ],
+ "properties": {
+ "submitTimeUtc": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time of request in UTC. \n",
+ "example": "2016-08-11T22:47:57Z"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Documented reason code\n",
+ "example": "INVALID_DATA"
+ },
+ "message": {
+ "type": "string",
+ "description": "Short descriptive message to the user.\n",
+ "example": "One or more fields contains invalid data"
+ },
+ "details": {
+ "type": "array",
+ "description": "Error field list\n",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "Field in request that caused an error\n"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Documented reason code\n"
+ }
+ },
+ "description": "Provides failed validation input field detail\n"
+ }
+ }
+ },
+ "description": "HTTP status code for client application"
}
},
"404": {
@@ -16999,22 +16206,21 @@
}
}
},
- "/reporting/v3/payment-batch-summaries": {
+ "/reporting/v3/conversion-details": {
"get": {
"tags": [
- "PaymentBatchSummaries"
+ "ConversionDetails"
],
- "summary": "Get payment batch summary data",
- "description": "Scope can be either account/merchant or reseller.",
- "operationId": "getPaymentBatchSummary",
+ "summary": "Get conversion detail transactions",
+ "description": "Get conversion detail of transactions for a merchant.",
+ "operationId": "getConversionDetail",
"x-devcenter-metaData": {
- "categoryTag": "Reporting",
- "isClientSideApi": true
+ "categoryTag": "Reporting"
},
"x-queryParameterDefaults": {
- "organizationId": "testrest",
- "startTime": "2018-05-01T12:00:00-05:00",
- "endTime": "2018-05-30T12:00:00-05:00"
+ "startTime": "2019-03-21T00:00:00.0Z",
+ "endTime": "2019-03-21T23:00:00.0Z",
+ "organizationId": "testrest"
},
"produces": [
"application/hal+json"
@@ -17045,256 +16251,45 @@
"type": "string",
"minLength": 1,
"maxLength": 32
- },
- {
- "name": "rollUp",
- "in": "query",
- "description": "Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant",
- "required": false,
- "type": "string",
- "enum": [
- "day",
- "week",
- "month"
- ]
- },
- {
- "name": "breakdown",
- "in": "query",
- "description": "Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant.",
- "required": false,
- "type": "string",
- "enum": [
- "account_rollup",
- "all_merchant",
- "selected_merchant"
- ]
- },
- {
- "name": "startDayOfWeek",
- "in": "query",
- "description": "Optional - Start day of week to breakdown data for weeks in a month",
- "required": false,
- "type": "integer",
- "format": "int32",
- "minimum": 1,
- "maximum": 7
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
+ "title": "reportingV3ConversionDetailsGet200Response",
"type": "object",
"properties": {
+ "organizationId": {
+ "type": "string",
+ "description": "Merchant Id",
+ "example": "testMerchantId"
+ },
"startTime": {
"type": "string",
- "format": "date-time"
+ "format": "date-time",
+ "example": "2017-10-01T10:10:10+05:00"
},
"endTime": {
"type": "string",
- "format": "date-time"
+ "format": "date-time",
+ "example": "2017-10-01T10:10:10+05:00"
},
- "paymentBatchSummaries": {
+ "conversionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
- "currencyCode": {
+ "merchantReferenceNumber": {
"type": "string",
- "example": "USD"
+ "description": "Merchant reference number of a merchant",
+ "example": "1234567890"
},
- "paymentSubTypeDescription": {
+ "conversionTime": {
"type": "string",
- "example": "Diners Club"
- },
- "startTime": {
- "type": "string",
- "format": "date-time"
- },
- "endTime": {
- "type": "string",
- "format": "date-time"
- },
- "salesCount": {
- "type": "integer",
- "example": 10,
- "format": "int32"
- },
- "salesAmount": {
- "type": "string",
- "example": "5000.01"
- },
- "creditCount": {
- "type": "integer",
- "example": 10,
- "format": "int32"
- },
- "creditAmount": {
- "type": "string",
- "example": "5000.01"
- },
- "accountName": {
- "type": "string",
- "example": "ubmerchant296"
- },
- "accountId": {
- "type": "string",
- "example": "ubmerchant296_acct"
- },
- "merchantId": {
- "type": "string",
- "example": "ubmerchant296_3"
- },
- "merchantName": {
- "type": "string",
- "example": "ubmerchant296_3"
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid request",
- "schema": {
- "type": "object",
- "required": [
- "submitTimeUtc",
- "reason",
- "message",
- "details"
- ],
- "properties": {
- "submitTimeUtc": {
- "type": "string",
- "format": "date-time",
- "description": "Time of request in UTC. \n",
- "example": "2016-08-11T22:47:57Z"
- },
- "reason": {
- "type": "string",
- "description": "Documented reason code\n",
- "example": "INVALID_DATA"
- },
- "message": {
- "type": "string",
- "description": "Short descriptive message to the user.\n",
- "example": "One or more fields contains invalid data"
- },
- "details": {
- "type": "array",
- "description": "Error field list\n",
- "items": {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "description": "Field in request that caused an error\n"
- },
- "reason": {
- "type": "string",
- "description": "Documented reason code\n"
- }
- },
- "description": "Provides failed validation input field detail\n"
- }
- }
- },
- "description": "HTTP status code for client application"
- }
- },
- "404": {
- "description": "Payment Batch Summary not found"
- }
- }
- }
- },
- "/reporting/v3/conversion-details": {
- "get": {
- "tags": [
- "ConversionDetails"
- ],
- "summary": "Get conversion detail transactions",
- "description": "Get conversion detail of transactions for a merchant.",
- "operationId": "getConversionDetail",
- "x-devcenter-metaData": {
- "categoryTag": "Reporting"
- },
- "x-queryParameterDefaults": {
- "startTime": "2019-03-21T00:00:00.0Z",
- "endTime": "2019-03-21T23:00:00.0Z",
- "organizationId": "testrest"
- },
- "produces": [
- "application/hal+json"
- ],
- "parameters": [
- {
- "name": "startTime",
- "in": "query",
- "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n",
- "required": true,
- "type": "string",
- "format": "date-time"
- },
- {
- "name": "endTime",
- "in": "query",
- "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n",
- "required": true,
- "type": "string",
- "format": "date-time"
- },
- {
- "name": "organizationId",
- "in": "query",
- "description": "Valid Cybersource Organization Id",
- "pattern": "[a-zA-Z0-9-_]+",
- "required": false,
- "type": "string",
- "minLength": 1,
- "maxLength": 32
- }
- ],
- "responses": {
- "200": {
- "description": "Ok",
- "schema": {
- "title": "reportingV3ConversionDetailsGet200Response",
- "type": "object",
- "properties": {
- "organizationId": {
- "type": "string",
- "description": "Merchant Id",
- "example": "testMerchantId"
- },
- "startTime": {
- "type": "string",
- "format": "date-time",
- "example": "2017-10-01T10:10:10+05:00"
- },
- "endTime": {
- "type": "string",
- "format": "date-time",
- "example": "2017-10-01T10:10:10+05:00"
- },
- "conversionDetails": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "merchantReferenceNumber": {
- "type": "string",
- "description": "Merchant reference number of a merchant",
- "example": "1234567890"
- },
- "conversionTime": {
- "type": "string",
- "format": "date-time",
- "description": "Date of conversion",
- "example": "2017-10-01T10:10:10+05:00"
+ "format": "date-time",
+ "description": "Date of conversion",
+ "example": "2017-10-01T10:10:10+05:00"
},
"requestId": {
"type": "string",
@@ -17837,86 +16832,6 @@
}
}
},
- "/reporting/v3/dtds/{reportDefinitionNameVersion}": {
- "get": {
- "tags": [
- "DownloadDTD"
- ],
- "summary": "Used to download DTDs for reports.",
- "description": "Downloads DTDs for reports on no-auth.",
- "operationId": "getDTDV2",
- "x-devcenter-metaData": {
- "categoryTag": "Reporting",
- "isClientSideApi": true
- },
- "produces": [
- "application/xml-dtd"
- ],
- "parameters": [
- {
- "name": "reportDefinitionNameVersion",
- "in": "path",
- "description": "Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Ok"
- },
- "400": {
- "description": "Bad request. DTD file name may be invalid"
- },
- "404": {
- "description": "DTD file not found"
- },
- "500": {
- "description": "Internal Server Error"
- }
- }
- }
- },
- "/reporting/v3/xsds/{reportDefinitionNameVersion}": {
- "get": {
- "tags": [
- "DownloadXSD"
- ],
- "summary": "Used to download XSDs for reports.",
- "description": "Downloads XSDs for reports on no-auth.",
- "operationId": "getXSDV2",
- "x-devcenter-metaData": {
- "categoryTag": "Reporting",
- "isClientSideApi": true
- },
- "produces": [
- "text/xml"
- ],
- "parameters": [
- {
- "name": "reportDefinitionNameVersion",
- "in": "path",
- "description": "Name and version of XSD file to download. Some XSDs only have one version. In that case version name is not needed. Some example values are DecisionManagerDetailReport, DecisionManagerTypes",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "Ok"
- },
- "400": {
- "description": "Bad request. XSD file name may be invalid"
- },
- "404": {
- "description": "XSD file not found"
- },
- "500": {
- "description": "Internal Server Error"
- }
- }
- }
- },
"/risk/v1/decisions": {
"post": {
"summary": "Create Decision Manager case",
@@ -17952,7 +16867,7 @@
"code": {
"type": "string",
"maxLength": 50,
- "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
},
"comments": {
"type": "string",
@@ -17989,11 +16904,11 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"bin": {
"type": "string",
@@ -18003,12 +16918,12 @@
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
},
@@ -18018,7 +16933,7 @@
"properties": {
"type": {
"type": "string",
- "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n"
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"number": {
"type": "string",
@@ -18028,12 +16943,12 @@
"expirationMonth": {
"type": "string",
"maxLength": 2,
- "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"expirationYear": {
"type": "string",
"maxLength": 4,
- "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
}
@@ -18053,12 +16968,12 @@
"currency": {
"type": "string",
"maxLength": 3,
- "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n"
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
"totalAmount": {
"type": "string",
"maxLength": 19,
- "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf 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. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n"
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
}
}
},
@@ -18067,9 +16982,8 @@
"description": "Contains shipping information not related to address.",
"properties": {
"giftWrap": {
- "type": "string",
- "maxLength": 3,
- "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n\n- `yes`: The customer requested gift wrapping.\n- `no`: The customer did not request gift wrapping.\n"
+ "type": "boolean",
+ "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n- true: The customer requested gift wrapping.\n- false: The customer did not request gift wrapping.\n"
},
"shippingMethod": {
"type": "string",
@@ -18130,9 +17044,8 @@
}
},
"returnsAccepted": {
- "type": "string",
- "maxLength": 3,
- "description": "Boolean that indicates whether returns are accepted for this order.\nThis field can contain one of the following values:\n- `yes`: Returns are accepted for this order.\n- `no`: Returns are not accepted for this order.\n"
+ "type": "boolean",
+ "description": "Boolean that indicates whether returns are accepted for this order.\nThis field can contain one of the following values:\n- true: Returns are accepted for this order.\n- false: Returns are not accepted for this order.\n"
},
"lineItems": {
"type": "array",
@@ -18143,13 +17056,13 @@
"unitPrice": {
"type": "string",
"maxLength": 15,
- "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf 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. See \"Zero Amount Authorizations,\" page 220.\n"
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"quantity": {
"type": "number",
"minimum": 1,
"maximum": 9999999999,
- "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n",
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
"default": 1
},
"productSKU": {
@@ -18170,13 +17083,11 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"
+ "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"gift": {
- "type": "string",
- "maxLength": 3,
- "description": "Determines whether to assign risk to the order if the billing and shipping addresses specify different cities,\nstates, or countries. This field can contain one of the following values:\n- `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different.\n- `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different.\n- `off`: Differences between billing and shipping addresses do not affect the score.\n",
- "default": "no"
+ "type": "boolean",
+ "description": "Determines whether to assign risk to the order if the billing and shipping addresses specify different cities,\nstates, or countries. This field can contain one of the following values:\n- true: Orders are assigned only slight additional risk if billing and shipping addresses are different.\n- false: Orders are assigned higher additional risk if billing and shipping addresses are different.\n"
},
"distributorProductSku": {
"type": "string",
@@ -18200,7 +17111,7 @@
"phone": {
"type": "string",
"maxLength": 15,
- "description": "Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include\nthe country code.\n"
+ "description": "Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include\nthe [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
},
"firstName": {
"type": "string",
@@ -18221,6 +17132,11 @@
"type": "string",
"maxLength": 255,
"description": "Passenger's email address, including the full domain name, such as jdoe@example.com."
+ },
+ "nationality": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Passenger's nationality country. Use the two character ISO Standard Country Codes."
}
}
}
@@ -18233,52 +17149,52 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
},
"email": {
"type": "string",
"maxLength": 255,
- "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
}
}
}
@@ -18288,15 +17204,20 @@
"type": "object",
"description": "Contains information about the buyer.",
"properties": {
+ "username": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Specifies the customer account user name."
+ },
"hashedPassword": {
"type": "string",
"maxLength": 100,
- "description": "The description for this field is not available.\n"
+ "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
},
"dateOfBirth": {
"type": "string",
"maxLength": 8,
- "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n"
+ "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
},
"personalIdentification": {
"type": "array",
@@ -18305,7 +17226,7 @@
"properties": {
"type": {
"type": "string",
- "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n**ComercioLatino**\\\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\\\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n",
+ "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n",
"enum": [
"NATIONAL",
"CPF",
@@ -18318,11 +17239,11 @@
"id": {
"type": "string",
"maxLength": 26,
- "description": "The value of the identification type. This field is supported only on the following processors.\n\n**ComercioLatino**\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf type = PASSPORT, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n"
+ "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n"
},
"issuedBy": {
"type": "string",
- "description": "If type = DRIVER_LICENSE, this is the State or province where the customer\u2019s driver\u2019s license was issued.\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n\nIf type = PASSPORT, this is the Issuing country for the cardholder\u2019s passport.\nRecommended for Discover ProtectBuy.\n"
+ "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer\u2019s driver\u2019s license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder\u2019s passport. Recommended for Discover ProtectBuy.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
}
@@ -18334,21 +17255,21 @@
"properties": {
"cookiesAccepted": {
"type": "string",
- "description": "Boolean that indicates whether the customer\u2019s browser accepts cookies. This field can contain one of the following values:\n - `yes`: The customer\u2019s browser accepts cookies.\n - `no`: The customer\u2019s browser does not accept cookies.\n"
+ "description": "Whether the customer\u2019s browser accepts cookies. This field can contain one of the following values:\n- `yes`: The customer\u2019s browser accepts cookies.\n- `no`: The customer\u2019s browser does not accept cookies.\n"
},
"ipAddress": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n"
+ "description": "IP address of the customer.\n"
},
"hostName": {
"type": "string",
"maxLength": 60,
- "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header."
+ "description": "DNS resolved hostname from `ipAddress`."
},
"fingerprintSessionId": {
"type": "string",
- "description": "Contains the session ID that you send to Decision Manager to obtain the device fingerprint\ninformation. The string can contain uppercase and lowercase letters, digits, hyphen (-), and\nunderscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs.\nThe session ID must be unique for each merchant ID. You can use any string that you are already generating,\nsuch as an order number or web session ID.The session ID must be unique for each page load, regardless of an\nindividual\u2019s web session ID.\nIf the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled\npage, then navigates back to the profiled page, the generated session ID should be different and unique.\nAn example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a\nunique ID is generated every time the page is loaded, even if it is the same user reloading the page.\n"
+ "description": "Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint\ninformation. The string can contain uppercase and lowercase letters, digits, hyphen (-), and\nunderscore (_). However, do not use the same uppercase and lowercase letters to indicate\ndifferent session IDs.\n\nThe session ID must be unique for each merchant ID. You can use any string that you are already\ngenerating, such as an order number or web session ID.\n\nThe session ID must be unique for each page load, regardless of an individual\u2019s web session ID.\nIf a user navigates to a profiled page and is assigned a web session, navigates away from the\nprofiled page, then navigates back to the profiled page, the generated session ID should be different\nand unique. You may use a web session ID, but it is preferable to use an application GUID (Globally\nUnique Identifier). This measure ensures that a unique ID is generated every time the page is\nloaded, even if it is the same user reloading the page.\n"
},
"httpBrowserEmail": {
"type": "string",
@@ -18357,7 +17278,7 @@
"userAgent": {
"type": "string",
"maxLength": 40,
- "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"
+ "description": "Customer\u2019s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -18367,7 +17288,7 @@
"resultCode": {
"type": "string",
"maxLength": 1,
- "description": "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode`\nreply field. If ics_auth and ics_score are requested at the same time, the value is automatically\npassed from ics_auth to ics_score. For more information on using this field, see\n\"\"Sending the Results of Address and Card Verification Tests,\"\" page 16.\nThe field contains one of the following values:\n - `I`: Card verification number failed processor's data\n validation check.\n - `M`: Card verification number matched.\n - `N`: Card verification number not matched.\n - `P`: Card verification number not processed.\n - `S`: Card verification number is on the card but was not included in the request.\n - `U`: Card verification is not supported by the issuing bank.\n - `X`: Card verification is not supported by the payment card company.\n - Space Character: Deprecated. Ignore this value.\n - `1`: CyberSource does not support card verification for this processor or card type.\n - `2`: Processor returned value unrecognized for card verification response.\n - `3`: Processor did not return card verification result code.\n"
+ "description": "CVN result code.\n\nFor details, see the `auth_cv_result` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\nFor a description of the card verification check, see \"Card Verification Numbers (CVNs)\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\nFor a list of possible values, see \"CVN Codes\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
}
}
},
@@ -18381,15 +17302,25 @@
"name": {
"type": "string",
"maxLength": 30,
- "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n"
+ "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\n"
}
}
+ },
+ "eventType": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Specifies one of the following types of events:\n- login\n- account_creation\n- account_update\nFor regular payment transactions, do not send this field.\n"
}
}
},
"travelInformation": {
"type": "object",
"properties": {
+ "actualFinalDestination": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "IATA Code for the actual final destination that the customer intends to travel to.\nIt should be a destination on the completeRoute.\n"
+ },
"completeRoute": {
"type": "string",
"maxLength": 255,
@@ -18413,12 +17344,17 @@
"origination": {
"type": "string",
"maxLength": 3,
- "description": "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco.\nDo not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.\nThe leg number can be a positive integer from 0 to N.\nFor example:\ndecision_manager_travel_leg0_orig=SFO\ndecision_manager_travel_leg1_orig=SFO\nNote In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n"
+ "description": "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco.\nDo not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.\nThe leg number can be a positive integer from 0 to N.\nFor example:\n`travelInformation.legs.0.origination=SFO`\n`travelInformation.legs.1.origination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
},
"destination": {
"type": "string",
"maxLength": 3,
- "description": "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the\ncolon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a\npositive integer from 0 to N.\nFor example:\ndecision_manager_travel_leg0_dest=SFO\ndecision_manager_travel_leg1_dest=SFO\nNote In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n"
+ "description": "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the\ncolon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a\npositive integer from 0 to N.\nFor example:\n\n`travelInformation.legs.0.destination=SFO`\n`travelInformation.legs.1.destination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
+ },
+ "departureDateTime": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "Departure date and time for the nth leg of the trip. Use one of the following formats:\n - yyyy-MM-dd HH:mm z\n - yyyy-MM-dd hh:mm a z\n - yyyy-MM-dd hh:mma z\n `HH` = hour in 24-hour format\n `hh` = hour in 12-hour format\n `a` = am or pm (case insensitive)\n `z` = time zone of the departing flight, for example: If the\n airline is based in city A, but the flight departs from city\n B, z is the time zone of city B at the time of departure.\n**Important** For travel information, use GMT instead of UTC, or use the local time zone.\n#### Examples\n2011-03-20 11:30 PM PDT\n2011-03-20 11:30pm GMT\n2011-03-20 11:30pm GMT-05:00\nEastern Standard Time: GMT-05:00 or EST\n**Note** When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no\nspaces between the time zone and the offset.\n"
}
}
}
@@ -18434,7 +17370,7 @@
"key": {
"type": "string",
"maxLength": 255,
- "description": "Fields that you can use to store information. The value\nappears in the Case Management Details window in the\nBusiness Center. The first four fields are the same fields\nthat are used by the Secure Data services. See request\ncode examples.\nWarning Merchant-defined data fields are not intended\nto and must not be used to capture personally identifying\ninformation. Accordingly, merchants are prohibited from\ncapturing, obtaining, and/or transmitting any personally\nidentifying information in or via the merchant-defined data\nfields. Personally identifying information includes, but is\nnot limited to, address, credit card number, social security\nnumber, driver's license number, state-issued\nidentification number, passport number, and card\nverification numbers (CVV, CVC2, CVV2, CID, CVN). In\nthe event CyberSource discovers that a merchant is\ncapturing and/or transmitting personally identifying\ninformation via the merchant-defined data fields, whether\nor not intentionally, CyberSource will immediately\nsuspend the merchant's account, which will result in a\nrejection of any and all transaction requests submitted by\nthe merchant after the point of suspension.\n"
+ "description": "Fields that you can use to store information. The value\nappears in the Case Management Details window in the\nBusiness Center. The first four fields are the same fields\nthat are used by the Secure Data services. See request\ncode examples.\n**Warning** Merchant-defined data fields are not intended\nto and must not be used to capture personally identifying\ninformation. Accordingly, merchants are prohibited from\ncapturing, obtaining, and/or transmitting any personally\nidentifying information in or via the merchant-defined data\nfields. Personally identifying information includes, but is\nnot limited to, address, credit card number, social security\nnumber, driver's license number, state-issued\nidentification number, passport number, and card\nverification numbers (CVV, CVC2, CVV2, CID, CVN). In\nthe event CyberSource discovers that a merchant is\ncapturing and/or transmitting personally identifying\ninformation via the merchant-defined data fields, whether\nor not intentionally, CyberSource will immediately\nsuspend the merchant's account, which will result in a\nrejection of any and all transaction requests submitted by\nthe merchant after the point of suspension.\n"
},
"value": {
"type": "string",
@@ -18526,7 +17462,7 @@
"name": {
"type": "string",
"maxLength": 30,
- "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n"
+ "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\n"
},
"desinationQueue": {
"type": "string",
@@ -18563,7 +17499,7 @@
"properties": {
"velocity": {
"type": "array",
- "description": "List of information codes triggered by the order. These information codes were generated when you created\nthe order and product velocity rules and are returned so that you can associate them with the rules.\n",
+ "description": "List of information codes triggered by the order. These information codes were generated when you created\nthe order and product velocity rules and are returned so that you can associate them with the rules.\n\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string",
"description": "Indicates excessive volume of transactions."
@@ -18571,49 +17507,49 @@
},
"address": {
"type": "array",
- "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.",
+ "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"customerList": {
"type": "array",
- "description": "Indicates that customer information is associated with transactions that are either on the negative or\nthe positive list.\n",
+ "description": "Indicates that customer information is associated with transactions that are either on the negative or\nthe positive list.\n\nFor all possible values, see the `score_hotlist_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"identityChange": {
"type": "array",
- "description": "Indicates excessive identity changes. The threshold is variable depending on the identity elements being\ncompared. This field can contain one or more information codes, separated by carets (^).\n",
+ "description": "Indicates excessive identity changes. The threshold is variable depending on the identity elements being\ncompared. This field can contain one or more information codes, separated by carets (^).\n\nFor all possible values, see the `score_identity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"internet": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.",
+ "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.\n\nFor all possible values, see the `score_internet_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"phone": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s phone number.",
+ "description": "Indicates a problem with the customer\u2019s phone number.\n\nFor all possible values, see the `score_phone_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"suspicious": {
"type": "array",
- "description": "Indicates that the customer provided potentially suspicious information.",
+ "description": "Indicates that the customer provided potentially suspicious information.\n\nFor all possible values, see the `score_suspicious_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
},
"globalVelocity": {
"type": "array",
- "description": "Indicates that the customer has a high purchase frequency.",
+ "description": "Indicates that the customer has a high purchase frequency.\n\nFor all possible values, see the `score_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "string"
}
@@ -18625,23 +17561,24 @@
"properties": {
"morphing": {
"type": "array",
+ "description": "List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules.\n\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"items": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"maxLength": 5,
- "description": "Morphing count. Note The count is not returned for the initial transaction."
+ "description": "Morphing count specified by the number #.\n\n**Note** The count is not returned for the initial transaction.\n\nFor all possible values, see the `decision_velocity_morphing_#_count` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
"fieldName": {
"type": "string",
"maxLength": 255,
- "description": "Field name of the morphing element. specified by the setting that you chose in the\nVelocity Editor. For all possible values, Please refer to Simple Order API Developer Guide\n on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_morphingElement_#_fieldName\".\n"
+ "description": "Field name of the morphing element. specified by the setting that you chose in the\nVelocity Editor.\n\nFor all possible values, see the `decisionReply_morphingElement_#_fieldName` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
"informationCode": {
"type": "string",
"maxLength": 255,
- "description": "Identifier that CYBS assigned to the velocity rule specified by the number."
+ "description": "Identifier that CyberSource assigned to the velocity rule specified by the number #.\n\nFor all possible values, see the `decision_velocity_morphing_#_info_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
}
}
@@ -18651,7 +17588,7 @@
"items": {
"type": "string",
"maxLength": 255,
- "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses."
+ "description": "Indicates a mismatch between the customer's billing and shipping addresses.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
}
}
@@ -18659,63 +17596,32 @@
"casePriority": {
"type": "integer",
"maxLength": 1,
- "description": "You receive this field only if you subscribe to the Enhanced Case Management service.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\".\n"
+ "description": "You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order.\n\nFor all possible values, see the `decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
"localTime": {
"type": "string",
"maxLength": 255,
- "description": "The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the\ncustomer's billing address.\n"
+ "description": "The customer's local time (`hh:mm:ss`), which is calculated from the transaction request time and the\ncustomer's billing address.\n\nFor details, see the `score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/)\n"
},
- "paymentInformation": {
+ "score": {
"type": "object",
- "description": "Contains response information about the payment.",
"properties": {
- "binCountry": {
- "type": "string",
- "maxLength": 255,
- "description": "Country (two-digit country code) associated with the BIN of the customer\u2019s card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the Business Center.\n"
+ "factorCodes": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "This field contains information that affected the score of the order.\nThis field will contain one or more codes, separated by carets (^).\n\nFor all possible values, see the `score_factors` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
+ }
},
- "accountType": {
+ "modelUsed": {
"type": "string",
"maxLength": 255,
- "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n"
+ "description": "Name of the score model used for the transaction. If you did not include a custom model in your request,\nthis field contains the name of CyberSource\u2019s default model.\n\nFor all possible values, see the `score_model_used` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
- "issuer": {
+ "result": {
"type": "string",
"maxLength": 255,
- "description": "Name of the bank or entity that issued the card account."
- },
- "scheme": {
- "type": "string",
- "maxLength": 255,
- "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n*Note:* Additional values may be present.\n"
- },
- "bin": {
- "type": "string",
- "maxLength": 255,
- "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field\nor from the first six characters of the `number` field.\n"
- }
- }
- },
- "score": {
- "type": "object",
- "properties": {
- "factorCodes": {
- "type": "array",
- "items": {
- "type": "string",
- "description": "This field contains information that affected the score of the order.\nThis field will contain one or more codes, separated by carets (^).\n"
- }
- },
- "modelUsed": {
- "type": "string",
- "maxLength": 255,
- "description": "Name of the score model used for the transaction. If you did not include a custom model in your request,\nthis field contains the name of CyberSource\u2019s default model.\n"
- },
- "result": {
- "type": "string",
- "maxLength": 255,
- "description": "Total score calculated for this order. The value cannot be negative.\n"
+ "description": "Total score calculated for this order. The value cannot be negative.\n\nFor all possible values, see the `score_score_result` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
}
},
@@ -18726,27 +17632,27 @@
"anonymizerStatus": {
"type": "string",
"maxLength": 255,
- "description": "Indicates whether the transaction IP address is associated with a known anonymous proxy.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsReply_ipAnonymizerStatus\".\n"
+ "description": "Indicates whether the transaction IP address is associated with a known anonymous proxy.\n\nFor all possible values, see the `score_ip_anonymizer_status` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
- "city": {
+ "locality": {
"type": "string",
"maxLength": 255,
- "description": "Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.\n"
+ "description": "Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.\n\nFor all possible values, see the `score_ip_city` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
"country": {
"type": "string",
"maxLength": 255,
- "description": "Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.\n"
+ "description": "Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.\n\nFor all possible values, see the `score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
- "state": {
+ "administrativeArea": {
"type": "string",
"maxLength": 255,
- "description": "Name of the state decoded from the IP address used directly or indirectly by the customer to send the order.\n"
+ "description": "Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.\n\nFor all possible values, see the `score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
},
"routingMethod": {
"type": "string",
"maxLength": 255,
- "description": "Routing method decoded from the IP address used directly or indirectly by the customer to send the order.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsService_ipRoutingMethod \".\n"
+ "description": "Routing method decoded from the IP address used directly or indirectly by the customer to send the order.\n\nFor all possible values, see the `score_ip_routing_method` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
}
},
@@ -18757,13 +17663,13 @@
"type": "array",
"items": {
"type": "object",
- "description": "Name of the 3rd party provider, for example, Emailage.",
+ "description": "Name of the 3rd party provider, for example, Emailage.\n\nFor all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n",
"properties": {
"fieldName": {
"type": "array",
"items": {
"type": "string",
- "description": "Field name, for example, email address domain name (domain_name)."
+ "description": "Field name, for example, email address domain name (domain_name).\n\nFor all possible values, see the `decision_provider_#_field_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
},
"fieldValue": {
@@ -18777,6 +17683,142 @@
}
}
}
+ },
+ "travel": {
+ "type": "object",
+ "properties": {
+ "actualFinalDestination": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "Country of actual final destination on the route."
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "City of actual final destination on the route."
+ },
+ "latitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Latitude of actual final destination on the route."
+ },
+ "longitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Longitude of actual final destination on the route."
+ }
+ }
+ },
+ "firstDeparture": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "Country of first departure on the route."
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "City of first departure on the route."
+ },
+ "latitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Latitude of first departure on the route."
+ },
+ "longitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Longitude of first departure on the route."
+ }
+ }
+ },
+ "firstDestination": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "Country of first destination on the route."
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "City of first destination on the route."
+ },
+ "latitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Latitude of first destination on the route."
+ },
+ "longitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Longitude of first destination on the route."
+ }
+ }
+ },
+ "lastDestination": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "Country of last destination on the route."
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 90,
+ "description": "City of last destination on the route."
+ },
+ "latitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Latitude of last destination on the route."
+ },
+ "longitude": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Longitude of last destination on the route."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "paymentInformation": {
+ "type": "object",
+ "description": "Contains response information about the payment.",
+ "properties": {
+ "binCountry": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Country (two-digit country code) associated with the BIN of the customer\u2019s card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
+ },
+ "accountType": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
+ },
+ "issuer": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
+ },
+ "scheme": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
+ },
+ "bin": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n"
}
}
},
@@ -18785,11 +17827,10 @@
"properties": {
"reason": {
"type": "string",
- "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n",
+ "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n",
"enum": [
"AVS_FAILED",
"CONTACT_PROCESSOR",
- "CV_FAILED",
"EXPIRED_CARD",
"PROCESSOR_DECLINED",
"INSUFFICIENT_FUND",
@@ -18799,11 +17840,17 @@
"CVN_NOT_MATCH",
"EXCEEDS_CREDIT_LIMIT",
"INVALID_CVN",
+ "DECLINED_CHECK",
+ "BLACKLISTED_CUSTOMER",
+ "SUSPENDED_ACCOUNT",
"PAYMENT_REFUSED",
+ "CV_FAILED",
"INVALID_ACCOUNT",
"GENERAL_DECLINE",
+ "INVALID_MERCHANT_CONFIGURATION",
"DECISION_PROFILE_REJECT",
- "SCORE_EXCEEDS_THRESHOLD"
+ "SCORE_EXCEEDS_THRESHOLD",
+ "PENDING_AUTHENTICATION"
]
},
"message": {
@@ -19549,627 +18596,735 @@
}
}
},
- "/sfs/v1/file-details": {
- "get": {
+ "/risk/v1/authentications": {
+ "post": {
+ "summary": "Check payer auth enrollment",
+ "description": "This call verifies that the card is enrolled in a card authentication program.",
+ "operationId": "checkPayerAuthEnrollment",
"tags": [
- "SecureFileShare"
+ "payer authentication"
],
- "summary": "Get list of files",
- "description": "Get list of files and it's information of them available inside the report directory",
- "operationId": "getFileDetail",
"x-devcenter-metaData": {
- "categoryTag": "Secure_File_Share"
+ "categoryTag": "Payer_Authentication"
},
- "x-queryParameterDefaults": {
- "organizationId": "testrest",
- "startDate": "2018-10-20T00:00:00.000Z",
- "endDate": "2018-10-30T00:00:00.000Z"
- },
- "produces": [
- "application/hal+json"
- ],
"parameters": [
{
- "name": "startDate",
- "in": "query",
- "description": "Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n",
- "required": true,
- "type": "string",
- "format": "date"
- },
- {
- "name": "endDate",
- "in": "query",
- "description": "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n",
+ "name": "checkPayerAuthEnrollmentRequest",
+ "in": "body",
"required": true,
- "type": "string",
- "format": "date"
- },
- {
- "name": "organizationId",
- "in": "query",
- "description": "Valid Cybersource Organization Id",
- "pattern": "[a-zA-Z0-9-_]+",
- "required": false,
- "type": "string",
- "minLength": 1,
- "maxLength": 32
- }
- ],
- "responses": {
- "200": {
- "description": "Ok",
"schema": {
- "title": "V1FileDetailsGet200Response",
"type": "object",
"properties": {
- "fileDetails": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "fileId": {
- "type": "string",
- "description": "Unique identifier of a file",
- "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"
- },
- "name": {
- "type": "string",
- "description": "Name of the file",
- "example": "MyTransactionDetailreport.xml"
- },
- "createdTime": {
- "type": "string",
- "format": "date-time",
- "description": "Date and time for the file in PST",
- "example": "2017-10-01T00:00:00+05:00"
- },
- "lastModifiedTime": {
- "type": "string",
- "format": "date-time",
- "description": "Date and time for the file in PST",
- "example": "2017-10-01T00:00:00+05:00"
- },
- "date": {
- "type": "string",
- "format": "date",
- "description": "Date and time for the file in PST",
- "example": "2017-10-05"
- },
- "mimeType": {
- "type": "string",
- "description": "File extension",
- "enum": [
- "application/xml",
- "text/csv",
- "application/pdf",
- "application/octet-stream"
- ],
- "example": "application/xml"
- },
- "size": {
- "type": "integer",
- "description": "Size of the file in bytes",
- "example": 2245397
- }
+ "clientReferenceInformation": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "code": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
}
}
},
- "_links": {
+ "orderInformation": {
"type": "object",
"properties": {
- "self": {
+ "amountDetails": {
"type": "object",
+ "description": "Contains `currency` and `totalAmount` for this order.",
+ "required": [
+ "currency"
+ ],
"properties": {
- "href": {
+ "currency": {
"type": "string",
- "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02"
+ "maxLength": 3,
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
},
- "method": {
+ "totalAmount": {
"type": "string",
- "example": "GET"
+ "maxLength": 19,
+ "description": "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.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"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/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet 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).\n\n#### FDMS South\nIf 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/wwhelp/wwhimpl/js/html/wwhelp.htm) \n\n#### DCC for First Data\nNot used.\n"
}
}
},
- "files": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "fileId": {
- "type": "string",
- "description": "Unique identifier for each file",
- "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"
- },
- "href": {
- "type": "string",
- "example": "/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"
- },
- "method": {
- "type": "string",
- "example": "GET"
+ "preOrder": {
+ "type": "string",
+ "description": "Indicates whether cardholder is placing an order with a future availability or release date.\nThis field can contain one of these values:\n- MERCHANDISE_AVAILABLE: Merchandise available\n- FUTURE_AVAILABILITY: Future availability\n"
+ },
+ "preOrderDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD\n"
+ },
+ "reordered": {
+ "type": "boolean",
+ "description": "Indicates whether the cardholder is reordering previously purchased merchandise.\nThis field can contain one of these values:\n- false: First time ordered\n- true: Reordered\n"
+ },
+ "shipTo": {
+ "type": "object",
+ "properties": {
+ "address1": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "First line of the shipping address."
+ },
+ "address2": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Second line of the shipping address."
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"
+ },
+ "country": {
+ "type": "string",
+ "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.",
+ "maxLength": 2
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "City of the shipping address."
+ },
+ "firstName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Phone number associated with the shipping address."
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n"
+ },
+ "destinationCode": {
+ "type": "integer",
+ "maxLength": 2,
+ "description": "Indicates destination chosen for the transaction. Possible values:\n- 01- Ship to cardholder billing address\n- 02- Ship to another verified address on file with merchant\n- 03- Ship to address that is different than billing address\n- 04- Ship to store (store address should be populated on request)\n- 05- Digital goods\n- 06- Travel and event tickets, not shipped\n- 07- Other\n"
+ },
+ "method": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Shipping method for the product. Possible values:\n- lowcost: Lowest-cost service\n- sameday: Courier or same-day service\n- oneday: Next-day or overnight service\n- twoday: Two-day service\n- threeday: Three-day service\n- pickup: Store pick-up\n- other: Other shipping method\n- none: No shipping method because product is a service or subscription\nRequired for American Express SafeKey (U.S.).\n"
+ }
+ }
+ },
+ "lineItems": {
+ "type": "array",
+ "description": "This array contains detailed information about individual products in the order.",
+ "items": {
+ "type": "object",
+ "required": [
+ "unitPrice"
+ ],
+ "properties": {
+ "totalAmount": {
+ "type": "string",
+ "maxLength": 13,
+ "description": "Total amount for the item. Normally calculated as the unit price times quantity.\n\nWhen `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units.\n\nExample: 123.45 USD = 123\n"
+ },
+ "unitPrice": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the `amount` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "quantity": {
+ "type": "number",
+ "minimum": 1,
+ "maximum": 9999999999,
+ "description": "Number of units for this order.\n\nThe default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis is the total count of individual prepaid gift cards purchased.\n",
+ "default": 1
+ },
+ "giftCardCurrency": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf)\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n"
+ },
+ "productSKU": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n"
+ },
+ "productDescription": {
+ "type": "string",
+ "description": "Brief description of item."
+ },
+ "productName": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n"
+ },
+ "passenger": {
+ "type": "object",
+ "description": "Contains travel-related passenger details.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 32,
+ "description": "Passenger classification associated with the price of the ticket. You can use one of the following values:\n- `ADT`: Adult\n- `CNN`: Child\n- `INF`: Infant\n- `YTH`: Youth\n- `STU`: Student\n- `SCR`: Senior Citizen\n- `MIL`: Military\n"
+ },
+ "status": {
+ "type": "string",
+ "maxLength": 32,
+ "description": "Your company's passenger classification, such as with a frequent flyer program. In this case, you might use\nvalues such as `standard`, `gold`, or `platinum`.\n"
+ },
+ "phone": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include\nthe [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n"
+ },
+ "firstName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Passenger's first name."
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Passenger's last name."
+ },
+ "id": {
+ "type": "string",
+ "maxLength": 40,
+ "description": "ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer\nnumber.\n"
+ },
+ "email": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Passenger's email address, including the full domain name, such as jdoe@example.com."
+ },
+ "nationality": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Passenger's nationality country. Use the two character ISO Standard Country Codes."
+ }
+ }
+ },
+ "taxAmount": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n"
}
}
}
+ },
+ "billTo": {
+ "type": "object",
+ "required": [
+ "address1",
+ "locality",
+ "country",
+ "administrativeArea",
+ "postalCode",
+ "email",
+ "firstName",
+ "lastName"
+ ],
+ "properties": {
+ "address1": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts: This field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_address1` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "address2": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions\nThis value is used for AVS.\n\n#### CyberSource through VisaNet\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_address2` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n##### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_state` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `bill_country` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "firstName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_firstname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n#### CyberSource Latin American Processing\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n"
+ },
+ "email": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_email` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the `bill_zip` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ }
+ }
}
}
- }
- }
- }
- },
- "400": {
- "description": "Invalid request",
- "schema": {
- "title": "V1FilesGet400Response",
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "string",
- "description": "Error code"
- },
- "message": {
- "type": "string",
- "description": "Error message"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localization Key Name"
- },
- "correlationId": {
- "type": "string",
- "description": "Correlation Id"
- },
- "detail": {
- "type": "string",
- "description": "Error Detail"
},
- "fields": {
- "type": "array",
- "description": "Error fields List",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the failed property"
- },
- "message": {
- "type": "string",
- "description": "Error description about validation failed field"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localized Key Name"
- }
- },
- "description": "Provide validation failed input field details"
- }
- }
- },
- "description": "Error Bean"
- },
- "examples": {
- "application/json": {
- "code": "VALIDATION_ERROR",
- "correlationId": null,
- "detail": null,
- "fields": [
- {
- "path": "startTime",
- "message": "Start date should not precede 18 months from current time in GMT",
- "localizationKey": null
+ "paymentInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "required": [
+ "type",
+ "expirationMonth",
+ "expirationYear",
+ "number"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationMonth": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationYear": {
+ "type": "string",
+ "maxLength": 4,
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "number": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ }
+ }
+ },
+ "tokenizedCard": {
+ "type": "object",
+ "required": [
+ "type",
+ "expirationMonth",
+ "expirationYear",
+ "number"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Three-digit value that indicates the card type.\n\nType of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationMonth": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "expirationYear": {
+ "type": "string",
+ "maxLength": 4,
+ "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"
+ },
+ "number": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Customer\u2019s payment network token value.\n"
+ }
+ }
+ }
}
- ],
- "localizationKey": "cybsapi.validation.errors",
- "message": "Field validation errors"
- }
- }
- },
- "401": {
- "description": "Ok",
- "schema": {
- "title": "V1FileDetailsGet401Response",
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "string",
- "description": "Error code"
- },
- "message": {
- "type": "string",
- "description": "Error message"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localization Key Name"
},
- "correlationId": {
- "type": "string",
- "description": "Correlation Id"
- },
- "detail": {
- "type": "string",
- "description": "Error Detail"
- },
- "fields": {
- "type": "array",
- "description": "Error fields List",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the failed property"
- },
- "message": {
- "type": "string",
- "description": "Error description about validation failed field"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localized Key Name"
+ "buyerInformation": {
+ "type": "object",
+ "properties": {
+ "personalIdentification": {
+ "description": "This array contains detailed information about the buyer's form of persoanl identification.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n",
+ "enum": [
+ "NATIONAL",
+ "CPF",
+ "CPNJ",
+ "CURP",
+ "SSN",
+ "DRIVER_LICENSE"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "maxLength": 26,
+ "description": "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the `personal_id` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "issuedBy": {
+ "type": "string",
+ "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer\u2019s driver\u2019s license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder\u2019s passport. Recommended for Discover ProtectBuy.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n#### TeleCheck\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n#### All Other Processors\nNot used.\n\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ }
+ }
}
},
- "description": "Provide validation failed input field details"
- }
- }
- },
- "description": "Error Bean"
- },
- "examples": {
- "application/json": {
- "code": "VALIDATION_ERROR",
- "correlationId": null,
- "detail": null,
- "fields": [
- {
- "path": "organizationId",
- "message": "Organization doesn't has access to File details",
- "localizationKey": null
+ "mobilePhone": {
+ "type": "integer",
+ "maxLength": 25,
+ "description": "Cardholder\u2019s mobile phone number.\n**Important** Required for Visa Secure transactions in Brazil.\nDo not use this request field for any other types of transactions.\n"
+ }
}
- ],
- "localizationKey": "cybsapi.validation.errors",
- "message": "Field validation errors"
- }
- }
- },
- "404": {
- "description": "Files Info not found",
- "schema": {
- "title": "V1FileDetailsGet404Response",
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "string",
- "description": "Error code"
- },
- "message": {
- "type": "string",
- "description": "Error message"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localization Key Name"
- },
- "correlationId": {
- "type": "string",
- "description": "Correlation Id"
- },
- "detail": {
- "type": "string",
- "description": "Error Detail"
},
- "fields": {
- "type": "array",
- "description": "Error fields List",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the failed property"
- },
- "message": {
- "type": "string",
- "description": "Error description about validation failed field"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localized Key Name"
+ "deviceInformation": {
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "type": "string",
+ "maxLength": 15,
+ "description": "IP address of the customer.\n"
+ },
+ "rawData": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "string",
+ "description": "Field that contains the device fingerprint data from the specified provider. The value should be Base64 encoded.\n"
+ },
+ "provider": {
+ "type": "string",
+ "maxLength": 32,
+ "description": "Possible values:\n- cardinal\n- inauth\n- threatmetrix\n"
+ }
+ }
}
},
- "description": "Provide validation failed input field details"
+ "httpAcceptBrowserValue": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Value of the Accept header sent by the customer\u2019s web browser.\n**Note** If the customer\u2019s browser provides a value, you must include it in your request.\n"
+ },
+ "httpAcceptContent": {
+ "type": "string",
+ "maxLength": 256,
+ "description": "The exact content of the HTTP accept header.\n"
+ },
+ "userAgentBrowserValue": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Value of the User-Agent header sent by the customer\u2019s web browser.\nNote If the customer\u2019s browser provides a value, you must include it in your request.\n"
+ }
}
- }
- },
- "description": "Error Bean"
- },
- "examples": {
- "application/json": {
- "code": "RESOURCE_NOTFOUND",
- "correlationId": null,
- "detail": "The requested resource is not found. Please try again later.",
- "localizationKey": "cybsapi.resource.notfound",
- "message": "Files Info not found for requested input values"
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "title": "V1FileDetailsGet500Response",
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "string",
- "description": "Error code"
},
- "message": {
- "type": "string",
- "description": "Error message"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localization Key Name"
- },
- "correlationId": {
- "type": "string",
- "description": "Correlation Id"
- },
- "detail": {
- "type": "string",
- "description": "Error Detail"
- },
- "fields": {
- "type": "array",
- "description": "Error fields List",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the failed property"
- },
- "message": {
- "type": "string",
- "description": "Error description about validation failed field"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localized Key Name"
- }
- },
- "description": "Provide validation failed input field details"
+ "merchantInformation": {
+ "type": "object",
+ "properties": {
+ "merchantName": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "Your company\u2019s name as you want it to appear to the customer in the issuing bank\u2019s authentication form.\nThis value overrides the value specified by your merchant bank.\n"
+ }
}
- }
- },
- "description": "Error Bean"
- },
- "examples": {
- "application/json": {
- "code": "SERVER_ERROR",
- "correlationId": null,
- "detail": "Internal Server Error. Please contact the customer support.",
- "localizationKey": "cybsapi.server.error",
- "message": "Error encountered while processing request"
- }
- }
- }
- }
- }
- },
- "/sfs/v1/files/{fileId}": {
- "get": {
- "tags": [
- "SecureFileShare"
- ],
- "summary": "Download a file with file identifier",
- "description": "Download a file for the given file identifier",
- "operationId": "getFile",
- "x-devcenter-metaData": {
- "categoryTag": "Secure_File_Share"
- },
- "x-queryParameterDefaults": {
- "organizationId": "testrest"
- },
- "produces": [
- "application/xml",
- "text/csv",
- "application/pdf"
- ],
- "parameters": [
- {
- "name": "fileId",
- "in": "path",
- "description": "Unique identifier for each file",
- "required": true,
- "type": "string"
- },
- {
- "name": "organizationId",
- "in": "query",
- "description": "Valid Cybersource Organization Id",
- "pattern": "[a-zA-Z0-9-_]+",
- "required": false,
- "type": "string",
- "minLength": 1,
- "maxLength": 32
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "400": {
- "description": "Invalid Request",
- "schema": {
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "string",
- "description": "Error code"
- },
- "message": {
- "type": "string",
- "description": "Error message"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localization Key Name"
- },
- "correlationId": {
- "type": "string",
- "description": "Correlation Id"
- },
- "detail": {
- "type": "string",
- "description": "Error Detail"
},
- "fields": {
- "type": "array",
- "description": "Error fields List",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the failed property"
- },
- "message": {
- "type": "string",
- "description": "Error description about validation failed field"
- },
- "localizationKey": {
- "type": "string",
- "description": "Localized Key Name"
- }
+ "recurringPaymentInformation": {
+ "type": "object",
+ "description": "This object contains recurring payment information.",
+ "properties": {
+ "endDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "The date after which no further recurring authorizations should be performed. Format: `YYYYMMDD`\n**Note** This field is required for recurring transactions.\n"
},
- "description": "Provide validation failed input field details"
+ "frequency": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "Integer value indicating the minimum number of days between recurring authorizations. A frequency\nof monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months.\nExample: 6 months = 168\n**Note** This field is required for recurring transactions.\n"
+ },
+ "originalPurchaseDate": {
+ "type": "string",
+ "maxLength": 17,
+ "description": "Date of original purchase. Required for recurring transactions.\nFormat: `YYYYMMDD:HH:MM:SS`\n**Note**: If this field is empty, the current date is used.\n"
+ }
}
- }
- },
- "description": "Error Bean"
- }
- },
- "404": {
- "description": "No Reports Found"
- }
- }
- }
- },
- "/tms/v1/instrumentidentifiers": {
- "post": {
- "summary": "Create an Instrument Identifier",
- "parameters": [
- {
- "name": "profile-id",
- "in": "header",
- "description": "The id of a profile containing user specific TMS configuration.",
- "required": true,
- "type": "string",
- "minLength": 36,
- "maxLength": 36
- },
- {
- "name": "createInstrumentIdentifierRequest",
- "in": "body",
- "description": "Please specify either a Card, Bank Account or Enrollable Card",
- "required": true,
- "schema": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "example": "enrollable card",
- "description": "Type of Card"
},
- "card": {
+ "consumerAuthenticationInformation": {
"type": "object",
+ "required": [
+ "transactionMode",
+ "mcc",
+ "referenceId"
+ ],
"properties": {
- "number": {
+ "alternateAuthenticationData": {
"type": "string",
- "example": "4622943127013705",
- "minLength": 12,
- "maxLength": 19,
- "description": "Credit card number (PAN)."
+ "maxLength": 2048,
+ "description": "Data that documents and supports a specific authentication process.\n"
},
- "expirationMonth": {
+ "alternateAuthenticationDate": {
"type": "string",
- "format": "MM",
- "example": "12",
- "minLength": 2,
- "maxLength": 2,
- "description": "Card expiration month.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n"
+ "maxLength": 14,
+ "description": "Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM\n"
},
- "expirationYear": {
+ "alternateAuthenticationMethod": {
"type": "string",
- "format": "YYYY",
- "example": "2022",
- "minLength": 4,
- "maxLength": 4,
- "description": "Card expiration year.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n"
+ "description": "Mechanism used by the cardholder to authenticate to the 3D Secure requestor.\nPossible values:\n- `01`: No authentication occurred\n- `02`: Login using merchant system credentials\n- `03`: Login using Federated ID\n- `04`: Login using FIDO Authenticator\n"
},
- "securityCode": {
+ "authenticationTransactionId": {
"type": "string",
- "example": "838",
- "minLength": 3,
+ "maxLength": 20,
+ "description": "Payer authentication transaction identifier passed to link the check enrollment\nand validate authentication messages.\n**Note**: Required for Standard integration for enroll service.\nRequired for Hybrid integration for validate service.\n"
+ },
+ "challengeCode": {
+ "type": "string",
+ "description": "Possible values:\n- `01`: No preference\n- `02`: No challenge request\n- `03`: Challenge requested (3D Secure requestor preference)\n- `04`: Challenge requested (mandate)\n- `05-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo)\n- `80-99`: Reserved for DS use\n\nFor details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "customerCardAlias": {
+ "type": "string",
+ "maxLength": 128,
+ "description": "An alias that uniquely identifies the customer's account and credit card on file.\nNote This field is required if Tokenization is enabled in the merchant profile settings.\n"
+ },
+ "defaultCard": {
+ "type": "boolean",
+ "description": "Indicates that the card being used is the one designated as the primary payment card for purchase.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "installmentTotalCount": {
+ "type": "integer",
"maxLength": 4,
- "description": "Card security code."
- }
- }
- },
- "billTo": {
- "type": "object",
- "properties": {
- "address1": {
+ "description": "An integer value greater than 1 indicating the max number of permitted authorizations for installment payments.\n**Note** This is required if the merchant and cardholder have agreed to installment payments.\n"
+ },
+ "marketingOptIn": {
+ "type": "boolean",
+ "description": "Indicates whether the customer has opted in for marketing offers.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "marketingSource": {
"type": "string",
- "example": "8310 Capital of Texas Highway North",
- "description": "First address line registered with card."
+ "maxLength": 40,
+ "description": "Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.\n"
},
- "address2": {
+ "mcc": {
"type": "string",
- "example": "Bluffstone Drive",
- "description": "Second address line registered with card."
+ "maxLength": 4,
+ "description": "Merchant category code.\n**Important** Required only for Visa Secure transactions in Brazil.\nDo not use this request field for any other types of transactions.\n"
},
- "locality": {
+ "messageCategory": {
"type": "string",
- "example": "Austin",
- "description": "Locality registered with card."
+ "description": "Category of the message for a specific use case. Possible values:\n\n- `01`: PA- payment authentication\n- `02`: NPA- non-payment authentication\n- `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo)\n- `80-99`: Reserved for DS use\n"
},
- "administrativeArea": {
+ "npaCode": {
"type": "string",
- "example": "TX",
- "description": "Administrative area registered with card."
+ "maxLength": 2,
+ "description": "Non-Payer Authentication Indicator.\nPossible values:\n- `01`: Add card\n- `02`: Maintain card information\n- `03`: Cardholder verification for EMV token\n- `04-80` Reserved for EMVCo\n- `80-90` Reserved DS\n"
},
- "postalCode": {
+ "overridePaymentMethod": {
"type": "string",
- "example": "78731",
- "description": "Postal code registered with card."
+ "description": "Specifies the Brazilian payment account type used for the transaction.\nThis field overrides other payment types that might be specified in the request.\nUse one of the following values for this field:\n- `NA`: Not applicable. Do not override other payment types that are specified in the request.\n- `CR`: Credit card.\n- `DB`: Debit card.\n- `VSAVR`: Visa Vale Refeicao\n- `VSAVA`: Visa Vale Alimentacao\n**Important** Required only for Visa Secure transactions in Brazil.\nDo not use this request field for any other types of transactions.\n"
},
- "country": {
+ "productCode": {
"type": "string",
- "example": "US",
- "description": "Country registered with card."
+ "maxLength": 3,
+ "description": "Specifies the product code, which designates the type of transaction.\nSpecify one of the following values for this field:\n- AIR: Airline purchase\nImportant Required for American Express SafeKey (U.S.).\n- `ACC`: Accommodation Rental\n- `ACF`: Account funding\n- `CHA`: Check acceptance\n- `DIG`: Digital Goods\n- `DSP`: Cash Dispensing\n- `GAS`: Fuel\n- `GEN`: General Retail\n- `LUX`: Luxury Retail\n- `PAL`: Prepaid activation and load\n- `PHY`: Goods or services purchase\n- `QCT`: Quasi-cash transaction\n- `REN`: Car Rental\n- `RES`: Restaurant\n- `SVC`: Services\n- `TBD`: Other\n- `TRA`: Travel\n**Important** Required for Visa Secure transactions in Brazil.\nDo not use this request field for any other types of transactions.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "maxLength": 35,
+ "description": "Cardinal's directory server assigned 3DS Requestor ID value"
+ },
+ "requestorName": {
+ "type": "string",
+ "maxLength": 40,
+ "description": "Cardinal's directory server assigned 3DS Requestor Name value"
+ },
+ "referenceId": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Reference ID that corresponds to the device fingerprinting data that was collected previously.\nNote Required for Hybrid integration.\n"
+ },
+ "transactionMode": {
+ "type": "string",
+ "description": "Transaction mode identifier. Identifies the channel from which the transaction originates.\nPossible values:\n- `MOTO` - MOTO (Mail Order Telephone Order)\n- `RETAIL` - Retail\n- `ECOMMERCE` - eCommerce\n- `MOBILE` - Mobile Device\n- `TABLET` - Tablet\n"
+ }
+ }
+ },
+ "riskInformation": {
+ "type": "object",
+ "properties": {
+ "buyerHistory": {
+ "type": "object",
+ "properties": {
+ "customerAccount": {
+ "type": "object",
+ "properties": {
+ "lastChangeDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Date the cardholder\u2019s account was last changed.\nThis includes changes to the billing or shipping address, new payment accounts or new users added.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "creationHistory": {
+ "type": "string",
+ "description": "The values from the enum can be:\n- GUEST\n- NEW_ACCOUNT\n- EXISTING_ACCOUNT\n"
+ },
+ "modificationHistory": {
+ "type": "string",
+ "description": "This field is applicable only in case of EXISTING_ACCOUNT in creationHistory. Possible values:\n- ACCOUNT_UPDATED_NOW\n- ACCOUNT_UPDATED_PAST\n"
+ },
+ "passwordHistory": {
+ "type": "string",
+ "description": "This only applies for EXISTING_ACCOUNT in creationHistory.\nThe values from the enum can be:\n- PASSWORD_CHANGED_NOW\n- PASSWORD_CHANGED_PAST\n- PASSWORD_NEVER_CHANGED\n"
+ },
+ "createDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Date the cardholder opened the account.\nRecommended for Discover ProtectBuy.\nThis only applies for EXISTING_ACCOUNT in creationHistory.\n"
+ },
+ "passwordChangeDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Date the cardholder last changed or reset password on account.\nRecommended for Discover ProtectBuy.\nThis only applies for PASSWORD_CHANGED_PAST in passwordHistory.\n"
+ }
+ }
+ },
+ "accountHistory": {
+ "type": "object",
+ "properties": {
+ "firstUseOfShippingAddress": {
+ "type": "boolean",
+ "description": "Applicable when this is not a guest account.\n"
+ },
+ "shippingAddressUsageDate": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Date when the shipping address for this transaction was first used.\nRecommended for Discover ProtectBuy.\nIf `firstUseOfShippingAddress` is false and not a guest account, then this date is entered.\n"
+ }
+ }
+ },
+ "accountPurchases": {
+ "type": "integer",
+ "maxLength": 4,
+ "description": "Number of purchases with this cardholder account during the previous six months.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "addCardAttempts": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "Number of add card attempts in the last 24 hours.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "priorSuspiciousActivity": {
+ "type": "boolean",
+ "description": "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "paymentAccountHistory": {
+ "type": "string",
+ "description": "This only applies for NEW_ACCOUNT and EXISTING_ACCOUNT in creationHistory. Possible values are:\n- PAYMENT_ACCOUNT_EXISTS\n- PAYMENT_ACCOUNT_ADDED_NOW\n"
+ },
+ "paymentAccountDate": {
+ "type": "integer",
+ "maxLength": 8,
+ "description": "Date applicable only for PAYMENT_ACCOUNT_EXISTS in paymentAccountHistory\n"
+ },
+ "transactionCountDay": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "Number of transaction (successful or abandoned) for this cardholder account within the last 24 hours.\nRecommended for Discover ProtectBuy.\n"
+ },
+ "transactionCountYear": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "Number of transaction (successful or abandoned) for this cardholder account within the last year.\nRecommended for Discover ProtectBuy.\n"
+ }
+ }
+ }
+ }
+ },
+ "travelInformation": {
+ "type": "object",
+ "properties": {
+ "legs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "origination": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco.\nDo not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.\nThe leg number can be a positive integer from 0 to N.\nFor example:\n`travelInformation.legs.0.origination=SFO`\n`travelInformation.legs.1.origination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
+ },
+ "destination": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the\ncolon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a\npositive integer from 0 to N.\nFor example:\n\n`travelInformation.legs.0.destination=SFO`\n`travelInformation.legs.1.destination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n"
+ },
+ "carrierCode": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "International Air Transport Association (IATA) code for the carrier for this leg of the trip.\nRequired for each leg.\nRequired for American Express SafeKey (U.S.) for travel-related requests.\n\nFor details, see `airline_leg#_carrier_code` in [Airline Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Airline_SCMP_API/Airline_SCMP_API.pdf)\n"
+ },
+ "departureDate": {
+ "type": "string",
+ "description": "Departure date for the first leg of the trip. Format: YYYYMMDD.\nRequired for American Express SafeKey (U.S.) for travel-related requests.\n\nFor details, see `airline_leg#_leg_departure_date` in [Airline Processing Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Airline_SCMP_API/Airline_SCMP_API.pdf)\n"
+ }
+ }
+ }
+ },
+ "numberOfPassengers": {
+ "type": "integer",
+ "maxLength": 3,
+ "description": "Number of passengers for whom the ticket was issued.\nIf you do not include this field in your request, CyberSource uses a default value of 1.\nRequired for American Express SafeKey (U.S.) for travel-related requests.\n"
+ },
+ "passengers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "firstName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "First name of the passenger to whom the ticket was issued.\nIf there are multiple passengers, include all listed on the ticket.\nDo not include special characters such as commas, hyphens, or apostrophes.\nOnly ASCII characters are supported.\nRequired for American Express SafeKey (U.S.) for travel-related requests.\n"
+ },
+ "lastName": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Last name of the passenger to whom the ticket was issued.\nIf there are multiple passengers, include all listed on the ticket.\nDo not include special characters such as commas, hyphens, or apostrophes.\nOnly ASCII characters are supported.\nRequired for American Express SafeKey (U.S.) for travel-related requests.\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "merchantDefinedInformation": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "description": "Contains merchant-defined key-value pairs.",
+ "properties": {
+ "key": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Fields that you can use to store information. The value\nappears in the Case Management Details window in the\nBusiness Center. The first four fields are the same fields\nthat are used by the Secure Data services. See request\ncode examples.\n**Warning** Merchant-defined data fields are not intended\nto and must not be used to capture personally identifying\ninformation. Accordingly, merchants are prohibited from\ncapturing, obtaining, and/or transmitting any personally\nidentifying information in or via the merchant-defined data\nfields. Personally identifying information includes, but is\nnot limited to, address, credit card number, social security\nnumber, driver's license number, state-issued\nidentification number, passport number, and card\nverification numbers (CVV, CVC2, CVV2, CID, CVN). In\nthe event CyberSource discovers that a merchant is\ncapturing and/or transmitting personally identifying\ninformation via the merchant-defined data fields, whether\nor not intentionally, CyberSource will immediately\nsuspend the merchant's account, which will result in a\nrejection of any and all transaction requests submitted by\nthe merchant after the point of suspension.\n"
+ },
+ "value": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "String value for the key"
+ }
}
}
}
@@ -20177,64 +19332,26 @@
}
}
],
- "tags": [
- "Instrument Identifier"
- ],
- "operationId": "createInstrumentIdentifier",
- "x-devcenter-metaData": {
- "categoryTag": "Token_Management"
- },
- "consumes": [
- "application/json;charset=utf-8"
- ],
- "produces": [
- "application/json;charset=utf-8"
- ],
"responses": {
- "200": {
- "description": "An existing Instrument Identifier containing the same data has already been returned.",
- "headers": {
- "Location": {
- "description": "Link to the Instrument Identifier.",
- "type": "string"
- },
- "uniqueTransactionID": {
- "description": "A globally unique ID associated with your request.",
- "type": "string"
- }
- },
+ "201": {
+ "description": "Successful response",
"schema": {
- "title": "tmsV1InstrumentIdentifiersPost200Response",
+ "title": "riskV1AuthenticationsPost201Response",
"type": "object",
"properties": {
"_links": {
"type": "object",
- "readOnly": true,
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
- }
- },
- "ancestor": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
- }
- },
- "successor": {
- "type": "object",
- "properties": {
- "href": {
+ "description": "This is the endpoint of the resource that was created by the successful request."
+ },
+ "method": {
"type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
+ "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource."
}
}
}
@@ -20242,616 +19359,799 @@
},
"id": {
"type": "string",
- "readOnly": true,
- "example": "1234567890123456800",
- "description": "Unique identification number assigned by CyberSource to the submitted request."
+ "maxLength": 26,
+ "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource."
},
- "object": {
+ "submitTimeUtc": {
"type": "string",
- "readOnly": true,
- "example": "instrumentIdentifier",
- "description": "Describes type of token.",
- "enum": [
- "instrumentIdentifier"
- ]
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
},
- "state": {
+ "submitTimeLocal": {
"type": "string",
- "readOnly": true,
- "example": "ACTIVE",
- "description": "Current state of the token.",
- "enum": [
- "ACTIVE",
- "CLOSED"
- ]
+ "description": "Time that the transaction was submitted in local time."
},
- "card": {
+ "status": {
+ "type": "string",
+ "description": "The status for payerAuthentication 201 enroll and validate calls. Possible values are:\n- AUTHENTICATION_SUCCESSFUL\n- PENDING_AUTHENTICATION\n"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason of the status. Possible values are:\n- Authentication_Completed_Or_Skipped_Sucessfully\n- Pending_Authentication\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The message describing the reason of the status. Value is:\n- The cardholder is enrolled in Payer Authentication. Please authenticate\nthe cardholder before continuing with the transaction.\n"
+ },
+ "clientReferenceInformation": {
"type": "object",
"properties": {
- "number": {
+ "code": {
"type": "string",
- "example": "1234567890987654",
- "minLength": 12,
- "maxLength": 19,
- "description": "Customer\u2019s credit card number."
+ "maxLength": 50,
+ "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n"
}
}
},
- "bankAccount": {
+ "orderInformation": {
"type": "object",
"properties": {
- "number": {
- "type": "string",
- "example": "1234567890123456800",
- "minLength": 1,
- "maxLength": 19,
- "description": "Checking account number."
- },
- "routingNumber": {
- "type": "string",
- "example": "123456789",
- "minLength": 1,
- "maxLength": 9,
- "description": "Routing number."
+ "amountDetails": {
+ "type": "object",
+ "properties": {
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor 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.\n\n#### DCC for First Data\nYour 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).\n"
+ }
+ }
}
}
},
- "processingInformation": {
+ "consumerAuthenticationInformation": {
"type": "object",
"properties": {
- "authorizationOptions": {
- "type": "object",
- "properties": {
- "initiator": {
- "type": "object",
- "properties": {
- "merchantInitiatedTransaction": {
- "type": "object",
- "properties": {
- "previousTransactionId": {
- "type": "string",
- "example": "123456789012345",
- "maxLength": 15,
- "description": "Previous Consumer Initiated Transaction Id."
- }
- }
- }
- }
- }
- }
+ "acsUrl": {
+ "type": "string",
+ "maxLength": 2048,
+ "description": "URL for the card-issuing bank\u2019s authentication form that you receive when the card is enrolled.\nThe value can be very large.\n"
+ },
+ "authenticationPath": {
+ "type": "string",
+ "description": "Indicates what displays to the customer during the authentication process.\nThis field can contain one of these values:\n- `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process.\n- `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed.\n- `ENROLLED`: (Card enrolled) the card issuer\u2019s authentication window displays.\n- `UNKNOWN`: Card enrollment status cannot be determined.\n- `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.\n\nThe following values can be returned if you are using rules-based payer authentication.\n- `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely\nto be challenged cannot be determined.\n- `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the\ncardholder will not be challenged to provide credentials, also known as _silent authentication_.\n\nFor details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\"\nin [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "authenticationTransactionId": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Payer authentication transaction identifier passed to link the check\nenrollment and validate authentication messages.\n"
+ },
+ "cavv": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and\nDiscover transactions after the customer is authenticated. The value is in base64. When you\nrequest the card authorization service, CyberSource automatically converts the value, not the field name,\nto the format required by your payment processor.\n"
+ },
+ "cavvAlgorithm": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "Field that is returned only when the CAVV is generated, which occurs when paresStatus\ncontains the values Y (successful authentication) or A (attempted authentication). If\nyou use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the\nauthorization service. This field contains one of these values:\n- `2`: Visa, American Express, JCB, Diners Club, and Discover\n- `3`: Mastercard\n"
+ },
+ "challengeRequired": {
+ "type": "boolean",
+ "description": "Indicates whether a challenge is required to complete authentication (region mandates).\n"
+ },
+ "ecommerceIndicator": {
+ "type": "string",
+ "maxLength": 255,
+ "description": "Commerce indicator for cards not enrolled. This field contains one of these values:\n- `internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift.\n- `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift.\n- `js_failure`: J/Secure directory service is not available. No liability shift.\n- `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift.\n- `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift.\n- `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive\nthis result if Visa\u2019s directory service is not available. No liability shift.\n"
+ },
+ "eci": {
+ "type": "string",
+ "description": "Note This field applies only to non-U.S-issued cards.\n\nFor enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB,\nDiners Club, and Discover transactions when the card is not enrolled. For more information, see\n\"Interpreting the Reply,\" page 22.\n\nIf you are not using the CyberSource payment services, you must send this value to your payment\nprocessor in the subsequent request for card authorization. This field contains one of these values:\n- `06`: The card can be enrolled. Liability shift.\n- `07`: The card cannot be enrolled. No liability shift.\n\nFor validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB,\nDiners Club, and Discover transactions. The field is absent when authentication fails.\nYou must send this value to your payment processor in the subsequent request for card authorization.\nThis field contains one of these values:\n- `05`: Successful authentication\n- `06`: Authentication attempted\n- `07`: Failed authentication (No response from the merchant because of a problem.)\n"
+ },
+ "eciRaw": {
+ "type": "string",
+ "description": "ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover.\nThe field is absent when authentication fails. If your payment processor is Streamline, you must pass the\nvalue of this field instead of the value of `eci` or `ucafCollectionIndicator`.\n\nThis field can contain one of these values:\n- `01`: Authentication attempted (Mastercard)\n- `02`: Successful authentication (Mastercard)\n- `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover)\n- `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)\n"
+ },
+ "pareq": {
+ "type": "string",
+ "description": "Payer authentication request (PAReq) message that you need to forward to the ACS.\nThe value can be very large. The value is in base64.\n"
+ },
+ "paresStatus": {
+ "type": "string",
+ "description": "Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway\nProcessing, you need to send the value of this field in your authorization request. This field can contain\none of these values:\n- `A`: Proof of authentication attempt was generated.\n- `B`: Bypassed authentication.\n- `N`: Customer failed or canceled authentication. Transaction denied.\n- `R`: Authentication rejected (used for 3D Secure 2.0 transactions only)\n- `U`: Authentication not completed regardless of the reason.\n- `Y`: Customer was successfully authenticated.\n"
+ },
+ "proofXml": {
+ "type": "string",
+ "description": "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in\n[CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.\n- For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n"
+ },
+ "proxyPan": {
+ "type": "string",
+ "description": "Encrypted version of the card number used in the payer authentication request message.\n"
+ },
+ "specificationVersion": {
+ "type": "string",
+ "description": "This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.\n"
+ },
+ "ucafAuthenticationData": {
+ "type": "string",
+ "description": "AAV is a unique identifier generated by the cardissuing bank for Mastercard SecureCode\ntransactions after the customer is authenticated. The value is in base64.\nInclude the data in the card authorization request.\n"
+ },
+ "ucafCollectionIndicator": {
+ "type": "number",
+ "maxLength": 1,
+ "description": "For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the\ncustomer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator.\nThis field can contain these values: 0, 1.\n\nFor validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard SecureCode\ntransactions. The field is absent when authentication fails. You must send this value to your payment\nprocessor in the request for card authorization. This field contain one of these values:\n- `0`: Authentication data not collected, and customer authentication was not completed.\n- `1`: Authentication data not collected because customer authentication was not completed.\n- `2`: Authentication data collected because customer completed authentication.\n"
+ },
+ "veresEnrolled": {
+ "type": "string",
+ "description": "Result of the enrollment check. This field can contain one of these values:\n- `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.\n- `N`: Card not enrolled; proceed with authorization. Liability shift.\n- `U`: Unable to authenticate regardless of the reason. No liability shift.\n\n**Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for\nthis processor, you must send the value of this field in your authorization request.\n\nThe following value can be returned if you are using rules-based Payer Authentication:\n- `B`: Indicates that authentication was bypassed.\n\nFor details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n"
+ },
+ "xid": {
+ "type": "string",
+ "description": "Transaction identifier generated by CyberSource for successful enrollment or validation checks.\nUse this value, which is in base64, to match an outgoing PAReq with an incoming PARes.\nCyberSource forwards the XID with the card authorization service to these payment processors in these cases:\n- Barclays\n- Streamline (when the **ecommerceIndicator**`=spa`)\n"
}
}
},
- "metadata": {
+ "errorInformation": {
"type": "object",
- "readOnly": true,
"properties": {
- "creator": {
+ "reason": {
"type": "string",
- "example": "merchantName",
- "description": "The creator of the token."
+ "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n",
+ "enum": [
+ "AVS_FAILED",
+ "CONTACT_PROCESSOR",
+ "EXPIRED_CARD",
+ "PROCESSOR_DECLINED",
+ "INSUFFICIENT_FUND",
+ "STOLEN_LOST_CARD",
+ "ISSUER_UNAVAILABLE",
+ "UNAUTHORIZED_CARD",
+ "CVN_NOT_MATCH",
+ "EXCEEDS_CREDIT_LIMIT",
+ "INVALID_CVN",
+ "DECLINED_CHECK",
+ "BLACKLISTED_CUSTOMER",
+ "SUSPENDED_ACCOUNT",
+ "PAYMENT_REFUSED",
+ "CV_FAILED",
+ "INVALID_ACCOUNT",
+ "GENERAL_DECLINE",
+ "INVALID_MERCHANT_CONFIGURATION",
+ "DECISION_PROFILE_REJECT",
+ "SCORE_EXCEEDS_THRESHOLD",
+ "PENDING_AUTHENTICATION"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "The detail message related to the status and reason listed above."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid."
+ },
+ "reason": {
+ "type": "string",
+ "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
+ "enum": [
+ "MISSING_FIELD",
+ "INVALID_DATA"
+ ]
+ }
+ }
+ }
}
}
}
}
- },
- "examples": {
- "application/json": {
- "_links": {
- "self": {
- "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
+ }
+ },
+ "400": {
+ "description": "Invalid request",
+ "schema": {
+ "title": "riskV1AuthenticationsPost400Response",
+ "type": "object",
+ "properties": {
+ "submitTimeUtc": {
+ "type": "string",
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
},
- "paymentInstruments": {
- "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"
+ "status": {
+ "type": "string",
+ "description": "The status for payerAuthentication 201 enroll and validate calls. Value is:\n- AUTHENTICATION_FAILED\n"
},
- "id": "1234567890123456789",
- "object": "instrumentIdentifier",
- "state": "ACTIVE",
- "card": {
- "number": "444444XXXXXX4444"
+ "reason": {
+ "type": "string",
+ "description": "The reason of the status. Value is Failed_Authentication.\n"
},
- "processingInformation": {
- "authorizationOptions": {
- "initiator": {
- "merchantInitiatedTransaction": {
- "previousTransactionId": "123456789012345"
+ "message": {
+ "type": "string",
+ "description": "The message describing the reason of the status. Value is:\n- Encountered a Payer Authentication problem. Payer could not be authenticated.\n"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "This is the flattened JSON object field name/path that is either missing or invalid."
+ },
+ "reason": {
+ "type": "string",
+ "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n",
+ "enum": [
+ "MISSING_FIELD",
+ "INVALID_DATA"
+ ]
}
}
}
- },
- "metadata": {
- "creator": "user"
}
}
}
},
- "201": {
- "description": "A new Instrument Identifier has been created.",
- "headers": {
- "Location": {
- "description": "Link to the Instrument Identifier.",
- "type": "string"
- },
- "uniqueTransactionID": {
- "description": "A globally unique ID associated with your request.",
- "type": "string"
- }
- },
+ "502": {
+ "description": "Unexpected system error or system timeout.",
"schema": {
- "title": "tmsV1InstrumentIdentifiersPost201Response",
+ "title": "riskV1AuthenticationsPost502Response",
"type": "object",
"properties": {
- "_links": {
- "type": "object",
- "readOnly": true,
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
- }
- },
- "ancestor": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
- }
- },
- "successor": {
- "type": "object",
- "properties": {
- "href": {
- "type": "string",
- "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- }
- }
- }
- }
- },
- "id": {
+ "submitTimeUtc": {
"type": "string",
- "readOnly": true,
- "example": "1234567890123456800",
- "description": "Unique identification number assigned by CyberSource to the submitted request."
+ "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n"
},
- "object": {
+ "status": {
"type": "string",
- "readOnly": true,
- "example": "instrumentIdentifier",
- "description": "Describes type of token.",
+ "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n",
"enum": [
- "instrumentIdentifier"
+ "SERVER_ERROR"
]
},
- "state": {
+ "reason": {
"type": "string",
- "readOnly": true,
- "example": "ACTIVE",
- "description": "Current state of the token.",
+ "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n",
"enum": [
- "ACTIVE",
- "CLOSED"
+ "SYSTEM_ERROR",
+ "SERVER_TIMEOUT",
+ "SERVICE_TIMEOUT",
+ "INVALID_OR_MISSING_CONFIG",
+ "PROCESSOR_TIMEOUT"
]
},
- "card": {
- "type": "object",
- "properties": {
- "number": {
- "type": "string",
- "example": "1234567890987654",
- "minLength": 12,
- "maxLength": 19,
- "description": "Customer\u2019s credit card number."
- }
- }
- },
- "bankAccount": {
- "type": "object",
- "properties": {
- "number": {
- "type": "string",
- "example": "1234567890123456800",
- "minLength": 1,
- "maxLength": 19,
- "description": "Checking account number."
- },
- "routingNumber": {
- "type": "string",
- "example": "123456789",
- "minLength": 1,
- "maxLength": 9,
- "description": "Routing number."
- }
- }
- },
- "processingInformation": {
- "type": "object",
- "properties": {
- "authorizationOptions": {
- "type": "object",
- "properties": {
- "initiator": {
- "type": "object",
- "properties": {
- "merchantInitiatedTransaction": {
- "type": "object",
- "properties": {
- "previousTransactionId": {
- "type": "string",
- "example": "123456789012345",
- "maxLength": 15,
- "description": "Previous Consumer Initiated Transaction Id."
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "metadata": {
- "type": "object",
- "readOnly": true,
- "properties": {
- "creator": {
- "type": "string",
- "example": "merchantName",
- "description": "The creator of the token."
- }
- }
+ "message": {
+ "type": "string",
+ "description": "The detail message related to the status and reason listed above."
}
}
- },
- "examples": {
- "application/json": {
- "_links": {
- "self": {
- "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"
- },
- "paymentInstruments": {
- "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"
- }
+ }
+ }
+ },
+ "x-example": {
+ "example0": {
+ "summary": "Enroll with Pending Authentication",
+ "value": {
+ "clientReferenceInformation": {
+ "code": "cybs_test"
+ },
+ "orderInformation": {
+ "billTo": {
+ "firstName": "John",
+ "lastName": "Doe",
+ "address2": "Address 2",
+ "address1": "1 Market St",
+ "postalCode": "94105",
+ "locality": "san francisco",
+ "administrativeArea": "CA",
+ "country": "US",
+ "phoneNumber": "4158880000",
+ "company": "Visa",
+ "email": "test@cybs.com"
},
- "id": "1234567890123456789",
- "object": "instrumentIdentifier",
- "state": "ACTIVE",
+ "amountDetails": {
+ "totalAmount": "10.99",
+ "currency": "USD"
+ }
+ },
+ "buyerInformation": {
+ "mobilePhone": "1245789632"
+ },
+ "paymentInformation": {
"card": {
- "number": "444444XXXXXX4444"
- },
- "processingInformation": {
- "authorizationOptions": {
- "initiator": {
- "merchantInitiatedTransaction": {
- "previousTransactionId": "123456789012345"
- }
- }
- }
- },
- "metadata": {
- "creator": "user"
+ "expirationMonth": "12",
+ "expirationYear": "2025",
+ "number": "4000000000000101"
}
+ },
+ "consumerAuthenticationInformation": {
+ "transactionMode": "MOTO"
}
+ },
+ "responseValue": {
+ "clientReferenceInformation": {
+ "code": "cybs_test"
+ },
+ "consumerAuthenticationInformation": {
+ "acsUrl": "https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?visaattempts=true&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+ "xid": "OE9oRVBLeTNBcDJ6b3U1MjI2TDA=",
+ "authenticationTransactionId": "8OhEPKy3Ap2zou5226L0",
+ "pareq": "eNpVUclOwzAQvfsrKsQ5XrKoqaaWUlKJQjeVwj11RySILHUS1PL12ElDwaf3ZvHMewP7VCPGL6hajRJWWNfJO46y4/RuvEnn2+eLG1Xiu2x9IYIlu5OwjXZ4kvCFus7KQnKHOQLoQIn5Qqs0KRoJiTrNFmvpBaHgAdArJZCjXsTS9bgnhCdY/4D2YQJFkqNssG5GFgHtOAFVtkWjL3LsmdqBEGj1p0ybpqonlKrLwaxRtlqho8ocqE0SoLeVtq1FtVF6zo5yMw/L3dtsifv1TMVPwcF95auPhdjH0RSorSBwTBqUgvGQ+SIcMXfCxcQ3grs4gSS3m8h7zpwwNBp7SqCyg6KecWZTfyNGTas1FmqQMzACeK7KAk2NmfGLjYbb5g+P1lrVGLMECxjjnvW24117ZnwRPu/7s84kanvo9XL0emSD/h3/BzWppsk=",
+ "veresEnrolled": "Y",
+ "proxyPan": "2060014",
+ "authenticationPath": "ATTEMPTS",
+ "proofXml": "
- * The index module provides access to constructors for all the classes which comprise the public API.
- *
- * var CyberSource = require('index'); // See note below*.
- * var xxxSvc = new CyberSource.XxxApi(); // Allocate the API class we're going to use.
- * var yyyModel = new CyberSource.Yyy(); // Construct a model instance.
- * yyyModel.someProperty = 'someValue';
- * ...
- * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
- * ...
- *
- * *NOTE: For a top-level AMD script, use require(['index'], function(){...})
- * and put the application logic within the callback function.
- *
- * A non-AMD browser application (discouraged) might do something like this: - *
- * var xxxSvc = new CyberSource.XxxApi(); // Allocate the API class we're going to use. - * var yyy = new CyberSource.Yyy(); // Construct a model instance. - * yyyModel.someProperty = 'someValue'; - * ... - * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service. - * ... - *- * - * @module index - * @version 0.0.1 - */ - var exports = { - /** - * The ApiClient constructor. - * @property {module:ApiClient} - */ - ApiClient: ApiClient, - /** - * The AuthReversalRequest model constructor. - * @property {module:model/AuthReversalRequest} - */ - AuthReversalRequest: AuthReversalRequest, - /** - * The CapturePaymentRequest model constructor. - * @property {module:model/CapturePaymentRequest} - */ - CapturePaymentRequest: CapturePaymentRequest, - /** - * The CreateCreditRequest model constructor. - * @property {module:model/CreateCreditRequest} - */ - CreateCreditRequest: CreateCreditRequest, - /** - * The CreateDecisionManagerCaseRequest model constructor. - * @property {module:model/CreateDecisionManagerCaseRequest} - */ - CreateDecisionManagerCaseRequest: CreateDecisionManagerCaseRequest, - /** - * The CreateInstrumentIdentifierRequest model constructor. - * @property {module:model/CreateInstrumentIdentifierRequest} - */ - CreateInstrumentIdentifierRequest: CreateInstrumentIdentifierRequest, - /** - * The CreatePaymentInstrumentRequest model constructor. - * @property {module:model/CreatePaymentInstrumentRequest} - */ - CreatePaymentInstrumentRequest: CreatePaymentInstrumentRequest, - /** - * The CreatePaymentRequest model constructor. - * @property {module:model/CreatePaymentRequest} - */ - CreatePaymentRequest: CreatePaymentRequest, - /** - * The CreateSearchRequest model constructor. - * @property {module:model/CreateSearchRequest} - */ - CreateSearchRequest: CreateSearchRequest, - /** - * The FlexV1KeysPost200Response model constructor. - * @property {module:model/FlexV1KeysPost200Response} - */ - FlexV1KeysPost200Response: FlexV1KeysPost200Response, - /** - * The FlexV1KeysPost200ResponseDer model constructor. - * @property {module:model/FlexV1KeysPost200ResponseDer} - */ - FlexV1KeysPost200ResponseDer: FlexV1KeysPost200ResponseDer, - /** - * The FlexV1KeysPost200ResponseJwk model constructor. - * @property {module:model/FlexV1KeysPost200ResponseJwk} - */ - FlexV1KeysPost200ResponseJwk: FlexV1KeysPost200ResponseJwk, - /** - * The FlexV1TokensPost200Response model constructor. - * @property {module:model/FlexV1TokensPost200Response} - */ - FlexV1TokensPost200Response: FlexV1TokensPost200Response, - /** - * The Flexv1tokensCardInfo model constructor. - * @property {module:model/Flexv1tokensCardInfo} - */ - Flexv1tokensCardInfo: Flexv1tokensCardInfo, - /** - * The GeneratePublicKeyRequest model constructor. - * @property {module:model/GeneratePublicKeyRequest} - */ - GeneratePublicKeyRequest: GeneratePublicKeyRequest, - /** - * The InlineResponse200 model constructor. - * @property {module:model/InlineResponse200} - */ - InlineResponse200: InlineResponse200, - /** - * The InlineResponse200PaymentBatchSummaries model constructor. - * @property {module:model/InlineResponse200PaymentBatchSummaries} - */ - InlineResponse200PaymentBatchSummaries: InlineResponse200PaymentBatchSummaries, - /** - * The InlineResponse400 model constructor. - * @property {module:model/InlineResponse400} - */ - InlineResponse400: InlineResponse400, - /** - * The InlineResponse4001 model constructor. - * @property {module:model/InlineResponse4001} - */ - InlineResponse4001: InlineResponse4001, - /** - * The InlineResponse400Fields model constructor. - * @property {module:model/InlineResponse400Fields} - */ - InlineResponse400Fields: InlineResponse400Fields, - /** - * The InlineResponseDefault model constructor. - * @property {module:model/InlineResponseDefault} - */ - InlineResponseDefault: InlineResponseDefault, - /** - * The InlineResponseDefaultLinks model constructor. - * @property {module:model/InlineResponseDefaultLinks} - */ - InlineResponseDefaultLinks: InlineResponseDefaultLinks, - /** - * The InlineResponseDefaultLinksNext model constructor. - * @property {module:model/InlineResponseDefaultLinksNext} - */ - InlineResponseDefaultLinksNext: InlineResponseDefaultLinksNext, - /** - * The InlineResponseDefaultResponseStatus model constructor. - * @property {module:model/InlineResponseDefaultResponseStatus} - */ - InlineResponseDefaultResponseStatus: InlineResponseDefaultResponseStatus, - /** - * The InlineResponseDefaultResponseStatusDetails model constructor. - * @property {module:model/InlineResponseDefaultResponseStatusDetails} - */ - InlineResponseDefaultResponseStatusDetails: InlineResponseDefaultResponseStatusDetails, - /** - * The MitReversalRequest model constructor. - * @property {module:model/MitReversalRequest} - */ - MitReversalRequest: MitReversalRequest, - /** - * The MitVoidRequest model constructor. - * @property {module:model/MitVoidRequest} - */ - MitVoidRequest: MitVoidRequest, - /** - * The OctCreatePaymentRequest model constructor. - * @property {module:model/OctCreatePaymentRequest} - */ - OctCreatePaymentRequest: OctCreatePaymentRequest, - /** - * The PtsV1TransactionBatchesGet200Response model constructor. - * @property {module:model/PtsV1TransactionBatchesGet200Response} - */ - PtsV1TransactionBatchesGet200Response: PtsV1TransactionBatchesGet200Response, - /** - * The PtsV1TransactionBatchesGet200ResponseLinks model constructor. - * @property {module:model/PtsV1TransactionBatchesGet200ResponseLinks} - */ - PtsV1TransactionBatchesGet200ResponseLinks: PtsV1TransactionBatchesGet200ResponseLinks, - /** - * The PtsV1TransactionBatchesGet200ResponseLinksSelf model constructor. - * @property {module:model/PtsV1TransactionBatchesGet200ResponseLinksSelf} - */ - PtsV1TransactionBatchesGet200ResponseLinksSelf: PtsV1TransactionBatchesGet200ResponseLinksSelf, - /** - * The PtsV1TransactionBatchesGet200ResponseTransactionBatches model constructor. - * @property {module:model/PtsV1TransactionBatchesGet200ResponseTransactionBatches} - */ - PtsV1TransactionBatchesGet200ResponseTransactionBatches: PtsV1TransactionBatchesGet200ResponseTransactionBatches, - /** - * The PtsV1TransactionBatchesGet400Response model constructor. - * @property {module:model/PtsV1TransactionBatchesGet400Response} - */ - PtsV1TransactionBatchesGet400Response: PtsV1TransactionBatchesGet400Response, - /** - * The PtsV1TransactionBatchesGet400ResponseErrorInformation model constructor. - * @property {module:model/PtsV1TransactionBatchesGet400ResponseErrorInformation} - */ - PtsV1TransactionBatchesGet400ResponseErrorInformation: PtsV1TransactionBatchesGet400ResponseErrorInformation, - /** - * The PtsV1TransactionBatchesGet400ResponseErrorInformationDetails model constructor. - * @property {module:model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails} - */ - PtsV1TransactionBatchesGet400ResponseErrorInformationDetails: PtsV1TransactionBatchesGet400ResponseErrorInformationDetails, - /** - * The PtsV1TransactionBatchesGet500Response model constructor. - * @property {module:model/PtsV1TransactionBatchesGet500Response} - */ - PtsV1TransactionBatchesGet500Response: PtsV1TransactionBatchesGet500Response, - /** - * The PtsV1TransactionBatchesGet500ResponseErrorInformation model constructor. - * @property {module:model/PtsV1TransactionBatchesGet500ResponseErrorInformation} - */ - PtsV1TransactionBatchesGet500ResponseErrorInformation: PtsV1TransactionBatchesGet500ResponseErrorInformation, - /** - * The PtsV1TransactionBatchesIdGet200Response model constructor. - * @property {module:model/PtsV1TransactionBatchesIdGet200Response} - */ - PtsV1TransactionBatchesIdGet200Response: PtsV1TransactionBatchesIdGet200Response, - /** - * The PtsV1TransactionBatchesIdGet200ResponseLinks model constructor. - * @property {module:model/PtsV1TransactionBatchesIdGet200ResponseLinks} - */ - PtsV1TransactionBatchesIdGet200ResponseLinks: PtsV1TransactionBatchesIdGet200ResponseLinks, - /** - * The PtsV1TransactionBatchesIdGet200ResponseLinksTransactions model constructor. - * @property {module:model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions} - */ - PtsV1TransactionBatchesIdGet200ResponseLinksTransactions: PtsV1TransactionBatchesIdGet200ResponseLinksTransactions, - /** - * The PtsV2CreditsPost201Response model constructor. - * @property {module:model/PtsV2CreditsPost201Response} - */ - PtsV2CreditsPost201Response: PtsV2CreditsPost201Response, - /** - * The PtsV2CreditsPost201ResponseCreditAmountDetails model constructor. - * @property {module:model/PtsV2CreditsPost201ResponseCreditAmountDetails} - */ - PtsV2CreditsPost201ResponseCreditAmountDetails: PtsV2CreditsPost201ResponseCreditAmountDetails, - /** - * The PtsV2CreditsPost201ResponsePaymentInformation model constructor. - * @property {module:model/PtsV2CreditsPost201ResponsePaymentInformation} - */ - PtsV2CreditsPost201ResponsePaymentInformation: PtsV2CreditsPost201ResponsePaymentInformation, - /** - * The PtsV2CreditsPost201ResponseProcessingInformation model constructor. - * @property {module:model/PtsV2CreditsPost201ResponseProcessingInformation} - */ - PtsV2CreditsPost201ResponseProcessingInformation: PtsV2CreditsPost201ResponseProcessingInformation, - /** - * The PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions model constructor. - * @property {module:model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions} - */ - PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions: PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions, - /** - * The PtsV2PaymentsCapturesPost201Response model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost201Response} - */ - PtsV2PaymentsCapturesPost201Response: PtsV2PaymentsCapturesPost201Response, - /** - * The PtsV2PaymentsCapturesPost201ResponseLinks model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost201ResponseLinks} - */ - PtsV2PaymentsCapturesPost201ResponseLinks: PtsV2PaymentsCapturesPost201ResponseLinks, - /** - * The PtsV2PaymentsCapturesPost201ResponseOrderInformation model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost201ResponseOrderInformation} - */ - PtsV2PaymentsCapturesPost201ResponseOrderInformation: PtsV2PaymentsCapturesPost201ResponseOrderInformation, - /** - * The PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails} - */ - PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails: PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails, - /** - * The PtsV2PaymentsCapturesPost201ResponseProcessorInformation model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation} - */ - PtsV2PaymentsCapturesPost201ResponseProcessorInformation: PtsV2PaymentsCapturesPost201ResponseProcessorInformation, - /** - * The PtsV2PaymentsCapturesPost400Response model constructor. - * @property {module:model/PtsV2PaymentsCapturesPost400Response} - */ - PtsV2PaymentsCapturesPost400Response: PtsV2PaymentsCapturesPost400Response, - /** - * The PtsV2PaymentsPost201Response model constructor. - * @property {module:model/PtsV2PaymentsPost201Response} - */ - PtsV2PaymentsPost201Response: PtsV2PaymentsPost201Response, - /** - * The PtsV2PaymentsPost201ResponseClientReferenceInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseClientReferenceInformation} - */ - PtsV2PaymentsPost201ResponseClientReferenceInformation: PtsV2PaymentsPost201ResponseClientReferenceInformation, - /** - * The PtsV2PaymentsPost201ResponseErrorInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseErrorInformation} - */ - PtsV2PaymentsPost201ResponseErrorInformation: PtsV2PaymentsPost201ResponseErrorInformation, - /** - * The PtsV2PaymentsPost201ResponseErrorInformationDetails model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseErrorInformationDetails} - */ - PtsV2PaymentsPost201ResponseErrorInformationDetails: PtsV2PaymentsPost201ResponseErrorInformationDetails, - /** - * The PtsV2PaymentsPost201ResponseInstallmentInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseInstallmentInformation} - */ - PtsV2PaymentsPost201ResponseInstallmentInformation: PtsV2PaymentsPost201ResponseInstallmentInformation, - /** - * The PtsV2PaymentsPost201ResponseIssuerInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseIssuerInformation} - */ - PtsV2PaymentsPost201ResponseIssuerInformation: PtsV2PaymentsPost201ResponseIssuerInformation, - /** - * The PtsV2PaymentsPost201ResponseLinks model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseLinks} - */ - PtsV2PaymentsPost201ResponseLinks: PtsV2PaymentsPost201ResponseLinks, - /** - * The PtsV2PaymentsPost201ResponseLinksSelf model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseLinksSelf} - */ - PtsV2PaymentsPost201ResponseLinksSelf: PtsV2PaymentsPost201ResponseLinksSelf, - /** - * The PtsV2PaymentsPost201ResponseOrderInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformation} - */ - PtsV2PaymentsPost201ResponseOrderInformation: PtsV2PaymentsPost201ResponseOrderInformation, - /** - * The PtsV2PaymentsPost201ResponseOrderInformationAmountDetails model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails} - */ - PtsV2PaymentsPost201ResponseOrderInformationAmountDetails: PtsV2PaymentsPost201ResponseOrderInformationAmountDetails, - /** - * The PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails} - */ - PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails: PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformation} - */ - PtsV2PaymentsPost201ResponsePaymentInformation: PtsV2PaymentsPost201ResponsePaymentInformation, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures} - */ - PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures: PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformationBank model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationBank} - */ - PtsV2PaymentsPost201ResponsePaymentInformationBank: PtsV2PaymentsPost201ResponsePaymentInformationBank, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformationBankAccount model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount} - */ - PtsV2PaymentsPost201ResponsePaymentInformationBankAccount: PtsV2PaymentsPost201ResponsePaymentInformationBankAccount, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformationCard model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationCard} - */ - PtsV2PaymentsPost201ResponsePaymentInformationCard: PtsV2PaymentsPost201ResponsePaymentInformationCard, - /** - * The PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard} - */ - PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard: PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard, - /** - * The PtsV2PaymentsPost201ResponsePointOfSaleInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePointOfSaleInformation} - */ - PtsV2PaymentsPost201ResponsePointOfSaleInformation: PtsV2PaymentsPost201ResponsePointOfSaleInformation, - /** - * The PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv} - */ - PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv: PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv, - /** - * The PtsV2PaymentsPost201ResponseProcessingInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessingInformation} - */ - PtsV2PaymentsPost201ResponseProcessingInformation: PtsV2PaymentsPost201ResponseProcessingInformation, - /** - * The PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions} - */ - PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions: PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformation model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformation} - */ - PtsV2PaymentsPost201ResponseProcessorInformation: PtsV2PaymentsPost201ResponseProcessorInformation, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationAchVerification model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification} - */ - PtsV2PaymentsPost201ResponseProcessorInformationAchVerification: PtsV2PaymentsPost201ResponseProcessorInformationAchVerification, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationAvs model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationAvs} - */ - PtsV2PaymentsPost201ResponseProcessorInformationAvs: PtsV2PaymentsPost201ResponseProcessorInformationAvs, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationCardVerification model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification} - */ - PtsV2PaymentsPost201ResponseProcessorInformationCardVerification: PtsV2PaymentsPost201ResponseProcessorInformationCardVerification, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse} - */ - PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse: PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationCustomer model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer} - */ - PtsV2PaymentsPost201ResponseProcessorInformationCustomer: PtsV2PaymentsPost201ResponseProcessorInformationCustomer, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults} - */ - PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults: PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice} - */ - PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice: PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice, - /** - * The PtsV2PaymentsPost201ResponseProcessorInformationRouting model constructor. - * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationRouting} - */ - PtsV2PaymentsPost201ResponseProcessorInformationRouting: PtsV2PaymentsPost201ResponseProcessorInformationRouting, - /** - * The PtsV2PaymentsPost400Response model constructor. - * @property {module:model/PtsV2PaymentsPost400Response} - */ - PtsV2PaymentsPost400Response: PtsV2PaymentsPost400Response, - /** - * The PtsV2PaymentsPost502Response model constructor. - * @property {module:model/PtsV2PaymentsPost502Response} - */ - PtsV2PaymentsPost502Response: PtsV2PaymentsPost502Response, - /** - * The PtsV2PaymentsRefundPost201Response model constructor. - * @property {module:model/PtsV2PaymentsRefundPost201Response} - */ - PtsV2PaymentsRefundPost201Response: PtsV2PaymentsRefundPost201Response, - /** - * The PtsV2PaymentsRefundPost201ResponseLinks model constructor. - * @property {module:model/PtsV2PaymentsRefundPost201ResponseLinks} - */ - PtsV2PaymentsRefundPost201ResponseLinks: PtsV2PaymentsRefundPost201ResponseLinks, - /** - * The PtsV2PaymentsRefundPost201ResponseOrderInformation model constructor. - * @property {module:model/PtsV2PaymentsRefundPost201ResponseOrderInformation} - */ - PtsV2PaymentsRefundPost201ResponseOrderInformation: PtsV2PaymentsRefundPost201ResponseOrderInformation, - /** - * The PtsV2PaymentsRefundPost201ResponseProcessorInformation model constructor. - * @property {module:model/PtsV2PaymentsRefundPost201ResponseProcessorInformation} - */ - PtsV2PaymentsRefundPost201ResponseProcessorInformation: PtsV2PaymentsRefundPost201ResponseProcessorInformation, - /** - * The PtsV2PaymentsRefundPost201ResponseRefundAmountDetails model constructor. - * @property {module:model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails} - */ - PtsV2PaymentsRefundPost201ResponseRefundAmountDetails: PtsV2PaymentsRefundPost201ResponseRefundAmountDetails, - /** - * The PtsV2PaymentsRefundPost400Response model constructor. - * @property {module:model/PtsV2PaymentsRefundPost400Response} - */ - PtsV2PaymentsRefundPost400Response: PtsV2PaymentsRefundPost400Response, - /** - * The PtsV2PaymentsReversalsPost201Response model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201Response} - */ - PtsV2PaymentsReversalsPost201Response: PtsV2PaymentsReversalsPost201Response, - /** - * The PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation} - */ - PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation: PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation, - /** - * The PtsV2PaymentsReversalsPost201ResponseIssuerInformation model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation} - */ - PtsV2PaymentsReversalsPost201ResponseIssuerInformation: PtsV2PaymentsReversalsPost201ResponseIssuerInformation, - /** - * The PtsV2PaymentsReversalsPost201ResponseLinks model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201ResponseLinks} - */ - PtsV2PaymentsReversalsPost201ResponseLinks: PtsV2PaymentsReversalsPost201ResponseLinks, - /** - * The PtsV2PaymentsReversalsPost201ResponseProcessorInformation model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation} - */ - PtsV2PaymentsReversalsPost201ResponseProcessorInformation: PtsV2PaymentsReversalsPost201ResponseProcessorInformation, - /** - * The PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails} - */ - PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails: PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails, - /** - * The PtsV2PaymentsReversalsPost400Response model constructor. - * @property {module:model/PtsV2PaymentsReversalsPost400Response} - */ - PtsV2PaymentsReversalsPost400Response: PtsV2PaymentsReversalsPost400Response, - /** - * The PtsV2PaymentsVoidsPost201Response model constructor. - * @property {module:model/PtsV2PaymentsVoidsPost201Response} - */ - PtsV2PaymentsVoidsPost201Response: PtsV2PaymentsVoidsPost201Response, - /** - * The PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails model constructor. - * @property {module:model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails} - */ - PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails: PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails, - /** - * The PtsV2PaymentsVoidsPost400Response model constructor. - * @property {module:model/PtsV2PaymentsVoidsPost400Response} - */ - PtsV2PaymentsVoidsPost400Response: PtsV2PaymentsVoidsPost400Response, - /** - * The PtsV2PayoutsPost201Response model constructor. - * @property {module:model/PtsV2PayoutsPost201Response} - */ - PtsV2PayoutsPost201Response: PtsV2PayoutsPost201Response, - /** - * The PtsV2PayoutsPost201ResponseErrorInformation model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseErrorInformation} - */ - PtsV2PayoutsPost201ResponseErrorInformation: PtsV2PayoutsPost201ResponseErrorInformation, - /** - * The PtsV2PayoutsPost201ResponseMerchantInformation model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseMerchantInformation} - */ - PtsV2PayoutsPost201ResponseMerchantInformation: PtsV2PayoutsPost201ResponseMerchantInformation, - /** - * The PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor} - */ - PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor: PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor, - /** - * The PtsV2PayoutsPost201ResponseOrderInformation model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseOrderInformation} - */ - PtsV2PayoutsPost201ResponseOrderInformation: PtsV2PayoutsPost201ResponseOrderInformation, - /** - * The PtsV2PayoutsPost201ResponseOrderInformationAmountDetails model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails} - */ - PtsV2PayoutsPost201ResponseOrderInformationAmountDetails: PtsV2PayoutsPost201ResponseOrderInformationAmountDetails, - /** - * The PtsV2PayoutsPost201ResponseProcessorInformation model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseProcessorInformation} - */ - PtsV2PayoutsPost201ResponseProcessorInformation: PtsV2PayoutsPost201ResponseProcessorInformation, - /** - * The PtsV2PayoutsPost201ResponseRecipientInformation model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseRecipientInformation} - */ - PtsV2PayoutsPost201ResponseRecipientInformation: PtsV2PayoutsPost201ResponseRecipientInformation, - /** - * The PtsV2PayoutsPost201ResponseRecipientInformationCard model constructor. - * @property {module:model/PtsV2PayoutsPost201ResponseRecipientInformationCard} - */ - PtsV2PayoutsPost201ResponseRecipientInformationCard: PtsV2PayoutsPost201ResponseRecipientInformationCard, - /** - * The PtsV2PayoutsPost400Response model constructor. - * @property {module:model/PtsV2PayoutsPost400Response} - */ - PtsV2PayoutsPost400Response: PtsV2PayoutsPost400Response, - /** - * The Ptsv2creditsPointOfSaleInformation model constructor. - * @property {module:model/Ptsv2creditsPointOfSaleInformation} - */ - Ptsv2creditsPointOfSaleInformation: Ptsv2creditsPointOfSaleInformation, - /** - * The Ptsv2creditsPointOfSaleInformationEmv model constructor. - * @property {module:model/Ptsv2creditsPointOfSaleInformationEmv} - */ - Ptsv2creditsPointOfSaleInformationEmv: Ptsv2creditsPointOfSaleInformationEmv, - /** - * The Ptsv2creditsProcessingInformation model constructor. - * @property {module:model/Ptsv2creditsProcessingInformation} - */ - Ptsv2creditsProcessingInformation: Ptsv2creditsProcessingInformation, - /** - * The Ptsv2creditsProcessingInformationBankTransferOptions model constructor. - * @property {module:model/Ptsv2creditsProcessingInformationBankTransferOptions} - */ - Ptsv2creditsProcessingInformationBankTransferOptions: Ptsv2creditsProcessingInformationBankTransferOptions, - /** - * The Ptsv2paymentsAggregatorInformation model constructor. - * @property {module:model/Ptsv2paymentsAggregatorInformation} - */ - Ptsv2paymentsAggregatorInformation: Ptsv2paymentsAggregatorInformation, - /** - * The Ptsv2paymentsAggregatorInformationSubMerchant model constructor. - * @property {module:model/Ptsv2paymentsAggregatorInformationSubMerchant} - */ - Ptsv2paymentsAggregatorInformationSubMerchant: Ptsv2paymentsAggregatorInformationSubMerchant, - /** - * The Ptsv2paymentsBuyerInformation model constructor. - * @property {module:model/Ptsv2paymentsBuyerInformation} - */ - Ptsv2paymentsBuyerInformation: Ptsv2paymentsBuyerInformation, - /** - * The Ptsv2paymentsBuyerInformationPersonalIdentification model constructor. - * @property {module:model/Ptsv2paymentsBuyerInformationPersonalIdentification} - */ - Ptsv2paymentsBuyerInformationPersonalIdentification: Ptsv2paymentsBuyerInformationPersonalIdentification, - /** - * The Ptsv2paymentsClientReferenceInformation model constructor. - * @property {module:model/Ptsv2paymentsClientReferenceInformation} - */ - Ptsv2paymentsClientReferenceInformation: Ptsv2paymentsClientReferenceInformation, - /** - * The Ptsv2paymentsClientReferenceInformationPartner model constructor. - * @property {module:model/Ptsv2paymentsClientReferenceInformationPartner} - */ - Ptsv2paymentsClientReferenceInformationPartner: Ptsv2paymentsClientReferenceInformationPartner, - /** - * The Ptsv2paymentsConsumerAuthenticationInformation model constructor. - * @property {module:model/Ptsv2paymentsConsumerAuthenticationInformation} - */ - Ptsv2paymentsConsumerAuthenticationInformation: Ptsv2paymentsConsumerAuthenticationInformation, - /** - * The Ptsv2paymentsDeviceInformation model constructor. - * @property {module:model/Ptsv2paymentsDeviceInformation} - */ - Ptsv2paymentsDeviceInformation: Ptsv2paymentsDeviceInformation, - /** - * The Ptsv2paymentsInstallmentInformation model constructor. - * @property {module:model/Ptsv2paymentsInstallmentInformation} - */ - Ptsv2paymentsInstallmentInformation: Ptsv2paymentsInstallmentInformation, - /** - * The Ptsv2paymentsIssuerInformation model constructor. - * @property {module:model/Ptsv2paymentsIssuerInformation} - */ - Ptsv2paymentsIssuerInformation: Ptsv2paymentsIssuerInformation, - /** - * The Ptsv2paymentsMerchantDefinedInformation model constructor. - * @property {module:model/Ptsv2paymentsMerchantDefinedInformation} - */ - Ptsv2paymentsMerchantDefinedInformation: Ptsv2paymentsMerchantDefinedInformation, - /** - * The Ptsv2paymentsMerchantInformation model constructor. - * @property {module:model/Ptsv2paymentsMerchantInformation} - */ - Ptsv2paymentsMerchantInformation: Ptsv2paymentsMerchantInformation, - /** - * The Ptsv2paymentsMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/Ptsv2paymentsMerchantInformationMerchantDescriptor} - */ - Ptsv2paymentsMerchantInformationMerchantDescriptor: Ptsv2paymentsMerchantInformationMerchantDescriptor, - /** - * The Ptsv2paymentsMerchantInformationServiceFeeDescriptor model constructor. - * @property {module:model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor} - */ - Ptsv2paymentsMerchantInformationServiceFeeDescriptor: Ptsv2paymentsMerchantInformationServiceFeeDescriptor, - /** - * The Ptsv2paymentsOrderInformation model constructor. - * @property {module:model/Ptsv2paymentsOrderInformation} - */ - Ptsv2paymentsOrderInformation: Ptsv2paymentsOrderInformation, - /** - * The Ptsv2paymentsOrderInformationAmountDetails model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationAmountDetails} - */ - Ptsv2paymentsOrderInformationAmountDetails: Ptsv2paymentsOrderInformationAmountDetails, - /** - * The Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts} - */ - Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts: Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts, - /** - * The Ptsv2paymentsOrderInformationAmountDetailsSurcharge model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge} - */ - Ptsv2paymentsOrderInformationAmountDetailsSurcharge: Ptsv2paymentsOrderInformationAmountDetailsSurcharge, - /** - * The Ptsv2paymentsOrderInformationAmountDetailsTaxDetails model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails} - */ - Ptsv2paymentsOrderInformationAmountDetailsTaxDetails: Ptsv2paymentsOrderInformationAmountDetailsTaxDetails, - /** - * The Ptsv2paymentsOrderInformationBillTo model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationBillTo} - */ - Ptsv2paymentsOrderInformationBillTo: Ptsv2paymentsOrderInformationBillTo, - /** - * The Ptsv2paymentsOrderInformationBillToCompany model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationBillToCompany} - */ - Ptsv2paymentsOrderInformationBillToCompany: Ptsv2paymentsOrderInformationBillToCompany, - /** - * The Ptsv2paymentsOrderInformationInvoiceDetails model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationInvoiceDetails} - */ - Ptsv2paymentsOrderInformationInvoiceDetails: Ptsv2paymentsOrderInformationInvoiceDetails, - /** - * The Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum} - */ - Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum: Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum, - /** - * The Ptsv2paymentsOrderInformationLineItems model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationLineItems} - */ - Ptsv2paymentsOrderInformationLineItems: Ptsv2paymentsOrderInformationLineItems, - /** - * The Ptsv2paymentsOrderInformationShipTo model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationShipTo} - */ - Ptsv2paymentsOrderInformationShipTo: Ptsv2paymentsOrderInformationShipTo, - /** - * The Ptsv2paymentsOrderInformationShippingDetails model constructor. - * @property {module:model/Ptsv2paymentsOrderInformationShippingDetails} - */ - Ptsv2paymentsOrderInformationShippingDetails: Ptsv2paymentsOrderInformationShippingDetails, - /** - * The Ptsv2paymentsPaymentInformation model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformation} - */ - Ptsv2paymentsPaymentInformation: Ptsv2paymentsPaymentInformation, - /** - * The Ptsv2paymentsPaymentInformationBank model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationBank} - */ - Ptsv2paymentsPaymentInformationBank: Ptsv2paymentsPaymentInformationBank, - /** - * The Ptsv2paymentsPaymentInformationBankAccount model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationBankAccount} - */ - Ptsv2paymentsPaymentInformationBankAccount: Ptsv2paymentsPaymentInformationBankAccount, - /** - * The Ptsv2paymentsPaymentInformationCard model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationCard} - */ - Ptsv2paymentsPaymentInformationCard: Ptsv2paymentsPaymentInformationCard, - /** - * The Ptsv2paymentsPaymentInformationCustomer model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationCustomer} - */ - Ptsv2paymentsPaymentInformationCustomer: Ptsv2paymentsPaymentInformationCustomer, - /** - * The Ptsv2paymentsPaymentInformationFluidData model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationFluidData} - */ - Ptsv2paymentsPaymentInformationFluidData: Ptsv2paymentsPaymentInformationFluidData, - /** - * The Ptsv2paymentsPaymentInformationTokenizedCard model constructor. - * @property {module:model/Ptsv2paymentsPaymentInformationTokenizedCard} - */ - Ptsv2paymentsPaymentInformationTokenizedCard: Ptsv2paymentsPaymentInformationTokenizedCard, - /** - * The Ptsv2paymentsPointOfSaleInformation model constructor. - * @property {module:model/Ptsv2paymentsPointOfSaleInformation} - */ - Ptsv2paymentsPointOfSaleInformation: Ptsv2paymentsPointOfSaleInformation, - /** - * The Ptsv2paymentsPointOfSaleInformationEmv model constructor. - * @property {module:model/Ptsv2paymentsPointOfSaleInformationEmv} - */ - Ptsv2paymentsPointOfSaleInformationEmv: Ptsv2paymentsPointOfSaleInformationEmv, - /** - * The Ptsv2paymentsProcessingInformation model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformation} - */ - Ptsv2paymentsProcessingInformation: Ptsv2paymentsProcessingInformation, - /** - * The Ptsv2paymentsProcessingInformationAuthorizationOptions model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptions} - */ - Ptsv2paymentsProcessingInformationAuthorizationOptions: Ptsv2paymentsProcessingInformationAuthorizationOptions, - /** - * The Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator} - */ - Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator: Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator, - /** - * The Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction} - */ - Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction: Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, - /** - * The Ptsv2paymentsProcessingInformationBankTransferOptions model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationBankTransferOptions} - */ - Ptsv2paymentsProcessingInformationBankTransferOptions: Ptsv2paymentsProcessingInformationBankTransferOptions, - /** - * The Ptsv2paymentsProcessingInformationCaptureOptions model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationCaptureOptions} - */ - Ptsv2paymentsProcessingInformationCaptureOptions: Ptsv2paymentsProcessingInformationCaptureOptions, - /** - * The Ptsv2paymentsProcessingInformationRecurringOptions model constructor. - * @property {module:model/Ptsv2paymentsProcessingInformationRecurringOptions} - */ - Ptsv2paymentsProcessingInformationRecurringOptions: Ptsv2paymentsProcessingInformationRecurringOptions, - /** - * The Ptsv2paymentsRecipientInformation model constructor. - * @property {module:model/Ptsv2paymentsRecipientInformation} - */ - Ptsv2paymentsRecipientInformation: Ptsv2paymentsRecipientInformation, - /** - * The Ptsv2paymentsidcapturesAggregatorInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesAggregatorInformation} - */ - Ptsv2paymentsidcapturesAggregatorInformation: Ptsv2paymentsidcapturesAggregatorInformation, - /** - * The Ptsv2paymentsidcapturesAggregatorInformationSubMerchant model constructor. - * @property {module:model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant} - */ - Ptsv2paymentsidcapturesAggregatorInformationSubMerchant: Ptsv2paymentsidcapturesAggregatorInformationSubMerchant, - /** - * The Ptsv2paymentsidcapturesBuyerInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesBuyerInformation} - */ - Ptsv2paymentsidcapturesBuyerInformation: Ptsv2paymentsidcapturesBuyerInformation, - /** - * The Ptsv2paymentsidcapturesInstallmentInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesInstallmentInformation} - */ - Ptsv2paymentsidcapturesInstallmentInformation: Ptsv2paymentsidcapturesInstallmentInformation, - /** - * The Ptsv2paymentsidcapturesMerchantInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesMerchantInformation} - */ - Ptsv2paymentsidcapturesMerchantInformation: Ptsv2paymentsidcapturesMerchantInformation, - /** - * The Ptsv2paymentsidcapturesOrderInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformation} - */ - Ptsv2paymentsidcapturesOrderInformation: Ptsv2paymentsidcapturesOrderInformation, - /** - * The Ptsv2paymentsidcapturesOrderInformationAmountDetails model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformationAmountDetails} - */ - Ptsv2paymentsidcapturesOrderInformationAmountDetails: Ptsv2paymentsidcapturesOrderInformationAmountDetails, - /** - * The Ptsv2paymentsidcapturesOrderInformationBillTo model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformationBillTo} - */ - Ptsv2paymentsidcapturesOrderInformationBillTo: Ptsv2paymentsidcapturesOrderInformationBillTo, - /** - * The Ptsv2paymentsidcapturesOrderInformationInvoiceDetails model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails} - */ - Ptsv2paymentsidcapturesOrderInformationInvoiceDetails: Ptsv2paymentsidcapturesOrderInformationInvoiceDetails, - /** - * The Ptsv2paymentsidcapturesOrderInformationShipTo model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformationShipTo} - */ - Ptsv2paymentsidcapturesOrderInformationShipTo: Ptsv2paymentsidcapturesOrderInformationShipTo, - /** - * The Ptsv2paymentsidcapturesOrderInformationShippingDetails model constructor. - * @property {module:model/Ptsv2paymentsidcapturesOrderInformationShippingDetails} - */ - Ptsv2paymentsidcapturesOrderInformationShippingDetails: Ptsv2paymentsidcapturesOrderInformationShippingDetails, - /** - * The Ptsv2paymentsidcapturesPaymentInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesPaymentInformation} - */ - Ptsv2paymentsidcapturesPaymentInformation: Ptsv2paymentsidcapturesPaymentInformation, - /** - * The Ptsv2paymentsidcapturesPointOfSaleInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesPointOfSaleInformation} - */ - Ptsv2paymentsidcapturesPointOfSaleInformation: Ptsv2paymentsidcapturesPointOfSaleInformation, - /** - * The Ptsv2paymentsidcapturesPointOfSaleInformationEmv model constructor. - * @property {module:model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv} - */ - Ptsv2paymentsidcapturesPointOfSaleInformationEmv: Ptsv2paymentsidcapturesPointOfSaleInformationEmv, - /** - * The Ptsv2paymentsidcapturesProcessingInformation model constructor. - * @property {module:model/Ptsv2paymentsidcapturesProcessingInformation} - */ - Ptsv2paymentsidcapturesProcessingInformation: Ptsv2paymentsidcapturesProcessingInformation, - /** - * The Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions model constructor. - * @property {module:model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions} - */ - Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions: Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions, - /** - * The Ptsv2paymentsidcapturesProcessingInformationCaptureOptions model constructor. - * @property {module:model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions} - */ - Ptsv2paymentsidcapturesProcessingInformationCaptureOptions: Ptsv2paymentsidcapturesProcessingInformationCaptureOptions, - /** - * The Ptsv2paymentsidrefundsMerchantInformation model constructor. - * @property {module:model/Ptsv2paymentsidrefundsMerchantInformation} - */ - Ptsv2paymentsidrefundsMerchantInformation: Ptsv2paymentsidrefundsMerchantInformation, - /** - * The Ptsv2paymentsidrefundsOrderInformation model constructor. - * @property {module:model/Ptsv2paymentsidrefundsOrderInformation} - */ - Ptsv2paymentsidrefundsOrderInformation: Ptsv2paymentsidrefundsOrderInformation, - /** - * The Ptsv2paymentsidrefundsOrderInformationLineItems model constructor. - * @property {module:model/Ptsv2paymentsidrefundsOrderInformationLineItems} - */ - Ptsv2paymentsidrefundsOrderInformationLineItems: Ptsv2paymentsidrefundsOrderInformationLineItems, - /** - * The Ptsv2paymentsidrefundsPaymentInformation model constructor. - * @property {module:model/Ptsv2paymentsidrefundsPaymentInformation} - */ - Ptsv2paymentsidrefundsPaymentInformation: Ptsv2paymentsidrefundsPaymentInformation, - /** - * The Ptsv2paymentsidrefundsPaymentInformationCard model constructor. - * @property {module:model/Ptsv2paymentsidrefundsPaymentInformationCard} - */ - Ptsv2paymentsidrefundsPaymentInformationCard: Ptsv2paymentsidrefundsPaymentInformationCard, - /** - * The Ptsv2paymentsidrefundsPointOfSaleInformation model constructor. - * @property {module:model/Ptsv2paymentsidrefundsPointOfSaleInformation} - */ - Ptsv2paymentsidrefundsPointOfSaleInformation: Ptsv2paymentsidrefundsPointOfSaleInformation, - /** - * The Ptsv2paymentsidrefundsProcessingInformation model constructor. - * @property {module:model/Ptsv2paymentsidrefundsProcessingInformation} - */ - Ptsv2paymentsidrefundsProcessingInformation: Ptsv2paymentsidrefundsProcessingInformation, - /** - * The Ptsv2paymentsidrefundsProcessingInformationRecurringOptions model constructor. - * @property {module:model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions} - */ - Ptsv2paymentsidrefundsProcessingInformationRecurringOptions: Ptsv2paymentsidrefundsProcessingInformationRecurringOptions, - /** - * The Ptsv2paymentsidreversalsClientReferenceInformation model constructor. - * @property {module:model/Ptsv2paymentsidreversalsClientReferenceInformation} - */ - Ptsv2paymentsidreversalsClientReferenceInformation: Ptsv2paymentsidreversalsClientReferenceInformation, - /** - * The Ptsv2paymentsidreversalsClientReferenceInformationPartner model constructor. - * @property {module:model/Ptsv2paymentsidreversalsClientReferenceInformationPartner} - */ - Ptsv2paymentsidreversalsClientReferenceInformationPartner: Ptsv2paymentsidreversalsClientReferenceInformationPartner, - /** - * The Ptsv2paymentsidreversalsOrderInformation model constructor. - * @property {module:model/Ptsv2paymentsidreversalsOrderInformation} - */ - Ptsv2paymentsidreversalsOrderInformation: Ptsv2paymentsidreversalsOrderInformation, - /** - * The Ptsv2paymentsidreversalsOrderInformationAmountDetails model constructor. - * @property {module:model/Ptsv2paymentsidreversalsOrderInformationAmountDetails} - */ - Ptsv2paymentsidreversalsOrderInformationAmountDetails: Ptsv2paymentsidreversalsOrderInformationAmountDetails, - /** - * The Ptsv2paymentsidreversalsOrderInformationLineItems model constructor. - * @property {module:model/Ptsv2paymentsidreversalsOrderInformationLineItems} - */ - Ptsv2paymentsidreversalsOrderInformationLineItems: Ptsv2paymentsidreversalsOrderInformationLineItems, - /** - * The Ptsv2paymentsidreversalsPointOfSaleInformation model constructor. - * @property {module:model/Ptsv2paymentsidreversalsPointOfSaleInformation} - */ - Ptsv2paymentsidreversalsPointOfSaleInformation: Ptsv2paymentsidreversalsPointOfSaleInformation, - /** - * The Ptsv2paymentsidreversalsProcessingInformation model constructor. - * @property {module:model/Ptsv2paymentsidreversalsProcessingInformation} - */ - Ptsv2paymentsidreversalsProcessingInformation: Ptsv2paymentsidreversalsProcessingInformation, - /** - * The Ptsv2paymentsidreversalsReversalInformation model constructor. - * @property {module:model/Ptsv2paymentsidreversalsReversalInformation} - */ - Ptsv2paymentsidreversalsReversalInformation: Ptsv2paymentsidreversalsReversalInformation, - /** - * The Ptsv2paymentsidreversalsReversalInformationAmountDetails model constructor. - * @property {module:model/Ptsv2paymentsidreversalsReversalInformationAmountDetails} - */ - Ptsv2paymentsidreversalsReversalInformationAmountDetails: Ptsv2paymentsidreversalsReversalInformationAmountDetails, - /** - * The Ptsv2payoutsClientReferenceInformation model constructor. - * @property {module:model/Ptsv2payoutsClientReferenceInformation} - */ - Ptsv2payoutsClientReferenceInformation: Ptsv2payoutsClientReferenceInformation, - /** - * The Ptsv2payoutsMerchantInformation model constructor. - * @property {module:model/Ptsv2payoutsMerchantInformation} - */ - Ptsv2payoutsMerchantInformation: Ptsv2payoutsMerchantInformation, - /** - * The Ptsv2payoutsMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/Ptsv2payoutsMerchantInformationMerchantDescriptor} - */ - Ptsv2payoutsMerchantInformationMerchantDescriptor: Ptsv2payoutsMerchantInformationMerchantDescriptor, - /** - * The Ptsv2payoutsOrderInformation model constructor. - * @property {module:model/Ptsv2payoutsOrderInformation} - */ - Ptsv2payoutsOrderInformation: Ptsv2payoutsOrderInformation, - /** - * The Ptsv2payoutsOrderInformationAmountDetails model constructor. - * @property {module:model/Ptsv2payoutsOrderInformationAmountDetails} - */ - Ptsv2payoutsOrderInformationAmountDetails: Ptsv2payoutsOrderInformationAmountDetails, - /** - * The Ptsv2payoutsOrderInformationAmountDetailsSurcharge model constructor. - * @property {module:model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge} - */ - Ptsv2payoutsOrderInformationAmountDetailsSurcharge: Ptsv2payoutsOrderInformationAmountDetailsSurcharge, - /** - * The Ptsv2payoutsOrderInformationBillTo model constructor. - * @property {module:model/Ptsv2payoutsOrderInformationBillTo} - */ - Ptsv2payoutsOrderInformationBillTo: Ptsv2payoutsOrderInformationBillTo, - /** - * The Ptsv2payoutsPaymentInformation model constructor. - * @property {module:model/Ptsv2payoutsPaymentInformation} - */ - Ptsv2payoutsPaymentInformation: Ptsv2payoutsPaymentInformation, - /** - * The Ptsv2payoutsPaymentInformationCard model constructor. - * @property {module:model/Ptsv2payoutsPaymentInformationCard} - */ - Ptsv2payoutsPaymentInformationCard: Ptsv2payoutsPaymentInformationCard, - /** - * The Ptsv2payoutsProcessingInformation model constructor. - * @property {module:model/Ptsv2payoutsProcessingInformation} - */ - Ptsv2payoutsProcessingInformation: Ptsv2payoutsProcessingInformation, - /** - * The Ptsv2payoutsProcessingInformationPayoutsOptions model constructor. - * @property {module:model/Ptsv2payoutsProcessingInformationPayoutsOptions} - */ - Ptsv2payoutsProcessingInformationPayoutsOptions: Ptsv2payoutsProcessingInformationPayoutsOptions, - /** - * The Ptsv2payoutsRecipientInformation model constructor. - * @property {module:model/Ptsv2payoutsRecipientInformation} - */ - Ptsv2payoutsRecipientInformation: Ptsv2payoutsRecipientInformation, - /** - * The Ptsv2payoutsSenderInformation model constructor. - * @property {module:model/Ptsv2payoutsSenderInformation} - */ - Ptsv2payoutsSenderInformation: Ptsv2payoutsSenderInformation, - /** - * The Ptsv2payoutsSenderInformationAccount model constructor. - * @property {module:model/Ptsv2payoutsSenderInformationAccount} - */ - Ptsv2payoutsSenderInformationAccount: Ptsv2payoutsSenderInformationAccount, - /** - * The RefundCaptureRequest model constructor. - * @property {module:model/RefundCaptureRequest} - */ - RefundCaptureRequest: RefundCaptureRequest, - /** - * The RefundPaymentRequest model constructor. - * @property {module:model/RefundPaymentRequest} - */ - RefundPaymentRequest: RefundPaymentRequest, - /** - * The ReportingV3ConversionDetailsGet200Response model constructor. - * @property {module:model/ReportingV3ConversionDetailsGet200Response} - */ - ReportingV3ConversionDetailsGet200Response: ReportingV3ConversionDetailsGet200Response, - /** - * The ReportingV3ConversionDetailsGet200ResponseConversionDetails model constructor. - * @property {module:model/ReportingV3ConversionDetailsGet200ResponseConversionDetails} - */ - ReportingV3ConversionDetailsGet200ResponseConversionDetails: ReportingV3ConversionDetailsGet200ResponseConversionDetails, - /** - * The ReportingV3ConversionDetailsGet200ResponseNotes model constructor. - * @property {module:model/ReportingV3ConversionDetailsGet200ResponseNotes} - */ - ReportingV3ConversionDetailsGet200ResponseNotes: ReportingV3ConversionDetailsGet200ResponseNotes, - /** - * The ReportingV3NetFundingsGet200Response model constructor. - * @property {module:model/ReportingV3NetFundingsGet200Response} - */ - ReportingV3NetFundingsGet200Response: ReportingV3NetFundingsGet200Response, - /** - * The ReportingV3NetFundingsGet200ResponseNetFundingSummaries model constructor. - * @property {module:model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries} - */ - ReportingV3NetFundingsGet200ResponseNetFundingSummaries: ReportingV3NetFundingsGet200ResponseNetFundingSummaries, - /** - * The ReportingV3NetFundingsGet200ResponseTotalPurchases model constructor. - * @property {module:model/ReportingV3NetFundingsGet200ResponseTotalPurchases} - */ - ReportingV3NetFundingsGet200ResponseTotalPurchases: ReportingV3NetFundingsGet200ResponseTotalPurchases, - /** - * The ReportingV3NotificationofChangesGet200Response model constructor. - * @property {module:model/ReportingV3NotificationofChangesGet200Response} - */ - ReportingV3NotificationofChangesGet200Response: ReportingV3NotificationofChangesGet200Response, - /** - * The ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges model constructor. - * @property {module:model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges} - */ - ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges: ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges, - /** - * The ReportingV3PurchaseRefundDetailsGet200Response model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200Response} - */ - ReportingV3PurchaseRefundDetailsGet200Response: ReportingV3PurchaseRefundDetailsGet200Response, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations: ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails: ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseOthers model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseOthers: ReportingV3PurchaseRefundDetailsGet200ResponseOthers, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails: ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses: ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses, - /** - * The ReportingV3PurchaseRefundDetailsGet200ResponseSettlements model constructor. - * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements} - */ - ReportingV3PurchaseRefundDetailsGet200ResponseSettlements: ReportingV3PurchaseRefundDetailsGet200ResponseSettlements, - /** - * The ReportingV3ReportDefinitionsGet200Response model constructor. - * @property {module:model/ReportingV3ReportDefinitionsGet200Response} - */ - ReportingV3ReportDefinitionsGet200Response: ReportingV3ReportDefinitionsGet200Response, - /** - * The ReportingV3ReportDefinitionsGet200ResponseReportDefinitions model constructor. - * @property {module:model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions} - */ - ReportingV3ReportDefinitionsGet200ResponseReportDefinitions: ReportingV3ReportDefinitionsGet200ResponseReportDefinitions, - /** - * The ReportingV3ReportDefinitionsNameGet200Response model constructor. - * @property {module:model/ReportingV3ReportDefinitionsNameGet200Response} - */ - ReportingV3ReportDefinitionsNameGet200Response: ReportingV3ReportDefinitionsNameGet200Response, - /** - * The ReportingV3ReportDefinitionsNameGet200ResponseAttributes model constructor. - * @property {module:model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes} - */ - ReportingV3ReportDefinitionsNameGet200ResponseAttributes: ReportingV3ReportDefinitionsNameGet200ResponseAttributes, - /** - * The ReportingV3ReportSubscriptionsGet200Response model constructor. - * @property {module:model/ReportingV3ReportSubscriptionsGet200Response} - */ - ReportingV3ReportSubscriptionsGet200Response: ReportingV3ReportSubscriptionsGet200Response, - /** - * The ReportingV3ReportSubscriptionsGet200ResponseSubscriptions model constructor. - * @property {module:model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions} - */ - ReportingV3ReportSubscriptionsGet200ResponseSubscriptions: ReportingV3ReportSubscriptionsGet200ResponseSubscriptions, - /** - * The ReportingV3ReportsGet200Response model constructor. - * @property {module:model/ReportingV3ReportsGet200Response} - */ - ReportingV3ReportsGet200Response: ReportingV3ReportsGet200Response, - /** - * The ReportingV3ReportsGet200ResponseReports model constructor. - * @property {module:model/ReportingV3ReportsGet200ResponseReports} - */ - ReportingV3ReportsGet200ResponseReports: ReportingV3ReportsGet200ResponseReports, - /** - * The ReportingV3ReportsIdGet200Response model constructor. - * @property {module:model/ReportingV3ReportsIdGet200Response} - */ - ReportingV3ReportsIdGet200Response: ReportingV3ReportsIdGet200Response, - /** - * The Reportingv3ReportDownloadsGet400Response model constructor. - * @property {module:model/Reportingv3ReportDownloadsGet400Response} - */ - Reportingv3ReportDownloadsGet400Response: Reportingv3ReportDownloadsGet400Response, - /** - * The Reportingv3ReportDownloadsGet400ResponseDetails model constructor. - * @property {module:model/Reportingv3ReportDownloadsGet400ResponseDetails} - */ - Reportingv3ReportDownloadsGet400ResponseDetails: Reportingv3ReportDownloadsGet400ResponseDetails, - /** - * The Reportingv3reportsReportPreferences model constructor. - * @property {module:model/Reportingv3reportsReportPreferences} - */ - Reportingv3reportsReportPreferences: Reportingv3reportsReportPreferences, - /** - * The RequestBody model constructor. - * @property {module:model/RequestBody} - */ - RequestBody: RequestBody, - /** - * The RequestBody1 model constructor. - * @property {module:model/RequestBody1} - */ - RequestBody1: RequestBody1, - /** - * The RiskV1DecisionsPost201Response model constructor. - * @property {module:model/RiskV1DecisionsPost201Response} - */ - RiskV1DecisionsPost201Response: RiskV1DecisionsPost201Response, - /** - * The RiskV1DecisionsPost201ResponseRiskInformation model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformation} - */ - RiskV1DecisionsPost201ResponseRiskInformation: RiskV1DecisionsPost201ResponseRiskInformation, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationInfoCodes model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes} - */ - RiskV1DecisionsPost201ResponseRiskInformationInfoCodes: RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationIpAddress model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress} - */ - RiskV1DecisionsPost201ResponseRiskInformationIpAddress: RiskV1DecisionsPost201ResponseRiskInformationIpAddress, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation} - */ - RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation: RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationProfile model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProfile} - */ - RiskV1DecisionsPost201ResponseRiskInformationProfile: RiskV1DecisionsPost201ResponseRiskInformationProfile, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationProviders model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProviders} - */ - RiskV1DecisionsPost201ResponseRiskInformationProviders: RiskV1DecisionsPost201ResponseRiskInformationProviders, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName} - */ - RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName: RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationRules model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationRules} - */ - RiskV1DecisionsPost201ResponseRiskInformationRules: RiskV1DecisionsPost201ResponseRiskInformationRules, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationScore model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationScore} - */ - RiskV1DecisionsPost201ResponseRiskInformationScore: RiskV1DecisionsPost201ResponseRiskInformationScore, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationVelocity model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationVelocity} - */ - RiskV1DecisionsPost201ResponseRiskInformationVelocity: RiskV1DecisionsPost201ResponseRiskInformationVelocity, - /** - * The RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing model constructor. - * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing} - */ - RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing: RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing, - /** - * The RiskV1DecisionsPost400Response model constructor. - * @property {module:model/RiskV1DecisionsPost400Response} - */ - RiskV1DecisionsPost400Response: RiskV1DecisionsPost400Response, - /** - * The Riskv1decisionsBuyerInformation model constructor. - * @property {module:model/Riskv1decisionsBuyerInformation} - */ - Riskv1decisionsBuyerInformation: Riskv1decisionsBuyerInformation, - /** - * The Riskv1decisionsCardVerification model constructor. - * @property {module:model/Riskv1decisionsCardVerification} - */ - Riskv1decisionsCardVerification: Riskv1decisionsCardVerification, - /** - * The Riskv1decisionsClientReferenceInformation model constructor. - * @property {module:model/Riskv1decisionsClientReferenceInformation} - */ - Riskv1decisionsClientReferenceInformation: Riskv1decisionsClientReferenceInformation, - /** - * The Riskv1decisionsDeviceInformation model constructor. - * @property {module:model/Riskv1decisionsDeviceInformation} - */ - Riskv1decisionsDeviceInformation: Riskv1decisionsDeviceInformation, - /** - * The Riskv1decisionsMerchantDefinedInformation model constructor. - * @property {module:model/Riskv1decisionsMerchantDefinedInformation} - */ - Riskv1decisionsMerchantDefinedInformation: Riskv1decisionsMerchantDefinedInformation, - /** - * The Riskv1decisionsOrderInformation model constructor. - * @property {module:model/Riskv1decisionsOrderInformation} - */ - Riskv1decisionsOrderInformation: Riskv1decisionsOrderInformation, - /** - * The Riskv1decisionsOrderInformationAmountDetails model constructor. - * @property {module:model/Riskv1decisionsOrderInformationAmountDetails} - */ - Riskv1decisionsOrderInformationAmountDetails: Riskv1decisionsOrderInformationAmountDetails, - /** - * The Riskv1decisionsOrderInformationBillTo model constructor. - * @property {module:model/Riskv1decisionsOrderInformationBillTo} - */ - Riskv1decisionsOrderInformationBillTo: Riskv1decisionsOrderInformationBillTo, - /** - * The Riskv1decisionsOrderInformationLineItems model constructor. - * @property {module:model/Riskv1decisionsOrderInformationLineItems} - */ - Riskv1decisionsOrderInformationLineItems: Riskv1decisionsOrderInformationLineItems, - /** - * The Riskv1decisionsOrderInformationPassenger model constructor. - * @property {module:model/Riskv1decisionsOrderInformationPassenger} - */ - Riskv1decisionsOrderInformationPassenger: Riskv1decisionsOrderInformationPassenger, - /** - * The Riskv1decisionsOrderInformationShipTo model constructor. - * @property {module:model/Riskv1decisionsOrderInformationShipTo} - */ - Riskv1decisionsOrderInformationShipTo: Riskv1decisionsOrderInformationShipTo, - /** - * The Riskv1decisionsOrderInformationShippingDetails model constructor. - * @property {module:model/Riskv1decisionsOrderInformationShippingDetails} - */ - Riskv1decisionsOrderInformationShippingDetails: Riskv1decisionsOrderInformationShippingDetails, - /** - * The Riskv1decisionsPaymentInformation model constructor. - * @property {module:model/Riskv1decisionsPaymentInformation} - */ - Riskv1decisionsPaymentInformation: Riskv1decisionsPaymentInformation, - /** - * The Riskv1decisionsPaymentInformationCard model constructor. - * @property {module:model/Riskv1decisionsPaymentInformationCard} - */ - Riskv1decisionsPaymentInformationCard: Riskv1decisionsPaymentInformationCard, - /** - * The Riskv1decisionsPaymentInformationTokenizedCard model constructor. - * @property {module:model/Riskv1decisionsPaymentInformationTokenizedCard} - */ - Riskv1decisionsPaymentInformationTokenizedCard: Riskv1decisionsPaymentInformationTokenizedCard, - /** - * The Riskv1decisionsProcessorInformation model constructor. - * @property {module:model/Riskv1decisionsProcessorInformation} - */ - Riskv1decisionsProcessorInformation: Riskv1decisionsProcessorInformation, - /** - * The Riskv1decisionsProcessorInformationAvs model constructor. - * @property {module:model/Riskv1decisionsProcessorInformationAvs} - */ - Riskv1decisionsProcessorInformationAvs: Riskv1decisionsProcessorInformationAvs, - /** - * The Riskv1decisionsRiskInformation model constructor. - * @property {module:model/Riskv1decisionsRiskInformation} - */ - Riskv1decisionsRiskInformation: Riskv1decisionsRiskInformation, - /** - * The Riskv1decisionsRiskInformationProfile model constructor. - * @property {module:model/Riskv1decisionsRiskInformationProfile} - */ - Riskv1decisionsRiskInformationProfile: Riskv1decisionsRiskInformationProfile, - /** - * The Riskv1decisionsTravelInformation model constructor. - * @property {module:model/Riskv1decisionsTravelInformation} - */ - Riskv1decisionsTravelInformation: Riskv1decisionsTravelInformation, - /** - * The Riskv1decisionsTravelInformationLegs model constructor. - * @property {module:model/Riskv1decisionsTravelInformationLegs} - */ - Riskv1decisionsTravelInformationLegs: Riskv1decisionsTravelInformationLegs, - /** - * The TmsV1InstrumentIdentifiersDelete409Response model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersDelete409Response} - */ - TmsV1InstrumentIdentifiersDelete409Response: TmsV1InstrumentIdentifiersDelete409Response, - /** - * The TmsV1InstrumentIdentifiersDelete409ResponseLinks model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersDelete409ResponseLinks} - */ - TmsV1InstrumentIdentifiersDelete409ResponseLinks: TmsV1InstrumentIdentifiersDelete409ResponseLinks, - /** - * The TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments} - */ - TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments: TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments, - /** - * The TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response model constructor. - * @property {module:model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev, - /** - * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf} - */ - TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf, - /** - * The TmsV1InstrumentIdentifiersPost200Response model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200Response} - */ - TmsV1InstrumentIdentifiersPost200Response: TmsV1InstrumentIdentifiersPost200Response, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseBankAccount model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount} - */ - TmsV1InstrumentIdentifiersPost200ResponseBankAccount: TmsV1InstrumentIdentifiersPost200ResponseBankAccount, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseCard model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseCard} - */ - TmsV1InstrumentIdentifiersPost200ResponseCard: TmsV1InstrumentIdentifiersPost200ResponseCard, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseLinks model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinks} - */ - TmsV1InstrumentIdentifiersPost200ResponseLinks: TmsV1InstrumentIdentifiersPost200ResponseLinks, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseLinksSelf model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf} - */ - TmsV1InstrumentIdentifiersPost200ResponseLinksSelf: TmsV1InstrumentIdentifiersPost200ResponseLinksSelf, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseMetadata model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseMetadata} - */ - TmsV1InstrumentIdentifiersPost200ResponseMetadata: TmsV1InstrumentIdentifiersPost200ResponseMetadata, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation} - */ - TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions} - */ - TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator} - */ - TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator, - /** - * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction model constructor. - * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction} - */ - TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, - /** - * The Tmsv1instrumentidentifiersBillTo model constructor. - * @property {module:model/Tmsv1instrumentidentifiersBillTo} - */ - Tmsv1instrumentidentifiersBillTo: Tmsv1instrumentidentifiersBillTo, - /** - * The Tmsv1instrumentidentifiersCard model constructor. - * @property {module:model/Tmsv1instrumentidentifiersCard} - */ - Tmsv1instrumentidentifiersCard: Tmsv1instrumentidentifiersCard, - /** - * The Tmsv1instrumentidentifiersDetails model constructor. - * @property {module:model/Tmsv1instrumentidentifiersDetails} - */ - Tmsv1instrumentidentifiersDetails: Tmsv1instrumentidentifiersDetails, - /** - * The TokenizeRequest model constructor. - * @property {module:model/TokenizeRequest} - */ - TokenizeRequest: TokenizeRequest, - /** - * The TssV2TransactionsGet200Response model constructor. - * @property {module:model/TssV2TransactionsGet200Response} - */ - TssV2TransactionsGet200Response: TssV2TransactionsGet200Response, - /** - * The TssV2TransactionsGet200ResponseApplicationInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseApplicationInformation} - */ - TssV2TransactionsGet200ResponseApplicationInformation: TssV2TransactionsGet200ResponseApplicationInformation, - /** - * The TssV2TransactionsGet200ResponseApplicationInformationApplications model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseApplicationInformationApplications} - */ - TssV2TransactionsGet200ResponseApplicationInformationApplications: TssV2TransactionsGet200ResponseApplicationInformationApplications, - /** - * The TssV2TransactionsGet200ResponseBuyerInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseBuyerInformation} - */ - TssV2TransactionsGet200ResponseBuyerInformation: TssV2TransactionsGet200ResponseBuyerInformation, - /** - * The TssV2TransactionsGet200ResponseClientReferenceInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseClientReferenceInformation} - */ - TssV2TransactionsGet200ResponseClientReferenceInformation: TssV2TransactionsGet200ResponseClientReferenceInformation, - /** - * The TssV2TransactionsGet200ResponseConsumerAuthenticationInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation} - */ - TssV2TransactionsGet200ResponseConsumerAuthenticationInformation: TssV2TransactionsGet200ResponseConsumerAuthenticationInformation, - /** - * The TssV2TransactionsGet200ResponseDeviceInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseDeviceInformation} - */ - TssV2TransactionsGet200ResponseDeviceInformation: TssV2TransactionsGet200ResponseDeviceInformation, - /** - * The TssV2TransactionsGet200ResponseErrorInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseErrorInformation} - */ - TssV2TransactionsGet200ResponseErrorInformation: TssV2TransactionsGet200ResponseErrorInformation, - /** - * The TssV2TransactionsGet200ResponseFraudMarkingInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseFraudMarkingInformation} - */ - TssV2TransactionsGet200ResponseFraudMarkingInformation: TssV2TransactionsGet200ResponseFraudMarkingInformation, - /** - * The TssV2TransactionsGet200ResponseInstallmentInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseInstallmentInformation} - */ - TssV2TransactionsGet200ResponseInstallmentInformation: TssV2TransactionsGet200ResponseInstallmentInformation, - /** - * The TssV2TransactionsGet200ResponseLinks model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseLinks} - */ - TssV2TransactionsGet200ResponseLinks: TssV2TransactionsGet200ResponseLinks, - /** - * The TssV2TransactionsGet200ResponseMerchantInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseMerchantInformation} - */ - TssV2TransactionsGet200ResponseMerchantInformation: TssV2TransactionsGet200ResponseMerchantInformation, - /** - * The TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor} - */ - TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor: TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor, - /** - * The TssV2TransactionsGet200ResponseOrderInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformation} - */ - TssV2TransactionsGet200ResponseOrderInformation: TssV2TransactionsGet200ResponseOrderInformation, - /** - * The TssV2TransactionsGet200ResponseOrderInformationAmountDetails model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails} - */ - TssV2TransactionsGet200ResponseOrderInformationAmountDetails: TssV2TransactionsGet200ResponseOrderInformationAmountDetails, - /** - * The TssV2TransactionsGet200ResponseOrderInformationBillTo model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationBillTo} - */ - TssV2TransactionsGet200ResponseOrderInformationBillTo: TssV2TransactionsGet200ResponseOrderInformationBillTo, - /** - * The TssV2TransactionsGet200ResponseOrderInformationLineItems model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationLineItems} - */ - TssV2TransactionsGet200ResponseOrderInformationLineItems: TssV2TransactionsGet200ResponseOrderInformationLineItems, - /** - * The TssV2TransactionsGet200ResponseOrderInformationShipTo model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationShipTo} - */ - TssV2TransactionsGet200ResponseOrderInformationShipTo: TssV2TransactionsGet200ResponseOrderInformationShipTo, - /** - * The TssV2TransactionsGet200ResponseOrderInformationShippingDetails model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails} - */ - TssV2TransactionsGet200ResponseOrderInformationShippingDetails: TssV2TransactionsGet200ResponseOrderInformationShippingDetails, - /** - * The TssV2TransactionsGet200ResponsePaymentInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformation} - */ - TssV2TransactionsGet200ResponsePaymentInformation: TssV2TransactionsGet200ResponsePaymentInformation, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures} - */ - TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures: TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationBank model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBank} - */ - TssV2TransactionsGet200ResponsePaymentInformationBank: TssV2TransactionsGet200ResponsePaymentInformationBank, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationBankAccount model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount} - */ - TssV2TransactionsGet200ResponsePaymentInformationBankAccount: TssV2TransactionsGet200ResponsePaymentInformationBankAccount, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationBankMandate model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate} - */ - TssV2TransactionsGet200ResponsePaymentInformationBankMandate: TssV2TransactionsGet200ResponsePaymentInformationBankMandate, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationCard model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationCard} - */ - TssV2TransactionsGet200ResponsePaymentInformationCard: TssV2TransactionsGet200ResponsePaymentInformationCard, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationInvoice model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationInvoice} - */ - TssV2TransactionsGet200ResponsePaymentInformationInvoice: TssV2TransactionsGet200ResponsePaymentInformationInvoice, - /** - * The TssV2TransactionsGet200ResponsePaymentInformationPaymentType model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType} - */ - TssV2TransactionsGet200ResponsePaymentInformationPaymentType: TssV2TransactionsGet200ResponsePaymentInformationPaymentType, - /** - * The TssV2TransactionsGet200ResponsePointOfSaleInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponsePointOfSaleInformation} - */ - TssV2TransactionsGet200ResponsePointOfSaleInformation: TssV2TransactionsGet200ResponsePointOfSaleInformation, - /** - * The TssV2TransactionsGet200ResponseProcessingInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformation} - */ - TssV2TransactionsGet200ResponseProcessingInformation: TssV2TransactionsGet200ResponseProcessingInformation, - /** - * The TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions} - */ - TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions: TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions, - /** - * The TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions} - */ - TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions: TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions, - /** - * The TssV2TransactionsGet200ResponseProcessorInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformation} - */ - TssV2TransactionsGet200ResponseProcessorInformation: TssV2TransactionsGet200ResponseProcessorInformation, - /** - * The TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults} - */ - TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults: TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults, - /** - * The TssV2TransactionsGet200ResponseProcessorInformationProcessor model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformationProcessor} - */ - TssV2TransactionsGet200ResponseProcessorInformationProcessor: TssV2TransactionsGet200ResponseProcessorInformationProcessor, - /** - * The TssV2TransactionsGet200ResponseRiskInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseRiskInformation} - */ - TssV2TransactionsGet200ResponseRiskInformation: TssV2TransactionsGet200ResponseRiskInformation, - /** - * The TssV2TransactionsGet200ResponseRiskInformationProfile model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationProfile} - */ - TssV2TransactionsGet200ResponseRiskInformationProfile: TssV2TransactionsGet200ResponseRiskInformationProfile, - /** - * The TssV2TransactionsGet200ResponseRiskInformationRules model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationRules} - */ - TssV2TransactionsGet200ResponseRiskInformationRules: TssV2TransactionsGet200ResponseRiskInformationRules, - /** - * The TssV2TransactionsGet200ResponseRiskInformationScore model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationScore} - */ - TssV2TransactionsGet200ResponseRiskInformationScore: TssV2TransactionsGet200ResponseRiskInformationScore, - /** - * The TssV2TransactionsGet200ResponseSenderInformation model constructor. - * @property {module:model/TssV2TransactionsGet200ResponseSenderInformation} - */ - TssV2TransactionsGet200ResponseSenderInformation: TssV2TransactionsGet200ResponseSenderInformation, - /** - * The TssV2TransactionsPost201Response model constructor. - * @property {module:model/TssV2TransactionsPost201Response} - */ - TssV2TransactionsPost201Response: TssV2TransactionsPost201Response, - /** - * The TssV2TransactionsPost201ResponseEmbedded model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbedded} - */ - TssV2TransactionsPost201ResponseEmbedded: TssV2TransactionsPost201ResponseEmbedded, - /** - * The TssV2TransactionsPost201ResponseEmbeddedBuyerInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedBuyerInformation: TssV2TransactionsPost201ResponseEmbeddedBuyerInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation: TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation: TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedDeviceInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedDeviceInformation: TssV2TransactionsPost201ResponseEmbeddedDeviceInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedLinks model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedLinks} - */ - TssV2TransactionsPost201ResponseEmbeddedLinks: TssV2TransactionsPost201ResponseEmbeddedLinks, - /** - * The TssV2TransactionsPost201ResponseEmbeddedMerchantInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedMerchantInformation: TssV2TransactionsPost201ResponseEmbeddedMerchantInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedOrderInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedOrderInformation: TssV2TransactionsPost201ResponseEmbeddedOrderInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo} - */ - TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo: TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo, - /** - * The TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo} - */ - TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo: TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo, - /** - * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedPaymentInformation: TssV2TransactionsPost201ResponseEmbeddedPaymentInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard} - */ - TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard: TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard, - /** - * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType} - */ - TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType: TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType, - /** - * The TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation: TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedProcessingInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedProcessingInformation: TssV2TransactionsPost201ResponseEmbeddedProcessingInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedProcessorInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedProcessorInformation: TssV2TransactionsPost201ResponseEmbeddedProcessorInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedRiskInformation model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation} - */ - TssV2TransactionsPost201ResponseEmbeddedRiskInformation: TssV2TransactionsPost201ResponseEmbeddedRiskInformation, - /** - * The TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders} - */ - TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders: TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders, - /** - * The TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint} - */ - TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint: TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint, - /** - * The TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries model constructor. - * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries} - */ - TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries: TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries, - /** - * The TssV2TransactionsPost400Response model constructor. - * @property {module:model/TssV2TransactionsPost400Response} - */ - TssV2TransactionsPost400Response: TssV2TransactionsPost400Response, - /** - * The UmsV1UsersGet200Response model constructor. - * @property {module:model/UmsV1UsersGet200Response} - */ - UmsV1UsersGet200Response: UmsV1UsersGet200Response, - /** - * The UmsV1UsersGet200ResponseAccountInformation model constructor. - * @property {module:model/UmsV1UsersGet200ResponseAccountInformation} - */ - UmsV1UsersGet200ResponseAccountInformation: UmsV1UsersGet200ResponseAccountInformation, - /** - * The UmsV1UsersGet200ResponseContactInformation model constructor. - * @property {module:model/UmsV1UsersGet200ResponseContactInformation} - */ - UmsV1UsersGet200ResponseContactInformation: UmsV1UsersGet200ResponseContactInformation, - /** - * The UmsV1UsersGet200ResponseOrganizationInformation model constructor. - * @property {module:model/UmsV1UsersGet200ResponseOrganizationInformation} - */ - UmsV1UsersGet200ResponseOrganizationInformation: UmsV1UsersGet200ResponseOrganizationInformation, - /** - * The UmsV1UsersGet200ResponseUsers model constructor. - * @property {module:model/UmsV1UsersGet200ResponseUsers} - */ - UmsV1UsersGet200ResponseUsers: UmsV1UsersGet200ResponseUsers, - /** - * The UpdateInstrumentIdentifierRequest model constructor. - * @property {module:model/UpdateInstrumentIdentifierRequest} - */ - UpdateInstrumentIdentifierRequest: UpdateInstrumentIdentifierRequest, - /** - * The UpdatePaymentInstrumentRequest model constructor. - * @property {module:model/UpdatePaymentInstrumentRequest} - */ - UpdatePaymentInstrumentRequest: UpdatePaymentInstrumentRequest, - /** - * The V1FileDetailsGet200Response model constructor. - * @property {module:model/V1FileDetailsGet200Response} - */ - V1FileDetailsGet200Response: V1FileDetailsGet200Response, - /** - * The V1FileDetailsGet200ResponseFileDetails model constructor. - * @property {module:model/V1FileDetailsGet200ResponseFileDetails} - */ - V1FileDetailsGet200ResponseFileDetails: V1FileDetailsGet200ResponseFileDetails, - /** - * The V1FileDetailsGet200ResponseLinks model constructor. - * @property {module:model/V1FileDetailsGet200ResponseLinks} - */ - V1FileDetailsGet200ResponseLinks: V1FileDetailsGet200ResponseLinks, - /** - * The V1FileDetailsGet200ResponseLinksFiles model constructor. - * @property {module:model/V1FileDetailsGet200ResponseLinksFiles} - */ - V1FileDetailsGet200ResponseLinksFiles: V1FileDetailsGet200ResponseLinksFiles, - /** - * The V1FileDetailsGet200ResponseLinksSelf model constructor. - * @property {module:model/V1FileDetailsGet200ResponseLinksSelf} - */ - V1FileDetailsGet200ResponseLinksSelf: V1FileDetailsGet200ResponseLinksSelf, - /** - * The VoidCaptureRequest model constructor. - * @property {module:model/VoidCaptureRequest} - */ - VoidCaptureRequest: VoidCaptureRequest, - /** - * The VoidCreditRequest model constructor. - * @property {module:model/VoidCreditRequest} - */ - VoidCreditRequest: VoidCreditRequest, - /** - * The VoidPaymentRequest model constructor. - * @property {module:model/VoidPaymentRequest} - */ - VoidPaymentRequest: VoidPaymentRequest, - /** - * The VoidRefundRequest model constructor. - * @property {module:model/VoidRefundRequest} - */ - VoidRefundRequest: VoidRefundRequest, - /** - * The CaptureApi service constructor. - * @property {module:api/CaptureApi} - */ - CaptureApi: CaptureApi, - /** - * The ConversionDetailsApi service constructor. - * @property {module:api/ConversionDetailsApi} - */ - ConversionDetailsApi: ConversionDetailsApi, - /** - * The CreditApi service constructor. - * @property {module:api/CreditApi} - */ - CreditApi: CreditApi, - /** - * The DecisionManagerApi service constructor. - * @property {module:api/DecisionManagerApi} - */ - DecisionManagerApi: DecisionManagerApi, - - - - - - - - - - - /** - * The InstrumentIdentifierApi service constructor. - * @property {module:api/InstrumentIdentifierApi} - */ - InstrumentIdentifierApi: InstrumentIdentifierApi, - /** - * The KeyGenerationApi service constructor. - * @property {module:api/KeyGenerationApi} - */ - KeyGenerationApi: KeyGenerationApi, - /** - * The NetFundingsApi service constructor. - * @property {module:api/NetFundingsApi} - */ - NetFundingsApi: NetFundingsApi, - /** - * The NotificationOfChangesApi service constructor. - * @property {module:api/NotificationOfChangesApi} - */ - NotificationOfChangesApi: NotificationOfChangesApi, - /** - * The PaymentBatchSummariesApi service constructor. - * @property {module:api/PaymentBatchSummariesApi} - */ - PaymentBatchSummariesApi: PaymentBatchSummariesApi, - /** - * The PaymentInstrumentApi service constructor. - * @property {module:api/PaymentInstrumentApi} - */ - PaymentInstrumentApi: PaymentInstrumentApi, - /** - * The PaymentsApi service constructor. - * @property {module:api/PaymentsApi} - */ - PaymentsApi: PaymentsApi, - /** - * The PayoutsApi service constructor. - * @property {module:api/PayoutsApi} - */ - PayoutsApi: PayoutsApi, - /** - * The PurchaseAndRefundDetailsApi service constructor. - * @property {module:api/PurchaseAndRefundDetailsApi} - */ - PurchaseAndRefundDetailsApi: PurchaseAndRefundDetailsApi, - /** - * The RefundApi service constructor. - * @property {module:api/RefundApi} - */ - RefundApi: RefundApi, - /** - * The ReportDefinitionsApi service constructor. - * @property {module:api/ReportDefinitionsApi} - */ - ReportDefinitionsApi: ReportDefinitionsApi, - /** - * The ReportDownloadsApi service constructor. - * @property {module:api/ReportDownloadsApi} - */ - ReportDownloadsApi: ReportDownloadsApi, - /** - * The ReportSubscriptionsApi service constructor. - * @property {module:api/ReportSubscriptionsApi} - */ - ReportSubscriptionsApi: ReportSubscriptionsApi, - /** - * The ReportsApi service constructor. - * @property {module:api/ReportsApi} - */ - ReportsApi: ReportsApi, - /** - * The ReversalApi service constructor. - * @property {module:api/ReversalApi} - */ - ReversalApi: ReversalApi, - /** - * The SearchTransactionsApi service constructor. - * @property {module:api/SearchTransactionsApi} - */ - SearchTransactionsApi: SearchTransactionsApi, - /** - * The SecureFileShareApi service constructor. - * @property {module:api/SecureFileShareApi} - */ - SecureFileShareApi: SecureFileShareApi, - /** - * The TokenizationApi service constructor. - * @property {module:api/TokenizationApi} - */ - TokenizationApi: TokenizationApi, - /** - * The TransactionBatchesApi service constructor. - * @property {module:api/TransactionBatchesApi} - */ - TransactionBatchesApi: TransactionBatchesApi, - /** - * The TransactionDetailsApi service constructor. - * @property {module:api/TransactionDetailsApi} - */ - TransactionDetailsApi: TransactionDetailsApi, - /** - * The UserManagementApi service constructor. - * @property {module:api/UserManagementApi} - */ - UserManagementApi: UserManagementApi, - /** - * The VoidApi service constructor. - * @property {module:api/VoidApi} - */ - VoidApi: VoidApi - }; - - return exports; -})); +/** + * 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 + * + * Swagger Codegen version: 2.3.0 + * + * Do not edit the class manually. + * + */ + +(function(factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/AuthReversalRequest', 'model/AuthorizationOptions', 'model/BillTo', 'model/BuyerInformation', 'model/CapturePaymentRequest', 'model/CardInfo', 'model/CheckPayerAuthEnrollmentRequest', 'model/CreateCreditRequest', 'model/CreateDecisionManagerCaseRequest', 'model/CreateInstrumentIdentifierRequest', 'model/CreatePaymentInstrumentRequest', 'model/CreatePaymentRequest', 'model/CreateSearchRequest', 'model/DerPublicKey', 'model/Detail', 'model/EmbeddedInstrumentIdentifier', 'model/Error', 'model/ErrorBean', 'model/ErrorFieldBean', 'model/ErrorLinks', 'model/ErrorResponse', 'model/ErrorResponseWithHAL', 'model/ExistingInstrumentIdentifierId', 'model/FileBean', 'model/FileDetail', 'model/FileDetailsResponse', 'model/FlexV1KeysPost200Response', 'model/FlexV1KeysPost200ResponseDer', 'model/FlexV1KeysPost200ResponseJwk', 'model/FlexV1TokensPost200Response', 'model/Flexv1tokensCardInfo', 'model/GeneratePublicKeyRequest', 'model/Initiator', 'model/InlineResponse400', 'model/InlineResponse4001', 'model/InlineResponse400Fields', 'model/InlineResponseDefault', 'model/InlineResponseDefaultLinks', 'model/InlineResponseDefaultLinksNext', 'model/InlineResponseDefaultResponseStatus', 'model/InlineResponseDefaultResponseStatusDetails', 'model/InstrumentIdentifier', 'model/InstrumentIdentifierBankAccount', 'model/InstrumentIdentifierCard', 'model/InstrumentIdentifierEnrollableCard', 'model/InstrumentIdentifierProcessingInformation', 'model/InstrumentIdentifierUpdate', 'model/JsonWebKey', 'model/KeyParameters', 'model/KeyResult', 'model/Link', 'model/Links', 'model/MerchantInformation', 'model/MerchantInitiatedTransaction', 'model/Metadata', 'model/Model409Link', 'model/Model409Links', 'model/OctCreatePaymentRequest', 'model/PIForIILinkFirst', 'model/PIForIILinkLast', 'model/PIForIILinkNext', 'model/PIForIILinkPrev', 'model/PIForIILinkSelf', 'model/PaymentInstrument', 'model/PaymentInstrumentBankAccount', 'model/PaymentInstrumentCard', 'model/PaymentInstrumentForInstrumentIdentifierLinks', 'model/PaymentInstrumentsArray', 'model/PaymentInstrumentsForInstrumentIdentifier', 'model/PersonalIdentification', 'model/PersonalIdentificationArray', 'model/ProcessingInformation', 'model/PtsV1TransactionBatchesGet200Response', 'model/PtsV1TransactionBatchesGet200ResponseLinks', 'model/PtsV1TransactionBatchesGet200ResponseLinksSelf', 'model/PtsV1TransactionBatchesGet200ResponseTransactionBatches', 'model/PtsV1TransactionBatchesGet400Response', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformation', 'model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails', 'model/PtsV1TransactionBatchesGet500Response', 'model/PtsV1TransactionBatchesGet500ResponseErrorInformation', 'model/PtsV1TransactionBatchesIdGet200Response', 'model/PtsV1TransactionBatchesIdGet200ResponseLinks', 'model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions', 'model/PtsV2CreditsPost201Response', 'model/PtsV2CreditsPost201ResponseCreditAmountDetails', 'model/PtsV2CreditsPost201ResponsePaymentInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformation', 'model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2PaymentsCapturesPost201Response', 'model/PtsV2PaymentsCapturesPost201ResponseLinks', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformation', 'model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation', 'model/PtsV2PaymentsCapturesPost400Response', 'model/PtsV2PaymentsPost201Response', 'model/PtsV2PaymentsPost201ResponseClientReferenceInformation', 'model/PtsV2PaymentsPost201ResponseErrorInformation', 'model/PtsV2PaymentsPost201ResponseErrorInformationDetails', 'model/PtsV2PaymentsPost201ResponseInstallmentInformation', 'model/PtsV2PaymentsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsPost201ResponseLinks', 'model/PtsV2PaymentsPost201ResponseLinksSelf', 'model/PtsV2PaymentsPost201ResponseOrderInformation', 'model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails', 'model/PtsV2PaymentsPost201ResponsePaymentInformation', 'model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBank', 'model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount', 'model/PtsV2PaymentsPost201ResponsePaymentInformationCard', 'model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformation', 'model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv', 'model/PtsV2PaymentsPost201ResponseProcessingInformation', 'model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions', 'model/PtsV2PaymentsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationAvs', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification', 'model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse', 'model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer', 'model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults', 'model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice', 'model/PtsV2PaymentsPost201ResponseProcessorInformationRouting', 'model/PtsV2PaymentsPost400Response', 'model/PtsV2PaymentsPost502Response', 'model/PtsV2PaymentsRefundPost201Response', 'model/PtsV2PaymentsRefundPost201ResponseLinks', 'model/PtsV2PaymentsRefundPost201ResponseOrderInformation', 'model/PtsV2PaymentsRefundPost201ResponseProcessorInformation', 'model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails', 'model/PtsV2PaymentsRefundPost400Response', 'model/PtsV2PaymentsReversalsPost201Response', 'model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation', 'model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation', 'model/PtsV2PaymentsReversalsPost201ResponseLinks', 'model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation', 'model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails', 'model/PtsV2PaymentsReversalsPost400Response', 'model/PtsV2PaymentsVoidsPost201Response', 'model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails', 'model/PtsV2PaymentsVoidsPost400Response', 'model/PtsV2PayoutsPost201Response', 'model/PtsV2PayoutsPost201ResponseErrorInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformation', 'model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor', 'model/PtsV2PayoutsPost201ResponseOrderInformation', 'model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails', 'model/PtsV2PayoutsPost201ResponseProcessorInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformation', 'model/PtsV2PayoutsPost201ResponseRecipientInformationCard', 'model/PtsV2PayoutsPost400Response', 'model/Ptsv2creditsPointOfSaleInformation', 'model/Ptsv2creditsPointOfSaleInformationEmv', 'model/Ptsv2creditsProcessingInformation', 'model/Ptsv2creditsProcessingInformationBankTransferOptions', 'model/Ptsv2paymentsAggregatorInformation', 'model/Ptsv2paymentsAggregatorInformationSubMerchant', 'model/Ptsv2paymentsBuyerInformation', 'model/Ptsv2paymentsBuyerInformationPersonalIdentification', 'model/Ptsv2paymentsClientReferenceInformation', 'model/Ptsv2paymentsClientReferenceInformationPartner', 'model/Ptsv2paymentsConsumerAuthenticationInformation', 'model/Ptsv2paymentsDeviceInformation', 'model/Ptsv2paymentsInstallmentInformation', 'model/Ptsv2paymentsIssuerInformation', 'model/Ptsv2paymentsMerchantDefinedInformation', 'model/Ptsv2paymentsMerchantInformation', 'model/Ptsv2paymentsMerchantInformationMerchantDescriptor', 'model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor', 'model/Ptsv2paymentsOrderInformation', 'model/Ptsv2paymentsOrderInformationAmountDetails', 'model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts', 'model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails', 'model/Ptsv2paymentsOrderInformationBillTo', 'model/Ptsv2paymentsOrderInformationBillToCompany', 'model/Ptsv2paymentsOrderInformationInvoiceDetails', 'model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum', 'model/Ptsv2paymentsOrderInformationLineItems', 'model/Ptsv2paymentsOrderInformationShipTo', 'model/Ptsv2paymentsOrderInformationShippingDetails', 'model/Ptsv2paymentsPaymentInformation', 'model/Ptsv2paymentsPaymentInformationBank', 'model/Ptsv2paymentsPaymentInformationBankAccount', 'model/Ptsv2paymentsPaymentInformationCard', 'model/Ptsv2paymentsPaymentInformationCustomer', 'model/Ptsv2paymentsPaymentInformationFluidData', 'model/Ptsv2paymentsPaymentInformationTokenizedCard', 'model/Ptsv2paymentsPointOfSaleInformation', 'model/Ptsv2paymentsPointOfSaleInformationEmv', 'model/Ptsv2paymentsProcessingInformation', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator', 'model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/Ptsv2paymentsProcessingInformationBankTransferOptions', 'model/Ptsv2paymentsProcessingInformationCaptureOptions', 'model/Ptsv2paymentsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsRecipientInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformation', 'model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant', 'model/Ptsv2paymentsidcapturesBuyerInformation', 'model/Ptsv2paymentsidcapturesInstallmentInformation', 'model/Ptsv2paymentsidcapturesMerchantInformation', 'model/Ptsv2paymentsidcapturesOrderInformation', 'model/Ptsv2paymentsidcapturesOrderInformationAmountDetails', 'model/Ptsv2paymentsidcapturesOrderInformationBillTo', 'model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails', 'model/Ptsv2paymentsidcapturesOrderInformationShipTo', 'model/Ptsv2paymentsidcapturesOrderInformationShippingDetails', 'model/Ptsv2paymentsidcapturesPaymentInformation', 'model/Ptsv2paymentsidcapturesPointOfSaleInformation', 'model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv', 'model/Ptsv2paymentsidcapturesProcessingInformation', 'model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions', 'model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions', 'model/Ptsv2paymentsidrefundsMerchantInformation', 'model/Ptsv2paymentsidrefundsOrderInformation', 'model/Ptsv2paymentsidrefundsOrderInformationLineItems', 'model/Ptsv2paymentsidrefundsPaymentInformation', 'model/Ptsv2paymentsidrefundsPaymentInformationCard', 'model/Ptsv2paymentsidrefundsPointOfSaleInformation', 'model/Ptsv2paymentsidrefundsProcessingInformation', 'model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions', 'model/Ptsv2paymentsidreversalsClientReferenceInformation', 'model/Ptsv2paymentsidreversalsClientReferenceInformationPartner', 'model/Ptsv2paymentsidreversalsOrderInformation', 'model/Ptsv2paymentsidreversalsOrderInformationAmountDetails', 'model/Ptsv2paymentsidreversalsOrderInformationLineItems', 'model/Ptsv2paymentsidreversalsPointOfSaleInformation', 'model/Ptsv2paymentsidreversalsProcessingInformation', 'model/Ptsv2paymentsidreversalsReversalInformation', 'model/Ptsv2paymentsidreversalsReversalInformationAmountDetails', 'model/Ptsv2payoutsClientReferenceInformation', 'model/Ptsv2payoutsMerchantInformation', 'model/Ptsv2payoutsMerchantInformationMerchantDescriptor', 'model/Ptsv2payoutsOrderInformation', 'model/Ptsv2payoutsOrderInformationAmountDetails', 'model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge', 'model/Ptsv2payoutsOrderInformationBillTo', 'model/Ptsv2payoutsPaymentInformation', 'model/Ptsv2payoutsPaymentInformationCard', 'model/Ptsv2payoutsProcessingInformation', 'model/Ptsv2payoutsProcessingInformationPayoutsOptions', 'model/Ptsv2payoutsRecipientInformation', 'model/Ptsv2payoutsSenderInformation', 'model/Ptsv2payoutsSenderInformationAccount', 'model/RefundCaptureRequest', 'model/RefundPaymentRequest', 'model/ReportingV3ConversionDetailsGet200Response', 'model/ReportingV3ConversionDetailsGet200ResponseConversionDetails', 'model/ReportingV3ConversionDetailsGet200ResponseNotes', 'model/ReportingV3NetFundingsGet200Response', 'model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries', 'model/ReportingV3NetFundingsGet200ResponseTotalPurchases', 'model/ReportingV3NotificationofChangesGet200Response', 'model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges', 'model/ReportingV3PurchaseRefundDetailsGet200Response', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses', 'model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements', 'model/ReportingV3ReportDefinitionsGet200Response', 'model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions', 'model/ReportingV3ReportDefinitionsNameGet200Response', 'model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes', 'model/ReportingV3ReportSubscriptionsGet200Response', 'model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions', 'model/ReportingV3ReportsGet200Response', 'model/ReportingV3ReportsGet200ResponseReports', 'model/ReportingV3ReportsIdGet200Response', 'model/Reportingv3ReportDownloadsGet400Response', 'model/Reportingv3ReportDownloadsGet400ResponseDetails', 'model/Reportingv3reportsReportPreferences', 'model/Request', 'model/RequestBody', 'model/RequestBody1', 'model/ResponseStatus', 'model/ResponseStatusDetails', 'model/RiskV1AuthenticationResultsPost201Response', 'model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationsPost201Response', 'model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationsPost201ResponseOrderInformation', 'model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails', 'model/RiskV1AuthenticationsPost400Response', 'model/RiskV1DecisionsPost201Response', 'model/RiskV1DecisionsPost201ResponsePaymentInformation', 'model/RiskV1DecisionsPost201ResponseRiskInformation', 'model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes', 'model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress', 'model/RiskV1DecisionsPost201ResponseRiskInformationProfile', 'model/RiskV1DecisionsPost201ResponseRiskInformationProviders', 'model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName', 'model/RiskV1DecisionsPost201ResponseRiskInformationRules', 'model/RiskV1DecisionsPost201ResponseRiskInformationScore', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravel', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination', 'model/RiskV1DecisionsPost201ResponseRiskInformationVelocity', 'model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing', 'model/RiskV1DecisionsPost400Response', 'model/Riskv1authenticationresultsConsumerAuthenticationInformation', 'model/Riskv1authenticationresultsOrderInformation', 'model/Riskv1authenticationresultsOrderInformationLineItems', 'model/Riskv1authenticationresultsPaymentInformation', 'model/Riskv1authenticationresultsPaymentInformationCard', 'model/Riskv1authenticationresultsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsBuyerInformation', 'model/Riskv1authenticationsClientReferenceInformation', 'model/Riskv1authenticationsConsumerAuthenticationInformation', 'model/Riskv1authenticationsDeviceInformation', 'model/Riskv1authenticationsDeviceInformationRawData', 'model/Riskv1authenticationsMerchantInformation', 'model/Riskv1authenticationsOrderInformation', 'model/Riskv1authenticationsOrderInformationBillTo', 'model/Riskv1authenticationsOrderInformationLineItems', 'model/Riskv1authenticationsOrderInformationShipTo', 'model/Riskv1authenticationsPaymentInformation', 'model/Riskv1authenticationsPaymentInformationCard', 'model/Riskv1authenticationsPaymentInformationTokenizedCard', 'model/Riskv1authenticationsRecurringPaymentInformation', 'model/Riskv1authenticationsRiskInformation', 'model/Riskv1authenticationsRiskInformationBuyerHistory', 'model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory', 'model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount', 'model/Riskv1authenticationsTravelInformation', 'model/Riskv1authenticationsTravelInformationLegs', 'model/Riskv1authenticationsTravelInformationPassengers', 'model/Riskv1decisionsBuyerInformation', 'model/Riskv1decisionsCardVerification', 'model/Riskv1decisionsClientReferenceInformation', 'model/Riskv1decisionsDeviceInformation', 'model/Riskv1decisionsMerchantDefinedInformation', 'model/Riskv1decisionsOrderInformation', 'model/Riskv1decisionsOrderInformationAmountDetails', 'model/Riskv1decisionsOrderInformationBillTo', 'model/Riskv1decisionsOrderInformationLineItems', 'model/Riskv1decisionsOrderInformationPassenger', 'model/Riskv1decisionsOrderInformationShipTo', 'model/Riskv1decisionsOrderInformationShippingDetails', 'model/Riskv1decisionsPaymentInformation', 'model/Riskv1decisionsPaymentInformationCard', 'model/Riskv1decisionsPaymentInformationTokenizedCard', 'model/Riskv1decisionsProcessorInformation', 'model/Riskv1decisionsProcessorInformationAvs', 'model/Riskv1decisionsRiskInformation', 'model/Riskv1decisionsRiskInformationProfile', 'model/Riskv1decisionsTravelInformation', 'model/Riskv1decisionsTravelInformationLegs', 'model/SelfLinkBean', 'model/TmsV1InstrumentIdentifiersDelete409Response', 'model/TmsV1InstrumentIdentifiersDelete409ResponseLinks', 'model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf', 'model/TmsV1InstrumentIdentifiersPost200Response', 'model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount', 'model/TmsV1InstrumentIdentifiersPost200ResponseCard', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinks', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf', 'model/TmsV1InstrumentIdentifiersPost200ResponseMetadata', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction', 'model/Tmsv1instrumentidentifiersBillTo', 'model/Tmsv1instrumentidentifiersCard', 'model/Tmsv1instrumentidentifiersDetails', 'model/TokenizeParameters', 'model/TokenizeRequest', 'model/TokenizeResult', 'model/TssV2TransactionsGet200Response', 'model/TssV2TransactionsGet200ResponseApplicationInformation', 'model/TssV2TransactionsGet200ResponseApplicationInformationApplications', 'model/TssV2TransactionsGet200ResponseBuyerInformation', 'model/TssV2TransactionsGet200ResponseClientReferenceInformation', 'model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation', 'model/TssV2TransactionsGet200ResponseDeviceInformation', 'model/TssV2TransactionsGet200ResponseErrorInformation', 'model/TssV2TransactionsGet200ResponseFraudMarkingInformation', 'model/TssV2TransactionsGet200ResponseInstallmentInformation', 'model/TssV2TransactionsGet200ResponseLinks', 'model/TssV2TransactionsGet200ResponseMerchantInformation', 'model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor', 'model/TssV2TransactionsGet200ResponseOrderInformation', 'model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails', 'model/TssV2TransactionsGet200ResponseOrderInformationBillTo', 'model/TssV2TransactionsGet200ResponseOrderInformationLineItems', 'model/TssV2TransactionsGet200ResponseOrderInformationShipTo', 'model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails', 'model/TssV2TransactionsGet200ResponsePaymentInformation', 'model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures', 'model/TssV2TransactionsGet200ResponsePaymentInformationBank', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount', 'model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate', 'model/TssV2TransactionsGet200ResponsePaymentInformationCard', 'model/TssV2TransactionsGet200ResponsePaymentInformationInvoice', 'model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType', 'model/TssV2TransactionsGet200ResponsePointOfSaleInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformation', 'model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions', 'model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions', 'model/TssV2TransactionsGet200ResponseProcessorInformation', 'model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults', 'model/TssV2TransactionsGet200ResponseProcessorInformationProcessor', 'model/TssV2TransactionsGet200ResponseRiskInformation', 'model/TssV2TransactionsGet200ResponseRiskInformationProfile', 'model/TssV2TransactionsGet200ResponseRiskInformationRules', 'model/TssV2TransactionsGet200ResponseRiskInformationScore', 'model/TssV2TransactionsGet200ResponseSenderInformation', 'model/TssV2TransactionsPost201Response', 'model/TssV2TransactionsPost201ResponseEmbedded', 'model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedLinks', 'model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo', 'model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard', 'model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType', 'model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders', 'model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint', 'model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries', 'model/TssV2TransactionsPost400Response', 'model/UmsV1UsersGet200Response', 'model/UmsV1UsersGet200ResponseAccountInformation', 'model/UmsV1UsersGet200ResponseContactInformation', 'model/UmsV1UsersGet200ResponseOrganizationInformation', 'model/UmsV1UsersGet200ResponseUsers', 'model/UpdateInstrumentIdentifierRequest', 'model/UpdatePaymentInstrumentRequest', 'model/V1FileDetailsGet200Response', 'model/V1FileDetailsGet200ResponseFileDetails', 'model/V1FileDetailsGet200ResponseLinks', 'model/V1FileDetailsGet200ResponseLinksFiles', 'model/V1FileDetailsGet200ResponseLinksSelf', 'model/VoidCaptureRequest', 'model/VoidCreditRequest', 'model/VoidPaymentRequest', 'model/VoidRefundRequest', 'api/CaptureApi', 'api/ConversionDetailsApi', 'api/CreditApi', 'api/DecisionManagerApi', 'api/InstrumentIdentifierApi', 'api/KeyGenerationApi', 'api/NetFundingsApi', 'api/NotificationOfChangesApi', 'api/PayerAuthenticationApi', 'api/PaymentInstrumentApi', 'api/PaymentsApi', 'api/PayoutsApi', 'api/PurchaseAndRefundDetailsApi', 'api/RefundApi', 'api/ReportDefinitionsApi', 'api/ReportDownloadsApi', 'api/ReportSubscriptionsApi', 'api/ReportsApi', 'api/ReversalApi', 'api/SearchTransactionsApi', 'api/SecureFileShareApi', 'api/TokenizationApi', 'api/TransactionBatchesApi', 'api/TransactionDetailsApi', 'api/UserManagementApi', 'api/VoidApi'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('./ApiClient'), require('./model/AuthReversalRequest'), require('./model/AuthorizationOptions'), require('./model/BillTo'), require('./model/BuyerInformation'), require('./model/CapturePaymentRequest'), require('./model/CardInfo'), require('./model/CheckPayerAuthEnrollmentRequest'), require('./model/CreateCreditRequest'), require('./model/CreateDecisionManagerCaseRequest'), require('./model/CreateInstrumentIdentifierRequest'), require('./model/CreatePaymentInstrumentRequest'), require('./model/CreatePaymentRequest'), require('./model/CreateSearchRequest'), require('./model/DerPublicKey'), require('./model/Detail'), require('./model/EmbeddedInstrumentIdentifier'), require('./model/Error'), require('./model/ErrorBean'), require('./model/ErrorFieldBean'), require('./model/ErrorLinks'), require('./model/ErrorResponse'), require('./model/ErrorResponseWithHAL'), require('./model/ExistingInstrumentIdentifierId'), require('./model/FileBean'), require('./model/FileDetail'), require('./model/FileDetailsResponse'), require('./model/FlexV1KeysPost200Response'), require('./model/FlexV1KeysPost200ResponseDer'), require('./model/FlexV1KeysPost200ResponseJwk'), require('./model/FlexV1TokensPost200Response'), require('./model/Flexv1tokensCardInfo'), require('./model/GeneratePublicKeyRequest'), require('./model/Initiator'), require('./model/InlineResponse400'), require('./model/InlineResponse4001'), require('./model/InlineResponse400Fields'), require('./model/InlineResponseDefault'), require('./model/InlineResponseDefaultLinks'), require('./model/InlineResponseDefaultLinksNext'), require('./model/InlineResponseDefaultResponseStatus'), require('./model/InlineResponseDefaultResponseStatusDetails'), require('./model/InstrumentIdentifier'), require('./model/InstrumentIdentifierBankAccount'), require('./model/InstrumentIdentifierCard'), require('./model/InstrumentIdentifierEnrollableCard'), require('./model/InstrumentIdentifierProcessingInformation'), require('./model/InstrumentIdentifierUpdate'), require('./model/JsonWebKey'), require('./model/KeyParameters'), require('./model/KeyResult'), require('./model/Link'), require('./model/Links'), require('./model/MerchantInformation'), require('./model/MerchantInitiatedTransaction'), require('./model/Metadata'), require('./model/Model409Link'), require('./model/Model409Links'), require('./model/OctCreatePaymentRequest'), require('./model/PIForIILinkFirst'), require('./model/PIForIILinkLast'), require('./model/PIForIILinkNext'), require('./model/PIForIILinkPrev'), require('./model/PIForIILinkSelf'), require('./model/PaymentInstrument'), require('./model/PaymentInstrumentBankAccount'), require('./model/PaymentInstrumentCard'), require('./model/PaymentInstrumentForInstrumentIdentifierLinks'), require('./model/PaymentInstrumentsArray'), require('./model/PaymentInstrumentsForInstrumentIdentifier'), require('./model/PersonalIdentification'), require('./model/PersonalIdentificationArray'), require('./model/ProcessingInformation'), require('./model/PtsV1TransactionBatchesGet200Response'), require('./model/PtsV1TransactionBatchesGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesGet200ResponseLinksSelf'), require('./model/PtsV1TransactionBatchesGet200ResponseTransactionBatches'), require('./model/PtsV1TransactionBatchesGet400Response'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails'), require('./model/PtsV1TransactionBatchesGet500Response'), require('./model/PtsV1TransactionBatchesGet500ResponseErrorInformation'), require('./model/PtsV1TransactionBatchesIdGet200Response'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinks'), require('./model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions'), require('./model/PtsV2CreditsPost201Response'), require('./model/PtsV2CreditsPost201ResponseCreditAmountDetails'), require('./model/PtsV2CreditsPost201ResponsePaymentInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformation'), require('./model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2PaymentsCapturesPost201Response'), require('./model/PtsV2PaymentsCapturesPost201ResponseLinks'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsCapturesPost400Response'), require('./model/PtsV2PaymentsPost201Response'), require('./model/PtsV2PaymentsPost201ResponseClientReferenceInformation'), require('./model/PtsV2PaymentsPost201ResponseErrorInformation'), require('./model/PtsV2PaymentsPost201ResponseErrorInformationDetails'), require('./model/PtsV2PaymentsPost201ResponseInstallmentInformation'), require('./model/PtsV2PaymentsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsPost201ResponseLinks'), require('./model/PtsV2PaymentsPost201ResponseLinksSelf'), require('./model/PtsV2PaymentsPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformation'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBank'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationCard'), require('./model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformation'), require('./model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationAvs'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice'), require('./model/PtsV2PaymentsPost201ResponseProcessorInformationRouting'), require('./model/PtsV2PaymentsPost400Response'), require('./model/PtsV2PaymentsPost502Response'), require('./model/PtsV2PaymentsRefundPost201Response'), require('./model/PtsV2PaymentsRefundPost201ResponseLinks'), require('./model/PtsV2PaymentsRefundPost201ResponseOrderInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails'), require('./model/PtsV2PaymentsRefundPost400Response'), require('./model/PtsV2PaymentsReversalsPost201Response'), require('./model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseLinks'), require('./model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation'), require('./model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails'), require('./model/PtsV2PaymentsReversalsPost400Response'), require('./model/PtsV2PaymentsVoidsPost201Response'), require('./model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails'), require('./model/PtsV2PaymentsVoidsPost400Response'), require('./model/PtsV2PayoutsPost201Response'), require('./model/PtsV2PayoutsPost201ResponseErrorInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformation'), require('./model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor'), require('./model/PtsV2PayoutsPost201ResponseOrderInformation'), require('./model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails'), require('./model/PtsV2PayoutsPost201ResponseProcessorInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformation'), require('./model/PtsV2PayoutsPost201ResponseRecipientInformationCard'), require('./model/PtsV2PayoutsPost400Response'), require('./model/Ptsv2creditsPointOfSaleInformation'), require('./model/Ptsv2creditsPointOfSaleInformationEmv'), require('./model/Ptsv2creditsProcessingInformation'), require('./model/Ptsv2creditsProcessingInformationBankTransferOptions'), require('./model/Ptsv2paymentsAggregatorInformation'), require('./model/Ptsv2paymentsAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsBuyerInformation'), require('./model/Ptsv2paymentsBuyerInformationPersonalIdentification'), require('./model/Ptsv2paymentsClientReferenceInformation'), require('./model/Ptsv2paymentsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsConsumerAuthenticationInformation'), require('./model/Ptsv2paymentsDeviceInformation'), require('./model/Ptsv2paymentsInstallmentInformation'), require('./model/Ptsv2paymentsIssuerInformation'), require('./model/Ptsv2paymentsMerchantDefinedInformation'), require('./model/Ptsv2paymentsMerchantInformation'), require('./model/Ptsv2paymentsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor'), require('./model/Ptsv2paymentsOrderInformation'), require('./model/Ptsv2paymentsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails'), require('./model/Ptsv2paymentsOrderInformationBillTo'), require('./model/Ptsv2paymentsOrderInformationBillToCompany'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum'), require('./model/Ptsv2paymentsOrderInformationLineItems'), require('./model/Ptsv2paymentsOrderInformationShipTo'), require('./model/Ptsv2paymentsOrderInformationShippingDetails'), require('./model/Ptsv2paymentsPaymentInformation'), require('./model/Ptsv2paymentsPaymentInformationBank'), require('./model/Ptsv2paymentsPaymentInformationBankAccount'), require('./model/Ptsv2paymentsPaymentInformationCard'), require('./model/Ptsv2paymentsPaymentInformationCustomer'), require('./model/Ptsv2paymentsPaymentInformationFluidData'), require('./model/Ptsv2paymentsPaymentInformationTokenizedCard'), require('./model/Ptsv2paymentsPointOfSaleInformation'), require('./model/Ptsv2paymentsPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsProcessingInformation'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator'), require('./model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/Ptsv2paymentsProcessingInformationBankTransferOptions'), require('./model/Ptsv2paymentsProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsRecipientInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformation'), require('./model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant'), require('./model/Ptsv2paymentsidcapturesBuyerInformation'), require('./model/Ptsv2paymentsidcapturesInstallmentInformation'), require('./model/Ptsv2paymentsidcapturesMerchantInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformation'), require('./model/Ptsv2paymentsidcapturesOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationBillTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails'), require('./model/Ptsv2paymentsidcapturesOrderInformationShipTo'), require('./model/Ptsv2paymentsidcapturesOrderInformationShippingDetails'), require('./model/Ptsv2paymentsidcapturesPaymentInformation'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformation'), require('./model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv'), require('./model/Ptsv2paymentsidcapturesProcessingInformation'), require('./model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions'), require('./model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions'), require('./model/Ptsv2paymentsidrefundsMerchantInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformation'), require('./model/Ptsv2paymentsidrefundsOrderInformationLineItems'), require('./model/Ptsv2paymentsidrefundsPaymentInformation'), require('./model/Ptsv2paymentsidrefundsPaymentInformationCard'), require('./model/Ptsv2paymentsidrefundsPointOfSaleInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformation'), require('./model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformation'), require('./model/Ptsv2paymentsidreversalsClientReferenceInformationPartner'), require('./model/Ptsv2paymentsidreversalsOrderInformation'), require('./model/Ptsv2paymentsidreversalsOrderInformationAmountDetails'), require('./model/Ptsv2paymentsidreversalsOrderInformationLineItems'), require('./model/Ptsv2paymentsidreversalsPointOfSaleInformation'), require('./model/Ptsv2paymentsidreversalsProcessingInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformation'), require('./model/Ptsv2paymentsidreversalsReversalInformationAmountDetails'), require('./model/Ptsv2payoutsClientReferenceInformation'), require('./model/Ptsv2payoutsMerchantInformation'), require('./model/Ptsv2payoutsMerchantInformationMerchantDescriptor'), require('./model/Ptsv2payoutsOrderInformation'), require('./model/Ptsv2payoutsOrderInformationAmountDetails'), require('./model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge'), require('./model/Ptsv2payoutsOrderInformationBillTo'), require('./model/Ptsv2payoutsPaymentInformation'), require('./model/Ptsv2payoutsPaymentInformationCard'), require('./model/Ptsv2payoutsProcessingInformation'), require('./model/Ptsv2payoutsProcessingInformationPayoutsOptions'), require('./model/Ptsv2payoutsRecipientInformation'), require('./model/Ptsv2payoutsSenderInformation'), require('./model/Ptsv2payoutsSenderInformationAccount'), require('./model/RefundCaptureRequest'), require('./model/RefundPaymentRequest'), require('./model/ReportingV3ConversionDetailsGet200Response'), require('./model/ReportingV3ConversionDetailsGet200ResponseConversionDetails'), require('./model/ReportingV3ConversionDetailsGet200ResponseNotes'), require('./model/ReportingV3NetFundingsGet200Response'), require('./model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries'), require('./model/ReportingV3NetFundingsGet200ResponseTotalPurchases'), require('./model/ReportingV3NotificationofChangesGet200Response'), require('./model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges'), require('./model/ReportingV3PurchaseRefundDetailsGet200Response'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses'), require('./model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements'), require('./model/ReportingV3ReportDefinitionsGet200Response'), require('./model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions'), require('./model/ReportingV3ReportDefinitionsNameGet200Response'), require('./model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes'), require('./model/ReportingV3ReportSubscriptionsGet200Response'), require('./model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions'), require('./model/ReportingV3ReportsGet200Response'), require('./model/ReportingV3ReportsGet200ResponseReports'), require('./model/ReportingV3ReportsIdGet200Response'), require('./model/Reportingv3ReportDownloadsGet400Response'), require('./model/Reportingv3ReportDownloadsGet400ResponseDetails'), require('./model/Reportingv3reportsReportPreferences'), require('./model/Request'), require('./model/RequestBody'), require('./model/RequestBody1'), require('./model/ResponseStatus'), require('./model/ResponseStatusDetails'), require('./model/RiskV1AuthenticationResultsPost201Response'), require('./model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationsPost201Response'), require('./model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation'), require('./model/RiskV1AuthenticationsPost201ResponseOrderInformation'), require('./model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails'), require('./model/RiskV1AuthenticationsPost400Response'), require('./model/RiskV1DecisionsPost201Response'), require('./model/RiskV1DecisionsPost201ResponsePaymentInformation'), require('./model/RiskV1DecisionsPost201ResponseRiskInformation'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationProfile'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationProviders'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationRules'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationScore'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationTravel'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationVelocity'), require('./model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing'), require('./model/RiskV1DecisionsPost400Response'), require('./model/Riskv1authenticationresultsConsumerAuthenticationInformation'), require('./model/Riskv1authenticationresultsOrderInformation'), require('./model/Riskv1authenticationresultsOrderInformationLineItems'), require('./model/Riskv1authenticationresultsPaymentInformation'), require('./model/Riskv1authenticationresultsPaymentInformationCard'), require('./model/Riskv1authenticationresultsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsBuyerInformation'), require('./model/Riskv1authenticationsClientReferenceInformation'), require('./model/Riskv1authenticationsConsumerAuthenticationInformation'), require('./model/Riskv1authenticationsDeviceInformation'), require('./model/Riskv1authenticationsDeviceInformationRawData'), require('./model/Riskv1authenticationsMerchantInformation'), require('./model/Riskv1authenticationsOrderInformation'), require('./model/Riskv1authenticationsOrderInformationBillTo'), require('./model/Riskv1authenticationsOrderInformationLineItems'), require('./model/Riskv1authenticationsOrderInformationShipTo'), require('./model/Riskv1authenticationsPaymentInformation'), require('./model/Riskv1authenticationsPaymentInformationCard'), require('./model/Riskv1authenticationsPaymentInformationTokenizedCard'), require('./model/Riskv1authenticationsRecurringPaymentInformation'), require('./model/Riskv1authenticationsRiskInformation'), require('./model/Riskv1authenticationsRiskInformationBuyerHistory'), require('./model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory'), require('./model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount'), require('./model/Riskv1authenticationsTravelInformation'), require('./model/Riskv1authenticationsTravelInformationLegs'), require('./model/Riskv1authenticationsTravelInformationPassengers'), require('./model/Riskv1decisionsBuyerInformation'), require('./model/Riskv1decisionsCardVerification'), require('./model/Riskv1decisionsClientReferenceInformation'), require('./model/Riskv1decisionsDeviceInformation'), require('./model/Riskv1decisionsMerchantDefinedInformation'), require('./model/Riskv1decisionsOrderInformation'), require('./model/Riskv1decisionsOrderInformationAmountDetails'), require('./model/Riskv1decisionsOrderInformationBillTo'), require('./model/Riskv1decisionsOrderInformationLineItems'), require('./model/Riskv1decisionsOrderInformationPassenger'), require('./model/Riskv1decisionsOrderInformationShipTo'), require('./model/Riskv1decisionsOrderInformationShippingDetails'), require('./model/Riskv1decisionsPaymentInformation'), require('./model/Riskv1decisionsPaymentInformationCard'), require('./model/Riskv1decisionsPaymentInformationTokenizedCard'), require('./model/Riskv1decisionsProcessorInformation'), require('./model/Riskv1decisionsProcessorInformationAvs'), require('./model/Riskv1decisionsRiskInformation'), require('./model/Riskv1decisionsRiskInformationProfile'), require('./model/Riskv1decisionsTravelInformation'), require('./model/Riskv1decisionsTravelInformationLegs'), require('./model/SelfLinkBean'), require('./model/TmsV1InstrumentIdentifiersDelete409Response'), require('./model/TmsV1InstrumentIdentifiersDelete409ResponseLinks'), require('./model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev'), require('./model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf'), require('./model/TmsV1InstrumentIdentifiersPost200Response'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseCard'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseLinks'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseMetadata'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator'), require('./model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction'), require('./model/Tmsv1instrumentidentifiersBillTo'), require('./model/Tmsv1instrumentidentifiersCard'), require('./model/Tmsv1instrumentidentifiersDetails'), require('./model/TokenizeParameters'), require('./model/TokenizeRequest'), require('./model/TokenizeResult'), require('./model/TssV2TransactionsGet200Response'), require('./model/TssV2TransactionsGet200ResponseApplicationInformation'), require('./model/TssV2TransactionsGet200ResponseApplicationInformationApplications'), require('./model/TssV2TransactionsGet200ResponseBuyerInformation'), require('./model/TssV2TransactionsGet200ResponseClientReferenceInformation'), require('./model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation'), require('./model/TssV2TransactionsGet200ResponseDeviceInformation'), require('./model/TssV2TransactionsGet200ResponseErrorInformation'), require('./model/TssV2TransactionsGet200ResponseFraudMarkingInformation'), require('./model/TssV2TransactionsGet200ResponseInstallmentInformation'), require('./model/TssV2TransactionsGet200ResponseLinks'), require('./model/TssV2TransactionsGet200ResponseMerchantInformation'), require('./model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor'), require('./model/TssV2TransactionsGet200ResponseOrderInformation'), require('./model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails'), require('./model/TssV2TransactionsGet200ResponseOrderInformationBillTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationLineItems'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShipTo'), require('./model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails'), require('./model/TssV2TransactionsGet200ResponsePaymentInformation'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBank'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationCard'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationInvoice'), require('./model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType'), require('./model/TssV2TransactionsGet200ResponsePointOfSaleInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformation'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions'), require('./model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions'), require('./model/TssV2TransactionsGet200ResponseProcessorInformation'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults'), require('./model/TssV2TransactionsGet200ResponseProcessorInformationProcessor'), require('./model/TssV2TransactionsGet200ResponseRiskInformation'), require('./model/TssV2TransactionsGet200ResponseRiskInformationProfile'), require('./model/TssV2TransactionsGet200ResponseRiskInformationRules'), require('./model/TssV2TransactionsGet200ResponseRiskInformationScore'), require('./model/TssV2TransactionsGet200ResponseSenderInformation'), require('./model/TssV2TransactionsPost201Response'), require('./model/TssV2TransactionsPost201ResponseEmbedded'), require('./model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedLinks'), require('./model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType'), require('./model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders'), require('./model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint'), require('./model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries'), require('./model/TssV2TransactionsPost400Response'), require('./model/UmsV1UsersGet200Response'), require('./model/UmsV1UsersGet200ResponseAccountInformation'), require('./model/UmsV1UsersGet200ResponseContactInformation'), require('./model/UmsV1UsersGet200ResponseOrganizationInformation'), require('./model/UmsV1UsersGet200ResponseUsers'), require('./model/UpdateInstrumentIdentifierRequest'), require('./model/UpdatePaymentInstrumentRequest'), require('./model/V1FileDetailsGet200Response'), require('./model/V1FileDetailsGet200ResponseFileDetails'), require('./model/V1FileDetailsGet200ResponseLinks'), require('./model/V1FileDetailsGet200ResponseLinksFiles'), require('./model/V1FileDetailsGet200ResponseLinksSelf'), require('./model/VoidCaptureRequest'), require('./model/VoidCreditRequest'), require('./model/VoidPaymentRequest'), require('./model/VoidRefundRequest'), require('./api/CaptureApi'), require('./api/ConversionDetailsApi'), require('./api/CreditApi'), require('./api/DecisionManagerApi'), require('./api/InstrumentIdentifierApi'), require('./api/KeyGenerationApi'), require('./api/NetFundingsApi'), require('./api/NotificationOfChangesApi'), require('./api/PayerAuthenticationApi'), require('./api/PaymentInstrumentApi'), require('./api/PaymentsApi'), require('./api/PayoutsApi'), require('./api/PurchaseAndRefundDetailsApi'), require('./api/RefundApi'), require('./api/ReportDefinitionsApi'), require('./api/ReportDownloadsApi'), require('./api/ReportSubscriptionsApi'), require('./api/ReportsApi'), require('./api/ReversalApi'), require('./api/SearchTransactionsApi'), require('./api/SecureFileShareApi'), require('./api/TokenizationApi'), require('./api/TransactionBatchesApi'), require('./api/TransactionDetailsApi'), require('./api/UserManagementApi'), require('./api/VoidApi')); + } +}(function(ApiClient, AuthReversalRequest, AuthorizationOptions, BillTo, BuyerInformation, CapturePaymentRequest, CardInfo, CheckPayerAuthEnrollmentRequest, CreateCreditRequest, CreateDecisionManagerCaseRequest, CreateInstrumentIdentifierRequest, CreatePaymentInstrumentRequest, CreatePaymentRequest, CreateSearchRequest, DerPublicKey, Detail, EmbeddedInstrumentIdentifier, Error, ErrorBean, ErrorFieldBean, ErrorLinks, ErrorResponse, ErrorResponseWithHAL, ExistingInstrumentIdentifierId, FileBean, FileDetail, FileDetailsResponse, FlexV1KeysPost200Response, FlexV1KeysPost200ResponseDer, FlexV1KeysPost200ResponseJwk, FlexV1TokensPost200Response, Flexv1tokensCardInfo, GeneratePublicKeyRequest, Initiator, InlineResponse400, InlineResponse4001, InlineResponse400Fields, InlineResponseDefault, InlineResponseDefaultLinks, InlineResponseDefaultLinksNext, InlineResponseDefaultResponseStatus, InlineResponseDefaultResponseStatusDetails, InstrumentIdentifier, InstrumentIdentifierBankAccount, InstrumentIdentifierCard, InstrumentIdentifierEnrollableCard, InstrumentIdentifierProcessingInformation, InstrumentIdentifierUpdate, JsonWebKey, KeyParameters, KeyResult, Link, Links, MerchantInformation, MerchantInitiatedTransaction, Metadata, Model409Link, Model409Links, OctCreatePaymentRequest, PIForIILinkFirst, PIForIILinkLast, PIForIILinkNext, PIForIILinkPrev, PIForIILinkSelf, PaymentInstrument, PaymentInstrumentBankAccount, PaymentInstrumentCard, PaymentInstrumentForInstrumentIdentifierLinks, PaymentInstrumentsArray, PaymentInstrumentsForInstrumentIdentifier, PersonalIdentification, PersonalIdentificationArray, ProcessingInformation, PtsV1TransactionBatchesGet200Response, PtsV1TransactionBatchesGet200ResponseLinks, PtsV1TransactionBatchesGet200ResponseLinksSelf, PtsV1TransactionBatchesGet200ResponseTransactionBatches, PtsV1TransactionBatchesGet400Response, PtsV1TransactionBatchesGet400ResponseErrorInformation, PtsV1TransactionBatchesGet400ResponseErrorInformationDetails, PtsV1TransactionBatchesGet500Response, PtsV1TransactionBatchesGet500ResponseErrorInformation, PtsV1TransactionBatchesIdGet200Response, PtsV1TransactionBatchesIdGet200ResponseLinks, PtsV1TransactionBatchesIdGet200ResponseLinksTransactions, PtsV2CreditsPost201Response, PtsV2CreditsPost201ResponseCreditAmountDetails, PtsV2CreditsPost201ResponsePaymentInformation, PtsV2CreditsPost201ResponseProcessingInformation, PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions, PtsV2PaymentsCapturesPost201Response, PtsV2PaymentsCapturesPost201ResponseLinks, PtsV2PaymentsCapturesPost201ResponseOrderInformation, PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsCapturesPost201ResponseProcessorInformation, PtsV2PaymentsCapturesPost400Response, PtsV2PaymentsPost201Response, PtsV2PaymentsPost201ResponseClientReferenceInformation, PtsV2PaymentsPost201ResponseErrorInformation, PtsV2PaymentsPost201ResponseErrorInformationDetails, PtsV2PaymentsPost201ResponseInstallmentInformation, PtsV2PaymentsPost201ResponseIssuerInformation, PtsV2PaymentsPost201ResponseLinks, PtsV2PaymentsPost201ResponseLinksSelf, PtsV2PaymentsPost201ResponseOrderInformation, PtsV2PaymentsPost201ResponseOrderInformationAmountDetails, PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails, PtsV2PaymentsPost201ResponsePaymentInformation, PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures, PtsV2PaymentsPost201ResponsePaymentInformationBank, PtsV2PaymentsPost201ResponsePaymentInformationBankAccount, PtsV2PaymentsPost201ResponsePaymentInformationCard, PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard, PtsV2PaymentsPost201ResponsePointOfSaleInformation, PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv, PtsV2PaymentsPost201ResponseProcessingInformation, PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions, PtsV2PaymentsPost201ResponseProcessorInformation, PtsV2PaymentsPost201ResponseProcessorInformationAchVerification, PtsV2PaymentsPost201ResponseProcessorInformationAvs, PtsV2PaymentsPost201ResponseProcessorInformationCardVerification, PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse, PtsV2PaymentsPost201ResponseProcessorInformationCustomer, PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults, PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice, PtsV2PaymentsPost201ResponseProcessorInformationRouting, PtsV2PaymentsPost400Response, PtsV2PaymentsPost502Response, PtsV2PaymentsRefundPost201Response, PtsV2PaymentsRefundPost201ResponseLinks, PtsV2PaymentsRefundPost201ResponseOrderInformation, PtsV2PaymentsRefundPost201ResponseProcessorInformation, PtsV2PaymentsRefundPost201ResponseRefundAmountDetails, PtsV2PaymentsRefundPost400Response, PtsV2PaymentsReversalsPost201Response, PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation, PtsV2PaymentsReversalsPost201ResponseIssuerInformation, PtsV2PaymentsReversalsPost201ResponseLinks, PtsV2PaymentsReversalsPost201ResponseProcessorInformation, PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails, PtsV2PaymentsReversalsPost400Response, PtsV2PaymentsVoidsPost201Response, PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails, PtsV2PaymentsVoidsPost400Response, PtsV2PayoutsPost201Response, PtsV2PayoutsPost201ResponseErrorInformation, PtsV2PayoutsPost201ResponseMerchantInformation, PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor, PtsV2PayoutsPost201ResponseOrderInformation, PtsV2PayoutsPost201ResponseOrderInformationAmountDetails, PtsV2PayoutsPost201ResponseProcessorInformation, PtsV2PayoutsPost201ResponseRecipientInformation, PtsV2PayoutsPost201ResponseRecipientInformationCard, PtsV2PayoutsPost400Response, Ptsv2creditsPointOfSaleInformation, Ptsv2creditsPointOfSaleInformationEmv, Ptsv2creditsProcessingInformation, Ptsv2creditsProcessingInformationBankTransferOptions, Ptsv2paymentsAggregatorInformation, Ptsv2paymentsAggregatorInformationSubMerchant, Ptsv2paymentsBuyerInformation, Ptsv2paymentsBuyerInformationPersonalIdentification, Ptsv2paymentsClientReferenceInformation, Ptsv2paymentsClientReferenceInformationPartner, Ptsv2paymentsConsumerAuthenticationInformation, Ptsv2paymentsDeviceInformation, Ptsv2paymentsInstallmentInformation, Ptsv2paymentsIssuerInformation, Ptsv2paymentsMerchantDefinedInformation, Ptsv2paymentsMerchantInformation, Ptsv2paymentsMerchantInformationMerchantDescriptor, Ptsv2paymentsMerchantInformationServiceFeeDescriptor, Ptsv2paymentsOrderInformation, Ptsv2paymentsOrderInformationAmountDetails, Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts, Ptsv2paymentsOrderInformationAmountDetailsSurcharge, Ptsv2paymentsOrderInformationAmountDetailsTaxDetails, Ptsv2paymentsOrderInformationBillTo, Ptsv2paymentsOrderInformationBillToCompany, Ptsv2paymentsOrderInformationInvoiceDetails, Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum, Ptsv2paymentsOrderInformationLineItems, Ptsv2paymentsOrderInformationShipTo, Ptsv2paymentsOrderInformationShippingDetails, Ptsv2paymentsPaymentInformation, Ptsv2paymentsPaymentInformationBank, Ptsv2paymentsPaymentInformationBankAccount, Ptsv2paymentsPaymentInformationCard, Ptsv2paymentsPaymentInformationCustomer, Ptsv2paymentsPaymentInformationFluidData, Ptsv2paymentsPaymentInformationTokenizedCard, Ptsv2paymentsPointOfSaleInformation, Ptsv2paymentsPointOfSaleInformationEmv, Ptsv2paymentsProcessingInformation, Ptsv2paymentsProcessingInformationAuthorizationOptions, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator, Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, Ptsv2paymentsProcessingInformationBankTransferOptions, Ptsv2paymentsProcessingInformationCaptureOptions, Ptsv2paymentsProcessingInformationRecurringOptions, Ptsv2paymentsRecipientInformation, Ptsv2paymentsidcapturesAggregatorInformation, Ptsv2paymentsidcapturesAggregatorInformationSubMerchant, Ptsv2paymentsidcapturesBuyerInformation, Ptsv2paymentsidcapturesInstallmentInformation, Ptsv2paymentsidcapturesMerchantInformation, Ptsv2paymentsidcapturesOrderInformation, Ptsv2paymentsidcapturesOrderInformationAmountDetails, Ptsv2paymentsidcapturesOrderInformationBillTo, Ptsv2paymentsidcapturesOrderInformationInvoiceDetails, Ptsv2paymentsidcapturesOrderInformationShipTo, Ptsv2paymentsidcapturesOrderInformationShippingDetails, Ptsv2paymentsidcapturesPaymentInformation, Ptsv2paymentsidcapturesPointOfSaleInformation, Ptsv2paymentsidcapturesPointOfSaleInformationEmv, Ptsv2paymentsidcapturesProcessingInformation, Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions, Ptsv2paymentsidcapturesProcessingInformationCaptureOptions, Ptsv2paymentsidrefundsMerchantInformation, Ptsv2paymentsidrefundsOrderInformation, Ptsv2paymentsidrefundsOrderInformationLineItems, Ptsv2paymentsidrefundsPaymentInformation, Ptsv2paymentsidrefundsPaymentInformationCard, Ptsv2paymentsidrefundsPointOfSaleInformation, Ptsv2paymentsidrefundsProcessingInformation, Ptsv2paymentsidrefundsProcessingInformationRecurringOptions, Ptsv2paymentsidreversalsClientReferenceInformation, Ptsv2paymentsidreversalsClientReferenceInformationPartner, Ptsv2paymentsidreversalsOrderInformation, Ptsv2paymentsidreversalsOrderInformationAmountDetails, Ptsv2paymentsidreversalsOrderInformationLineItems, Ptsv2paymentsidreversalsPointOfSaleInformation, Ptsv2paymentsidreversalsProcessingInformation, Ptsv2paymentsidreversalsReversalInformation, Ptsv2paymentsidreversalsReversalInformationAmountDetails, Ptsv2payoutsClientReferenceInformation, Ptsv2payoutsMerchantInformation, Ptsv2payoutsMerchantInformationMerchantDescriptor, Ptsv2payoutsOrderInformation, Ptsv2payoutsOrderInformationAmountDetails, Ptsv2payoutsOrderInformationAmountDetailsSurcharge, Ptsv2payoutsOrderInformationBillTo, Ptsv2payoutsPaymentInformation, Ptsv2payoutsPaymentInformationCard, Ptsv2payoutsProcessingInformation, Ptsv2payoutsProcessingInformationPayoutsOptions, Ptsv2payoutsRecipientInformation, Ptsv2payoutsSenderInformation, Ptsv2payoutsSenderInformationAccount, RefundCaptureRequest, RefundPaymentRequest, ReportingV3ConversionDetailsGet200Response, ReportingV3ConversionDetailsGet200ResponseConversionDetails, ReportingV3ConversionDetailsGet200ResponseNotes, ReportingV3NetFundingsGet200Response, ReportingV3NetFundingsGet200ResponseNetFundingSummaries, ReportingV3NetFundingsGet200ResponseTotalPurchases, ReportingV3NotificationofChangesGet200Response, ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges, ReportingV3PurchaseRefundDetailsGet200Response, ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations, ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails, ReportingV3PurchaseRefundDetailsGet200ResponseOthers, ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails, ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses, ReportingV3PurchaseRefundDetailsGet200ResponseSettlements, ReportingV3ReportDefinitionsGet200Response, ReportingV3ReportDefinitionsGet200ResponseReportDefinitions, ReportingV3ReportDefinitionsNameGet200Response, ReportingV3ReportDefinitionsNameGet200ResponseAttributes, ReportingV3ReportSubscriptionsGet200Response, ReportingV3ReportSubscriptionsGet200ResponseSubscriptions, ReportingV3ReportsGet200Response, ReportingV3ReportsGet200ResponseReports, ReportingV3ReportsIdGet200Response, Reportingv3ReportDownloadsGet400Response, Reportingv3ReportDownloadsGet400ResponseDetails, Reportingv3reportsReportPreferences, Request, RequestBody, RequestBody1, ResponseStatus, ResponseStatusDetails, RiskV1AuthenticationResultsPost201Response, RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationsPost201Response, RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationsPost201ResponseOrderInformation, RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails, RiskV1AuthenticationsPost400Response, RiskV1DecisionsPost201Response, RiskV1DecisionsPost201ResponsePaymentInformation, RiskV1DecisionsPost201ResponseRiskInformation, RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, RiskV1DecisionsPost201ResponseRiskInformationIpAddress, RiskV1DecisionsPost201ResponseRiskInformationProfile, RiskV1DecisionsPost201ResponseRiskInformationProviders, RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName, RiskV1DecisionsPost201ResponseRiskInformationRules, RiskV1DecisionsPost201ResponseRiskInformationScore, RiskV1DecisionsPost201ResponseRiskInformationTravel, RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination, RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture, RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination, RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination, RiskV1DecisionsPost201ResponseRiskInformationVelocity, RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing, RiskV1DecisionsPost400Response, Riskv1authenticationresultsConsumerAuthenticationInformation, Riskv1authenticationresultsOrderInformation, Riskv1authenticationresultsOrderInformationLineItems, Riskv1authenticationresultsPaymentInformation, Riskv1authenticationresultsPaymentInformationCard, Riskv1authenticationresultsPaymentInformationTokenizedCard, Riskv1authenticationsBuyerInformation, Riskv1authenticationsClientReferenceInformation, Riskv1authenticationsConsumerAuthenticationInformation, Riskv1authenticationsDeviceInformation, Riskv1authenticationsDeviceInformationRawData, Riskv1authenticationsMerchantInformation, Riskv1authenticationsOrderInformation, Riskv1authenticationsOrderInformationBillTo, Riskv1authenticationsOrderInformationLineItems, Riskv1authenticationsOrderInformationShipTo, Riskv1authenticationsPaymentInformation, Riskv1authenticationsPaymentInformationCard, Riskv1authenticationsPaymentInformationTokenizedCard, Riskv1authenticationsRecurringPaymentInformation, Riskv1authenticationsRiskInformation, Riskv1authenticationsRiskInformationBuyerHistory, Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory, Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount, Riskv1authenticationsTravelInformation, Riskv1authenticationsTravelInformationLegs, Riskv1authenticationsTravelInformationPassengers, Riskv1decisionsBuyerInformation, Riskv1decisionsCardVerification, Riskv1decisionsClientReferenceInformation, Riskv1decisionsDeviceInformation, Riskv1decisionsMerchantDefinedInformation, Riskv1decisionsOrderInformation, Riskv1decisionsOrderInformationAmountDetails, Riskv1decisionsOrderInformationBillTo, Riskv1decisionsOrderInformationLineItems, Riskv1decisionsOrderInformationPassenger, Riskv1decisionsOrderInformationShipTo, Riskv1decisionsOrderInformationShippingDetails, Riskv1decisionsPaymentInformation, Riskv1decisionsPaymentInformationCard, Riskv1decisionsPaymentInformationTokenizedCard, Riskv1decisionsProcessorInformation, Riskv1decisionsProcessorInformationAvs, Riskv1decisionsRiskInformation, Riskv1decisionsRiskInformationProfile, Riskv1decisionsTravelInformation, Riskv1decisionsTravelInformationLegs, SelfLinkBean, TmsV1InstrumentIdentifiersDelete409Response, TmsV1InstrumentIdentifiersDelete409ResponseLinks, TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf, TmsV1InstrumentIdentifiersPost200Response, TmsV1InstrumentIdentifiersPost200ResponseBankAccount, TmsV1InstrumentIdentifiersPost200ResponseCard, TmsV1InstrumentIdentifiersPost200ResponseLinks, TmsV1InstrumentIdentifiersPost200ResponseLinksSelf, TmsV1InstrumentIdentifiersPost200ResponseMetadata, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, Tmsv1instrumentidentifiersBillTo, Tmsv1instrumentidentifiersCard, Tmsv1instrumentidentifiersDetails, TokenizeParameters, TokenizeRequest, TokenizeResult, TssV2TransactionsGet200Response, TssV2TransactionsGet200ResponseApplicationInformation, TssV2TransactionsGet200ResponseApplicationInformationApplications, TssV2TransactionsGet200ResponseBuyerInformation, TssV2TransactionsGet200ResponseClientReferenceInformation, TssV2TransactionsGet200ResponseConsumerAuthenticationInformation, TssV2TransactionsGet200ResponseDeviceInformation, TssV2TransactionsGet200ResponseErrorInformation, TssV2TransactionsGet200ResponseFraudMarkingInformation, TssV2TransactionsGet200ResponseInstallmentInformation, TssV2TransactionsGet200ResponseLinks, TssV2TransactionsGet200ResponseMerchantInformation, TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor, TssV2TransactionsGet200ResponseOrderInformation, TssV2TransactionsGet200ResponseOrderInformationAmountDetails, TssV2TransactionsGet200ResponseOrderInformationBillTo, TssV2TransactionsGet200ResponseOrderInformationLineItems, TssV2TransactionsGet200ResponseOrderInformationShipTo, TssV2TransactionsGet200ResponseOrderInformationShippingDetails, TssV2TransactionsGet200ResponsePaymentInformation, TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures, TssV2TransactionsGet200ResponsePaymentInformationBank, TssV2TransactionsGet200ResponsePaymentInformationBankAccount, TssV2TransactionsGet200ResponsePaymentInformationBankMandate, TssV2TransactionsGet200ResponsePaymentInformationCard, TssV2TransactionsGet200ResponsePaymentInformationInvoice, TssV2TransactionsGet200ResponsePaymentInformationPaymentType, TssV2TransactionsGet200ResponsePointOfSaleInformation, TssV2TransactionsGet200ResponseProcessingInformation, TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions, TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions, TssV2TransactionsGet200ResponseProcessorInformation, TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults, TssV2TransactionsGet200ResponseProcessorInformationProcessor, TssV2TransactionsGet200ResponseRiskInformation, TssV2TransactionsGet200ResponseRiskInformationProfile, TssV2TransactionsGet200ResponseRiskInformationRules, TssV2TransactionsGet200ResponseRiskInformationScore, TssV2TransactionsGet200ResponseSenderInformation, TssV2TransactionsPost201Response, TssV2TransactionsPost201ResponseEmbedded, TssV2TransactionsPost201ResponseEmbeddedBuyerInformation, TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation, TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation, TssV2TransactionsPost201ResponseEmbeddedDeviceInformation, TssV2TransactionsPost201ResponseEmbeddedLinks, TssV2TransactionsPost201ResponseEmbeddedMerchantInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformation, TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo, TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo, TssV2TransactionsPost201ResponseEmbeddedPaymentInformation, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard, TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType, TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation, TssV2TransactionsPost201ResponseEmbeddedProcessingInformation, TssV2TransactionsPost201ResponseEmbeddedProcessorInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformation, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders, TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint, TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries, TssV2TransactionsPost400Response, UmsV1UsersGet200Response, UmsV1UsersGet200ResponseAccountInformation, UmsV1UsersGet200ResponseContactInformation, UmsV1UsersGet200ResponseOrganizationInformation, UmsV1UsersGet200ResponseUsers, UpdateInstrumentIdentifierRequest, UpdatePaymentInstrumentRequest, V1FileDetailsGet200Response, V1FileDetailsGet200ResponseFileDetails, V1FileDetailsGet200ResponseLinks, V1FileDetailsGet200ResponseLinksFiles, V1FileDetailsGet200ResponseLinksSelf, VoidCaptureRequest, VoidCreditRequest, VoidPaymentRequest, VoidRefundRequest, CaptureApi, ConversionDetailsApi, CreditApi, DecisionManagerApi, InstrumentIdentifierApi, KeyGenerationApi, NetFundingsApi, NotificationOfChangesApi, PayerAuthenticationApi, PaymentInstrumentApi, PaymentsApi, PayoutsApi, PurchaseAndRefundDetailsApi, RefundApi, ReportDefinitionsApi, ReportDownloadsApi, ReportSubscriptionsApi, ReportsApi, ReversalApi, SearchTransactionsApi, SecureFileShareApi, TokenizationApi, TransactionBatchesApi, TransactionDetailsApi, UserManagementApi, VoidApi) { + 'use strict'; + + /** + * All_CyberSource_API_specs_merged_together__These_are_available_at_httpsdeveloper_cybersource_comapireferenceapi_reference_html.
index module provides access to constructors for all the classes which comprise the public API.
+ * + * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: + *
+ * var CyberSource = require('index'); // See note below*.
+ * var xxxSvc = new CyberSource.XxxApi(); // Allocate the API class we're going to use.
+ * var yyyModel = new CyberSource.Yyy(); // Construct a model instance.
+ * yyyModel.someProperty = 'someValue';
+ * ...
+ * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+ * ...
+ *
+ * *NOTE: For a top-level AMD script, use require(['index'], function(){...})
+ * and put the application logic within the callback function.
+ *
+ * + * A non-AMD browser application (discouraged) might do something like this: + *
+ * var xxxSvc = new CyberSource.XxxApi(); // Allocate the API class we're going to use. + * var yyy = new CyberSource.Yyy(); // Construct a model instance. + * yyyModel.someProperty = 'someValue'; + * ... + * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service. + * ... + *+ * + * @module index + * @version 0.0.1 + */ + var exports = { + /** + * The ApiClient constructor. + * @property {module:ApiClient} + */ + ApiClient: ApiClient, + /** + * The AuthReversalRequest model constructor. + * @property {module:model/AuthReversalRequest} + */ + AuthReversalRequest: AuthReversalRequest, + /** + * The AuthorizationOptions model constructor. + * @property {module:model/AuthorizationOptions} + */ + AuthorizationOptions: AuthorizationOptions, + /** + * The BillTo model constructor. + * @property {module:model/BillTo} + */ + BillTo: BillTo, + /** + * The BuyerInformation model constructor. + * @property {module:model/BuyerInformation} + */ + BuyerInformation: BuyerInformation, + /** + * The CapturePaymentRequest model constructor. + * @property {module:model/CapturePaymentRequest} + */ + CapturePaymentRequest: CapturePaymentRequest, + /** + * The CardInfo model constructor. + * @property {module:model/CardInfo} + */ + CardInfo: CardInfo, + /** + * The CheckPayerAuthEnrollmentRequest model constructor. + * @property {module:model/CheckPayerAuthEnrollmentRequest} + */ + CheckPayerAuthEnrollmentRequest: CheckPayerAuthEnrollmentRequest, + /** + * The CreateCreditRequest model constructor. + * @property {module:model/CreateCreditRequest} + */ + CreateCreditRequest: CreateCreditRequest, + /** + * The CreateDecisionManagerCaseRequest model constructor. + * @property {module:model/CreateDecisionManagerCaseRequest} + */ + CreateDecisionManagerCaseRequest: CreateDecisionManagerCaseRequest, + /** + * The CreateInstrumentIdentifierRequest model constructor. + * @property {module:model/CreateInstrumentIdentifierRequest} + */ + CreateInstrumentIdentifierRequest: CreateInstrumentIdentifierRequest, + /** + * The CreatePaymentInstrumentRequest model constructor. + * @property {module:model/CreatePaymentInstrumentRequest} + */ + CreatePaymentInstrumentRequest: CreatePaymentInstrumentRequest, + /** + * The CreatePaymentRequest model constructor. + * @property {module:model/CreatePaymentRequest} + */ + CreatePaymentRequest: CreatePaymentRequest, + /** + * The CreateSearchRequest model constructor. + * @property {module:model/CreateSearchRequest} + */ + CreateSearchRequest: CreateSearchRequest, + /** + * The DerPublicKey model constructor. + * @property {module:model/DerPublicKey} + */ + DerPublicKey: DerPublicKey, + /** + * The Detail model constructor. + * @property {module:model/Detail} + */ + Detail: Detail, + /** + * The EmbeddedInstrumentIdentifier model constructor. + * @property {module:model/EmbeddedInstrumentIdentifier} + */ + EmbeddedInstrumentIdentifier: EmbeddedInstrumentIdentifier, + /** + * The Error model constructor. + * @property {module:model/Error} + */ + Error: Error, + /** + * The ErrorBean model constructor. + * @property {module:model/ErrorBean} + */ + ErrorBean: ErrorBean, + /** + * The ErrorFieldBean model constructor. + * @property {module:model/ErrorFieldBean} + */ + ErrorFieldBean: ErrorFieldBean, + /** + * The ErrorLinks model constructor. + * @property {module:model/ErrorLinks} + */ + ErrorLinks: ErrorLinks, + /** + * The ErrorResponse model constructor. + * @property {module:model/ErrorResponse} + */ + ErrorResponse: ErrorResponse, + /** + * The ErrorResponseWithHAL model constructor. + * @property {module:model/ErrorResponseWithHAL} + */ + ErrorResponseWithHAL: ErrorResponseWithHAL, + /** + * The ExistingInstrumentIdentifierId model constructor. + * @property {module:model/ExistingInstrumentIdentifierId} + */ + ExistingInstrumentIdentifierId: ExistingInstrumentIdentifierId, + /** + * The FileBean model constructor. + * @property {module:model/FileBean} + */ + FileBean: FileBean, + /** + * The FileDetail model constructor. + * @property {module:model/FileDetail} + */ + FileDetail: FileDetail, + /** + * The FileDetailsResponse model constructor. + * @property {module:model/FileDetailsResponse} + */ + FileDetailsResponse: FileDetailsResponse, + /** + * The FlexV1KeysPost200Response model constructor. + * @property {module:model/FlexV1KeysPost200Response} + */ + FlexV1KeysPost200Response: FlexV1KeysPost200Response, + /** + * The FlexV1KeysPost200ResponseDer model constructor. + * @property {module:model/FlexV1KeysPost200ResponseDer} + */ + FlexV1KeysPost200ResponseDer: FlexV1KeysPost200ResponseDer, + /** + * The FlexV1KeysPost200ResponseJwk model constructor. + * @property {module:model/FlexV1KeysPost200ResponseJwk} + */ + FlexV1KeysPost200ResponseJwk: FlexV1KeysPost200ResponseJwk, + /** + * The FlexV1TokensPost200Response model constructor. + * @property {module:model/FlexV1TokensPost200Response} + */ + FlexV1TokensPost200Response: FlexV1TokensPost200Response, + /** + * The Flexv1tokensCardInfo model constructor. + * @property {module:model/Flexv1tokensCardInfo} + */ + Flexv1tokensCardInfo: Flexv1tokensCardInfo, + /** + * The GeneratePublicKeyRequest model constructor. + * @property {module:model/GeneratePublicKeyRequest} + */ + GeneratePublicKeyRequest: GeneratePublicKeyRequest, + /** + * The Initiator model constructor. + * @property {module:model/Initiator} + */ + Initiator: Initiator, + /** + * The InlineResponse400 model constructor. + * @property {module:model/InlineResponse400} + */ + InlineResponse400: InlineResponse400, + /** + * The InlineResponse4001 model constructor. + * @property {module:model/InlineResponse4001} + */ + InlineResponse4001: InlineResponse4001, + /** + * The InlineResponse400Fields model constructor. + * @property {module:model/InlineResponse400Fields} + */ + InlineResponse400Fields: InlineResponse400Fields, + /** + * The InlineResponseDefault model constructor. + * @property {module:model/InlineResponseDefault} + */ + InlineResponseDefault: InlineResponseDefault, + /** + * The InlineResponseDefaultLinks model constructor. + * @property {module:model/InlineResponseDefaultLinks} + */ + InlineResponseDefaultLinks: InlineResponseDefaultLinks, + /** + * The InlineResponseDefaultLinksNext model constructor. + * @property {module:model/InlineResponseDefaultLinksNext} + */ + InlineResponseDefaultLinksNext: InlineResponseDefaultLinksNext, + /** + * The InlineResponseDefaultResponseStatus model constructor. + * @property {module:model/InlineResponseDefaultResponseStatus} + */ + InlineResponseDefaultResponseStatus: InlineResponseDefaultResponseStatus, + /** + * The InlineResponseDefaultResponseStatusDetails model constructor. + * @property {module:model/InlineResponseDefaultResponseStatusDetails} + */ + InlineResponseDefaultResponseStatusDetails: InlineResponseDefaultResponseStatusDetails, + /** + * The InstrumentIdentifier model constructor. + * @property {module:model/InstrumentIdentifier} + */ + InstrumentIdentifier: InstrumentIdentifier, + /** + * The InstrumentIdentifierBankAccount model constructor. + * @property {module:model/InstrumentIdentifierBankAccount} + */ + InstrumentIdentifierBankAccount: InstrumentIdentifierBankAccount, + /** + * The InstrumentIdentifierCard model constructor. + * @property {module:model/InstrumentIdentifierCard} + */ + InstrumentIdentifierCard: InstrumentIdentifierCard, + /** + * The InstrumentIdentifierEnrollableCard model constructor. + * @property {module:model/InstrumentIdentifierEnrollableCard} + */ + InstrumentIdentifierEnrollableCard: InstrumentIdentifierEnrollableCard, + /** + * The InstrumentIdentifierProcessingInformation model constructor. + * @property {module:model/InstrumentIdentifierProcessingInformation} + */ + InstrumentIdentifierProcessingInformation: InstrumentIdentifierProcessingInformation, + /** + * The InstrumentIdentifierUpdate model constructor. + * @property {module:model/InstrumentIdentifierUpdate} + */ + InstrumentIdentifierUpdate: InstrumentIdentifierUpdate, + /** + * The JsonWebKey model constructor. + * @property {module:model/JsonWebKey} + */ + JsonWebKey: JsonWebKey, + /** + * The KeyParameters model constructor. + * @property {module:model/KeyParameters} + */ + KeyParameters: KeyParameters, + /** + * The KeyResult model constructor. + * @property {module:model/KeyResult} + */ + KeyResult: KeyResult, + /** + * The Link model constructor. + * @property {module:model/Link} + */ + Link: Link, + /** + * The Links model constructor. + * @property {module:model/Links} + */ + Links: Links, + /** + * The MerchantInformation model constructor. + * @property {module:model/MerchantInformation} + */ + MerchantInformation: MerchantInformation, + /** + * The MerchantInitiatedTransaction model constructor. + * @property {module:model/MerchantInitiatedTransaction} + */ + MerchantInitiatedTransaction: MerchantInitiatedTransaction, + /** + * The Metadata model constructor. + * @property {module:model/Metadata} + */ + Metadata: Metadata, + /** + * The Model409Link model constructor. + * @property {module:model/Model409Link} + */ + Model409Link: Model409Link, + /** + * The Model409Links model constructor. + * @property {module:model/Model409Links} + */ + Model409Links: Model409Links, + /** + * The OctCreatePaymentRequest model constructor. + * @property {module:model/OctCreatePaymentRequest} + */ + OctCreatePaymentRequest: OctCreatePaymentRequest, + /** + * The PIForIILinkFirst model constructor. + * @property {module:model/PIForIILinkFirst} + */ + PIForIILinkFirst: PIForIILinkFirst, + /** + * The PIForIILinkLast model constructor. + * @property {module:model/PIForIILinkLast} + */ + PIForIILinkLast: PIForIILinkLast, + /** + * The PIForIILinkNext model constructor. + * @property {module:model/PIForIILinkNext} + */ + PIForIILinkNext: PIForIILinkNext, + /** + * The PIForIILinkPrev model constructor. + * @property {module:model/PIForIILinkPrev} + */ + PIForIILinkPrev: PIForIILinkPrev, + /** + * The PIForIILinkSelf model constructor. + * @property {module:model/PIForIILinkSelf} + */ + PIForIILinkSelf: PIForIILinkSelf, + /** + * The PaymentInstrument model constructor. + * @property {module:model/PaymentInstrument} + */ + PaymentInstrument: PaymentInstrument, + /** + * The PaymentInstrumentBankAccount model constructor. + * @property {module:model/PaymentInstrumentBankAccount} + */ + PaymentInstrumentBankAccount: PaymentInstrumentBankAccount, + /** + * The PaymentInstrumentCard model constructor. + * @property {module:model/PaymentInstrumentCard} + */ + PaymentInstrumentCard: PaymentInstrumentCard, + /** + * The PaymentInstrumentForInstrumentIdentifierLinks model constructor. + * @property {module:model/PaymentInstrumentForInstrumentIdentifierLinks} + */ + PaymentInstrumentForInstrumentIdentifierLinks: PaymentInstrumentForInstrumentIdentifierLinks, + /** + * The PaymentInstrumentsArray model constructor. + * @property {module:model/PaymentInstrumentsArray} + */ + PaymentInstrumentsArray: PaymentInstrumentsArray, + /** + * The PaymentInstrumentsForInstrumentIdentifier model constructor. + * @property {module:model/PaymentInstrumentsForInstrumentIdentifier} + */ + PaymentInstrumentsForInstrumentIdentifier: PaymentInstrumentsForInstrumentIdentifier, + /** + * The PersonalIdentification model constructor. + * @property {module:model/PersonalIdentification} + */ + PersonalIdentification: PersonalIdentification, + /** + * The PersonalIdentificationArray model constructor. + * @property {module:model/PersonalIdentificationArray} + */ + PersonalIdentificationArray: PersonalIdentificationArray, + /** + * The ProcessingInformation model constructor. + * @property {module:model/ProcessingInformation} + */ + ProcessingInformation: ProcessingInformation, + /** + * The PtsV1TransactionBatchesGet200Response model constructor. + * @property {module:model/PtsV1TransactionBatchesGet200Response} + */ + PtsV1TransactionBatchesGet200Response: PtsV1TransactionBatchesGet200Response, + /** + * The PtsV1TransactionBatchesGet200ResponseLinks model constructor. + * @property {module:model/PtsV1TransactionBatchesGet200ResponseLinks} + */ + PtsV1TransactionBatchesGet200ResponseLinks: PtsV1TransactionBatchesGet200ResponseLinks, + /** + * The PtsV1TransactionBatchesGet200ResponseLinksSelf model constructor. + * @property {module:model/PtsV1TransactionBatchesGet200ResponseLinksSelf} + */ + PtsV1TransactionBatchesGet200ResponseLinksSelf: PtsV1TransactionBatchesGet200ResponseLinksSelf, + /** + * The PtsV1TransactionBatchesGet200ResponseTransactionBatches model constructor. + * @property {module:model/PtsV1TransactionBatchesGet200ResponseTransactionBatches} + */ + PtsV1TransactionBatchesGet200ResponseTransactionBatches: PtsV1TransactionBatchesGet200ResponseTransactionBatches, + /** + * The PtsV1TransactionBatchesGet400Response model constructor. + * @property {module:model/PtsV1TransactionBatchesGet400Response} + */ + PtsV1TransactionBatchesGet400Response: PtsV1TransactionBatchesGet400Response, + /** + * The PtsV1TransactionBatchesGet400ResponseErrorInformation model constructor. + * @property {module:model/PtsV1TransactionBatchesGet400ResponseErrorInformation} + */ + PtsV1TransactionBatchesGet400ResponseErrorInformation: PtsV1TransactionBatchesGet400ResponseErrorInformation, + /** + * The PtsV1TransactionBatchesGet400ResponseErrorInformationDetails model constructor. + * @property {module:model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails} + */ + PtsV1TransactionBatchesGet400ResponseErrorInformationDetails: PtsV1TransactionBatchesGet400ResponseErrorInformationDetails, + /** + * The PtsV1TransactionBatchesGet500Response model constructor. + * @property {module:model/PtsV1TransactionBatchesGet500Response} + */ + PtsV1TransactionBatchesGet500Response: PtsV1TransactionBatchesGet500Response, + /** + * The PtsV1TransactionBatchesGet500ResponseErrorInformation model constructor. + * @property {module:model/PtsV1TransactionBatchesGet500ResponseErrorInformation} + */ + PtsV1TransactionBatchesGet500ResponseErrorInformation: PtsV1TransactionBatchesGet500ResponseErrorInformation, + /** + * The PtsV1TransactionBatchesIdGet200Response model constructor. + * @property {module:model/PtsV1TransactionBatchesIdGet200Response} + */ + PtsV1TransactionBatchesIdGet200Response: PtsV1TransactionBatchesIdGet200Response, + /** + * The PtsV1TransactionBatchesIdGet200ResponseLinks model constructor. + * @property {module:model/PtsV1TransactionBatchesIdGet200ResponseLinks} + */ + PtsV1TransactionBatchesIdGet200ResponseLinks: PtsV1TransactionBatchesIdGet200ResponseLinks, + /** + * The PtsV1TransactionBatchesIdGet200ResponseLinksTransactions model constructor. + * @property {module:model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions} + */ + PtsV1TransactionBatchesIdGet200ResponseLinksTransactions: PtsV1TransactionBatchesIdGet200ResponseLinksTransactions, + /** + * The PtsV2CreditsPost201Response model constructor. + * @property {module:model/PtsV2CreditsPost201Response} + */ + PtsV2CreditsPost201Response: PtsV2CreditsPost201Response, + /** + * The PtsV2CreditsPost201ResponseCreditAmountDetails model constructor. + * @property {module:model/PtsV2CreditsPost201ResponseCreditAmountDetails} + */ + PtsV2CreditsPost201ResponseCreditAmountDetails: PtsV2CreditsPost201ResponseCreditAmountDetails, + /** + * The PtsV2CreditsPost201ResponsePaymentInformation model constructor. + * @property {module:model/PtsV2CreditsPost201ResponsePaymentInformation} + */ + PtsV2CreditsPost201ResponsePaymentInformation: PtsV2CreditsPost201ResponsePaymentInformation, + /** + * The PtsV2CreditsPost201ResponseProcessingInformation model constructor. + * @property {module:model/PtsV2CreditsPost201ResponseProcessingInformation} + */ + PtsV2CreditsPost201ResponseProcessingInformation: PtsV2CreditsPost201ResponseProcessingInformation, + /** + * The PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions model constructor. + * @property {module:model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions} + */ + PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions: PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions, + /** + * The PtsV2PaymentsCapturesPost201Response model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost201Response} + */ + PtsV2PaymentsCapturesPost201Response: PtsV2PaymentsCapturesPost201Response, + /** + * The PtsV2PaymentsCapturesPost201ResponseLinks model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost201ResponseLinks} + */ + PtsV2PaymentsCapturesPost201ResponseLinks: PtsV2PaymentsCapturesPost201ResponseLinks, + /** + * The PtsV2PaymentsCapturesPost201ResponseOrderInformation model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost201ResponseOrderInformation} + */ + PtsV2PaymentsCapturesPost201ResponseOrderInformation: PtsV2PaymentsCapturesPost201ResponseOrderInformation, + /** + * The PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails} + */ + PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails: PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails, + /** + * The PtsV2PaymentsCapturesPost201ResponseProcessorInformation model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation} + */ + PtsV2PaymentsCapturesPost201ResponseProcessorInformation: PtsV2PaymentsCapturesPost201ResponseProcessorInformation, + /** + * The PtsV2PaymentsCapturesPost400Response model constructor. + * @property {module:model/PtsV2PaymentsCapturesPost400Response} + */ + PtsV2PaymentsCapturesPost400Response: PtsV2PaymentsCapturesPost400Response, + /** + * The PtsV2PaymentsPost201Response model constructor. + * @property {module:model/PtsV2PaymentsPost201Response} + */ + PtsV2PaymentsPost201Response: PtsV2PaymentsPost201Response, + /** + * The PtsV2PaymentsPost201ResponseClientReferenceInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseClientReferenceInformation} + */ + PtsV2PaymentsPost201ResponseClientReferenceInformation: PtsV2PaymentsPost201ResponseClientReferenceInformation, + /** + * The PtsV2PaymentsPost201ResponseErrorInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseErrorInformation} + */ + PtsV2PaymentsPost201ResponseErrorInformation: PtsV2PaymentsPost201ResponseErrorInformation, + /** + * The PtsV2PaymentsPost201ResponseErrorInformationDetails model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseErrorInformationDetails} + */ + PtsV2PaymentsPost201ResponseErrorInformationDetails: PtsV2PaymentsPost201ResponseErrorInformationDetails, + /** + * The PtsV2PaymentsPost201ResponseInstallmentInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseInstallmentInformation} + */ + PtsV2PaymentsPost201ResponseInstallmentInformation: PtsV2PaymentsPost201ResponseInstallmentInformation, + /** + * The PtsV2PaymentsPost201ResponseIssuerInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseIssuerInformation} + */ + PtsV2PaymentsPost201ResponseIssuerInformation: PtsV2PaymentsPost201ResponseIssuerInformation, + /** + * The PtsV2PaymentsPost201ResponseLinks model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseLinks} + */ + PtsV2PaymentsPost201ResponseLinks: PtsV2PaymentsPost201ResponseLinks, + /** + * The PtsV2PaymentsPost201ResponseLinksSelf model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseLinksSelf} + */ + PtsV2PaymentsPost201ResponseLinksSelf: PtsV2PaymentsPost201ResponseLinksSelf, + /** + * The PtsV2PaymentsPost201ResponseOrderInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformation} + */ + PtsV2PaymentsPost201ResponseOrderInformation: PtsV2PaymentsPost201ResponseOrderInformation, + /** + * The PtsV2PaymentsPost201ResponseOrderInformationAmountDetails model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails} + */ + PtsV2PaymentsPost201ResponseOrderInformationAmountDetails: PtsV2PaymentsPost201ResponseOrderInformationAmountDetails, + /** + * The PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails} + */ + PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails: PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformation} + */ + PtsV2PaymentsPost201ResponsePaymentInformation: PtsV2PaymentsPost201ResponsePaymentInformation, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures} + */ + PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures: PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformationBank model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationBank} + */ + PtsV2PaymentsPost201ResponsePaymentInformationBank: PtsV2PaymentsPost201ResponsePaymentInformationBank, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformationBankAccount model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount} + */ + PtsV2PaymentsPost201ResponsePaymentInformationBankAccount: PtsV2PaymentsPost201ResponsePaymentInformationBankAccount, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformationCard model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationCard} + */ + PtsV2PaymentsPost201ResponsePaymentInformationCard: PtsV2PaymentsPost201ResponsePaymentInformationCard, + /** + * The PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard} + */ + PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard: PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard, + /** + * The PtsV2PaymentsPost201ResponsePointOfSaleInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePointOfSaleInformation} + */ + PtsV2PaymentsPost201ResponsePointOfSaleInformation: PtsV2PaymentsPost201ResponsePointOfSaleInformation, + /** + * The PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv} + */ + PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv: PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv, + /** + * The PtsV2PaymentsPost201ResponseProcessingInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessingInformation} + */ + PtsV2PaymentsPost201ResponseProcessingInformation: PtsV2PaymentsPost201ResponseProcessingInformation, + /** + * The PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions} + */ + PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions: PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformation model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformation} + */ + PtsV2PaymentsPost201ResponseProcessorInformation: PtsV2PaymentsPost201ResponseProcessorInformation, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationAchVerification model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification} + */ + PtsV2PaymentsPost201ResponseProcessorInformationAchVerification: PtsV2PaymentsPost201ResponseProcessorInformationAchVerification, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationAvs model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationAvs} + */ + PtsV2PaymentsPost201ResponseProcessorInformationAvs: PtsV2PaymentsPost201ResponseProcessorInformationAvs, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationCardVerification model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification} + */ + PtsV2PaymentsPost201ResponseProcessorInformationCardVerification: PtsV2PaymentsPost201ResponseProcessorInformationCardVerification, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse} + */ + PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse: PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationCustomer model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer} + */ + PtsV2PaymentsPost201ResponseProcessorInformationCustomer: PtsV2PaymentsPost201ResponseProcessorInformationCustomer, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults} + */ + PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults: PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice} + */ + PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice: PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice, + /** + * The PtsV2PaymentsPost201ResponseProcessorInformationRouting model constructor. + * @property {module:model/PtsV2PaymentsPost201ResponseProcessorInformationRouting} + */ + PtsV2PaymentsPost201ResponseProcessorInformationRouting: PtsV2PaymentsPost201ResponseProcessorInformationRouting, + /** + * The PtsV2PaymentsPost400Response model constructor. + * @property {module:model/PtsV2PaymentsPost400Response} + */ + PtsV2PaymentsPost400Response: PtsV2PaymentsPost400Response, + /** + * The PtsV2PaymentsPost502Response model constructor. + * @property {module:model/PtsV2PaymentsPost502Response} + */ + PtsV2PaymentsPost502Response: PtsV2PaymentsPost502Response, + /** + * The PtsV2PaymentsRefundPost201Response model constructor. + * @property {module:model/PtsV2PaymentsRefundPost201Response} + */ + PtsV2PaymentsRefundPost201Response: PtsV2PaymentsRefundPost201Response, + /** + * The PtsV2PaymentsRefundPost201ResponseLinks model constructor. + * @property {module:model/PtsV2PaymentsRefundPost201ResponseLinks} + */ + PtsV2PaymentsRefundPost201ResponseLinks: PtsV2PaymentsRefundPost201ResponseLinks, + /** + * The PtsV2PaymentsRefundPost201ResponseOrderInformation model constructor. + * @property {module:model/PtsV2PaymentsRefundPost201ResponseOrderInformation} + */ + PtsV2PaymentsRefundPost201ResponseOrderInformation: PtsV2PaymentsRefundPost201ResponseOrderInformation, + /** + * The PtsV2PaymentsRefundPost201ResponseProcessorInformation model constructor. + * @property {module:model/PtsV2PaymentsRefundPost201ResponseProcessorInformation} + */ + PtsV2PaymentsRefundPost201ResponseProcessorInformation: PtsV2PaymentsRefundPost201ResponseProcessorInformation, + /** + * The PtsV2PaymentsRefundPost201ResponseRefundAmountDetails model constructor. + * @property {module:model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails} + */ + PtsV2PaymentsRefundPost201ResponseRefundAmountDetails: PtsV2PaymentsRefundPost201ResponseRefundAmountDetails, + /** + * The PtsV2PaymentsRefundPost400Response model constructor. + * @property {module:model/PtsV2PaymentsRefundPost400Response} + */ + PtsV2PaymentsRefundPost400Response: PtsV2PaymentsRefundPost400Response, + /** + * The PtsV2PaymentsReversalsPost201Response model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201Response} + */ + PtsV2PaymentsReversalsPost201Response: PtsV2PaymentsReversalsPost201Response, + /** + * The PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation} + */ + PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation: PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation, + /** + * The PtsV2PaymentsReversalsPost201ResponseIssuerInformation model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation} + */ + PtsV2PaymentsReversalsPost201ResponseIssuerInformation: PtsV2PaymentsReversalsPost201ResponseIssuerInformation, + /** + * The PtsV2PaymentsReversalsPost201ResponseLinks model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201ResponseLinks} + */ + PtsV2PaymentsReversalsPost201ResponseLinks: PtsV2PaymentsReversalsPost201ResponseLinks, + /** + * The PtsV2PaymentsReversalsPost201ResponseProcessorInformation model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation} + */ + PtsV2PaymentsReversalsPost201ResponseProcessorInformation: PtsV2PaymentsReversalsPost201ResponseProcessorInformation, + /** + * The PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails} + */ + PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails: PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails, + /** + * The PtsV2PaymentsReversalsPost400Response model constructor. + * @property {module:model/PtsV2PaymentsReversalsPost400Response} + */ + PtsV2PaymentsReversalsPost400Response: PtsV2PaymentsReversalsPost400Response, + /** + * The PtsV2PaymentsVoidsPost201Response model constructor. + * @property {module:model/PtsV2PaymentsVoidsPost201Response} + */ + PtsV2PaymentsVoidsPost201Response: PtsV2PaymentsVoidsPost201Response, + /** + * The PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails model constructor. + * @property {module:model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails} + */ + PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails: PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails, + /** + * The PtsV2PaymentsVoidsPost400Response model constructor. + * @property {module:model/PtsV2PaymentsVoidsPost400Response} + */ + PtsV2PaymentsVoidsPost400Response: PtsV2PaymentsVoidsPost400Response, + /** + * The PtsV2PayoutsPost201Response model constructor. + * @property {module:model/PtsV2PayoutsPost201Response} + */ + PtsV2PayoutsPost201Response: PtsV2PayoutsPost201Response, + /** + * The PtsV2PayoutsPost201ResponseErrorInformation model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseErrorInformation} + */ + PtsV2PayoutsPost201ResponseErrorInformation: PtsV2PayoutsPost201ResponseErrorInformation, + /** + * The PtsV2PayoutsPost201ResponseMerchantInformation model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseMerchantInformation} + */ + PtsV2PayoutsPost201ResponseMerchantInformation: PtsV2PayoutsPost201ResponseMerchantInformation, + /** + * The PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor} + */ + PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor: PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor, + /** + * The PtsV2PayoutsPost201ResponseOrderInformation model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseOrderInformation} + */ + PtsV2PayoutsPost201ResponseOrderInformation: PtsV2PayoutsPost201ResponseOrderInformation, + /** + * The PtsV2PayoutsPost201ResponseOrderInformationAmountDetails model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails} + */ + PtsV2PayoutsPost201ResponseOrderInformationAmountDetails: PtsV2PayoutsPost201ResponseOrderInformationAmountDetails, + /** + * The PtsV2PayoutsPost201ResponseProcessorInformation model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseProcessorInformation} + */ + PtsV2PayoutsPost201ResponseProcessorInformation: PtsV2PayoutsPost201ResponseProcessorInformation, + /** + * The PtsV2PayoutsPost201ResponseRecipientInformation model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseRecipientInformation} + */ + PtsV2PayoutsPost201ResponseRecipientInformation: PtsV2PayoutsPost201ResponseRecipientInformation, + /** + * The PtsV2PayoutsPost201ResponseRecipientInformationCard model constructor. + * @property {module:model/PtsV2PayoutsPost201ResponseRecipientInformationCard} + */ + PtsV2PayoutsPost201ResponseRecipientInformationCard: PtsV2PayoutsPost201ResponseRecipientInformationCard, + /** + * The PtsV2PayoutsPost400Response model constructor. + * @property {module:model/PtsV2PayoutsPost400Response} + */ + PtsV2PayoutsPost400Response: PtsV2PayoutsPost400Response, + /** + * The Ptsv2creditsPointOfSaleInformation model constructor. + * @property {module:model/Ptsv2creditsPointOfSaleInformation} + */ + Ptsv2creditsPointOfSaleInformation: Ptsv2creditsPointOfSaleInformation, + /** + * The Ptsv2creditsPointOfSaleInformationEmv model constructor. + * @property {module:model/Ptsv2creditsPointOfSaleInformationEmv} + */ + Ptsv2creditsPointOfSaleInformationEmv: Ptsv2creditsPointOfSaleInformationEmv, + /** + * The Ptsv2creditsProcessingInformation model constructor. + * @property {module:model/Ptsv2creditsProcessingInformation} + */ + Ptsv2creditsProcessingInformation: Ptsv2creditsProcessingInformation, + /** + * The Ptsv2creditsProcessingInformationBankTransferOptions model constructor. + * @property {module:model/Ptsv2creditsProcessingInformationBankTransferOptions} + */ + Ptsv2creditsProcessingInformationBankTransferOptions: Ptsv2creditsProcessingInformationBankTransferOptions, + /** + * The Ptsv2paymentsAggregatorInformation model constructor. + * @property {module:model/Ptsv2paymentsAggregatorInformation} + */ + Ptsv2paymentsAggregatorInformation: Ptsv2paymentsAggregatorInformation, + /** + * The Ptsv2paymentsAggregatorInformationSubMerchant model constructor. + * @property {module:model/Ptsv2paymentsAggregatorInformationSubMerchant} + */ + Ptsv2paymentsAggregatorInformationSubMerchant: Ptsv2paymentsAggregatorInformationSubMerchant, + /** + * The Ptsv2paymentsBuyerInformation model constructor. + * @property {module:model/Ptsv2paymentsBuyerInformation} + */ + Ptsv2paymentsBuyerInformation: Ptsv2paymentsBuyerInformation, + /** + * The Ptsv2paymentsBuyerInformationPersonalIdentification model constructor. + * @property {module:model/Ptsv2paymentsBuyerInformationPersonalIdentification} + */ + Ptsv2paymentsBuyerInformationPersonalIdentification: Ptsv2paymentsBuyerInformationPersonalIdentification, + /** + * The Ptsv2paymentsClientReferenceInformation model constructor. + * @property {module:model/Ptsv2paymentsClientReferenceInformation} + */ + Ptsv2paymentsClientReferenceInformation: Ptsv2paymentsClientReferenceInformation, + /** + * The Ptsv2paymentsClientReferenceInformationPartner model constructor. + * @property {module:model/Ptsv2paymentsClientReferenceInformationPartner} + */ + Ptsv2paymentsClientReferenceInformationPartner: Ptsv2paymentsClientReferenceInformationPartner, + /** + * The Ptsv2paymentsConsumerAuthenticationInformation model constructor. + * @property {module:model/Ptsv2paymentsConsumerAuthenticationInformation} + */ + Ptsv2paymentsConsumerAuthenticationInformation: Ptsv2paymentsConsumerAuthenticationInformation, + /** + * The Ptsv2paymentsDeviceInformation model constructor. + * @property {module:model/Ptsv2paymentsDeviceInformation} + */ + Ptsv2paymentsDeviceInformation: Ptsv2paymentsDeviceInformation, + /** + * The Ptsv2paymentsInstallmentInformation model constructor. + * @property {module:model/Ptsv2paymentsInstallmentInformation} + */ + Ptsv2paymentsInstallmentInformation: Ptsv2paymentsInstallmentInformation, + /** + * The Ptsv2paymentsIssuerInformation model constructor. + * @property {module:model/Ptsv2paymentsIssuerInformation} + */ + Ptsv2paymentsIssuerInformation: Ptsv2paymentsIssuerInformation, + /** + * The Ptsv2paymentsMerchantDefinedInformation model constructor. + * @property {module:model/Ptsv2paymentsMerchantDefinedInformation} + */ + Ptsv2paymentsMerchantDefinedInformation: Ptsv2paymentsMerchantDefinedInformation, + /** + * The Ptsv2paymentsMerchantInformation model constructor. + * @property {module:model/Ptsv2paymentsMerchantInformation} + */ + Ptsv2paymentsMerchantInformation: Ptsv2paymentsMerchantInformation, + /** + * The Ptsv2paymentsMerchantInformationMerchantDescriptor model constructor. + * @property {module:model/Ptsv2paymentsMerchantInformationMerchantDescriptor} + */ + Ptsv2paymentsMerchantInformationMerchantDescriptor: Ptsv2paymentsMerchantInformationMerchantDescriptor, + /** + * The Ptsv2paymentsMerchantInformationServiceFeeDescriptor model constructor. + * @property {module:model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor} + */ + Ptsv2paymentsMerchantInformationServiceFeeDescriptor: Ptsv2paymentsMerchantInformationServiceFeeDescriptor, + /** + * The Ptsv2paymentsOrderInformation model constructor. + * @property {module:model/Ptsv2paymentsOrderInformation} + */ + Ptsv2paymentsOrderInformation: Ptsv2paymentsOrderInformation, + /** + * The Ptsv2paymentsOrderInformationAmountDetails model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationAmountDetails} + */ + Ptsv2paymentsOrderInformationAmountDetails: Ptsv2paymentsOrderInformationAmountDetails, + /** + * The Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts} + */ + Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts: Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts, + /** + * The Ptsv2paymentsOrderInformationAmountDetailsSurcharge model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge} + */ + Ptsv2paymentsOrderInformationAmountDetailsSurcharge: Ptsv2paymentsOrderInformationAmountDetailsSurcharge, + /** + * The Ptsv2paymentsOrderInformationAmountDetailsTaxDetails model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails} + */ + Ptsv2paymentsOrderInformationAmountDetailsTaxDetails: Ptsv2paymentsOrderInformationAmountDetailsTaxDetails, + /** + * The Ptsv2paymentsOrderInformationBillTo model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationBillTo} + */ + Ptsv2paymentsOrderInformationBillTo: Ptsv2paymentsOrderInformationBillTo, + /** + * The Ptsv2paymentsOrderInformationBillToCompany model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationBillToCompany} + */ + Ptsv2paymentsOrderInformationBillToCompany: Ptsv2paymentsOrderInformationBillToCompany, + /** + * The Ptsv2paymentsOrderInformationInvoiceDetails model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationInvoiceDetails} + */ + Ptsv2paymentsOrderInformationInvoiceDetails: Ptsv2paymentsOrderInformationInvoiceDetails, + /** + * The Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum} + */ + Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum: Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum, + /** + * The Ptsv2paymentsOrderInformationLineItems model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationLineItems} + */ + Ptsv2paymentsOrderInformationLineItems: Ptsv2paymentsOrderInformationLineItems, + /** + * The Ptsv2paymentsOrderInformationShipTo model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationShipTo} + */ + Ptsv2paymentsOrderInformationShipTo: Ptsv2paymentsOrderInformationShipTo, + /** + * The Ptsv2paymentsOrderInformationShippingDetails model constructor. + * @property {module:model/Ptsv2paymentsOrderInformationShippingDetails} + */ + Ptsv2paymentsOrderInformationShippingDetails: Ptsv2paymentsOrderInformationShippingDetails, + /** + * The Ptsv2paymentsPaymentInformation model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformation} + */ + Ptsv2paymentsPaymentInformation: Ptsv2paymentsPaymentInformation, + /** + * The Ptsv2paymentsPaymentInformationBank model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationBank} + */ + Ptsv2paymentsPaymentInformationBank: Ptsv2paymentsPaymentInformationBank, + /** + * The Ptsv2paymentsPaymentInformationBankAccount model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationBankAccount} + */ + Ptsv2paymentsPaymentInformationBankAccount: Ptsv2paymentsPaymentInformationBankAccount, + /** + * The Ptsv2paymentsPaymentInformationCard model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationCard} + */ + Ptsv2paymentsPaymentInformationCard: Ptsv2paymentsPaymentInformationCard, + /** + * The Ptsv2paymentsPaymentInformationCustomer model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationCustomer} + */ + Ptsv2paymentsPaymentInformationCustomer: Ptsv2paymentsPaymentInformationCustomer, + /** + * The Ptsv2paymentsPaymentInformationFluidData model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationFluidData} + */ + Ptsv2paymentsPaymentInformationFluidData: Ptsv2paymentsPaymentInformationFluidData, + /** + * The Ptsv2paymentsPaymentInformationTokenizedCard model constructor. + * @property {module:model/Ptsv2paymentsPaymentInformationTokenizedCard} + */ + Ptsv2paymentsPaymentInformationTokenizedCard: Ptsv2paymentsPaymentInformationTokenizedCard, + /** + * The Ptsv2paymentsPointOfSaleInformation model constructor. + * @property {module:model/Ptsv2paymentsPointOfSaleInformation} + */ + Ptsv2paymentsPointOfSaleInformation: Ptsv2paymentsPointOfSaleInformation, + /** + * The Ptsv2paymentsPointOfSaleInformationEmv model constructor. + * @property {module:model/Ptsv2paymentsPointOfSaleInformationEmv} + */ + Ptsv2paymentsPointOfSaleInformationEmv: Ptsv2paymentsPointOfSaleInformationEmv, + /** + * The Ptsv2paymentsProcessingInformation model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformation} + */ + Ptsv2paymentsProcessingInformation: Ptsv2paymentsProcessingInformation, + /** + * The Ptsv2paymentsProcessingInformationAuthorizationOptions model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptions} + */ + Ptsv2paymentsProcessingInformationAuthorizationOptions: Ptsv2paymentsProcessingInformationAuthorizationOptions, + /** + * The Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator} + */ + Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator: Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator, + /** + * The Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction} + */ + Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction: Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, + /** + * The Ptsv2paymentsProcessingInformationBankTransferOptions model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationBankTransferOptions} + */ + Ptsv2paymentsProcessingInformationBankTransferOptions: Ptsv2paymentsProcessingInformationBankTransferOptions, + /** + * The Ptsv2paymentsProcessingInformationCaptureOptions model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationCaptureOptions} + */ + Ptsv2paymentsProcessingInformationCaptureOptions: Ptsv2paymentsProcessingInformationCaptureOptions, + /** + * The Ptsv2paymentsProcessingInformationRecurringOptions model constructor. + * @property {module:model/Ptsv2paymentsProcessingInformationRecurringOptions} + */ + Ptsv2paymentsProcessingInformationRecurringOptions: Ptsv2paymentsProcessingInformationRecurringOptions, + /** + * The Ptsv2paymentsRecipientInformation model constructor. + * @property {module:model/Ptsv2paymentsRecipientInformation} + */ + Ptsv2paymentsRecipientInformation: Ptsv2paymentsRecipientInformation, + /** + * The Ptsv2paymentsidcapturesAggregatorInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesAggregatorInformation} + */ + Ptsv2paymentsidcapturesAggregatorInformation: Ptsv2paymentsidcapturesAggregatorInformation, + /** + * The Ptsv2paymentsidcapturesAggregatorInformationSubMerchant model constructor. + * @property {module:model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant} + */ + Ptsv2paymentsidcapturesAggregatorInformationSubMerchant: Ptsv2paymentsidcapturesAggregatorInformationSubMerchant, + /** + * The Ptsv2paymentsidcapturesBuyerInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesBuyerInformation} + */ + Ptsv2paymentsidcapturesBuyerInformation: Ptsv2paymentsidcapturesBuyerInformation, + /** + * The Ptsv2paymentsidcapturesInstallmentInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesInstallmentInformation} + */ + Ptsv2paymentsidcapturesInstallmentInformation: Ptsv2paymentsidcapturesInstallmentInformation, + /** + * The Ptsv2paymentsidcapturesMerchantInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesMerchantInformation} + */ + Ptsv2paymentsidcapturesMerchantInformation: Ptsv2paymentsidcapturesMerchantInformation, + /** + * The Ptsv2paymentsidcapturesOrderInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformation} + */ + Ptsv2paymentsidcapturesOrderInformation: Ptsv2paymentsidcapturesOrderInformation, + /** + * The Ptsv2paymentsidcapturesOrderInformationAmountDetails model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformationAmountDetails} + */ + Ptsv2paymentsidcapturesOrderInformationAmountDetails: Ptsv2paymentsidcapturesOrderInformationAmountDetails, + /** + * The Ptsv2paymentsidcapturesOrderInformationBillTo model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformationBillTo} + */ + Ptsv2paymentsidcapturesOrderInformationBillTo: Ptsv2paymentsidcapturesOrderInformationBillTo, + /** + * The Ptsv2paymentsidcapturesOrderInformationInvoiceDetails model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails} + */ + Ptsv2paymentsidcapturesOrderInformationInvoiceDetails: Ptsv2paymentsidcapturesOrderInformationInvoiceDetails, + /** + * The Ptsv2paymentsidcapturesOrderInformationShipTo model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformationShipTo} + */ + Ptsv2paymentsidcapturesOrderInformationShipTo: Ptsv2paymentsidcapturesOrderInformationShipTo, + /** + * The Ptsv2paymentsidcapturesOrderInformationShippingDetails model constructor. + * @property {module:model/Ptsv2paymentsidcapturesOrderInformationShippingDetails} + */ + Ptsv2paymentsidcapturesOrderInformationShippingDetails: Ptsv2paymentsidcapturesOrderInformationShippingDetails, + /** + * The Ptsv2paymentsidcapturesPaymentInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesPaymentInformation} + */ + Ptsv2paymentsidcapturesPaymentInformation: Ptsv2paymentsidcapturesPaymentInformation, + /** + * The Ptsv2paymentsidcapturesPointOfSaleInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesPointOfSaleInformation} + */ + Ptsv2paymentsidcapturesPointOfSaleInformation: Ptsv2paymentsidcapturesPointOfSaleInformation, + /** + * The Ptsv2paymentsidcapturesPointOfSaleInformationEmv model constructor. + * @property {module:model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv} + */ + Ptsv2paymentsidcapturesPointOfSaleInformationEmv: Ptsv2paymentsidcapturesPointOfSaleInformationEmv, + /** + * The Ptsv2paymentsidcapturesProcessingInformation model constructor. + * @property {module:model/Ptsv2paymentsidcapturesProcessingInformation} + */ + Ptsv2paymentsidcapturesProcessingInformation: Ptsv2paymentsidcapturesProcessingInformation, + /** + * The Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions model constructor. + * @property {module:model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions} + */ + Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions: Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions, + /** + * The Ptsv2paymentsidcapturesProcessingInformationCaptureOptions model constructor. + * @property {module:model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions} + */ + Ptsv2paymentsidcapturesProcessingInformationCaptureOptions: Ptsv2paymentsidcapturesProcessingInformationCaptureOptions, + /** + * The Ptsv2paymentsidrefundsMerchantInformation model constructor. + * @property {module:model/Ptsv2paymentsidrefundsMerchantInformation} + */ + Ptsv2paymentsidrefundsMerchantInformation: Ptsv2paymentsidrefundsMerchantInformation, + /** + * The Ptsv2paymentsidrefundsOrderInformation model constructor. + * @property {module:model/Ptsv2paymentsidrefundsOrderInformation} + */ + Ptsv2paymentsidrefundsOrderInformation: Ptsv2paymentsidrefundsOrderInformation, + /** + * The Ptsv2paymentsidrefundsOrderInformationLineItems model constructor. + * @property {module:model/Ptsv2paymentsidrefundsOrderInformationLineItems} + */ + Ptsv2paymentsidrefundsOrderInformationLineItems: Ptsv2paymentsidrefundsOrderInformationLineItems, + /** + * The Ptsv2paymentsidrefundsPaymentInformation model constructor. + * @property {module:model/Ptsv2paymentsidrefundsPaymentInformation} + */ + Ptsv2paymentsidrefundsPaymentInformation: Ptsv2paymentsidrefundsPaymentInformation, + /** + * The Ptsv2paymentsidrefundsPaymentInformationCard model constructor. + * @property {module:model/Ptsv2paymentsidrefundsPaymentInformationCard} + */ + Ptsv2paymentsidrefundsPaymentInformationCard: Ptsv2paymentsidrefundsPaymentInformationCard, + /** + * The Ptsv2paymentsidrefundsPointOfSaleInformation model constructor. + * @property {module:model/Ptsv2paymentsidrefundsPointOfSaleInformation} + */ + Ptsv2paymentsidrefundsPointOfSaleInformation: Ptsv2paymentsidrefundsPointOfSaleInformation, + /** + * The Ptsv2paymentsidrefundsProcessingInformation model constructor. + * @property {module:model/Ptsv2paymentsidrefundsProcessingInformation} + */ + Ptsv2paymentsidrefundsProcessingInformation: Ptsv2paymentsidrefundsProcessingInformation, + /** + * The Ptsv2paymentsidrefundsProcessingInformationRecurringOptions model constructor. + * @property {module:model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions} + */ + Ptsv2paymentsidrefundsProcessingInformationRecurringOptions: Ptsv2paymentsidrefundsProcessingInformationRecurringOptions, + /** + * The Ptsv2paymentsidreversalsClientReferenceInformation model constructor. + * @property {module:model/Ptsv2paymentsidreversalsClientReferenceInformation} + */ + Ptsv2paymentsidreversalsClientReferenceInformation: Ptsv2paymentsidreversalsClientReferenceInformation, + /** + * The Ptsv2paymentsidreversalsClientReferenceInformationPartner model constructor. + * @property {module:model/Ptsv2paymentsidreversalsClientReferenceInformationPartner} + */ + Ptsv2paymentsidreversalsClientReferenceInformationPartner: Ptsv2paymentsidreversalsClientReferenceInformationPartner, + /** + * The Ptsv2paymentsidreversalsOrderInformation model constructor. + * @property {module:model/Ptsv2paymentsidreversalsOrderInformation} + */ + Ptsv2paymentsidreversalsOrderInformation: Ptsv2paymentsidreversalsOrderInformation, + /** + * The Ptsv2paymentsidreversalsOrderInformationAmountDetails model constructor. + * @property {module:model/Ptsv2paymentsidreversalsOrderInformationAmountDetails} + */ + Ptsv2paymentsidreversalsOrderInformationAmountDetails: Ptsv2paymentsidreversalsOrderInformationAmountDetails, + /** + * The Ptsv2paymentsidreversalsOrderInformationLineItems model constructor. + * @property {module:model/Ptsv2paymentsidreversalsOrderInformationLineItems} + */ + Ptsv2paymentsidreversalsOrderInformationLineItems: Ptsv2paymentsidreversalsOrderInformationLineItems, + /** + * The Ptsv2paymentsidreversalsPointOfSaleInformation model constructor. + * @property {module:model/Ptsv2paymentsidreversalsPointOfSaleInformation} + */ + Ptsv2paymentsidreversalsPointOfSaleInformation: Ptsv2paymentsidreversalsPointOfSaleInformation, + /** + * The Ptsv2paymentsidreversalsProcessingInformation model constructor. + * @property {module:model/Ptsv2paymentsidreversalsProcessingInformation} + */ + Ptsv2paymentsidreversalsProcessingInformation: Ptsv2paymentsidreversalsProcessingInformation, + /** + * The Ptsv2paymentsidreversalsReversalInformation model constructor. + * @property {module:model/Ptsv2paymentsidreversalsReversalInformation} + */ + Ptsv2paymentsidreversalsReversalInformation: Ptsv2paymentsidreversalsReversalInformation, + /** + * The Ptsv2paymentsidreversalsReversalInformationAmountDetails model constructor. + * @property {module:model/Ptsv2paymentsidreversalsReversalInformationAmountDetails} + */ + Ptsv2paymentsidreversalsReversalInformationAmountDetails: Ptsv2paymentsidreversalsReversalInformationAmountDetails, + /** + * The Ptsv2payoutsClientReferenceInformation model constructor. + * @property {module:model/Ptsv2payoutsClientReferenceInformation} + */ + Ptsv2payoutsClientReferenceInformation: Ptsv2payoutsClientReferenceInformation, + /** + * The Ptsv2payoutsMerchantInformation model constructor. + * @property {module:model/Ptsv2payoutsMerchantInformation} + */ + Ptsv2payoutsMerchantInformation: Ptsv2payoutsMerchantInformation, + /** + * The Ptsv2payoutsMerchantInformationMerchantDescriptor model constructor. + * @property {module:model/Ptsv2payoutsMerchantInformationMerchantDescriptor} + */ + Ptsv2payoutsMerchantInformationMerchantDescriptor: Ptsv2payoutsMerchantInformationMerchantDescriptor, + /** + * The Ptsv2payoutsOrderInformation model constructor. + * @property {module:model/Ptsv2payoutsOrderInformation} + */ + Ptsv2payoutsOrderInformation: Ptsv2payoutsOrderInformation, + /** + * The Ptsv2payoutsOrderInformationAmountDetails model constructor. + * @property {module:model/Ptsv2payoutsOrderInformationAmountDetails} + */ + Ptsv2payoutsOrderInformationAmountDetails: Ptsv2payoutsOrderInformationAmountDetails, + /** + * The Ptsv2payoutsOrderInformationAmountDetailsSurcharge model constructor. + * @property {module:model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge} + */ + Ptsv2payoutsOrderInformationAmountDetailsSurcharge: Ptsv2payoutsOrderInformationAmountDetailsSurcharge, + /** + * The Ptsv2payoutsOrderInformationBillTo model constructor. + * @property {module:model/Ptsv2payoutsOrderInformationBillTo} + */ + Ptsv2payoutsOrderInformationBillTo: Ptsv2payoutsOrderInformationBillTo, + /** + * The Ptsv2payoutsPaymentInformation model constructor. + * @property {module:model/Ptsv2payoutsPaymentInformation} + */ + Ptsv2payoutsPaymentInformation: Ptsv2payoutsPaymentInformation, + /** + * The Ptsv2payoutsPaymentInformationCard model constructor. + * @property {module:model/Ptsv2payoutsPaymentInformationCard} + */ + Ptsv2payoutsPaymentInformationCard: Ptsv2payoutsPaymentInformationCard, + /** + * The Ptsv2payoutsProcessingInformation model constructor. + * @property {module:model/Ptsv2payoutsProcessingInformation} + */ + Ptsv2payoutsProcessingInformation: Ptsv2payoutsProcessingInformation, + /** + * The Ptsv2payoutsProcessingInformationPayoutsOptions model constructor. + * @property {module:model/Ptsv2payoutsProcessingInformationPayoutsOptions} + */ + Ptsv2payoutsProcessingInformationPayoutsOptions: Ptsv2payoutsProcessingInformationPayoutsOptions, + /** + * The Ptsv2payoutsRecipientInformation model constructor. + * @property {module:model/Ptsv2payoutsRecipientInformation} + */ + Ptsv2payoutsRecipientInformation: Ptsv2payoutsRecipientInformation, + /** + * The Ptsv2payoutsSenderInformation model constructor. + * @property {module:model/Ptsv2payoutsSenderInformation} + */ + Ptsv2payoutsSenderInformation: Ptsv2payoutsSenderInformation, + /** + * The Ptsv2payoutsSenderInformationAccount model constructor. + * @property {module:model/Ptsv2payoutsSenderInformationAccount} + */ + Ptsv2payoutsSenderInformationAccount: Ptsv2payoutsSenderInformationAccount, + /** + * The RefundCaptureRequest model constructor. + * @property {module:model/RefundCaptureRequest} + */ + RefundCaptureRequest: RefundCaptureRequest, + /** + * The RefundPaymentRequest model constructor. + * @property {module:model/RefundPaymentRequest} + */ + RefundPaymentRequest: RefundPaymentRequest, + /** + * The ReportingV3ConversionDetailsGet200Response model constructor. + * @property {module:model/ReportingV3ConversionDetailsGet200Response} + */ + ReportingV3ConversionDetailsGet200Response: ReportingV3ConversionDetailsGet200Response, + /** + * The ReportingV3ConversionDetailsGet200ResponseConversionDetails model constructor. + * @property {module:model/ReportingV3ConversionDetailsGet200ResponseConversionDetails} + */ + ReportingV3ConversionDetailsGet200ResponseConversionDetails: ReportingV3ConversionDetailsGet200ResponseConversionDetails, + /** + * The ReportingV3ConversionDetailsGet200ResponseNotes model constructor. + * @property {module:model/ReportingV3ConversionDetailsGet200ResponseNotes} + */ + ReportingV3ConversionDetailsGet200ResponseNotes: ReportingV3ConversionDetailsGet200ResponseNotes, + /** + * The ReportingV3NetFundingsGet200Response model constructor. + * @property {module:model/ReportingV3NetFundingsGet200Response} + */ + ReportingV3NetFundingsGet200Response: ReportingV3NetFundingsGet200Response, + /** + * The ReportingV3NetFundingsGet200ResponseNetFundingSummaries model constructor. + * @property {module:model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries} + */ + ReportingV3NetFundingsGet200ResponseNetFundingSummaries: ReportingV3NetFundingsGet200ResponseNetFundingSummaries, + /** + * The ReportingV3NetFundingsGet200ResponseTotalPurchases model constructor. + * @property {module:model/ReportingV3NetFundingsGet200ResponseTotalPurchases} + */ + ReportingV3NetFundingsGet200ResponseTotalPurchases: ReportingV3NetFundingsGet200ResponseTotalPurchases, + /** + * The ReportingV3NotificationofChangesGet200Response model constructor. + * @property {module:model/ReportingV3NotificationofChangesGet200Response} + */ + ReportingV3NotificationofChangesGet200Response: ReportingV3NotificationofChangesGet200Response, + /** + * The ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges model constructor. + * @property {module:model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges} + */ + ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges: ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges, + /** + * The ReportingV3PurchaseRefundDetailsGet200Response model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200Response} + */ + ReportingV3PurchaseRefundDetailsGet200Response: ReportingV3PurchaseRefundDetailsGet200Response, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations: ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails: ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseOthers model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseOthers: ReportingV3PurchaseRefundDetailsGet200ResponseOthers, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails: ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses: ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses, + /** + * The ReportingV3PurchaseRefundDetailsGet200ResponseSettlements model constructor. + * @property {module:model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements} + */ + ReportingV3PurchaseRefundDetailsGet200ResponseSettlements: ReportingV3PurchaseRefundDetailsGet200ResponseSettlements, + /** + * The ReportingV3ReportDefinitionsGet200Response model constructor. + * @property {module:model/ReportingV3ReportDefinitionsGet200Response} + */ + ReportingV3ReportDefinitionsGet200Response: ReportingV3ReportDefinitionsGet200Response, + /** + * The ReportingV3ReportDefinitionsGet200ResponseReportDefinitions model constructor. + * @property {module:model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions} + */ + ReportingV3ReportDefinitionsGet200ResponseReportDefinitions: ReportingV3ReportDefinitionsGet200ResponseReportDefinitions, + /** + * The ReportingV3ReportDefinitionsNameGet200Response model constructor. + * @property {module:model/ReportingV3ReportDefinitionsNameGet200Response} + */ + ReportingV3ReportDefinitionsNameGet200Response: ReportingV3ReportDefinitionsNameGet200Response, + /** + * The ReportingV3ReportDefinitionsNameGet200ResponseAttributes model constructor. + * @property {module:model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes} + */ + ReportingV3ReportDefinitionsNameGet200ResponseAttributes: ReportingV3ReportDefinitionsNameGet200ResponseAttributes, + /** + * The ReportingV3ReportSubscriptionsGet200Response model constructor. + * @property {module:model/ReportingV3ReportSubscriptionsGet200Response} + */ + ReportingV3ReportSubscriptionsGet200Response: ReportingV3ReportSubscriptionsGet200Response, + /** + * The ReportingV3ReportSubscriptionsGet200ResponseSubscriptions model constructor. + * @property {module:model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions} + */ + ReportingV3ReportSubscriptionsGet200ResponseSubscriptions: ReportingV3ReportSubscriptionsGet200ResponseSubscriptions, + /** + * The ReportingV3ReportsGet200Response model constructor. + * @property {module:model/ReportingV3ReportsGet200Response} + */ + ReportingV3ReportsGet200Response: ReportingV3ReportsGet200Response, + /** + * The ReportingV3ReportsGet200ResponseReports model constructor. + * @property {module:model/ReportingV3ReportsGet200ResponseReports} + */ + ReportingV3ReportsGet200ResponseReports: ReportingV3ReportsGet200ResponseReports, + /** + * The ReportingV3ReportsIdGet200Response model constructor. + * @property {module:model/ReportingV3ReportsIdGet200Response} + */ + ReportingV3ReportsIdGet200Response: ReportingV3ReportsIdGet200Response, + /** + * The Reportingv3ReportDownloadsGet400Response model constructor. + * @property {module:model/Reportingv3ReportDownloadsGet400Response} + */ + Reportingv3ReportDownloadsGet400Response: Reportingv3ReportDownloadsGet400Response, + /** + * The Reportingv3ReportDownloadsGet400ResponseDetails model constructor. + * @property {module:model/Reportingv3ReportDownloadsGet400ResponseDetails} + */ + Reportingv3ReportDownloadsGet400ResponseDetails: Reportingv3ReportDownloadsGet400ResponseDetails, + /** + * The Reportingv3reportsReportPreferences model constructor. + * @property {module:model/Reportingv3reportsReportPreferences} + */ + Reportingv3reportsReportPreferences: Reportingv3reportsReportPreferences, + /** + * The Request model constructor. + * @property {module:model/Request} + */ + Request: Request, + /** + * The RequestBody model constructor. + * @property {module:model/RequestBody} + */ + RequestBody: RequestBody, + /** + * The RequestBody1 model constructor. + * @property {module:model/RequestBody1} + */ + RequestBody1: RequestBody1, + /** + * The ResponseStatus model constructor. + * @property {module:model/ResponseStatus} + */ + ResponseStatus: ResponseStatus, + /** + * The ResponseStatusDetails model constructor. + * @property {module:model/ResponseStatusDetails} + */ + ResponseStatusDetails: ResponseStatusDetails, + /** + * The RiskV1AuthenticationResultsPost201Response model constructor. + * @property {module:model/RiskV1AuthenticationResultsPost201Response} + */ + RiskV1AuthenticationResultsPost201Response: RiskV1AuthenticationResultsPost201Response, + /** + * The RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation model constructor. + * @property {module:model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation} + */ + RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation: RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation, + /** + * The RiskV1AuthenticationsPost201Response model constructor. + * @property {module:model/RiskV1AuthenticationsPost201Response} + */ + RiskV1AuthenticationsPost201Response: RiskV1AuthenticationsPost201Response, + /** + * The RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation model constructor. + * @property {module:model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation} + */ + RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation: RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation, + /** + * The RiskV1AuthenticationsPost201ResponseOrderInformation model constructor. + * @property {module:model/RiskV1AuthenticationsPost201ResponseOrderInformation} + */ + RiskV1AuthenticationsPost201ResponseOrderInformation: RiskV1AuthenticationsPost201ResponseOrderInformation, + /** + * The RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails model constructor. + * @property {module:model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails} + */ + RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails: RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails, + /** + * The RiskV1AuthenticationsPost400Response model constructor. + * @property {module:model/RiskV1AuthenticationsPost400Response} + */ + RiskV1AuthenticationsPost400Response: RiskV1AuthenticationsPost400Response, + /** + * The RiskV1DecisionsPost201Response model constructor. + * @property {module:model/RiskV1DecisionsPost201Response} + */ + RiskV1DecisionsPost201Response: RiskV1DecisionsPost201Response, + /** + * The RiskV1DecisionsPost201ResponsePaymentInformation model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponsePaymentInformation} + */ + RiskV1DecisionsPost201ResponsePaymentInformation: RiskV1DecisionsPost201ResponsePaymentInformation, + /** + * The RiskV1DecisionsPost201ResponseRiskInformation model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformation} + */ + RiskV1DecisionsPost201ResponseRiskInformation: RiskV1DecisionsPost201ResponseRiskInformation, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationInfoCodes model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes} + */ + RiskV1DecisionsPost201ResponseRiskInformationInfoCodes: RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationIpAddress model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress} + */ + RiskV1DecisionsPost201ResponseRiskInformationIpAddress: RiskV1DecisionsPost201ResponseRiskInformationIpAddress, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationProfile model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProfile} + */ + RiskV1DecisionsPost201ResponseRiskInformationProfile: RiskV1DecisionsPost201ResponseRiskInformationProfile, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationProviders model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProviders} + */ + RiskV1DecisionsPost201ResponseRiskInformationProviders: RiskV1DecisionsPost201ResponseRiskInformationProviders, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName} + */ + RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName: RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationRules model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationRules} + */ + RiskV1DecisionsPost201ResponseRiskInformationRules: RiskV1DecisionsPost201ResponseRiskInformationRules, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationScore model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationScore} + */ + RiskV1DecisionsPost201ResponseRiskInformationScore: RiskV1DecisionsPost201ResponseRiskInformationScore, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationTravel model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravel} + */ + RiskV1DecisionsPost201ResponseRiskInformationTravel: RiskV1DecisionsPost201ResponseRiskInformationTravel, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination} + */ + RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination: RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture} + */ + RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture: RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination} + */ + RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination: RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination} + */ + RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination: RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationVelocity model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationVelocity} + */ + RiskV1DecisionsPost201ResponseRiskInformationVelocity: RiskV1DecisionsPost201ResponseRiskInformationVelocity, + /** + * The RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing model constructor. + * @property {module:model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing} + */ + RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing: RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing, + /** + * The RiskV1DecisionsPost400Response model constructor. + * @property {module:model/RiskV1DecisionsPost400Response} + */ + RiskV1DecisionsPost400Response: RiskV1DecisionsPost400Response, + /** + * The Riskv1authenticationresultsConsumerAuthenticationInformation model constructor. + * @property {module:model/Riskv1authenticationresultsConsumerAuthenticationInformation} + */ + Riskv1authenticationresultsConsumerAuthenticationInformation: Riskv1authenticationresultsConsumerAuthenticationInformation, + /** + * The Riskv1authenticationresultsOrderInformation model constructor. + * @property {module:model/Riskv1authenticationresultsOrderInformation} + */ + Riskv1authenticationresultsOrderInformation: Riskv1authenticationresultsOrderInformation, + /** + * The Riskv1authenticationresultsOrderInformationLineItems model constructor. + * @property {module:model/Riskv1authenticationresultsOrderInformationLineItems} + */ + Riskv1authenticationresultsOrderInformationLineItems: Riskv1authenticationresultsOrderInformationLineItems, + /** + * The Riskv1authenticationresultsPaymentInformation model constructor. + * @property {module:model/Riskv1authenticationresultsPaymentInformation} + */ + Riskv1authenticationresultsPaymentInformation: Riskv1authenticationresultsPaymentInformation, + /** + * The Riskv1authenticationresultsPaymentInformationCard model constructor. + * @property {module:model/Riskv1authenticationresultsPaymentInformationCard} + */ + Riskv1authenticationresultsPaymentInformationCard: Riskv1authenticationresultsPaymentInformationCard, + /** + * The Riskv1authenticationresultsPaymentInformationTokenizedCard model constructor. + * @property {module:model/Riskv1authenticationresultsPaymentInformationTokenizedCard} + */ + Riskv1authenticationresultsPaymentInformationTokenizedCard: Riskv1authenticationresultsPaymentInformationTokenizedCard, + /** + * The Riskv1authenticationsBuyerInformation model constructor. + * @property {module:model/Riskv1authenticationsBuyerInformation} + */ + Riskv1authenticationsBuyerInformation: Riskv1authenticationsBuyerInformation, + /** + * The Riskv1authenticationsClientReferenceInformation model constructor. + * @property {module:model/Riskv1authenticationsClientReferenceInformation} + */ + Riskv1authenticationsClientReferenceInformation: Riskv1authenticationsClientReferenceInformation, + /** + * The Riskv1authenticationsConsumerAuthenticationInformation model constructor. + * @property {module:model/Riskv1authenticationsConsumerAuthenticationInformation} + */ + Riskv1authenticationsConsumerAuthenticationInformation: Riskv1authenticationsConsumerAuthenticationInformation, + /** + * The Riskv1authenticationsDeviceInformation model constructor. + * @property {module:model/Riskv1authenticationsDeviceInformation} + */ + Riskv1authenticationsDeviceInformation: Riskv1authenticationsDeviceInformation, + /** + * The Riskv1authenticationsDeviceInformationRawData model constructor. + * @property {module:model/Riskv1authenticationsDeviceInformationRawData} + */ + Riskv1authenticationsDeviceInformationRawData: Riskv1authenticationsDeviceInformationRawData, + /** + * The Riskv1authenticationsMerchantInformation model constructor. + * @property {module:model/Riskv1authenticationsMerchantInformation} + */ + Riskv1authenticationsMerchantInformation: Riskv1authenticationsMerchantInformation, + /** + * The Riskv1authenticationsOrderInformation model constructor. + * @property {module:model/Riskv1authenticationsOrderInformation} + */ + Riskv1authenticationsOrderInformation: Riskv1authenticationsOrderInformation, + /** + * The Riskv1authenticationsOrderInformationBillTo model constructor. + * @property {module:model/Riskv1authenticationsOrderInformationBillTo} + */ + Riskv1authenticationsOrderInformationBillTo: Riskv1authenticationsOrderInformationBillTo, + /** + * The Riskv1authenticationsOrderInformationLineItems model constructor. + * @property {module:model/Riskv1authenticationsOrderInformationLineItems} + */ + Riskv1authenticationsOrderInformationLineItems: Riskv1authenticationsOrderInformationLineItems, + /** + * The Riskv1authenticationsOrderInformationShipTo model constructor. + * @property {module:model/Riskv1authenticationsOrderInformationShipTo} + */ + Riskv1authenticationsOrderInformationShipTo: Riskv1authenticationsOrderInformationShipTo, + /** + * The Riskv1authenticationsPaymentInformation model constructor. + * @property {module:model/Riskv1authenticationsPaymentInformation} + */ + Riskv1authenticationsPaymentInformation: Riskv1authenticationsPaymentInformation, + /** + * The Riskv1authenticationsPaymentInformationCard model constructor. + * @property {module:model/Riskv1authenticationsPaymentInformationCard} + */ + Riskv1authenticationsPaymentInformationCard: Riskv1authenticationsPaymentInformationCard, + /** + * The Riskv1authenticationsPaymentInformationTokenizedCard model constructor. + * @property {module:model/Riskv1authenticationsPaymentInformationTokenizedCard} + */ + Riskv1authenticationsPaymentInformationTokenizedCard: Riskv1authenticationsPaymentInformationTokenizedCard, + /** + * The Riskv1authenticationsRecurringPaymentInformation model constructor. + * @property {module:model/Riskv1authenticationsRecurringPaymentInformation} + */ + Riskv1authenticationsRecurringPaymentInformation: Riskv1authenticationsRecurringPaymentInformation, + /** + * The Riskv1authenticationsRiskInformation model constructor. + * @property {module:model/Riskv1authenticationsRiskInformation} + */ + Riskv1authenticationsRiskInformation: Riskv1authenticationsRiskInformation, + /** + * The Riskv1authenticationsRiskInformationBuyerHistory model constructor. + * @property {module:model/Riskv1authenticationsRiskInformationBuyerHistory} + */ + Riskv1authenticationsRiskInformationBuyerHistory: Riskv1authenticationsRiskInformationBuyerHistory, + /** + * The Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory model constructor. + * @property {module:model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory} + */ + Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory: Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory, + /** + * The Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount model constructor. + * @property {module:model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount} + */ + Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount: Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount, + /** + * The Riskv1authenticationsTravelInformation model constructor. + * @property {module:model/Riskv1authenticationsTravelInformation} + */ + Riskv1authenticationsTravelInformation: Riskv1authenticationsTravelInformation, + /** + * The Riskv1authenticationsTravelInformationLegs model constructor. + * @property {module:model/Riskv1authenticationsTravelInformationLegs} + */ + Riskv1authenticationsTravelInformationLegs: Riskv1authenticationsTravelInformationLegs, + /** + * The Riskv1authenticationsTravelInformationPassengers model constructor. + * @property {module:model/Riskv1authenticationsTravelInformationPassengers} + */ + Riskv1authenticationsTravelInformationPassengers: Riskv1authenticationsTravelInformationPassengers, + /** + * The Riskv1decisionsBuyerInformation model constructor. + * @property {module:model/Riskv1decisionsBuyerInformation} + */ + Riskv1decisionsBuyerInformation: Riskv1decisionsBuyerInformation, + /** + * The Riskv1decisionsCardVerification model constructor. + * @property {module:model/Riskv1decisionsCardVerification} + */ + Riskv1decisionsCardVerification: Riskv1decisionsCardVerification, + /** + * The Riskv1decisionsClientReferenceInformation model constructor. + * @property {module:model/Riskv1decisionsClientReferenceInformation} + */ + Riskv1decisionsClientReferenceInformation: Riskv1decisionsClientReferenceInformation, + /** + * The Riskv1decisionsDeviceInformation model constructor. + * @property {module:model/Riskv1decisionsDeviceInformation} + */ + Riskv1decisionsDeviceInformation: Riskv1decisionsDeviceInformation, + /** + * The Riskv1decisionsMerchantDefinedInformation model constructor. + * @property {module:model/Riskv1decisionsMerchantDefinedInformation} + */ + Riskv1decisionsMerchantDefinedInformation: Riskv1decisionsMerchantDefinedInformation, + /** + * The Riskv1decisionsOrderInformation model constructor. + * @property {module:model/Riskv1decisionsOrderInformation} + */ + Riskv1decisionsOrderInformation: Riskv1decisionsOrderInformation, + /** + * The Riskv1decisionsOrderInformationAmountDetails model constructor. + * @property {module:model/Riskv1decisionsOrderInformationAmountDetails} + */ + Riskv1decisionsOrderInformationAmountDetails: Riskv1decisionsOrderInformationAmountDetails, + /** + * The Riskv1decisionsOrderInformationBillTo model constructor. + * @property {module:model/Riskv1decisionsOrderInformationBillTo} + */ + Riskv1decisionsOrderInformationBillTo: Riskv1decisionsOrderInformationBillTo, + /** + * The Riskv1decisionsOrderInformationLineItems model constructor. + * @property {module:model/Riskv1decisionsOrderInformationLineItems} + */ + Riskv1decisionsOrderInformationLineItems: Riskv1decisionsOrderInformationLineItems, + /** + * The Riskv1decisionsOrderInformationPassenger model constructor. + * @property {module:model/Riskv1decisionsOrderInformationPassenger} + */ + Riskv1decisionsOrderInformationPassenger: Riskv1decisionsOrderInformationPassenger, + /** + * The Riskv1decisionsOrderInformationShipTo model constructor. + * @property {module:model/Riskv1decisionsOrderInformationShipTo} + */ + Riskv1decisionsOrderInformationShipTo: Riskv1decisionsOrderInformationShipTo, + /** + * The Riskv1decisionsOrderInformationShippingDetails model constructor. + * @property {module:model/Riskv1decisionsOrderInformationShippingDetails} + */ + Riskv1decisionsOrderInformationShippingDetails: Riskv1decisionsOrderInformationShippingDetails, + /** + * The Riskv1decisionsPaymentInformation model constructor. + * @property {module:model/Riskv1decisionsPaymentInformation} + */ + Riskv1decisionsPaymentInformation: Riskv1decisionsPaymentInformation, + /** + * The Riskv1decisionsPaymentInformationCard model constructor. + * @property {module:model/Riskv1decisionsPaymentInformationCard} + */ + Riskv1decisionsPaymentInformationCard: Riskv1decisionsPaymentInformationCard, + /** + * The Riskv1decisionsPaymentInformationTokenizedCard model constructor. + * @property {module:model/Riskv1decisionsPaymentInformationTokenizedCard} + */ + Riskv1decisionsPaymentInformationTokenizedCard: Riskv1decisionsPaymentInformationTokenizedCard, + /** + * The Riskv1decisionsProcessorInformation model constructor. + * @property {module:model/Riskv1decisionsProcessorInformation} + */ + Riskv1decisionsProcessorInformation: Riskv1decisionsProcessorInformation, + /** + * The Riskv1decisionsProcessorInformationAvs model constructor. + * @property {module:model/Riskv1decisionsProcessorInformationAvs} + */ + Riskv1decisionsProcessorInformationAvs: Riskv1decisionsProcessorInformationAvs, + /** + * The Riskv1decisionsRiskInformation model constructor. + * @property {module:model/Riskv1decisionsRiskInformation} + */ + Riskv1decisionsRiskInformation: Riskv1decisionsRiskInformation, + /** + * The Riskv1decisionsRiskInformationProfile model constructor. + * @property {module:model/Riskv1decisionsRiskInformationProfile} + */ + Riskv1decisionsRiskInformationProfile: Riskv1decisionsRiskInformationProfile, + /** + * The Riskv1decisionsTravelInformation model constructor. + * @property {module:model/Riskv1decisionsTravelInformation} + */ + Riskv1decisionsTravelInformation: Riskv1decisionsTravelInformation, + /** + * The Riskv1decisionsTravelInformationLegs model constructor. + * @property {module:model/Riskv1decisionsTravelInformationLegs} + */ + Riskv1decisionsTravelInformationLegs: Riskv1decisionsTravelInformationLegs, + /** + * The SelfLinkBean model constructor. + * @property {module:model/SelfLinkBean} + */ + SelfLinkBean: SelfLinkBean, + /** + * The TmsV1InstrumentIdentifiersDelete409Response model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersDelete409Response} + */ + TmsV1InstrumentIdentifiersDelete409Response: TmsV1InstrumentIdentifiersDelete409Response, + /** + * The TmsV1InstrumentIdentifiersDelete409ResponseLinks model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersDelete409ResponseLinks} + */ + TmsV1InstrumentIdentifiersDelete409ResponseLinks: TmsV1InstrumentIdentifiersDelete409ResponseLinks, + /** + * The TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments} + */ + TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments: TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev, + /** + * The TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf} + */ + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf: TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf, + /** + * The TmsV1InstrumentIdentifiersPost200Response model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200Response} + */ + TmsV1InstrumentIdentifiersPost200Response: TmsV1InstrumentIdentifiersPost200Response, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseBankAccount model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount} + */ + TmsV1InstrumentIdentifiersPost200ResponseBankAccount: TmsV1InstrumentIdentifiersPost200ResponseBankAccount, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseCard model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseCard} + */ + TmsV1InstrumentIdentifiersPost200ResponseCard: TmsV1InstrumentIdentifiersPost200ResponseCard, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseLinks model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinks} + */ + TmsV1InstrumentIdentifiersPost200ResponseLinks: TmsV1InstrumentIdentifiersPost200ResponseLinks, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseLinksSelf model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf} + */ + TmsV1InstrumentIdentifiersPost200ResponseLinksSelf: TmsV1InstrumentIdentifiersPost200ResponseLinksSelf, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseMetadata model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseMetadata} + */ + TmsV1InstrumentIdentifiersPost200ResponseMetadata: TmsV1InstrumentIdentifiersPost200ResponseMetadata, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation} + */ + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions} + */ + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator} + */ + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator, + /** + * The TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction model constructor. + * @property {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction} + */ + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction: TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction, + /** + * The Tmsv1instrumentidentifiersBillTo model constructor. + * @property {module:model/Tmsv1instrumentidentifiersBillTo} + */ + Tmsv1instrumentidentifiersBillTo: Tmsv1instrumentidentifiersBillTo, + /** + * The Tmsv1instrumentidentifiersCard model constructor. + * @property {module:model/Tmsv1instrumentidentifiersCard} + */ + Tmsv1instrumentidentifiersCard: Tmsv1instrumentidentifiersCard, + /** + * The Tmsv1instrumentidentifiersDetails model constructor. + * @property {module:model/Tmsv1instrumentidentifiersDetails} + */ + Tmsv1instrumentidentifiersDetails: Tmsv1instrumentidentifiersDetails, + /** + * The TokenizeParameters model constructor. + * @property {module:model/TokenizeParameters} + */ + TokenizeParameters: TokenizeParameters, + /** + * The TokenizeRequest model constructor. + * @property {module:model/TokenizeRequest} + */ + TokenizeRequest: TokenizeRequest, + /** + * The TokenizeResult model constructor. + * @property {module:model/TokenizeResult} + */ + TokenizeResult: TokenizeResult, + /** + * The TssV2TransactionsGet200Response model constructor. + * @property {module:model/TssV2TransactionsGet200Response} + */ + TssV2TransactionsGet200Response: TssV2TransactionsGet200Response, + /** + * The TssV2TransactionsGet200ResponseApplicationInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseApplicationInformation} + */ + TssV2TransactionsGet200ResponseApplicationInformation: TssV2TransactionsGet200ResponseApplicationInformation, + /** + * The TssV2TransactionsGet200ResponseApplicationInformationApplications model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseApplicationInformationApplications} + */ + TssV2TransactionsGet200ResponseApplicationInformationApplications: TssV2TransactionsGet200ResponseApplicationInformationApplications, + /** + * The TssV2TransactionsGet200ResponseBuyerInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseBuyerInformation} + */ + TssV2TransactionsGet200ResponseBuyerInformation: TssV2TransactionsGet200ResponseBuyerInformation, + /** + * The TssV2TransactionsGet200ResponseClientReferenceInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseClientReferenceInformation} + */ + TssV2TransactionsGet200ResponseClientReferenceInformation: TssV2TransactionsGet200ResponseClientReferenceInformation, + /** + * The TssV2TransactionsGet200ResponseConsumerAuthenticationInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation} + */ + TssV2TransactionsGet200ResponseConsumerAuthenticationInformation: TssV2TransactionsGet200ResponseConsumerAuthenticationInformation, + /** + * The TssV2TransactionsGet200ResponseDeviceInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseDeviceInformation} + */ + TssV2TransactionsGet200ResponseDeviceInformation: TssV2TransactionsGet200ResponseDeviceInformation, + /** + * The TssV2TransactionsGet200ResponseErrorInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseErrorInformation} + */ + TssV2TransactionsGet200ResponseErrorInformation: TssV2TransactionsGet200ResponseErrorInformation, + /** + * The TssV2TransactionsGet200ResponseFraudMarkingInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseFraudMarkingInformation} + */ + TssV2TransactionsGet200ResponseFraudMarkingInformation: TssV2TransactionsGet200ResponseFraudMarkingInformation, + /** + * The TssV2TransactionsGet200ResponseInstallmentInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseInstallmentInformation} + */ + TssV2TransactionsGet200ResponseInstallmentInformation: TssV2TransactionsGet200ResponseInstallmentInformation, + /** + * The TssV2TransactionsGet200ResponseLinks model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseLinks} + */ + TssV2TransactionsGet200ResponseLinks: TssV2TransactionsGet200ResponseLinks, + /** + * The TssV2TransactionsGet200ResponseMerchantInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseMerchantInformation} + */ + TssV2TransactionsGet200ResponseMerchantInformation: TssV2TransactionsGet200ResponseMerchantInformation, + /** + * The TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor} + */ + TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor: TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor, + /** + * The TssV2TransactionsGet200ResponseOrderInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformation} + */ + TssV2TransactionsGet200ResponseOrderInformation: TssV2TransactionsGet200ResponseOrderInformation, + /** + * The TssV2TransactionsGet200ResponseOrderInformationAmountDetails model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails} + */ + TssV2TransactionsGet200ResponseOrderInformationAmountDetails: TssV2TransactionsGet200ResponseOrderInformationAmountDetails, + /** + * The TssV2TransactionsGet200ResponseOrderInformationBillTo model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationBillTo} + */ + TssV2TransactionsGet200ResponseOrderInformationBillTo: TssV2TransactionsGet200ResponseOrderInformationBillTo, + /** + * The TssV2TransactionsGet200ResponseOrderInformationLineItems model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationLineItems} + */ + TssV2TransactionsGet200ResponseOrderInformationLineItems: TssV2TransactionsGet200ResponseOrderInformationLineItems, + /** + * The TssV2TransactionsGet200ResponseOrderInformationShipTo model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationShipTo} + */ + TssV2TransactionsGet200ResponseOrderInformationShipTo: TssV2TransactionsGet200ResponseOrderInformationShipTo, + /** + * The TssV2TransactionsGet200ResponseOrderInformationShippingDetails model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails} + */ + TssV2TransactionsGet200ResponseOrderInformationShippingDetails: TssV2TransactionsGet200ResponseOrderInformationShippingDetails, + /** + * The TssV2TransactionsGet200ResponsePaymentInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformation} + */ + TssV2TransactionsGet200ResponsePaymentInformation: TssV2TransactionsGet200ResponsePaymentInformation, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures} + */ + TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures: TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationBank model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBank} + */ + TssV2TransactionsGet200ResponsePaymentInformationBank: TssV2TransactionsGet200ResponsePaymentInformationBank, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationBankAccount model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount} + */ + TssV2TransactionsGet200ResponsePaymentInformationBankAccount: TssV2TransactionsGet200ResponsePaymentInformationBankAccount, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationBankMandate model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate} + */ + TssV2TransactionsGet200ResponsePaymentInformationBankMandate: TssV2TransactionsGet200ResponsePaymentInformationBankMandate, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationCard model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationCard} + */ + TssV2TransactionsGet200ResponsePaymentInformationCard: TssV2TransactionsGet200ResponsePaymentInformationCard, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationInvoice model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationInvoice} + */ + TssV2TransactionsGet200ResponsePaymentInformationInvoice: TssV2TransactionsGet200ResponsePaymentInformationInvoice, + /** + * The TssV2TransactionsGet200ResponsePaymentInformationPaymentType model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType} + */ + TssV2TransactionsGet200ResponsePaymentInformationPaymentType: TssV2TransactionsGet200ResponsePaymentInformationPaymentType, + /** + * The TssV2TransactionsGet200ResponsePointOfSaleInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponsePointOfSaleInformation} + */ + TssV2TransactionsGet200ResponsePointOfSaleInformation: TssV2TransactionsGet200ResponsePointOfSaleInformation, + /** + * The TssV2TransactionsGet200ResponseProcessingInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformation} + */ + TssV2TransactionsGet200ResponseProcessingInformation: TssV2TransactionsGet200ResponseProcessingInformation, + /** + * The TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions} + */ + TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions: TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions, + /** + * The TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions} + */ + TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions: TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions, + /** + * The TssV2TransactionsGet200ResponseProcessorInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformation} + */ + TssV2TransactionsGet200ResponseProcessorInformation: TssV2TransactionsGet200ResponseProcessorInformation, + /** + * The TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults} + */ + TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults: TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults, + /** + * The TssV2TransactionsGet200ResponseProcessorInformationProcessor model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseProcessorInformationProcessor} + */ + TssV2TransactionsGet200ResponseProcessorInformationProcessor: TssV2TransactionsGet200ResponseProcessorInformationProcessor, + /** + * The TssV2TransactionsGet200ResponseRiskInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseRiskInformation} + */ + TssV2TransactionsGet200ResponseRiskInformation: TssV2TransactionsGet200ResponseRiskInformation, + /** + * The TssV2TransactionsGet200ResponseRiskInformationProfile model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationProfile} + */ + TssV2TransactionsGet200ResponseRiskInformationProfile: TssV2TransactionsGet200ResponseRiskInformationProfile, + /** + * The TssV2TransactionsGet200ResponseRiskInformationRules model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationRules} + */ + TssV2TransactionsGet200ResponseRiskInformationRules: TssV2TransactionsGet200ResponseRiskInformationRules, + /** + * The TssV2TransactionsGet200ResponseRiskInformationScore model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseRiskInformationScore} + */ + TssV2TransactionsGet200ResponseRiskInformationScore: TssV2TransactionsGet200ResponseRiskInformationScore, + /** + * The TssV2TransactionsGet200ResponseSenderInformation model constructor. + * @property {module:model/TssV2TransactionsGet200ResponseSenderInformation} + */ + TssV2TransactionsGet200ResponseSenderInformation: TssV2TransactionsGet200ResponseSenderInformation, + /** + * The TssV2TransactionsPost201Response model constructor. + * @property {module:model/TssV2TransactionsPost201Response} + */ + TssV2TransactionsPost201Response: TssV2TransactionsPost201Response, + /** + * The TssV2TransactionsPost201ResponseEmbedded model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbedded} + */ + TssV2TransactionsPost201ResponseEmbedded: TssV2TransactionsPost201ResponseEmbedded, + /** + * The TssV2TransactionsPost201ResponseEmbeddedBuyerInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedBuyerInformation: TssV2TransactionsPost201ResponseEmbeddedBuyerInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation: TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation: TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedDeviceInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedDeviceInformation: TssV2TransactionsPost201ResponseEmbeddedDeviceInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedLinks model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedLinks} + */ + TssV2TransactionsPost201ResponseEmbeddedLinks: TssV2TransactionsPost201ResponseEmbeddedLinks, + /** + * The TssV2TransactionsPost201ResponseEmbeddedMerchantInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedMerchantInformation: TssV2TransactionsPost201ResponseEmbeddedMerchantInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedOrderInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedOrderInformation: TssV2TransactionsPost201ResponseEmbeddedOrderInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo} + */ + TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo: TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo, + /** + * The TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo} + */ + TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo: TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo, + /** + * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedPaymentInformation: TssV2TransactionsPost201ResponseEmbeddedPaymentInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard} + */ + TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard: TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard, + /** + * The TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType} + */ + TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType: TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType, + /** + * The TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation: TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedProcessingInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedProcessingInformation: TssV2TransactionsPost201ResponseEmbeddedProcessingInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedProcessorInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedProcessorInformation: TssV2TransactionsPost201ResponseEmbeddedProcessorInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedRiskInformation model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation} + */ + TssV2TransactionsPost201ResponseEmbeddedRiskInformation: TssV2TransactionsPost201ResponseEmbeddedRiskInformation, + /** + * The TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders} + */ + TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders: TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders, + /** + * The TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint} + */ + TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint: TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint, + /** + * The TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries model constructor. + * @property {module:model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries} + */ + TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries: TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries, + /** + * The TssV2TransactionsPost400Response model constructor. + * @property {module:model/TssV2TransactionsPost400Response} + */ + TssV2TransactionsPost400Response: TssV2TransactionsPost400Response, + /** + * The UmsV1UsersGet200Response model constructor. + * @property {module:model/UmsV1UsersGet200Response} + */ + UmsV1UsersGet200Response: UmsV1UsersGet200Response, + /** + * The UmsV1UsersGet200ResponseAccountInformation model constructor. + * @property {module:model/UmsV1UsersGet200ResponseAccountInformation} + */ + UmsV1UsersGet200ResponseAccountInformation: UmsV1UsersGet200ResponseAccountInformation, + /** + * The UmsV1UsersGet200ResponseContactInformation model constructor. + * @property {module:model/UmsV1UsersGet200ResponseContactInformation} + */ + UmsV1UsersGet200ResponseContactInformation: UmsV1UsersGet200ResponseContactInformation, + /** + * The UmsV1UsersGet200ResponseOrganizationInformation model constructor. + * @property {module:model/UmsV1UsersGet200ResponseOrganizationInformation} + */ + UmsV1UsersGet200ResponseOrganizationInformation: UmsV1UsersGet200ResponseOrganizationInformation, + /** + * The UmsV1UsersGet200ResponseUsers model constructor. + * @property {module:model/UmsV1UsersGet200ResponseUsers} + */ + UmsV1UsersGet200ResponseUsers: UmsV1UsersGet200ResponseUsers, + /** + * The UpdateInstrumentIdentifierRequest model constructor. + * @property {module:model/UpdateInstrumentIdentifierRequest} + */ + UpdateInstrumentIdentifierRequest: UpdateInstrumentIdentifierRequest, + /** + * The UpdatePaymentInstrumentRequest model constructor. + * @property {module:model/UpdatePaymentInstrumentRequest} + */ + UpdatePaymentInstrumentRequest: UpdatePaymentInstrumentRequest, + /** + * The V1FileDetailsGet200Response model constructor. + * @property {module:model/V1FileDetailsGet200Response} + */ + V1FileDetailsGet200Response: V1FileDetailsGet200Response, + /** + * The V1FileDetailsGet200ResponseFileDetails model constructor. + * @property {module:model/V1FileDetailsGet200ResponseFileDetails} + */ + V1FileDetailsGet200ResponseFileDetails: V1FileDetailsGet200ResponseFileDetails, + /** + * The V1FileDetailsGet200ResponseLinks model constructor. + * @property {module:model/V1FileDetailsGet200ResponseLinks} + */ + V1FileDetailsGet200ResponseLinks: V1FileDetailsGet200ResponseLinks, + /** + * The V1FileDetailsGet200ResponseLinksFiles model constructor. + * @property {module:model/V1FileDetailsGet200ResponseLinksFiles} + */ + V1FileDetailsGet200ResponseLinksFiles: V1FileDetailsGet200ResponseLinksFiles, + /** + * The V1FileDetailsGet200ResponseLinksSelf model constructor. + * @property {module:model/V1FileDetailsGet200ResponseLinksSelf} + */ + V1FileDetailsGet200ResponseLinksSelf: V1FileDetailsGet200ResponseLinksSelf, + /** + * The VoidCaptureRequest model constructor. + * @property {module:model/VoidCaptureRequest} + */ + VoidCaptureRequest: VoidCaptureRequest, + /** + * The VoidCreditRequest model constructor. + * @property {module:model/VoidCreditRequest} + */ + VoidCreditRequest: VoidCreditRequest, + /** + * The VoidPaymentRequest model constructor. + * @property {module:model/VoidPaymentRequest} + */ + VoidPaymentRequest: VoidPaymentRequest, + /** + * The VoidRefundRequest model constructor. + * @property {module:model/VoidRefundRequest} + */ + VoidRefundRequest: VoidRefundRequest, + /** + * The CaptureApi service constructor. + * @property {module:api/CaptureApi} + */ + CaptureApi: CaptureApi, + /** + * The ConversionDetailsApi service constructor. + * @property {module:api/ConversionDetailsApi} + */ + ConversionDetailsApi: ConversionDetailsApi, + /** + * The CreditApi service constructor. + * @property {module:api/CreditApi} + */ + CreditApi: CreditApi, + /** + * The DecisionManagerApi service constructor. + * @property {module:api/DecisionManagerApi} + */ + DecisionManagerApi: DecisionManagerApi, + /** + * The InstrumentIdentifierApi service constructor. + * @property {module:api/InstrumentIdentifierApi} + */ + InstrumentIdentifierApi: InstrumentIdentifierApi, + /** + * The KeyGenerationApi service constructor. + * @property {module:api/KeyGenerationApi} + */ + KeyGenerationApi: KeyGenerationApi, + /** + * The NetFundingsApi service constructor. + * @property {module:api/NetFundingsApi} + */ + NetFundingsApi: NetFundingsApi, + /** + * The NotificationOfChangesApi service constructor. + * @property {module:api/NotificationOfChangesApi} + */ + NotificationOfChangesApi: NotificationOfChangesApi, + /** + * The PayerAuthenticationApi service constructor. + * @property {module:api/PayerAuthenticationApi} + */ + PayerAuthenticationApi: PayerAuthenticationApi, + /** + * The PaymentInstrumentApi service constructor. + * @property {module:api/PaymentInstrumentApi} + */ + PaymentInstrumentApi: PaymentInstrumentApi, + /** + * The PaymentsApi service constructor. + * @property {module:api/PaymentsApi} + */ + PaymentsApi: PaymentsApi, + /** + * The PayoutsApi service constructor. + * @property {module:api/PayoutsApi} + */ + PayoutsApi: PayoutsApi, + /** + * The PurchaseAndRefundDetailsApi service constructor. + * @property {module:api/PurchaseAndRefundDetailsApi} + */ + PurchaseAndRefundDetailsApi: PurchaseAndRefundDetailsApi, + /** + * The RefundApi service constructor. + * @property {module:api/RefundApi} + */ + RefundApi: RefundApi, + /** + * The ReportDefinitionsApi service constructor. + * @property {module:api/ReportDefinitionsApi} + */ + ReportDefinitionsApi: ReportDefinitionsApi, + /** + * The ReportDownloadsApi service constructor. + * @property {module:api/ReportDownloadsApi} + */ + ReportDownloadsApi: ReportDownloadsApi, + /** + * The ReportSubscriptionsApi service constructor. + * @property {module:api/ReportSubscriptionsApi} + */ + ReportSubscriptionsApi: ReportSubscriptionsApi, + /** + * The ReportsApi service constructor. + * @property {module:api/ReportsApi} + */ + ReportsApi: ReportsApi, + /** + * The ReversalApi service constructor. + * @property {module:api/ReversalApi} + */ + ReversalApi: ReversalApi, + /** + * The SearchTransactionsApi service constructor. + * @property {module:api/SearchTransactionsApi} + */ + SearchTransactionsApi: SearchTransactionsApi, + /** + * The SecureFileShareApi service constructor. + * @property {module:api/SecureFileShareApi} + */ + SecureFileShareApi: SecureFileShareApi, + /** + * The TokenizationApi service constructor. + * @property {module:api/TokenizationApi} + */ + TokenizationApi: TokenizationApi, + /** + * The TransactionBatchesApi service constructor. + * @property {module:api/TransactionBatchesApi} + */ + TransactionBatchesApi: TransactionBatchesApi, + /** + * The TransactionDetailsApi service constructor. + * @property {module:api/TransactionDetailsApi} + */ + TransactionDetailsApi: TransactionDetailsApi, + /** + * The UserManagementApi service constructor. + * @property {module:api/UserManagementApi} + */ + UserManagementApi: UserManagementApi, + /** + * The VoidApi service constructor. + * @property {module:api/VoidApi} + */ + VoidApi: VoidApi + }; + + return exports; +})); diff --git a/src/model/AuthorizationOptions.js b/src/model/AuthorizationOptions.js new file mode 100644 index 00000000..afd3bb17 --- /dev/null +++ b/src/model/AuthorizationOptions.js @@ -0,0 +1,81 @@ +/** + * 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 + * + * Swagger Codegen version: 2.3.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator')); + } else { + // Browser globals (root is window) + if (!root.CyberSource) { + root.CyberSource = {}; + } + root.CyberSource.AuthorizationOptions = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator); + } +}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator) { + 'use strict'; + + + + + /** + * The AuthorizationOptions model module. + * @module model/AuthorizationOptions + * @version 0.0.1 + */ + + /** + * Constructs a new
AuthorizationOptions.
+ * @alias module:model/AuthorizationOptions
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a AuthorizationOptions from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/AuthorizationOptions} obj Optional instance to populate.
+ * @return {module:model/AuthorizationOptions} The populated AuthorizationOptions instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('initiator')) {
+ obj['initiator'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.constructFromObject(data['initiator']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator} initiator
+ */
+ exports.prototype['initiator'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/BillTo.js b/src/model/BillTo.js
new file mode 100644
index 00000000..e3b0fbaa
--- /dev/null
+++ b/src/model/BillTo.js
@@ -0,0 +1,172 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.BillTo = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The BillTo model module.
+ * @module model/BillTo
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new BillTo.
+ * @alias module:model/BillTo
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a BillTo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/BillTo} obj Optional instance to populate.
+ * @return {module:model/BillTo} The populated BillTo instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('firstName')) {
+ obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
+ }
+ if (data.hasOwnProperty('lastName')) {
+ obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
+ }
+ if (data.hasOwnProperty('company')) {
+ obj['company'] = ApiClient.convertToType(data['company'], 'String');
+ }
+ if (data.hasOwnProperty('address1')) {
+ obj['address1'] = ApiClient.convertToType(data['address1'], 'String');
+ }
+ if (data.hasOwnProperty('address2')) {
+ obj['address2'] = ApiClient.convertToType(data['address2'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('administrativeArea')) {
+ obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String');
+ }
+ if (data.hasOwnProperty('postalCode')) {
+ obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String');
+ }
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('email')) {
+ obj['email'] = ApiClient.convertToType(data['email'], 'String');
+ }
+ if (data.hasOwnProperty('phoneNumber')) {
+ obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} firstName
+ */
+ exports.prototype['firstName'] = undefined;
+ /**
+ * Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} lastName
+ */
+ exports.prototype['lastName'] = undefined;
+ /**
+ * Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} company
+ */
+ exports.prototype['company'] = undefined;
+ /**
+ * First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} address1
+ */
+ exports.prototype['address1'] = undefined;
+ /**
+ * Additional address information.
+ * @member {String} address2
+ */
+ exports.prototype['address2'] = undefined;
+ /**
+ * City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} administrativeArea
+ */
+ exports.prototype['administrativeArea'] = undefined;
+ /**
+ * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} postalCode
+ */
+ exports.prototype['postalCode'] = undefined;
+ /**
+ * Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} email
+ */
+ exports.prototype['email'] = undefined;
+ /**
+ * Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional.
+ * @member {String} phoneNumber
+ */
+ exports.prototype['phoneNumber'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/BuyerInformation.js b/src/model/BuyerInformation.js
new file mode 100644
index 00000000..cb2b5e32
--- /dev/null
+++ b/src/model/BuyerInformation.js
@@ -0,0 +1,108 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.BuyerInformation = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification) {
+ 'use strict';
+
+
+
+
+ /**
+ * The BuyerInformation model module.
+ * @module model/BuyerInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new BuyerInformation.
+ * @alias module:model/BuyerInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a BuyerInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/BuyerInformation} obj Optional instance to populate.
+ * @return {module:model/BuyerInformation} The populated BuyerInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('companyTaxID')) {
+ obj['companyTaxID'] = ApiClient.convertToType(data['companyTaxID'], 'String');
+ }
+ if (data.hasOwnProperty('currency')) {
+ obj['currency'] = ApiClient.convertToType(data['currency'], 'String');
+ }
+ if (data.hasOwnProperty('dateOBirth')) {
+ obj['dateOBirth'] = ApiClient.convertToType(data['dateOBirth'], 'String');
+ }
+ if (data.hasOwnProperty('personalIdentification')) {
+ obj['personalIdentification'] = ApiClient.convertToType(data['personalIdentification'], [TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Tax identifier for the customer’s company. **Important**: Contact your TeleCheck representative to find out whether this field is required or optional.
+ * @member {String} companyTaxID
+ */
+ exports.prototype['companyTaxID'] = undefined;
+ /**
+ * Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha.
+ * @member {String} currency
+ */
+ exports.prototype['currency'] = undefined;
+ /**
+ * Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD`
+ * @member {String} dateOBirth
+ */
+ exports.prototype['dateOBirth'] = undefined;
+ /**
+ * @member {Array.CardInfo.
+ * @alias module:model/CardInfo
+ * @class
+ * @param cardNumber {String} Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request.
+ * @param cardType {String} Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types.
+ */
+ var exports = function(cardNumber, cardType) {
+ var _this = this;
+
+ _this['cardNumber'] = cardNumber;
+
+
+ _this['cardType'] = cardType;
+ };
+
+ /**
+ * Constructs a CardInfo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/CardInfo} obj Optional instance to populate.
+ * @return {module:model/CardInfo} The populated CardInfo instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('cardNumber')) {
+ obj['cardNumber'] = ApiClient.convertToType(data['cardNumber'], 'String');
+ }
+ if (data.hasOwnProperty('cardExpirationMonth')) {
+ obj['cardExpirationMonth'] = ApiClient.convertToType(data['cardExpirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('cardExpirationYear')) {
+ obj['cardExpirationYear'] = ApiClient.convertToType(data['cardExpirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('cardType')) {
+ obj['cardType'] = ApiClient.convertToType(data['cardType'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request.
+ * @member {String} cardNumber
+ */
+ exports.prototype['cardNumber'] = undefined;
+ /**
+ * Two digit expiration month
+ * @member {String} cardExpirationMonth
+ */
+ exports.prototype['cardExpirationMonth'] = undefined;
+ /**
+ * Four digit expiration year
+ * @member {String} cardExpirationYear
+ */
+ exports.prototype['cardExpirationYear'] = undefined;
+ /**
+ * Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types.
+ * @member {String} cardType
+ */
+ exports.prototype['cardType'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/CheckPayerAuthEnrollmentRequest.js b/src/model/CheckPayerAuthEnrollmentRequest.js
new file mode 100644
index 00000000..b7a7e45b
--- /dev/null
+++ b/src/model/CheckPayerAuthEnrollmentRequest.js
@@ -0,0 +1,161 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsBuyerInformation', 'model/Riskv1authenticationsClientReferenceInformation', 'model/Riskv1authenticationsConsumerAuthenticationInformation', 'model/Riskv1authenticationsDeviceInformation', 'model/Riskv1authenticationsMerchantInformation', 'model/Riskv1authenticationsOrderInformation', 'model/Riskv1authenticationsPaymentInformation', 'model/Riskv1authenticationsRecurringPaymentInformation', 'model/Riskv1authenticationsRiskInformation', 'model/Riskv1authenticationsTravelInformation', 'model/Riskv1decisionsMerchantDefinedInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsBuyerInformation'), require('./Riskv1authenticationsClientReferenceInformation'), require('./Riskv1authenticationsConsumerAuthenticationInformation'), require('./Riskv1authenticationsDeviceInformation'), require('./Riskv1authenticationsMerchantInformation'), require('./Riskv1authenticationsOrderInformation'), require('./Riskv1authenticationsPaymentInformation'), require('./Riskv1authenticationsRecurringPaymentInformation'), require('./Riskv1authenticationsRiskInformation'), require('./Riskv1authenticationsTravelInformation'), require('./Riskv1decisionsMerchantDefinedInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.CheckPayerAuthEnrollmentRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsBuyerInformation, root.CyberSource.Riskv1authenticationsClientReferenceInformation, root.CyberSource.Riskv1authenticationsConsumerAuthenticationInformation, root.CyberSource.Riskv1authenticationsDeviceInformation, root.CyberSource.Riskv1authenticationsMerchantInformation, root.CyberSource.Riskv1authenticationsOrderInformation, root.CyberSource.Riskv1authenticationsPaymentInformation, root.CyberSource.Riskv1authenticationsRecurringPaymentInformation, root.CyberSource.Riskv1authenticationsRiskInformation, root.CyberSource.Riskv1authenticationsTravelInformation, root.CyberSource.Riskv1decisionsMerchantDefinedInformation);
+ }
+}(this, function(ApiClient, Riskv1authenticationsBuyerInformation, Riskv1authenticationsClientReferenceInformation, Riskv1authenticationsConsumerAuthenticationInformation, Riskv1authenticationsDeviceInformation, Riskv1authenticationsMerchantInformation, Riskv1authenticationsOrderInformation, Riskv1authenticationsPaymentInformation, Riskv1authenticationsRecurringPaymentInformation, Riskv1authenticationsRiskInformation, Riskv1authenticationsTravelInformation, Riskv1decisionsMerchantDefinedInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The CheckPayerAuthEnrollmentRequest model module.
+ * @module model/CheckPayerAuthEnrollmentRequest
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new CheckPayerAuthEnrollmentRequest.
+ * @alias module:model/CheckPayerAuthEnrollmentRequest
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a CheckPayerAuthEnrollmentRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/CheckPayerAuthEnrollmentRequest} obj Optional instance to populate.
+ * @return {module:model/CheckPayerAuthEnrollmentRequest} The populated CheckPayerAuthEnrollmentRequest instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('clientReferenceInformation')) {
+ obj['clientReferenceInformation'] = Riskv1authenticationsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
+ }
+ if (data.hasOwnProperty('orderInformation')) {
+ obj['orderInformation'] = Riskv1authenticationsOrderInformation.constructFromObject(data['orderInformation']);
+ }
+ if (data.hasOwnProperty('paymentInformation')) {
+ obj['paymentInformation'] = Riskv1authenticationsPaymentInformation.constructFromObject(data['paymentInformation']);
+ }
+ if (data.hasOwnProperty('buyerInformation')) {
+ obj['buyerInformation'] = Riskv1authenticationsBuyerInformation.constructFromObject(data['buyerInformation']);
+ }
+ if (data.hasOwnProperty('deviceInformation')) {
+ obj['deviceInformation'] = Riskv1authenticationsDeviceInformation.constructFromObject(data['deviceInformation']);
+ }
+ if (data.hasOwnProperty('merchantInformation')) {
+ obj['merchantInformation'] = Riskv1authenticationsMerchantInformation.constructFromObject(data['merchantInformation']);
+ }
+ if (data.hasOwnProperty('recurringPaymentInformation')) {
+ obj['recurringPaymentInformation'] = Riskv1authenticationsRecurringPaymentInformation.constructFromObject(data['recurringPaymentInformation']);
+ }
+ if (data.hasOwnProperty('consumerAuthenticationInformation')) {
+ obj['consumerAuthenticationInformation'] = Riskv1authenticationsConsumerAuthenticationInformation.constructFromObject(data['consumerAuthenticationInformation']);
+ }
+ if (data.hasOwnProperty('riskInformation')) {
+ obj['riskInformation'] = Riskv1authenticationsRiskInformation.constructFromObject(data['riskInformation']);
+ }
+ if (data.hasOwnProperty('travelInformation')) {
+ obj['travelInformation'] = Riskv1authenticationsTravelInformation.constructFromObject(data['travelInformation']);
+ }
+ if (data.hasOwnProperty('merchantDefinedInformation')) {
+ obj['merchantDefinedInformation'] = ApiClient.convertToType(data['merchantDefinedInformation'], [Riskv1decisionsMerchantDefinedInformation]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationsClientReferenceInformation} clientReferenceInformation
+ */
+ exports.prototype['clientReferenceInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsOrderInformation} orderInformation
+ */
+ exports.prototype['orderInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsPaymentInformation} paymentInformation
+ */
+ exports.prototype['paymentInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsBuyerInformation} buyerInformation
+ */
+ exports.prototype['buyerInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsDeviceInformation} deviceInformation
+ */
+ exports.prototype['deviceInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsMerchantInformation} merchantInformation
+ */
+ exports.prototype['merchantInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsRecurringPaymentInformation} recurringPaymentInformation
+ */
+ exports.prototype['recurringPaymentInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsConsumerAuthenticationInformation} consumerAuthenticationInformation
+ */
+ exports.prototype['consumerAuthenticationInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsRiskInformation} riskInformation
+ */
+ exports.prototype['riskInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsTravelInformation} travelInformation
+ */
+ exports.prototype['travelInformation'] = undefined;
+ /**
+ * @member {Array.DerPublicKey.
+ * The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.
+ * @alias module:model/DerPublicKey
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a DerPublicKey from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/DerPublicKey} obj Optional instance to populate.
+ * @return {module:model/DerPublicKey} The populated DerPublicKey instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('format')) {
+ obj['format'] = ApiClient.convertToType(data['format'], 'String');
+ }
+ if (data.hasOwnProperty('algorithm')) {
+ obj['algorithm'] = ApiClient.convertToType(data['algorithm'], 'String');
+ }
+ if (data.hasOwnProperty('publicKey')) {
+ obj['publicKey'] = ApiClient.convertToType(data['publicKey'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Specifies the format of the public key; currently X.509.
+ * @member {String} format
+ */
+ exports.prototype['format'] = undefined;
+ /**
+ * Algorithm used to encrypt the public key.
+ * @member {String} algorithm
+ */
+ exports.prototype['algorithm'] = undefined;
+ /**
+ * Base64 encoded public key value.
+ * @member {String} publicKey
+ */
+ exports.prototype['publicKey'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Detail.js b/src/model/Detail.js
new file mode 100644
index 00000000..60f17c26
--- /dev/null
+++ b/src/model/Detail.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Detail = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Detail model module.
+ * @module model/Detail
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Detail.
+ * @alias module:model/Detail
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Detail from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Detail} obj Optional instance to populate.
+ * @return {module:model/Detail} The populated Detail instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('location')) {
+ obj['location'] = ApiClient.convertToType(data['location'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The name of the field that threw the error.
+ * @member {String} name
+ */
+ exports.prototype['name'] = undefined;
+ /**
+ * The location of the field that threw the error.
+ * @member {String} location
+ */
+ exports.prototype['location'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/EmbeddedInstrumentIdentifier.js b/src/model/EmbeddedInstrumentIdentifier.js
new file mode 100644
index 00000000..d6740609
--- /dev/null
+++ b/src/model/EmbeddedInstrumentIdentifier.js
@@ -0,0 +1,169 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount', 'model/TmsV1InstrumentIdentifiersPost200ResponseCard', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinks', 'model/TmsV1InstrumentIdentifiersPost200ResponseMetadata', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseBankAccount'), require('./TmsV1InstrumentIdentifiersPost200ResponseCard'), require('./TmsV1InstrumentIdentifiersPost200ResponseLinks'), require('./TmsV1InstrumentIdentifiersPost200ResponseMetadata'), require('./TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.EmbeddedInstrumentIdentifier = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseBankAccount, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseCard, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseLinks, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseMetadata, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseBankAccount, TmsV1InstrumentIdentifiersPost200ResponseCard, TmsV1InstrumentIdentifiersPost200ResponseLinks, TmsV1InstrumentIdentifiersPost200ResponseMetadata, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The EmbeddedInstrumentIdentifier model module.
+ * @module model/EmbeddedInstrumentIdentifier
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new EmbeddedInstrumentIdentifier.
+ * @alias module:model/EmbeddedInstrumentIdentifier
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a EmbeddedInstrumentIdentifier from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/EmbeddedInstrumentIdentifier} obj Optional instance to populate.
+ * @return {module:model/EmbeddedInstrumentIdentifier} The populated EmbeddedInstrumentIdentifier instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = TmsV1InstrumentIdentifiersPost200ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('object')) {
+ obj['object'] = ApiClient.convertToType(data['object'], 'String');
+ }
+ if (data.hasOwnProperty('state')) {
+ obj['state'] = ApiClient.convertToType(data['state'], 'String');
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = TmsV1InstrumentIdentifiersPost200ResponseCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('bankAccount')) {
+ obj['bankAccount'] = TmsV1InstrumentIdentifiersPost200ResponseBankAccount.constructFromObject(data['bankAccount']);
+ }
+ if (data.hasOwnProperty('processingInformation')) {
+ obj['processingInformation'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.constructFromObject(data['processingInformation']);
+ }
+ if (data.hasOwnProperty('metadata')) {
+ obj['metadata'] = TmsV1InstrumentIdentifiersPost200ResponseMetadata.constructFromObject(data['metadata']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * Describes type of token.
+ * @member {module:model/EmbeddedInstrumentIdentifier.ObjectEnum} object
+ */
+ exports.prototype['object'] = undefined;
+ /**
+ * Current state of the token.
+ * @member {module:model/EmbeddedInstrumentIdentifier.StateEnum} state
+ */
+ exports.prototype['state'] = undefined;
+ /**
+ * The ID of the existing instrument identifier to be linked to the newly created payment instrument.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount} bankAccount
+ */
+ exports.prototype['bankAccount'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation} processingInformation
+ */
+ exports.prototype['processingInformation'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseMetadata} metadata
+ */
+ exports.prototype['metadata'] = undefined;
+
+
+ /**
+ * Allowed values for the object property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.ObjectEnum = {
+ /**
+ * value: "instrumentIdentifier"
+ * @const
+ */
+ "instrumentIdentifier": "instrumentIdentifier" };
+
+ /**
+ * Allowed values for the state property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.StateEnum = {
+ /**
+ * value: "ACTIVE"
+ * @const
+ */
+ "ACTIVE": "ACTIVE",
+ /**
+ * value: "CLOSED"
+ * @const
+ */
+ "CLOSED": "CLOSED" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Error.js b/src/model/Error.js
new file mode 100644
index 00000000..64f54f8e
--- /dev/null
+++ b/src/model/Error.js
@@ -0,0 +1,98 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Tmsv1instrumentidentifiersDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Tmsv1instrumentidentifiersDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Error = factory(root.CyberSource.ApiClient, root.CyberSource.Tmsv1instrumentidentifiersDetails);
+ }
+}(this, function(ApiClient, Tmsv1instrumentidentifiersDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Error model module.
+ * @module model/Error
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Error.
+ * @alias module:model/Error
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a Error from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Error} obj Optional instance to populate.
+ * @return {module:model/Error} The populated Error instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('details')) {
+ obj['details'] = Tmsv1instrumentidentifiersDetails.constructFromObject(data['details']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * The detailed message related to the type stated above.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * @member {module:model/Tmsv1instrumentidentifiersDetails} details
+ */
+ exports.prototype['details'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/ErrorBean.js b/src/model/ErrorBean.js
new file mode 100644
index 00000000..32886357
--- /dev/null
+++ b/src/model/ErrorBean.js
@@ -0,0 +1,130 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/InlineResponse400Fields'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./InlineResponse400Fields'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ErrorBean = factory(root.CyberSource.ApiClient, root.CyberSource.InlineResponse400Fields);
+ }
+}(this, function(ApiClient, InlineResponse400Fields) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ErrorBean model module.
+ * @module model/ErrorBean
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ErrorBean.
+ * Error Bean
+ * @alias module:model/ErrorBean
+ * @class
+ * @param code {String} Error code
+ * @param message {String} Error message
+ */
+ var exports = function(code, message) {
+ var _this = this;
+
+ _this['code'] = code;
+ _this['message'] = message;
+
+
+
+
+ };
+
+ /**
+ * Constructs a ErrorBean from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ErrorBean} obj Optional instance to populate.
+ * @return {module:model/ErrorBean} The populated ErrorBean instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('code')) {
+ obj['code'] = ApiClient.convertToType(data['code'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('localizationKey')) {
+ obj['localizationKey'] = ApiClient.convertToType(data['localizationKey'], 'String');
+ }
+ if (data.hasOwnProperty('correlationId')) {
+ obj['correlationId'] = ApiClient.convertToType(data['correlationId'], 'String');
+ }
+ if (data.hasOwnProperty('detail')) {
+ obj['detail'] = ApiClient.convertToType(data['detail'], 'String');
+ }
+ if (data.hasOwnProperty('fields')) {
+ obj['fields'] = ApiClient.convertToType(data['fields'], [InlineResponse400Fields]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Error code
+ * @member {String} code
+ */
+ exports.prototype['code'] = undefined;
+ /**
+ * Error message
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * Localization Key Name
+ * @member {String} localizationKey
+ */
+ exports.prototype['localizationKey'] = undefined;
+ /**
+ * Correlation Id
+ * @member {String} correlationId
+ */
+ exports.prototype['correlationId'] = undefined;
+ /**
+ * Error Detail
+ * @member {String} detail
+ */
+ exports.prototype['detail'] = undefined;
+ /**
+ * Error fields List
+ * @member {Array.ErrorFieldBean.
+ * Provide validation failed input field details
+ * @alias module:model/ErrorFieldBean
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a ErrorFieldBean from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ErrorFieldBean} obj Optional instance to populate.
+ * @return {module:model/ErrorFieldBean} The populated ErrorFieldBean instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('path')) {
+ obj['path'] = ApiClient.convertToType(data['path'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('localizationKey')) {
+ obj['localizationKey'] = ApiClient.convertToType(data['localizationKey'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Path of the failed property
+ * @member {String} path
+ */
+ exports.prototype['path'] = undefined;
+ /**
+ * Error description about validation failed field
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * Localized Key Name
+ * @member {String} localizationKey
+ */
+ exports.prototype['localizationKey'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/ErrorLinks.js b/src/model/ErrorLinks.js
new file mode 100644
index 00000000..b154e927
--- /dev/null
+++ b/src/model/ErrorLinks.js
@@ -0,0 +1,97 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/InlineResponseDefaultLinksNext'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./InlineResponseDefaultLinksNext'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ErrorLinks = factory(root.CyberSource.ApiClient, root.CyberSource.InlineResponseDefaultLinksNext);
+ }
+}(this, function(ApiClient, InlineResponseDefaultLinksNext) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ErrorLinks model module.
+ * @module model/ErrorLinks
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ErrorLinks.
+ * @alias module:model/ErrorLinks
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a ErrorLinks from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ErrorLinks} obj Optional instance to populate.
+ * @return {module:model/ErrorLinks} The populated ErrorLinks instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('next')) {
+ obj['next'] = ApiClient.convertToType(data['next'], [InlineResponseDefaultLinksNext]);
+ }
+ if (data.hasOwnProperty('documentation')) {
+ obj['documentation'] = ApiClient.convertToType(data['documentation'], [InlineResponseDefaultLinksNext]);
+ }
+ if (data.hasOwnProperty('self')) {
+ obj['self'] = InlineResponseDefaultLinksNext.constructFromObject(data['self']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {Array.MitVoidRequest.
- * @alias module:model/MitVoidRequest
+ * Constructs a new ErrorResponse.
+ * @alias module:model/ErrorResponse
* @class
+ * @extends Array
*/
var exports = function() {
var _this = this;
+ _this = new Array();
+ Object.setPrototypeOf(_this, exports);
-
+ return _this;
};
/**
- * Constructs a MitVoidRequest from a plain JavaScript object, optionally creating a new instance.
+ * Constructs a ErrorResponse from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from data to obj if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/MitVoidRequest} obj Optional instance to populate.
- * @return {module:model/MitVoidRequest} The populated MitVoidRequest instance.
+ * @param {module:model/ErrorResponse} obj Optional instance to populate.
+ * @return {module:model/ErrorResponse} The populated ErrorResponse instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
+ ApiClient.constructFromObject(data, obj, 'InlineResponse4001');
- if (data.hasOwnProperty('clientReferenceInformation')) {
- obj['clientReferenceInformation'] = Ptsv2paymentsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
- }
}
return obj;
}
- /**
- * @member {module:model/Ptsv2paymentsClientReferenceInformation} clientReferenceInformation
- */
- exports.prototype['clientReferenceInformation'] = undefined;
diff --git a/src/model/ErrorResponseWithHAL.js b/src/model/ErrorResponseWithHAL.js
new file mode 100644
index 00000000..443c9b89
--- /dev/null
+++ b/src/model/ErrorResponseWithHAL.js
@@ -0,0 +1,78 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/InlineResponse4001'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./InlineResponse4001'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ErrorResponseWithHAL = factory(root.CyberSource.ApiClient, root.CyberSource.InlineResponse4001);
+ }
+}(this, function(ApiClient, InlineResponse4001) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ErrorResponseWithHAL model module.
+ * @module model/ErrorResponseWithHAL
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ErrorResponseWithHAL.
+ * @alias module:model/ErrorResponseWithHAL
+ * @class
+ * @extends Array
+ */
+ var exports = function() {
+ var _this = this;
+ _this = new Array();
+ Object.setPrototypeOf(_this, exports);
+
+ return _this;
+ };
+
+ /**
+ * Constructs a ErrorResponseWithHAL from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ErrorResponseWithHAL} obj Optional instance to populate.
+ * @return {module:model/ErrorResponseWithHAL} The populated ErrorResponseWithHAL instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+ ApiClient.constructFromObject(data, obj, 'InlineResponse4001');
+
+ }
+ return obj;
+ }
+
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/ExistingInstrumentIdentifierId.js b/src/model/ExistingInstrumentIdentifierId.js
new file mode 100644
index 00000000..b63c5437
--- /dev/null
+++ b/src/model/ExistingInstrumentIdentifierId.js
@@ -0,0 +1,74 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ExistingInstrumentIdentifierId = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ExistingInstrumentIdentifierId model module.
+ * @module model/ExistingInstrumentIdentifierId
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ExistingInstrumentIdentifierId.
+ * The ID of the existing instrument identifier to be linked to the newly created payment instrument.
+ * @alias module:model/ExistingInstrumentIdentifierId
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+ };
+
+ /**
+ * Constructs a ExistingInstrumentIdentifierId from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ExistingInstrumentIdentifierId} obj Optional instance to populate.
+ * @return {module:model/ExistingInstrumentIdentifierId} The populated ExistingInstrumentIdentifierId instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ }
+ return obj;
+ }
+
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/FileBean.js b/src/model/FileBean.js
new file mode 100644
index 00000000..be2dc8b4
--- /dev/null
+++ b/src/model/FileBean.js
@@ -0,0 +1,98 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.FileBean = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The FileBean model module.
+ * @module model/FileBean
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new FileBean.
+ * @alias module:model/FileBean
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a FileBean from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/FileBean} obj Optional instance to populate.
+ * @return {module:model/FileBean} The populated FileBean instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('fileId')) {
+ obj['fileId'] = ApiClient.convertToType(data['fileId'], 'String');
+ }
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ if (data.hasOwnProperty('method')) {
+ obj['method'] = ApiClient.convertToType(data['method'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier for each file
+ * @member {String} fileId
+ */
+ exports.prototype['fileId'] = undefined;
+ /**
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+ /**
+ * @member {String} method
+ */
+ exports.prototype['method'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/FileDetail.js b/src/model/FileDetail.js
new file mode 100644
index 00000000..f80ead29
--- /dev/null
+++ b/src/model/FileDetail.js
@@ -0,0 +1,163 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.FileDetail = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The FileDetail model module.
+ * @module model/FileDetail
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new FileDetail.
+ * @alias module:model/FileDetail
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a FileDetail from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/FileDetail} obj Optional instance to populate.
+ * @return {module:model/FileDetail} The populated FileDetail instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('fileId')) {
+ obj['fileId'] = ApiClient.convertToType(data['fileId'], 'String');
+ }
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('createdTime')) {
+ obj['createdTime'] = ApiClient.convertToType(data['createdTime'], 'Date');
+ }
+ if (data.hasOwnProperty('lastModifiedTime')) {
+ obj['lastModifiedTime'] = ApiClient.convertToType(data['lastModifiedTime'], 'Date');
+ }
+ if (data.hasOwnProperty('date')) {
+ obj['date'] = ApiClient.convertToType(data['date'], 'Date');
+ }
+ if (data.hasOwnProperty('mimeType')) {
+ obj['mimeType'] = ApiClient.convertToType(data['mimeType'], 'String');
+ }
+ if (data.hasOwnProperty('size')) {
+ obj['size'] = ApiClient.convertToType(data['size'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier of a file
+ * @member {String} fileId
+ */
+ exports.prototype['fileId'] = undefined;
+ /**
+ * Name of the file
+ * @member {String} name
+ */
+ exports.prototype['name'] = undefined;
+ /**
+ * Date and time for the file in PST
+ * @member {Date} createdTime
+ */
+ exports.prototype['createdTime'] = undefined;
+ /**
+ * Date and time for the file in PST
+ * @member {Date} lastModifiedTime
+ */
+ exports.prototype['lastModifiedTime'] = undefined;
+ /**
+ * Date and time for the file in PST
+ * @member {Date} date
+ */
+ exports.prototype['date'] = undefined;
+ /**
+ * File extension
+ * @member {module:model/FileDetail.MimeTypeEnum} mimeType
+ */
+ exports.prototype['mimeType'] = undefined;
+ /**
+ * Size of the file in bytes
+ * @member {Number} size
+ */
+ exports.prototype['size'] = undefined;
+
+
+ /**
+ * Allowed values for the mimeType property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.MimeTypeEnum = {
+ /**
+ * value: "application/xml"
+ * @const
+ */
+ "application/xml": "application/xml",
+ /**
+ * value: "text/csv"
+ * @const
+ */
+ "text/csv": "text/csv",
+ /**
+ * value: "application/pdf"
+ * @const
+ */
+ "application/pdf": "application/pdf",
+ /**
+ * value: "application/octet-stream"
+ * @const
+ */
+ "application/octet-stream": "application/octet-stream" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/FileDetailsResponse.js b/src/model/FileDetailsResponse.js
new file mode 100644
index 00000000..fa131322
--- /dev/null
+++ b/src/model/FileDetailsResponse.js
@@ -0,0 +1,89 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/V1FileDetailsGet200ResponseFileDetails', 'model/V1FileDetailsGet200ResponseLinks'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./V1FileDetailsGet200ResponseFileDetails'), require('./V1FileDetailsGet200ResponseLinks'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.FileDetailsResponse = factory(root.CyberSource.ApiClient, root.CyberSource.V1FileDetailsGet200ResponseFileDetails, root.CyberSource.V1FileDetailsGet200ResponseLinks);
+ }
+}(this, function(ApiClient, V1FileDetailsGet200ResponseFileDetails, V1FileDetailsGet200ResponseLinks) {
+ 'use strict';
+
+
+
+
+ /**
+ * The FileDetailsResponse model module.
+ * @module model/FileDetailsResponse
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new FileDetailsResponse.
+ * @alias module:model/FileDetailsResponse
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a FileDetailsResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/FileDetailsResponse} obj Optional instance to populate.
+ * @return {module:model/FileDetailsResponse} The populated FileDetailsResponse instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('fileDetails')) {
+ obj['fileDetails'] = ApiClient.convertToType(data['fileDetails'], [V1FileDetailsGet200ResponseFileDetails]);
+ }
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = V1FileDetailsGet200ResponseLinks.constructFromObject(data['_links']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {Array.Initiator.
+ * @alias module:model/Initiator
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Initiator from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Initiator} obj Optional instance to populate.
+ * @return {module:model/Initiator} The populated Initiator instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('merchantInitiatedTransaction')) {
+ obj['merchantInitiatedTransaction'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.constructFromObject(data['merchantInitiatedTransaction']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction} merchantInitiatedTransaction
+ */
+ exports.prototype['merchantInitiatedTransaction'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InlineResponse200.js b/src/model/InlineResponse200.js
deleted file mode 100644
index 23867287..00000000
--- a/src/model/InlineResponse200.js
+++ /dev/null
@@ -1,97 +0,0 @@
-/**
- * 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
- *
- * Swagger Codegen version: 2.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
- if (typeof define === 'function' && define.amd) {
- // AMD. Register as an anonymous module.
- define(['ApiClient', 'model/InlineResponse200PaymentBatchSummaries'], factory);
- } else if (typeof module === 'object' && module.exports) {
- // CommonJS-like environments that support module.exports, like Node.
- module.exports = factory(require('../ApiClient'), require('./InlineResponse200PaymentBatchSummaries'));
- } else {
- // Browser globals (root is window)
- if (!root.CyberSource) {
- root.CyberSource = {};
- }
- root.CyberSource.InlineResponse200 = factory(root.CyberSource.ApiClient, root.CyberSource.InlineResponse200PaymentBatchSummaries);
- }
-}(this, function(ApiClient, InlineResponse200PaymentBatchSummaries) {
- 'use strict';
-
-
-
-
- /**
- * The InlineResponse200 model module.
- * @module model/InlineResponse200
- * @version 0.0.1
- */
-
- /**
- * Constructs a new InlineResponse200.
- * @alias module:model/InlineResponse200
- * @class
- */
- var exports = function() {
- var _this = this;
-
-
-
-
- };
-
- /**
- * Constructs a InlineResponse200 from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/InlineResponse200} obj Optional instance to populate.
- * @return {module:model/InlineResponse200} The populated InlineResponse200 instance.
- */
- exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('startTime')) {
- obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date');
- }
- if (data.hasOwnProperty('endTime')) {
- obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date');
- }
- if (data.hasOwnProperty('paymentBatchSummaries')) {
- obj['paymentBatchSummaries'] = ApiClient.convertToType(data['paymentBatchSummaries'], [InlineResponse200PaymentBatchSummaries]);
- }
- }
- return obj;
- }
-
- /**
- * @member {Date} startTime
- */
- exports.prototype['startTime'] = undefined;
- /**
- * @member {Date} endTime
- */
- exports.prototype['endTime'] = undefined;
- /**
- * @member {Array.InlineResponse200PaymentBatchSummaries.
- * @alias module:model/InlineResponse200PaymentBatchSummaries
- * @class
- */
- var exports = function() {
- var _this = this;
-
-
-
-
-
-
-
-
-
-
-
-
-
- };
-
- /**
- * Constructs a InlineResponse200PaymentBatchSummaries from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/InlineResponse200PaymentBatchSummaries} obj Optional instance to populate.
- * @return {module:model/InlineResponse200PaymentBatchSummaries} The populated InlineResponse200PaymentBatchSummaries instance.
- */
- exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('currencyCode')) {
- obj['currencyCode'] = ApiClient.convertToType(data['currencyCode'], 'String');
- }
- if (data.hasOwnProperty('paymentSubTypeDescription')) {
- obj['paymentSubTypeDescription'] = ApiClient.convertToType(data['paymentSubTypeDescription'], 'String');
- }
- if (data.hasOwnProperty('startTime')) {
- obj['startTime'] = ApiClient.convertToType(data['startTime'], 'Date');
- }
- if (data.hasOwnProperty('endTime')) {
- obj['endTime'] = ApiClient.convertToType(data['endTime'], 'Date');
- }
- if (data.hasOwnProperty('salesCount')) {
- obj['salesCount'] = ApiClient.convertToType(data['salesCount'], 'Number');
- }
- if (data.hasOwnProperty('salesAmount')) {
- obj['salesAmount'] = ApiClient.convertToType(data['salesAmount'], 'String');
- }
- if (data.hasOwnProperty('creditCount')) {
- obj['creditCount'] = ApiClient.convertToType(data['creditCount'], 'Number');
- }
- if (data.hasOwnProperty('creditAmount')) {
- obj['creditAmount'] = ApiClient.convertToType(data['creditAmount'], 'String');
- }
- if (data.hasOwnProperty('accountName')) {
- obj['accountName'] = ApiClient.convertToType(data['accountName'], 'String');
- }
- if (data.hasOwnProperty('accountId')) {
- obj['accountId'] = ApiClient.convertToType(data['accountId'], 'String');
- }
- if (data.hasOwnProperty('merchantId')) {
- obj['merchantId'] = ApiClient.convertToType(data['merchantId'], 'String');
- }
- if (data.hasOwnProperty('merchantName')) {
- obj['merchantName'] = ApiClient.convertToType(data['merchantName'], 'String');
- }
- }
- return obj;
- }
-
- /**
- * @member {String} currencyCode
- */
- exports.prototype['currencyCode'] = undefined;
- /**
- * @member {String} paymentSubTypeDescription
- */
- exports.prototype['paymentSubTypeDescription'] = undefined;
- /**
- * @member {Date} startTime
- */
- exports.prototype['startTime'] = undefined;
- /**
- * @member {Date} endTime
- */
- exports.prototype['endTime'] = undefined;
- /**
- * @member {Number} salesCount
- */
- exports.prototype['salesCount'] = undefined;
- /**
- * @member {String} salesAmount
- */
- exports.prototype['salesAmount'] = undefined;
- /**
- * @member {Number} creditCount
- */
- exports.prototype['creditCount'] = undefined;
- /**
- * @member {String} creditAmount
- */
- exports.prototype['creditAmount'] = undefined;
- /**
- * @member {String} accountName
- */
- exports.prototype['accountName'] = undefined;
- /**
- * @member {String} accountId
- */
- exports.prototype['accountId'] = undefined;
- /**
- * @member {String} merchantId
- */
- exports.prototype['merchantId'] = undefined;
- /**
- * @member {String} merchantName
- */
- exports.prototype['merchantName'] = undefined;
-
-
-
- return exports;
-}));
-
-
diff --git a/src/model/InstrumentIdentifier.js b/src/model/InstrumentIdentifier.js
new file mode 100644
index 00000000..39945ae9
--- /dev/null
+++ b/src/model/InstrumentIdentifier.js
@@ -0,0 +1,169 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount', 'model/TmsV1InstrumentIdentifiersPost200ResponseCard', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinks', 'model/TmsV1InstrumentIdentifiersPost200ResponseMetadata', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseBankAccount'), require('./TmsV1InstrumentIdentifiersPost200ResponseCard'), require('./TmsV1InstrumentIdentifiersPost200ResponseLinks'), require('./TmsV1InstrumentIdentifiersPost200ResponseMetadata'), require('./TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifier = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseBankAccount, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseCard, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseLinks, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseMetadata, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseBankAccount, TmsV1InstrumentIdentifiersPost200ResponseCard, TmsV1InstrumentIdentifiersPost200ResponseLinks, TmsV1InstrumentIdentifiersPost200ResponseMetadata, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifier model module.
+ * @module model/InstrumentIdentifier
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifier.
+ * @alias module:model/InstrumentIdentifier
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifier from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifier} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifier} The populated InstrumentIdentifier instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = TmsV1InstrumentIdentifiersPost200ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('object')) {
+ obj['object'] = ApiClient.convertToType(data['object'], 'String');
+ }
+ if (data.hasOwnProperty('state')) {
+ obj['state'] = ApiClient.convertToType(data['state'], 'String');
+ }
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = TmsV1InstrumentIdentifiersPost200ResponseCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('bankAccount')) {
+ obj['bankAccount'] = TmsV1InstrumentIdentifiersPost200ResponseBankAccount.constructFromObject(data['bankAccount']);
+ }
+ if (data.hasOwnProperty('processingInformation')) {
+ obj['processingInformation'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.constructFromObject(data['processingInformation']);
+ }
+ if (data.hasOwnProperty('metadata')) {
+ obj['metadata'] = TmsV1InstrumentIdentifiersPost200ResponseMetadata.constructFromObject(data['metadata']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * Unique identification number assigned by CyberSource to the submitted request.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * Describes type of token.
+ * @member {module:model/InstrumentIdentifier.ObjectEnum} object
+ */
+ exports.prototype['object'] = undefined;
+ /**
+ * Current state of the token.
+ * @member {module:model/InstrumentIdentifier.StateEnum} state
+ */
+ exports.prototype['state'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount} bankAccount
+ */
+ exports.prototype['bankAccount'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation} processingInformation
+ */
+ exports.prototype['processingInformation'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseMetadata} metadata
+ */
+ exports.prototype['metadata'] = undefined;
+
+
+ /**
+ * Allowed values for the object property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.ObjectEnum = {
+ /**
+ * value: "instrumentIdentifier"
+ * @const
+ */
+ "instrumentIdentifier": "instrumentIdentifier" };
+
+ /**
+ * Allowed values for the state property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.StateEnum = {
+ /**
+ * value: "ACTIVE"
+ * @const
+ */
+ "ACTIVE": "ACTIVE",
+ /**
+ * value: "CLOSED"
+ * @const
+ */
+ "CLOSED": "CLOSED" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InstrumentIdentifierBankAccount.js b/src/model/InstrumentIdentifierBankAccount.js
new file mode 100644
index 00000000..60645c30
--- /dev/null
+++ b/src/model/InstrumentIdentifierBankAccount.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifierBankAccount = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifierBankAccount model module.
+ * @module model/InstrumentIdentifierBankAccount
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifierBankAccount.
+ * @alias module:model/InstrumentIdentifierBankAccount
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifierBankAccount from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifierBankAccount} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifierBankAccount} The populated InstrumentIdentifierBankAccount instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ if (data.hasOwnProperty('routingNumber')) {
+ obj['routingNumber'] = ApiClient.convertToType(data['routingNumber'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Checking account number.
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+ /**
+ * Routing number.
+ * @member {String} routingNumber
+ */
+ exports.prototype['routingNumber'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InstrumentIdentifierCard.js b/src/model/InstrumentIdentifierCard.js
new file mode 100644
index 00000000..1b474d68
--- /dev/null
+++ b/src/model/InstrumentIdentifierCard.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifierCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifierCard model module.
+ * @module model/InstrumentIdentifierCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifierCard.
+ * @alias module:model/InstrumentIdentifierCard
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifierCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifierCard} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifierCard} The populated InstrumentIdentifierCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Customer’s credit card number.
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InstrumentIdentifierEnrollableCard.js b/src/model/InstrumentIdentifierEnrollableCard.js
new file mode 100644
index 00000000..2f97461f
--- /dev/null
+++ b/src/model/InstrumentIdentifierEnrollableCard.js
@@ -0,0 +1,98 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Tmsv1instrumentidentifiersBillTo', 'model/Tmsv1instrumentidentifiersCard'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Tmsv1instrumentidentifiersBillTo'), require('./Tmsv1instrumentidentifiersCard'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifierEnrollableCard = factory(root.CyberSource.ApiClient, root.CyberSource.Tmsv1instrumentidentifiersBillTo, root.CyberSource.Tmsv1instrumentidentifiersCard);
+ }
+}(this, function(ApiClient, Tmsv1instrumentidentifiersBillTo, Tmsv1instrumentidentifiersCard) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifierEnrollableCard model module.
+ * @module model/InstrumentIdentifierEnrollableCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifierEnrollableCard.
+ * @alias module:model/InstrumentIdentifierEnrollableCard
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifierEnrollableCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifierEnrollableCard} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifierEnrollableCard} The populated InstrumentIdentifierEnrollableCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = Tmsv1instrumentidentifiersCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('billTo')) {
+ obj['billTo'] = Tmsv1instrumentidentifiersBillTo.constructFromObject(data['billTo']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Type of Card
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * @member {module:model/Tmsv1instrumentidentifiersCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/Tmsv1instrumentidentifiersBillTo} billTo
+ */
+ exports.prototype['billTo'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InstrumentIdentifierProcessingInformation.js b/src/model/InstrumentIdentifierProcessingInformation.js
new file mode 100644
index 00000000..5c942eeb
--- /dev/null
+++ b/src/model/InstrumentIdentifierProcessingInformation.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifierProcessingInformation = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifierProcessingInformation model module.
+ * @module model/InstrumentIdentifierProcessingInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifierProcessingInformation.
+ * @alias module:model/InstrumentIdentifierProcessingInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifierProcessingInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifierProcessingInformation} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifierProcessingInformation} The populated InstrumentIdentifierProcessingInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('authorizationOptions')) {
+ obj['authorizationOptions'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.constructFromObject(data['authorizationOptions']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions} authorizationOptions
+ */
+ exports.prototype['authorizationOptions'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/InstrumentIdentifierUpdate.js b/src/model/InstrumentIdentifierUpdate.js
new file mode 100644
index 00000000..4eae424a
--- /dev/null
+++ b/src/model/InstrumentIdentifierUpdate.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.InstrumentIdentifierUpdate = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The InstrumentIdentifierUpdate model module.
+ * @module model/InstrumentIdentifierUpdate
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new InstrumentIdentifierUpdate.
+ * @alias module:model/InstrumentIdentifierUpdate
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a InstrumentIdentifierUpdate from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/InstrumentIdentifierUpdate} obj Optional instance to populate.
+ * @return {module:model/InstrumentIdentifierUpdate} The populated InstrumentIdentifierUpdate instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('processingInformation')) {
+ obj['processingInformation'] = TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.constructFromObject(data['processingInformation']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation} processingInformation
+ */
+ exports.prototype['processingInformation'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/JsonWebKey.js b/src/model/JsonWebKey.js
new file mode 100644
index 00000000..426e673f
--- /dev/null
+++ b/src/model/JsonWebKey.js
@@ -0,0 +1,119 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.JsonWebKey = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The JsonWebKey model module.
+ * @module model/JsonWebKey
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new JsonWebKey.
+ * The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.
+ * @alias module:model/JsonWebKey
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a JsonWebKey from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/JsonWebKey} obj Optional instance to populate.
+ * @return {module:model/JsonWebKey} The populated JsonWebKey instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('kty')) {
+ obj['kty'] = ApiClient.convertToType(data['kty'], 'String');
+ }
+ if (data.hasOwnProperty('use')) {
+ obj['use'] = ApiClient.convertToType(data['use'], 'String');
+ }
+ if (data.hasOwnProperty('kid')) {
+ obj['kid'] = ApiClient.convertToType(data['kid'], 'String');
+ }
+ if (data.hasOwnProperty('n')) {
+ obj['n'] = ApiClient.convertToType(data['n'], 'String');
+ }
+ if (data.hasOwnProperty('e')) {
+ obj['e'] = ApiClient.convertToType(data['e'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Algorithm used to encrypt the public key.
+ * @member {String} kty
+ */
+ exports.prototype['kty'] = undefined;
+ /**
+ * Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc.
+ * @member {String} use
+ */
+ exports.prototype['use'] = undefined;
+ /**
+ * The key ID in JWK format.
+ * @member {String} kid
+ */
+ exports.prototype['kid'] = undefined;
+ /**
+ * JWK RSA Modulus
+ * @member {String} n
+ */
+ exports.prototype['n'] = undefined;
+ /**
+ * JWK RSA Exponent
+ * @member {String} e
+ */
+ exports.prototype['e'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/KeyParameters.js b/src/model/KeyParameters.js
new file mode 100644
index 00000000..2060b92b
--- /dev/null
+++ b/src/model/KeyParameters.js
@@ -0,0 +1,83 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.KeyParameters = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The KeyParameters model module.
+ * @module model/KeyParameters
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new KeyParameters.
+ * @alias module:model/KeyParameters
+ * @class
+ * @param encryptionType {String} How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified.
+ */
+ var exports = function(encryptionType) {
+ var _this = this;
+
+ _this['encryptionType'] = encryptionType;
+ };
+
+ /**
+ * Constructs a KeyParameters from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/KeyParameters} obj Optional instance to populate.
+ * @return {module:model/KeyParameters} The populated KeyParameters instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('encryptionType')) {
+ obj['encryptionType'] = ApiClient.convertToType(data['encryptionType'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified.
+ * @member {String} encryptionType
+ */
+ exports.prototype['encryptionType'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/KeyResult.js b/src/model/KeyResult.js
new file mode 100644
index 00000000..b9d3e89f
--- /dev/null
+++ b/src/model/KeyResult.js
@@ -0,0 +1,98 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/FlexV1KeysPost200ResponseDer', 'model/FlexV1KeysPost200ResponseJwk'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./FlexV1KeysPost200ResponseDer'), require('./FlexV1KeysPost200ResponseJwk'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.KeyResult = factory(root.CyberSource.ApiClient, root.CyberSource.FlexV1KeysPost200ResponseDer, root.CyberSource.FlexV1KeysPost200ResponseJwk);
+ }
+}(this, function(ApiClient, FlexV1KeysPost200ResponseDer, FlexV1KeysPost200ResponseJwk) {
+ 'use strict';
+
+
+
+
+ /**
+ * The KeyResult model module.
+ * @module model/KeyResult
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new KeyResult.
+ * @alias module:model/KeyResult
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a KeyResult from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/KeyResult} obj Optional instance to populate.
+ * @return {module:model/KeyResult} The populated KeyResult instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('keyId')) {
+ obj['keyId'] = ApiClient.convertToType(data['keyId'], 'String');
+ }
+ if (data.hasOwnProperty('der')) {
+ obj['der'] = FlexV1KeysPost200ResponseDer.constructFromObject(data['der']);
+ }
+ if (data.hasOwnProperty('jwk')) {
+ obj['jwk'] = FlexV1KeysPost200ResponseJwk.constructFromObject(data['jwk']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer’s device or browser.
+ * @member {String} keyId
+ */
+ exports.prototype['keyId'] = undefined;
+ /**
+ * @member {module:model/FlexV1KeysPost200ResponseDer} der
+ */
+ exports.prototype['der'] = undefined;
+ /**
+ * @member {module:model/FlexV1KeysPost200ResponseJwk} jwk
+ */
+ exports.prototype['jwk'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Link.js b/src/model/Link.js
new file mode 100644
index 00000000..b718f3ec
--- /dev/null
+++ b/src/model/Link.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Link = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Link model module.
+ * @module model/Link
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Link.
+ * @alias module:model/Link
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Link from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Link} obj Optional instance to populate.
+ * @return {module:model/Link} The populated Link instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Links.js b/src/model/Links.js
new file mode 100644
index 00000000..9e5dcdab
--- /dev/null
+++ b/src/model/Links.js
@@ -0,0 +1,97 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPost200ResponseLinksSelf'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Links = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseLinksSelf);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPost200ResponseLinksSelf) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Links model module.
+ * @module model/Links
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Links.
+ * @alias module:model/Links
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a Links from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Links} obj Optional instance to populate.
+ * @return {module:model/Links} The populated Links instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('self')) {
+ obj['self'] = TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.constructFromObject(data['self']);
+ }
+ if (data.hasOwnProperty('ancestor')) {
+ obj['ancestor'] = TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.constructFromObject(data['ancestor']);
+ }
+ if (data.hasOwnProperty('successor')) {
+ obj['successor'] = TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.constructFromObject(data['successor']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf} self
+ */
+ exports.prototype['self'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf} ancestor
+ */
+ exports.prototype['ancestor'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf} successor
+ */
+ exports.prototype['successor'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/MerchantInformation.js b/src/model/MerchantInformation.js
new file mode 100644
index 00000000..8847f540
--- /dev/null
+++ b/src/model/MerchantInformation.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.MerchantInformation = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor) {
+ 'use strict';
+
+
+
+
+ /**
+ * The MerchantInformation model module.
+ * @module model/MerchantInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new MerchantInformation.
+ * @alias module:model/MerchantInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a MerchantInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/MerchantInformation} obj Optional instance to populate.
+ * @return {module:model/MerchantInformation} The populated MerchantInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('merchantDescriptor')) {
+ obj['merchantDescriptor'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.constructFromObject(data['merchantDescriptor']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor} merchantDescriptor
+ */
+ exports.prototype['merchantDescriptor'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/MerchantInitiatedTransaction.js b/src/model/MerchantInitiatedTransaction.js
new file mode 100644
index 00000000..de63cc87
--- /dev/null
+++ b/src/model/MerchantInitiatedTransaction.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.MerchantInitiatedTransaction = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The MerchantInitiatedTransaction model module.
+ * @module model/MerchantInitiatedTransaction
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new MerchantInitiatedTransaction.
+ * @alias module:model/MerchantInitiatedTransaction
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a MerchantInitiatedTransaction from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/MerchantInitiatedTransaction} obj Optional instance to populate.
+ * @return {module:model/MerchantInitiatedTransaction} The populated MerchantInitiatedTransaction instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('previousTransactionId')) {
+ obj['previousTransactionId'] = ApiClient.convertToType(data['previousTransactionId'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Previous Consumer Initiated Transaction Id.
+ * @member {String} previousTransactionId
+ */
+ exports.prototype['previousTransactionId'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Metadata.js b/src/model/Metadata.js
new file mode 100644
index 00000000..27ad9758
--- /dev/null
+++ b/src/model/Metadata.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Metadata = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Metadata model module.
+ * @module model/Metadata
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Metadata.
+ * @alias module:model/Metadata
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Metadata from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Metadata} obj Optional instance to populate.
+ * @return {module:model/Metadata} The populated Metadata instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('creator')) {
+ obj['creator'] = ApiClient.convertToType(data['creator'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The creator of the token.
+ * @member {String} creator
+ */
+ exports.prototype['creator'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/MitReversalRequest.js b/src/model/MitReversalRequest.js
deleted file mode 100644
index c1eb835c..00000000
--- a/src/model/MitReversalRequest.js
+++ /dev/null
@@ -1,113 +0,0 @@
-/**
- * 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
- *
- * Swagger Codegen version: 2.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
- if (typeof define === 'function' && define.amd) {
- // AMD. Register as an anonymous module.
- define(['ApiClient', 'model/Ptsv2paymentsClientReferenceInformation', 'model/Ptsv2paymentsidreversalsOrderInformation', 'model/Ptsv2paymentsidreversalsPointOfSaleInformation', 'model/Ptsv2paymentsidreversalsProcessingInformation', 'model/Ptsv2paymentsidreversalsReversalInformation'], factory);
- } else if (typeof module === 'object' && module.exports) {
- // CommonJS-like environments that support module.exports, like Node.
- module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsClientReferenceInformation'), require('./Ptsv2paymentsidreversalsOrderInformation'), require('./Ptsv2paymentsidreversalsPointOfSaleInformation'), require('./Ptsv2paymentsidreversalsProcessingInformation'), require('./Ptsv2paymentsidreversalsReversalInformation'));
- } else {
- // Browser globals (root is window)
- if (!root.CyberSource) {
- root.CyberSource = {};
- }
- root.CyberSource.MitReversalRequest = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsClientReferenceInformation, root.CyberSource.Ptsv2paymentsidreversalsOrderInformation, root.CyberSource.Ptsv2paymentsidreversalsPointOfSaleInformation, root.CyberSource.Ptsv2paymentsidreversalsProcessingInformation, root.CyberSource.Ptsv2paymentsidreversalsReversalInformation);
- }
-}(this, function(ApiClient, Ptsv2paymentsClientReferenceInformation, Ptsv2paymentsidreversalsOrderInformation, Ptsv2paymentsidreversalsPointOfSaleInformation, Ptsv2paymentsidreversalsProcessingInformation, Ptsv2paymentsidreversalsReversalInformation) {
- 'use strict';
-
-
-
-
- /**
- * The MitReversalRequest model module.
- * @module model/MitReversalRequest
- * @version 0.0.1
- */
-
- /**
- * Constructs a new MitReversalRequest.
- * @alias module:model/MitReversalRequest
- * @class
- */
- var exports = function() {
- var _this = this;
-
-
-
-
-
-
- };
-
- /**
- * Constructs a MitReversalRequest from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/MitReversalRequest} obj Optional instance to populate.
- * @return {module:model/MitReversalRequest} The populated MitReversalRequest instance.
- */
- exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('clientReferenceInformation')) {
- obj['clientReferenceInformation'] = Ptsv2paymentsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
- }
- if (data.hasOwnProperty('reversalInformation')) {
- obj['reversalInformation'] = Ptsv2paymentsidreversalsReversalInformation.constructFromObject(data['reversalInformation']);
- }
- if (data.hasOwnProperty('processingInformation')) {
- obj['processingInformation'] = Ptsv2paymentsidreversalsProcessingInformation.constructFromObject(data['processingInformation']);
- }
- if (data.hasOwnProperty('orderInformation')) {
- obj['orderInformation'] = Ptsv2paymentsidreversalsOrderInformation.constructFromObject(data['orderInformation']);
- }
- if (data.hasOwnProperty('pointOfSaleInformation')) {
- obj['pointOfSaleInformation'] = Ptsv2paymentsidreversalsPointOfSaleInformation.constructFromObject(data['pointOfSaleInformation']);
- }
- }
- return obj;
- }
-
- /**
- * @member {module:model/Ptsv2paymentsClientReferenceInformation} clientReferenceInformation
- */
- exports.prototype['clientReferenceInformation'] = undefined;
- /**
- * @member {module:model/Ptsv2paymentsidreversalsReversalInformation} reversalInformation
- */
- exports.prototype['reversalInformation'] = undefined;
- /**
- * @member {module:model/Ptsv2paymentsidreversalsProcessingInformation} processingInformation
- */
- exports.prototype['processingInformation'] = undefined;
- /**
- * @member {module:model/Ptsv2paymentsidreversalsOrderInformation} orderInformation
- */
- exports.prototype['orderInformation'] = undefined;
- /**
- * @member {module:model/Ptsv2paymentsidreversalsPointOfSaleInformation} pointOfSaleInformation
- */
- exports.prototype['pointOfSaleInformation'] = undefined;
-
-
-
- return exports;
-}));
-
-
diff --git a/src/model/Model409Link.js b/src/model/Model409Link.js
new file mode 100644
index 00000000..9c6ee8cf
--- /dev/null
+++ b/src/model/Model409Link.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Model409Link = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Model409Link model module.
+ * @module model/Model409Link
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Model409Link.
+ * @alias module:model/Model409Link
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Model409Link from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Model409Link} obj Optional instance to populate.
+ * @return {module:model/Model409Link} The populated Model409Link instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Model409Links.js b/src/model/Model409Links.js
new file mode 100644
index 00000000..8520c7cf
--- /dev/null
+++ b/src/model/Model409Links.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Model409Links = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Model409Links model module.
+ * @module model/Model409Links
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Model409Links.
+ * @alias module:model/Model409Links
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Model409Links from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Model409Links} obj Optional instance to populate.
+ * @return {module:model/Model409Links} The populated Model409Links instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('paymentInstruments')) {
+ obj['paymentInstruments'] = TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.constructFromObject(data['paymentInstruments']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments} paymentInstruments
+ */
+ exports.prototype['paymentInstruments'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PIForIILinkFirst.js b/src/model/PIForIILinkFirst.js
new file mode 100644
index 00000000..b6cc7264
--- /dev/null
+++ b/src/model/PIForIILinkFirst.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PIForIILinkFirst = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PIForIILinkFirst model module.
+ * @module model/PIForIILinkFirst
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PIForIILinkFirst.
+ * @alias module:model/PIForIILinkFirst
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PIForIILinkFirst from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PIForIILinkFirst} obj Optional instance to populate.
+ * @return {module:model/PIForIILinkFirst} The populated PIForIILinkFirst instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * A link to the collection starting at offset zero for the supplied limit.
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PIForIILinkLast.js b/src/model/PIForIILinkLast.js
new file mode 100644
index 00000000..61c95b38
--- /dev/null
+++ b/src/model/PIForIILinkLast.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PIForIILinkLast = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PIForIILinkLast model module.
+ * @module model/PIForIILinkLast
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PIForIILinkLast.
+ * @alias module:model/PIForIILinkLast
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PIForIILinkLast from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PIForIILinkLast} obj Optional instance to populate.
+ * @return {module:model/PIForIILinkLast} The populated PIForIILinkLast instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * A link to the last collection containing the remaining objects.
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PIForIILinkNext.js b/src/model/PIForIILinkNext.js
new file mode 100644
index 00000000..b99a440a
--- /dev/null
+++ b/src/model/PIForIILinkNext.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PIForIILinkNext = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PIForIILinkNext model module.
+ * @module model/PIForIILinkNext
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PIForIILinkNext.
+ * @alias module:model/PIForIILinkNext
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PIForIILinkNext from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PIForIILinkNext} obj Optional instance to populate.
+ * @return {module:model/PIForIILinkNext} The populated PIForIILinkNext instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * A link to the next collection starting at the supplied offset plus the supplied limit.
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PIForIILinkPrev.js b/src/model/PIForIILinkPrev.js
new file mode 100644
index 00000000..686fe258
--- /dev/null
+++ b/src/model/PIForIILinkPrev.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PIForIILinkPrev = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PIForIILinkPrev model module.
+ * @module model/PIForIILinkPrev
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PIForIILinkPrev.
+ * A link to the previous collection starting at the supplied offset minus the supplied limit.
+ * @alias module:model/PIForIILinkPrev
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PIForIILinkPrev from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PIForIILinkPrev} obj Optional instance to populate.
+ * @return {module:model/PIForIILinkPrev} The populated PIForIILinkPrev instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PIForIILinkSelf.js b/src/model/PIForIILinkSelf.js
new file mode 100644
index 00000000..5bfe4afc
--- /dev/null
+++ b/src/model/PIForIILinkSelf.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PIForIILinkSelf = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PIForIILinkSelf model module.
+ * @module model/PIForIILinkSelf
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PIForIILinkSelf.
+ * @alias module:model/PIForIILinkSelf
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PIForIILinkSelf from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PIForIILinkSelf} obj Optional instance to populate.
+ * @return {module:model/PIForIILinkSelf} The populated PIForIILinkSelf instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * A link to the current requested collection.
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrument.js b/src/model/PaymentInstrument.js
new file mode 100644
index 00000000..19f4de5d
--- /dev/null
+++ b/src/model/PaymentInstrument.js
@@ -0,0 +1,201 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation', 'model/TmsV1InstrumentIdentifiersPost200ResponseLinks', 'model/TmsV1InstrumentIdentifiersPost200ResponseMetadata'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation'), require('./TmsV1InstrumentIdentifiersPost200ResponseLinks'), require('./TmsV1InstrumentIdentifiersPost200ResponseMetadata'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrument = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseLinks, root.CyberSource.TmsV1InstrumentIdentifiersPost200ResponseMetadata);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation, TmsV1InstrumentIdentifiersPost200ResponseLinks, TmsV1InstrumentIdentifiersPost200ResponseMetadata) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrument model module.
+ * @module model/PaymentInstrument
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrument.
+ * @alias module:model/PaymentInstrument
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a PaymentInstrument from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrument} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrument} The populated PaymentInstrument instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = TmsV1InstrumentIdentifiersPost200ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('object')) {
+ obj['object'] = ApiClient.convertToType(data['object'], 'String');
+ }
+ if (data.hasOwnProperty('state')) {
+ obj['state'] = ApiClient.convertToType(data['state'], 'String');
+ }
+ if (data.hasOwnProperty('bankAccount')) {
+ obj['bankAccount'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.constructFromObject(data['bankAccount']);
+ }
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('buyerInformation')) {
+ obj['buyerInformation'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.constructFromObject(data['buyerInformation']);
+ }
+ if (data.hasOwnProperty('billTo')) {
+ obj['billTo'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.constructFromObject(data['billTo']);
+ }
+ if (data.hasOwnProperty('processingInformation')) {
+ obj['processingInformation'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.constructFromObject(data['processingInformation']);
+ }
+ if (data.hasOwnProperty('merchantInformation')) {
+ obj['merchantInformation'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.constructFromObject(data['merchantInformation']);
+ }
+ if (data.hasOwnProperty('metaData')) {
+ obj['metaData'] = TmsV1InstrumentIdentifiersPost200ResponseMetadata.constructFromObject(data['metaData']);
+ }
+ if (data.hasOwnProperty('instrumentIdentifier')) {
+ obj['instrumentIdentifier'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.constructFromObject(data['instrumentIdentifier']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * Unique identification number assigned by CyberSource to the submitted request.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * Describes type of token.
+ * @member {module:model/PaymentInstrument.ObjectEnum} object
+ */
+ exports.prototype['object'] = undefined;
+ /**
+ * Current state of the token.
+ * @member {module:model/PaymentInstrument.StateEnum} state
+ */
+ exports.prototype['state'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount} bankAccount
+ */
+ exports.prototype['bankAccount'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation} buyerInformation
+ */
+ exports.prototype['buyerInformation'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo} billTo
+ */
+ exports.prototype['billTo'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation} processingInformation
+ */
+ exports.prototype['processingInformation'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation} merchantInformation
+ */
+ exports.prototype['merchantInformation'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPost200ResponseMetadata} metaData
+ */
+ exports.prototype['metaData'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier} instrumentIdentifier
+ */
+ exports.prototype['instrumentIdentifier'] = undefined;
+
+
+ /**
+ * Allowed values for the object property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.ObjectEnum = {
+ /**
+ * value: "paymentInstrument"
+ * @const
+ */
+ "paymentInstrument": "paymentInstrument" };
+
+ /**
+ * Allowed values for the state property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.StateEnum = {
+ /**
+ * value: "ACTIVE"
+ * @const
+ */
+ "ACTIVE": "ACTIVE",
+ /**
+ * value: "CLOSED"
+ * @const
+ */
+ "CLOSED": "CLOSED" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrumentBankAccount.js b/src/model/PaymentInstrumentBankAccount.js
new file mode 100644
index 00000000..bcbdc48c
--- /dev/null
+++ b/src/model/PaymentInstrumentBankAccount.js
@@ -0,0 +1,109 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrumentBankAccount = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrumentBankAccount model module.
+ * @module model/PaymentInstrumentBankAccount
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrumentBankAccount.
+ * @alias module:model/PaymentInstrumentBankAccount
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a PaymentInstrumentBankAccount from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrumentBankAccount} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrumentBankAccount} The populated PaymentInstrumentBankAccount instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Checking account type. Possible values: * C: checking * S: savings (USD only) * X: corporate checking (USD only) * G: general ledger
+ * @member {module:model/PaymentInstrumentBankAccount.TypeEnum} type
+ */
+ exports.prototype['type'] = undefined;
+
+
+ /**
+ * Allowed values for the type property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.TypeEnum = {
+ /**
+ * value: "checking"
+ * @const
+ */
+ "checking": "checking",
+ /**
+ * value: "savings"
+ * @const
+ */
+ "savings": "savings",
+ /**
+ * value: "corporate checking"
+ * @const
+ */
+ "corporate checking": "corporate checking",
+ /**
+ * value: "general ledger"
+ * @const
+ */
+ "general ledger": "general ledger" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrumentCard.js b/src/model/PaymentInstrumentCard.js
new file mode 100644
index 00000000..0925be24
--- /dev/null
+++ b/src/model/PaymentInstrumentCard.js
@@ -0,0 +1,429 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrumentCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrumentCard model module.
+ * @module model/PaymentInstrumentCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrumentCard.
+ * @alias module:model/PaymentInstrumentCard
+ * @class
+ * @param type {module:model/PaymentInstrumentCard.TypeEnum} Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063)
+ */
+ var exports = function(type) {
+ var _this = this;
+
+
+
+ _this['type'] = type;
+
+
+
+
+ };
+
+ /**
+ * Constructs a PaymentInstrumentCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrumentCard} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrumentCard} The populated PaymentInstrumentCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('expirationMonth')) {
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('expirationYear')) {
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('issueNumber')) {
+ obj['issueNumber'] = ApiClient.convertToType(data['issueNumber'], 'String');
+ }
+ if (data.hasOwnProperty('startMonth')) {
+ obj['startMonth'] = ApiClient.convertToType(data['startMonth'], 'String');
+ }
+ if (data.hasOwnProperty('startYear')) {
+ obj['startYear'] = ApiClient.convertToType(data['startYear'], 'String');
+ }
+ if (data.hasOwnProperty('useAs')) {
+ obj['useAs'] = ApiClient.convertToType(data['useAs'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Two-digit month in which the credit card expires. Format: `MM` Possible values: `01` through `12` This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * @member {String} expirationMonth
+ */
+ exports.prototype['expirationMonth'] = undefined;
+ /**
+ * Four-digit year in which the credit card expires. Format: `YYYY`. Possible values: `1900` through `2099`. **FDC Nashville Global and FDMS South** You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.'
+ * @member {String} expirationYear
+ */
+ exports.prototype['expirationYear'] = undefined;
+ /**
+ * Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063)
+ * @member {module:model/PaymentInstrumentCard.TypeEnum} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * Number of times a Maestro (UK Domestic) card has been issued to the account holder.
+ * @member {String} issueNumber
+ */
+ exports.prototype['issueNumber'] = undefined;
+ /**
+ * Month of the start of the Maestro (UK Domestic) card validity period. Format: `MM`. Possible values: `01` through `12`.
+ * @member {String} startMonth
+ */
+ exports.prototype['startMonth'] = undefined;
+ /**
+ * Year of the start of the Maestro (UK Domestic) card validity period. Format: `YYYY`. Possible values: `1900` through `2099`.
+ * @member {String} startYear
+ */
+ exports.prototype['startYear'] = undefined;
+ /**
+ * Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens.
+ * @member {String} useAs
+ */
+ exports.prototype['useAs'] = undefined;
+
+
+ /**
+ * Allowed values for the type property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.TypeEnum = {
+ /**
+ * value: "visa"
+ * @const
+ */
+ "visa": "visa",
+ /**
+ * value: "mastercard"
+ * @const
+ */
+ "mastercard": "mastercard",
+ /**
+ * value: "american express"
+ * @const
+ */
+ "american express": "american express",
+ /**
+ * value: "discover"
+ * @const
+ */
+ "discover": "discover",
+ /**
+ * value: "diners club"
+ * @const
+ */
+ "diners club": "diners club",
+ /**
+ * value: "carte blanche"
+ * @const
+ */
+ "carte blanche": "carte blanche",
+ /**
+ * value: "jcb"
+ * @const
+ */
+ "jcb": "jcb",
+ /**
+ * value: "optima"
+ * @const
+ */
+ "optima": "optima",
+ /**
+ * value: "twinpay credit"
+ * @const
+ */
+ "twinpay credit": "twinpay credit",
+ /**
+ * value: "twinpay debit"
+ * @const
+ */
+ "twinpay debit": "twinpay debit",
+ /**
+ * value: "walmart"
+ * @const
+ */
+ "walmart": "walmart",
+ /**
+ * value: "enroute"
+ * @const
+ */
+ "enroute": "enroute",
+ /**
+ * value: "lowes consumer"
+ * @const
+ */
+ "lowes consumer": "lowes consumer",
+ /**
+ * value: "home depot consumer"
+ * @const
+ */
+ "home depot consumer": "home depot consumer",
+ /**
+ * value: "mbna"
+ * @const
+ */
+ "mbna": "mbna",
+ /**
+ * value: "dicks sportswear"
+ * @const
+ */
+ "dicks sportswear": "dicks sportswear",
+ /**
+ * value: "casual corner"
+ * @const
+ */
+ "casual corner": "casual corner",
+ /**
+ * value: "sears"
+ * @const
+ */
+ "sears": "sears",
+ /**
+ * value: "jal"
+ * @const
+ */
+ "jal": "jal",
+ /**
+ * value: "disney"
+ * @const
+ */
+ "disney": "disney",
+ /**
+ * value: "maestro uk domestic"
+ * @const
+ */
+ "maestro uk domestic": "maestro uk domestic",
+ /**
+ * value: "sams club consumer"
+ * @const
+ */
+ "sams club consumer": "sams club consumer",
+ /**
+ * value: "sams club business"
+ * @const
+ */
+ "sams club business": "sams club business",
+ /**
+ * value: "nicos"
+ * @const
+ */
+ "nicos": "nicos",
+ /**
+ * value: "bill me later"
+ * @const
+ */
+ "bill me later": "bill me later",
+ /**
+ * value: "bebe"
+ * @const
+ */
+ "bebe": "bebe",
+ /**
+ * value: "restoration hardware"
+ * @const
+ */
+ "restoration hardware": "restoration hardware",
+ /**
+ * value: "delta online"
+ * @const
+ */
+ "delta online": "delta online",
+ /**
+ * value: "solo"
+ * @const
+ */
+ "solo": "solo",
+ /**
+ * value: "visa electron"
+ * @const
+ */
+ "visa electron": "visa electron",
+ /**
+ * value: "dankort"
+ * @const
+ */
+ "dankort": "dankort",
+ /**
+ * value: "laser"
+ * @const
+ */
+ "laser": "laser",
+ /**
+ * value: "carte bleue"
+ * @const
+ */
+ "carte bleue": "carte bleue",
+ /**
+ * value: "carta si"
+ * @const
+ */
+ "carta si": "carta si",
+ /**
+ * value: "pinless debit"
+ * @const
+ */
+ "pinless debit": "pinless debit",
+ /**
+ * value: "encoded account"
+ * @const
+ */
+ "encoded account": "encoded account",
+ /**
+ * value: "uatp"
+ * @const
+ */
+ "uatp": "uatp",
+ /**
+ * value: "household"
+ * @const
+ */
+ "household": "household",
+ /**
+ * value: "maestro international"
+ * @const
+ */
+ "maestro international": "maestro international",
+ /**
+ * value: "ge money uk"
+ * @const
+ */
+ "ge money uk": "ge money uk",
+ /**
+ * value: "korean cards"
+ * @const
+ */
+ "korean cards": "korean cards",
+ /**
+ * value: "style"
+ * @const
+ */
+ "style": "style",
+ /**
+ * value: "jcrew"
+ * @const
+ */
+ "jcrew": "jcrew",
+ /**
+ * value: "payease china processing ewallet"
+ * @const
+ */
+ "payease china processing ewallet": "payease china processing ewallet",
+ /**
+ * value: "payease china processing bank transfer"
+ * @const
+ */
+ "payease china processing bank transfer": "payease china processing bank transfer",
+ /**
+ * value: "meijer private label"
+ * @const
+ */
+ "meijer private label": "meijer private label",
+ /**
+ * value: "hipercard"
+ * @const
+ */
+ "hipercard": "hipercard",
+ /**
+ * value: "aura"
+ * @const
+ */
+ "aura": "aura",
+ /**
+ * value: "redecard"
+ * @const
+ */
+ "redecard": "redecard",
+ /**
+ * value: "orico"
+ * @const
+ */
+ "orico": "orico",
+ /**
+ * value: "elo"
+ * @const
+ */
+ "elo": "elo",
+ /**
+ * value: "capital one private label"
+ * @const
+ */
+ "capital one private label": "capital one private label",
+ /**
+ * value: "synchrony private label"
+ * @const
+ */
+ "synchrony private label": "synchrony private label",
+ /**
+ * value: "china union pay"
+ * @const
+ */
+ "china union pay": "china union pay",
+ /**
+ * value: "costco private label"
+ * @const
+ */
+ "costco private label": "costco private label",
+ /**
+ * value: "mada"
+ * @const
+ */
+ "mada": "mada",
+ /**
+ * value: "falabella private label"
+ * @const
+ */
+ "falabella private label": "falabella private label" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrumentForInstrumentIdentifierLinks.js b/src/model/PaymentInstrumentForInstrumentIdentifierLinks.js
new file mode 100644
index 00000000..5c6d5802
--- /dev/null
+++ b/src/model/PaymentInstrumentForInstrumentIdentifierLinks.js
@@ -0,0 +1,113 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrumentForInstrumentIdentifierLinks = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrumentForInstrumentIdentifierLinks model module.
+ * @module model/PaymentInstrumentForInstrumentIdentifierLinks
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrumentForInstrumentIdentifierLinks.
+ * @alias module:model/PaymentInstrumentForInstrumentIdentifierLinks
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a PaymentInstrumentForInstrumentIdentifierLinks from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrumentForInstrumentIdentifierLinks} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrumentForInstrumentIdentifierLinks} The populated PaymentInstrumentForInstrumentIdentifierLinks instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('self')) {
+ obj['self'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.constructFromObject(data['self']);
+ }
+ if (data.hasOwnProperty('first')) {
+ obj['first'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.constructFromObject(data['first']);
+ }
+ if (data.hasOwnProperty('prev')) {
+ obj['prev'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.constructFromObject(data['prev']);
+ }
+ if (data.hasOwnProperty('next')) {
+ obj['next'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.constructFromObject(data['next']);
+ }
+ if (data.hasOwnProperty('last')) {
+ obj['last'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.constructFromObject(data['last']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf} self
+ */
+ exports.prototype['self'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst} first
+ */
+ exports.prototype['first'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev} prev
+ */
+ exports.prototype['prev'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext} next
+ */
+ exports.prototype['next'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast} last
+ */
+ exports.prototype['last'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrumentsArray.js b/src/model/PaymentInstrumentsArray.js
new file mode 100644
index 00000000..b328ec21
--- /dev/null
+++ b/src/model/PaymentInstrumentsArray.js
@@ -0,0 +1,79 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrumentsArray = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrumentsArray model module.
+ * @module model/PaymentInstrumentsArray
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrumentsArray.
+ * Array of Payment Instruments returned for the supplied Instrument Identifier.
+ * @alias module:model/PaymentInstrumentsArray
+ * @class
+ * @extends Array
+ */
+ var exports = function() {
+ var _this = this;
+ _this = new Array();
+ Object.setPrototypeOf(_this, exports);
+
+ return _this;
+ };
+
+ /**
+ * Constructs a PaymentInstrumentsArray from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrumentsArray} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrumentsArray} The populated PaymentInstrumentsArray instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+ ApiClient.constructFromObject(data, obj, 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments');
+
+ }
+ return obj;
+ }
+
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PaymentInstrumentsForInstrumentIdentifier.js b/src/model/PaymentInstrumentsForInstrumentIdentifier.js
new file mode 100644
index 00000000..e25170cf
--- /dev/null
+++ b/src/model/PaymentInstrumentsForInstrumentIdentifier.js
@@ -0,0 +1,146 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PaymentInstrumentsForInstrumentIdentifier = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PaymentInstrumentsForInstrumentIdentifier model module.
+ * @module model/PaymentInstrumentsForInstrumentIdentifier
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PaymentInstrumentsForInstrumentIdentifier.
+ * @alias module:model/PaymentInstrumentsForInstrumentIdentifier
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a PaymentInstrumentsForInstrumentIdentifier from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PaymentInstrumentsForInstrumentIdentifier} obj Optional instance to populate.
+ * @return {module:model/PaymentInstrumentsForInstrumentIdentifier} The populated PaymentInstrumentsForInstrumentIdentifier instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('object')) {
+ obj['object'] = ApiClient.convertToType(data['object'], 'String');
+ }
+ if (data.hasOwnProperty('offset')) {
+ obj['offset'] = ApiClient.convertToType(data['offset'], 'String');
+ }
+ if (data.hasOwnProperty('limit')) {
+ obj['limit'] = ApiClient.convertToType(data['limit'], 'String');
+ }
+ if (data.hasOwnProperty('count')) {
+ obj['count'] = ApiClient.convertToType(data['count'], 'String');
+ }
+ if (data.hasOwnProperty('total')) {
+ obj['total'] = ApiClient.convertToType(data['total'], 'String');
+ }
+ if (data.hasOwnProperty('_embedded')) {
+ obj['_embedded'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.constructFromObject(data['_embedded']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * Shows the response is a collection of objects.
+ * @member {module:model/PaymentInstrumentsForInstrumentIdentifier.ObjectEnum} object
+ */
+ exports.prototype['object'] = undefined;
+ /**
+ * The offset parameter supplied in the request.
+ * @member {String} offset
+ */
+ exports.prototype['offset'] = undefined;
+ /**
+ * The limit parameter supplied in the request.
+ * @member {String} limit
+ */
+ exports.prototype['limit'] = undefined;
+ /**
+ * The number of Payment Instruments returned in the array.
+ * @member {String} count
+ */
+ exports.prototype['count'] = undefined;
+ /**
+ * The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset.
+ * @member {String} total
+ */
+ exports.prototype['total'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded} _embedded
+ */
+ exports.prototype['_embedded'] = undefined;
+
+
+ /**
+ * Allowed values for the object property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.ObjectEnum = {
+ /**
+ * value: "collection"
+ * @const
+ */
+ "collection": "collection" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PersonalIdentification.js b/src/model/PersonalIdentification.js
new file mode 100644
index 00000000..d02f896f
--- /dev/null
+++ b/src/model/PersonalIdentification.js
@@ -0,0 +1,111 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PersonalIdentification = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PersonalIdentification model module.
+ * @module model/PersonalIdentification
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PersonalIdentification.
+ * @alias module:model/PersonalIdentification
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a PersonalIdentification from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PersonalIdentification} obj Optional instance to populate.
+ * @return {module:model/PersonalIdentification} The populated PersonalIdentification instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('issuedBy')) {
+ obj['issuedBy'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.constructFromObject(data['issuedBy']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Customer's identification number. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * Type of personal identification. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional.
+ * @member {module:model/PersonalIdentification.TypeEnum} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy} issuedBy
+ */
+ exports.prototype['issuedBy'] = undefined;
+
+
+ /**
+ * Allowed values for the type property.
+ * @enum {String}
+ * @readonly
+ */
+ exports.TypeEnum = {
+ /**
+ * value: "driver license"
+ * @const
+ */
+ "license": "driver license" };
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PersonalIdentificationArray.js b/src/model/PersonalIdentificationArray.js
new file mode 100644
index 00000000..7d5eff9f
--- /dev/null
+++ b/src/model/PersonalIdentificationArray.js
@@ -0,0 +1,78 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.PersonalIdentificationArray = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification) {
+ 'use strict';
+
+
+
+
+ /**
+ * The PersonalIdentificationArray model module.
+ * @module model/PersonalIdentificationArray
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new PersonalIdentificationArray.
+ * @alias module:model/PersonalIdentificationArray
+ * @class
+ * @extends Array
+ */
+ var exports = function() {
+ var _this = this;
+ _this = new Array();
+ Object.setPrototypeOf(_this, exports);
+
+ return _this;
+ };
+
+ /**
+ * Constructs a PersonalIdentificationArray from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/PersonalIdentificationArray} obj Optional instance to populate.
+ * @return {module:model/PersonalIdentificationArray} The populated PersonalIdentificationArray instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+ ApiClient.constructFromObject(data, obj, 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification');
+
+ }
+ return obj;
+ }
+
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/ProcessingInformation.js b/src/model/ProcessingInformation.js
new file mode 100644
index 00000000..3f966524
--- /dev/null
+++ b/src/model/ProcessingInformation.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ProcessingInformation = factory(root.CyberSource.ApiClient, root.CyberSource.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions);
+ }
+}(this, function(ApiClient, TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ProcessingInformation model module.
+ * @module model/ProcessingInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ProcessingInformation.
+ * @alias module:model/ProcessingInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a ProcessingInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ProcessingInformation} obj Optional instance to populate.
+ * @return {module:model/ProcessingInformation} The populated ProcessingInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('billPaymentProgramEnabled')) {
+ obj['billPaymentProgramEnabled'] = ApiClient.convertToType(data['billPaymentProgramEnabled'], 'Boolean');
+ }
+ if (data.hasOwnProperty('bankTransferOptions')) {
+ obj['bankTransferOptions'] = TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.constructFromObject(data['bankTransferOptions']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Indicates that the payments for this customer profile are for the Bill Payment program. Possible values: * false: Not a Visa Bill Payment. * true: Visa Bill Payment.
+ * @member {Boolean} billPaymentProgramEnabled
+ * @default false
+ */
+ exports.prototype['billPaymentProgramEnabled'] = false;
+ /**
+ * @member {module:model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions} bankTransferOptions
+ */
+ exports.prototype['bankTransferOptions'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js b/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js
index 43a99472..33063181 100644
--- a/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js
+++ b/src/model/PtsV2CreditsPost201ResponseCreditAmountDetails.js
@@ -78,7 +78,7 @@
*/
exports.prototype['creditAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js b/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js
index 38214b47..988f3a51 100644
--- a/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js
+++ b/src/model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.js
@@ -69,7 +69,7 @@
}
/**
- * Method used for settlement. Possible values: - **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars) - **F**: Facsimile draft (U.S. dollars only) - **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) See \"Settlement Delivery Methods,\" page 44.
+ * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} settlementMethod
*/
exports.prototype['settlementMethod'] = undefined;
diff --git a/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js
index e4a301f0..e35e70fe 100644
--- a/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js
+++ b/src/model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.js
@@ -78,7 +78,7 @@
*/
exports.prototype['totalAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseClientReferenceInformation.js b/src/model/PtsV2PaymentsPost201ResponseClientReferenceInformation.js
index ba469ebb..9e888d89 100644
--- a/src/model/PtsV2PaymentsPost201ResponseClientReferenceInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponseClientReferenceInformation.js
@@ -77,7 +77,7 @@
}
/**
- * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
+ * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
* @member {String} code
*/
exports.prototype['code'] = undefined;
@@ -87,7 +87,7 @@
*/
exports.prototype['submitLocalDateTime'] = undefined;
/**
- * Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. See the subscription sharing information in Recurring Billing Using the Simple Order API. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. See the profile sharing information in Payment Tokenization Using the Simple Order API.
+ * Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. For details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} ownerMerchantId
*/
exports.prototype['ownerMerchantId'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseErrorInformation.js b/src/model/PtsV2PaymentsPost201ResponseErrorInformation.js
index 035929bb..a667509b 100644
--- a/src/model/PtsV2PaymentsPost201ResponseErrorInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponseErrorInformation.js
@@ -77,7 +77,7 @@
}
/**
- * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD
+ * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD - PENDING_AUTHENTICATION
* @member {module:model/PtsV2PaymentsPost201ResponseErrorInformation.ReasonEnum} reason
*/
exports.prototype['reason'] = undefined;
@@ -108,11 +108,6 @@
* @const
*/
"CONTACT_PROCESSOR": "CONTACT_PROCESSOR",
- /**
- * value: "CV_FAILED"
- * @const
- */
- "CV_FAILED": "CV_FAILED",
/**
* value: "EXPIRED_CARD"
* @const
@@ -158,11 +153,31 @@
* @const
*/
"INVALID_CVN": "INVALID_CVN",
+ /**
+ * value: "DECLINED_CHECK"
+ * @const
+ */
+ "DECLINED_CHECK": "DECLINED_CHECK",
+ /**
+ * value: "BLACKLISTED_CUSTOMER"
+ * @const
+ */
+ "BLACKLISTED_CUSTOMER": "BLACKLISTED_CUSTOMER",
+ /**
+ * value: "SUSPENDED_ACCOUNT"
+ * @const
+ */
+ "SUSPENDED_ACCOUNT": "SUSPENDED_ACCOUNT",
/**
* value: "PAYMENT_REFUSED"
* @const
*/
"PAYMENT_REFUSED": "PAYMENT_REFUSED",
+ /**
+ * value: "CV_FAILED"
+ * @const
+ */
+ "CV_FAILED": "CV_FAILED",
/**
* value: "INVALID_ACCOUNT"
* @const
@@ -173,6 +188,11 @@
* @const
*/
"GENERAL_DECLINE": "GENERAL_DECLINE",
+ /**
+ * value: "INVALID_MERCHANT_CONFIGURATION"
+ * @const
+ */
+ "INVALID_MERCHANT_CONFIGURATION": "INVALID_MERCHANT_CONFIGURATION",
/**
* value: "DECISION_PROFILE_REJECT"
* @const
@@ -182,7 +202,12 @@
* value: "SCORE_EXCEEDS_THRESHOLD"
* @const
*/
- "SCORE_EXCEEDS_THRESHOLD": "SCORE_EXCEEDS_THRESHOLD" };
+ "SCORE_EXCEEDS_THRESHOLD": "SCORE_EXCEEDS_THRESHOLD",
+ /**
+ * value: "PENDING_AUTHENTICATION"
+ * @const
+ */
+ "PENDING_AUTHENTICATION": "PENDING_AUTHENTICATION" };
return exports;
diff --git a/src/model/PtsV2PaymentsPost201ResponseInstallmentInformation.js b/src/model/PtsV2PaymentsPost201ResponseInstallmentInformation.js
index f4a0d72b..06676128 100644
--- a/src/model/PtsV2PaymentsPost201ResponseInstallmentInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponseInstallmentInformation.js
@@ -125,77 +125,77 @@
}
/**
- * Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs
+ * Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs
* @member {String} additionalCosts
*/
exports.prototype['additionalCosts'] = undefined;
/**
- * Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs
+ * Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs
* @member {String} additionalCostsPercentage
*/
exports.prototype['additionalCostsPercentage'] = undefined;
/**
- * Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded
+ * Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded
* @member {String} amountFunded
*/
exports.prototype['amountFunded'] = undefined;
/**
- * Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested
+ * Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested
* @member {String} amountRequestedPercentage
*/
exports.prototype['amountRequestedPercentage'] = undefined;
/**
- * Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing
+ * Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing
* @member {String} annualFinancingCost
*/
exports.prototype['annualFinancingCost'] = undefined;
/**
- * Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate
+ * Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate
* @member {String} annualInterestRate
*/
exports.prototype['annualInterestRate'] = undefined;
/**
- * Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses
+ * Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses
* @member {String} expenses
*/
exports.prototype['expenses'] = undefined;
/**
- * Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses
+ * Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses
* @member {String} expensesPercentage
*/
exports.prototype['expensesPercentage'] = undefined;
/**
- * Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees
+ * Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees
* @member {String} fees
*/
exports.prototype['fees'] = undefined;
/**
- * Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees
+ * Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees
* @member {String} feesPercentage
*/
exports.prototype['feesPercentage'] = undefined;
/**
- * Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance
+ * Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance
* @member {String} insurance
*/
exports.prototype['insurance'] = undefined;
/**
- * Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance
+ * Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance
* @member {String} insurancePercentage
*/
exports.prototype['insurancePercentage'] = undefined;
/**
- * Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate
+ * Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate
* @member {String} monthlyInterestRate
*/
exports.prototype['monthlyInterestRate'] = undefined;
/**
- * Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes
+ * Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes
* @member {String} taxes
*/
exports.prototype['taxes'] = undefined;
/**
- * Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource through VisaNet. This field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes
+ * Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes
* @member {String} taxesPercentage
*/
exports.prototype['taxesPercentage'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseIssuerInformation.js b/src/model/PtsV2PaymentsPost201ResponseIssuerInformation.js
index 7f1192ed..1d734c90 100644
--- a/src/model/PtsV2PaymentsPost201ResponseIssuerInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponseIssuerInformation.js
@@ -77,12 +77,12 @@
}
/**
- * Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character ISO Standard Country Codes. This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions.
+ * Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character ISO Standard Country Codes. This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. For details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} country
*/
exports.prototype['country'] = undefined;
/**
- * Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.
+ * Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} discretionaryData
*/
exports.prototype['discretionaryData'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js
index 2de3f054..4eab4ce9 100644
--- a/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js
+++ b/src/model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.js
@@ -87,7 +87,7 @@
*/
exports.prototype['authorizedAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.js b/src/model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.js
index 771f40b5..bc7d1573 100644
--- a/src/model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.js
+++ b/src/model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.js
@@ -69,7 +69,7 @@
}
/**
- * Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. For processor-specific information, see the bill_purchasing_level3_enabled field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false**
+ * Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. For processor-specific information, see the `bill_purchasing_level3_enabled` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false**
* @member {Boolean} level3TransmissionStatus
*/
exports.prototype['level3TransmissionStatus'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.js
index 196ee8ae..41daa9b9 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.js
@@ -133,12 +133,12 @@
}
/**
- * Type of account. This value is returned only if you requested a balance inquiry. Possible values: - **00**: Not applicable or not specified - **10**: Savings account - **20**: Checking account - **30**: Credit card account - **40**: Universal account
+ * Type of account. This value is returned only if you requested a balance inquiry. Possible values: - `00`: Not applicable or not specified - `10`: Savings account - `20`: Checking account - `30`: Credit card account - `40`: Universal account
* @member {String} accountType
*/
exports.prototype['accountType'] = undefined;
/**
- * Possible values: - **N**: Nonregulated - **R**: Regulated `Note` This field is returned only for CyberSource through VisaNet.
+ * Possible values: - `N`: Nonregulated - `R`: Regulated **Note** This field is returned only for CyberSource through VisaNet.
* @member {String} accountStatus
*/
exports.prototype['accountStatus'] = undefined;
@@ -148,12 +148,12 @@
*/
exports.prototype['balanceAmount'] = undefined;
/**
- * Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value that is returned. Possible values for deposit accounts: - **01**: Current ledger (posted) balance. - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account. Possible values for credit card accounts: - **01**: Credit amount remaining for customer (open to buy). - **02**: Credit limit.
+ * Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value that is returned. Possible values for deposit accounts: - `01`: Current ledger (posted) balance. - `02`: Current available balance, which is typically the ledger balance less outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account. Possible values for credit card accounts: - `01`: Credit amount remaining for customer (open to buy). - `02`: Credit limit.
* @member {String} balanceAmountType
*/
exports.prototype['balanceAmountType'] = undefined;
/**
- * Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.
+ * Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details, see `auth_account_balance_currency` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
@@ -168,12 +168,12 @@
*/
exports.prototype['affluenceIndicator'] = undefined;
/**
- * **CyberSource through VisaNet** Visa product ID. **GPN** Visa or Mastercard product ID. **Litle** Type of card used in the transaction. The only possible value is: - PREPAID: Prepaid Card **RBS WorldPay Atlanta** Type of card used in the transaction. Possible values: - **B**: Business Card - **O**: Noncommercial Card - **R**: Corporate Card - **S**: Purchase Card - **Blank**: Purchase card not supported **Maximum length for processors**: - CyberSource through VisaNet: 3 - GPN: 3 - Litle: 7 - RBS WorldPay Atlanta: 1
+ * #### CyberSource through VisaNet Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### GPN Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, seepag the Product ID table on the Visa Request & Response Codes web page at https://developer.visa.com/guides/request_response_codes. For descriptions of the Mastercard product IDs, see \"Product IDs\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Data Length: String (3) #### Worldpay VAP **Important** Before using this field on Worldpay VAP, you must contact CyberSource Customer Support to have your account configured for this feature. Type of card used in the transaction. The only possible value is: - `PREPAID`: Prepaid Card Data Length: String (7) #### RBS WorldPay Atlanta Type of card used in the transaction. Possible values: - `B`: Business Card - `O`: Noncommercial Card - `R`: Corporate Card - `S`: Purchase Card - `Blank`: Purchase card not supported Data Length: String (1)
* @member {String} category
*/
exports.prototype['category'] = undefined;
/**
- * Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown For details, see `auth_card_commercial` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} commercial
*/
exports.prototype['commercial'] = undefined;
@@ -183,37 +183,37 @@
*/
exports.prototype['group'] = undefined;
/**
- * Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_healthcare` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} healthCare
*/
exports.prototype['healthCare'] = undefined;
/**
- * Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB on **Chase Paymentech Solutions**. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_payroll` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} payroll
*/
exports.prototype['payroll'] = undefined;
/**
- * Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_level_3_eligible` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} level3Eligible
*/
exports.prototype['level3Eligible'] = undefined;
/**
- * Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_pinless_debit` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} pinlessDebit
*/
exports.prototype['pinlessDebit'] = undefined;
/**
- * Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_signature_debit` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} signatureDebit
*/
exports.prototype['signatureDebit'] = undefined;
/**
- * Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown
+ * Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see the `auth_card_prepaid` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} prepaid
*/
exports.prototype['prepaid'] = undefined;
/**
- * Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - **Y**: Yes (assets greater than 10B USD) - **N**: No (assets less than 10B USD) - **X**: Not applicable / Unknown
+ * Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown For details, see `auth_card_regulated` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} regulated
*/
exports.prototype['regulated'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js
index 9ba42399..5b619e39 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.js
@@ -69,7 +69,7 @@
}
/**
- * Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.
+ * Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} correctedAccountNumber
*/
exports.prototype['correctedAccountNumber'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationCard.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationCard.js
index fb44fb3c..95dcfdf0 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationCard.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationCard.js
@@ -69,7 +69,7 @@
}
/**
- * Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.
+ * Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. **Note** This field is returned only for CyberSource through VisaNet and FDC Nashville Global. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 85 - Field: American Express last 4 PAN return indicator.
* @member {String} suffix
*/
exports.prototype['suffix'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.js b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.js
index 6b807765..d7959dea 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.js
@@ -93,37 +93,37 @@
}
/**
- * First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.
+ * First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} prefix
*/
exports.prototype['prefix'] = undefined;
/**
- * Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.
+ * Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} suffix
*/
exports.prototype['suffix'] = undefined;
/**
- * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International)
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} type
*/
exports.prototype['type'] = undefined;
/**
- * Confidence level of the tokenization. This value is assigned by the token service provider. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
+ * Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
* @member {String} assuranceLevel
*/
exports.prototype['assuranceLevel'] = undefined;
/**
- * Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationMonth
*/
exports.prototype['expirationMonth'] = undefined;
/**
- * Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationYear
*/
exports.prototype['expirationYear'] = undefined;
/**
- * Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
+ * Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
* @member {String} requestorId
*/
exports.prototype['requestorId'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.js b/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.js
index e1083704..0f26b20d 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.js
@@ -77,7 +77,7 @@
*/
exports.prototype['emv'] = undefined;
/**
- * Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value.
+ * Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} amexCapnData
*/
exports.prototype['amexCapnData'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.js b/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.js
index d411cd1c..fdf84456 100644
--- a/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.js
+++ b/src/model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.js
@@ -69,7 +69,7 @@
}
/**
- * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. See \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
+ * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
* @member {String} tags
*/
exports.prototype['tags'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js b/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js
index ded3109a..740543b0 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.js
@@ -73,12 +73,12 @@
}
/**
- * Method used for settlement. Possible values: - **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars) - **F**: Facsimile draft (U.S. dollars only) - **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) See \"Settlement Delivery Methods,\" page 44.
+ * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} settlementMethod
*/
exports.prototype['settlementMethod'] = undefined;
/**
- * Level of fraud screening. Possible values: - **1**: Validation — default if the field has not already been configured for your merchant ID - **2**: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.
+ * Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
* @member {String} fraudScreeningLevel
*/
exports.prototype['fraudScreeningLevel'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js
index b809ba5f..b76e80aa 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js
@@ -187,7 +187,7 @@
*/
exports.prototype['approvalCode'] = undefined;
/**
- * Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value.
+ * Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} transactionId
*/
exports.prototype['transactionId'] = undefined;
@@ -202,7 +202,7 @@
*/
exports.prototype['providerTransactionId'] = undefined;
/**
- * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization.
+ * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.
* @member {String} responseCode
*/
exports.prototype['responseCode'] = undefined;
@@ -217,7 +217,7 @@
*/
exports.prototype['responseDetails'] = undefined;
/**
- * Processor-defined response category code. The associated detail error code is in the auth_auth_response field or the auth_reversal_auth_ response field depending on which service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3
+ * Processor-defined response category code. The associated detail error code is in the `responseCode` field of the service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3
* @member {String} responseCategoryCode
*/
exports.prototype['responseCategoryCode'] = undefined;
@@ -255,17 +255,17 @@
*/
exports.prototype['consumerAuthenticationResponse'] = undefined;
/**
- * This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt.
+ * This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} systemTraceAuditNumber
*/
exports.prototype['systemTraceAuditNumber'] = undefined;
/**
- * Visa-generated reference number that identifies a card-present transaction for which youprovided one of the following: - Visa primary account number (PAN) - Visa-generated token for a PAN This reference number serves as a link to the cardholder account and to all transactions for that account.
+ * Visa-generated reference number that identifies a card-present transaction for which you provided one of the following: - Visa primary account number (PAN) - Visa-generated token for a PAN This reference number serves as a link to the cardholder account and to all transactions for that account.
* @member {String} paymentAccountReferenceNumber
*/
exports.prototype['paymentAccountReferenceNumber'] = undefined;
/**
- * Transaction integrity classification provided by Mastercard. This value specifies Mastercard’s evaluation of the transaction’s safety and security. This field is returned only for **CyberSource through VisaNet**. For card-present transactions, possible values: - **A1**: EMV or token in a secure, trusted environment - **B1**: EMV or chip equivalent - **C1**: Magnetic stripe - **E1**: Key entered - **U0**: Unclassified For card-not-present transactions, possible values: - **A2**: Digital transactions - **B2**: Authenticated checkout - **C2**: Transaction validation - **D2**: Enhanced data - **E2**: Generic messaging - **U0**: Unclassified For information about these values, contact Mastercard or your acquirer.
+ * Transaction integrity classification provided by Mastercard. This value specifies Mastercard’s evaluation of the transaction’s safety and security. This field is returned only for **CyberSource through VisaNet**. For card-present transactions, possible values: - `A1`: EMV or token in a secure, trusted environment - `B1`: EMV or chip equivalent - `C1`: Magnetic stripe - `E1`: Key entered - `U0`: Unclassified For card-not-present transactions, possible values: - `A2`: Digital transactions - `B2`: Authenticated checkout - `C2`: Transaction validation - `D2`: Enhanced data - `E2`: Generic messaging - `U0`: Unclassified For information about these values, contact Mastercard or your acquirer. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file,1: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification 1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.
* @member {String} transactionIntegrityCode
*/
exports.prototype['transactionIntegrityCode'] = undefined;
@@ -280,17 +280,17 @@
*/
exports.prototype['salesSlipNumber'] = undefined;
/**
- * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service
+ * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet.
* @member {String} masterCardServiceCode
*/
exports.prototype['masterCardServiceCode'] = undefined;
/**
- * Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - **C**: Service completed successfully. - **F**: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - **I**: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - **T**: Invalid combination of token requestor ID and token. - **U**: Expired token. - **W**: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**.
+ * Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - `C`: Service completed successfully. - `F`: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - `I`: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - `T`: Invalid combination of token requestor ID and token. - `U`: Expired token. - `W`: Primary account number (PAN) listed in electronic warning bulletin. **Note** This field is returned only for **CyberSource through VisaNet**.
* @member {String} masterCardServiceReplyCode
*/
exports.prototype['masterCardServiceReplyCode'] = undefined;
/**
- * Type of authentication for which the transaction qualifies as determined by the Mastercard authentication service, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource. Possible values: - **1**: Transaction qualifies for Mastercard authentication type 1. - **2**: Transaction qualifies for Mastercard authentication type 2.
+ * Type of authentication for which the transaction qualifies as determined by the Mastercard authentication service, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource. Possible values: - `1`: Transaction qualifies for Mastercard authentication type 1. - `2`: Transaction qualifies for Mastercard authentication type 2. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for CyberSource through VisaNet.
* @member {String} masterCardAuthenticationType
*/
exports.prototype['masterCardAuthenticationType'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js
index 29bc32d3..49b2cc73 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.js
@@ -73,12 +73,12 @@
}
/**
- * Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible values, see Appendix H, \"Verification Codes,\" on page 91.
+ * Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
* @member {String} resultCode
*/
exports.prototype['resultCode'] = undefined;
/**
- * Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible values, see Appendix H, \"Verification Codes,\" on page 91.
+ * Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
* @member {String} resultCodeRaw
*/
exports.prototype['resultCodeRaw'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js
index 07ea7510..d3b77788 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.js
@@ -73,12 +73,12 @@
}
/**
- * Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code.
+ * CVN result code. For details, see the `auth_cv_result` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For a description of the card verification check, see \"Card Verification Numbers (CVNs)\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For a list of possible values, see \"CVN Codes\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} resultCode
*/
exports.prototype['resultCode'] = undefined;
/**
- * CVN result code sent directly from the processor. Returned only when the processor returns this value. `Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only.
+ * CVN result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only.
* @member {String} resultCodeRaw
*/
exports.prototype['resultCodeRaw'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.js
index 9a7f03ff..9ce5db33 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.js
@@ -73,12 +73,12 @@
}
/**
- * Mapped response code for Verified by Visa and American Express SafeKey:
+ * Mapped response code for Visa Secure and American Express SafeKey. For processor-specific details, see `auth_cavv_response_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} code
*/
exports.prototype['code'] = undefined;
/**
- * Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey:
+ * Raw response code sent directly from the processor for Visa Secure and American Express SafeKey: For processor-specific details, see `auth_cavv_response_code_raw` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} codeRaw
*/
exports.prototype['codeRaw'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.js
index fafc65e6..0f93d9ff 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.js
@@ -69,7 +69,7 @@
}
/**
- * Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin American Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this value indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record on file. Returned only when the personal ID result is returned by the processor. Possible values: - **Y**: Match - **N**: No match - **K**: Not supported - **U**: Unknown - **Z**: No response returned
+ * Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin American Processing. If you included `buyerInformation.personalIdentification[].ID` in the request, this value indicates whether or not `buyerInformation.personalIdentification[].ID` matched a value in a record on file. Returned only when the personal ID result is returned by the processor. Possible values: - **Y**: Match - **N**: No match - **K**: Not supported - **U**: Unknown - **Z**: No response returned **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America.The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.
* @member {String} personalIdResult
*/
exports.prototype['personalIdResult'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js
index 5b4f0707..c257c31c 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.js
@@ -113,7 +113,7 @@
}
/**
- * Mapped Electronic Verification response code for the customer’s name.
+ * Mapped Electronic Verification response code for the customer’s name. For details, see `auth_ev_name` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} code
*/
exports.prototype['code'] = undefined;
@@ -123,7 +123,7 @@
*/
exports.prototype['codeRaw'] = undefined;
/**
- * Mapped Electronic Verification response code for the customer’s email address.
+ * Mapped Electronic Verification response code for the customer’s email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} email
*/
exports.prototype['email'] = undefined;
@@ -133,7 +133,7 @@
*/
exports.prototype['emailRaw'] = undefined;
/**
- * Mapped Electronic Verification response code for the customer’s phone number.
+ * Mapped Electronic Verification response code for the customer’s phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} phoneNumber
*/
exports.prototype['phoneNumber'] = undefined;
@@ -143,7 +143,7 @@
*/
exports.prototype['phoneNumberRaw'] = undefined;
/**
- * Mapped Electronic Verification response code for the customer’s postal code.
+ * Mapped Electronic Verification response code for the customer’s postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} postalCode
*/
exports.prototype['postalCode'] = undefined;
@@ -153,7 +153,7 @@
*/
exports.prototype['postalCodeRaw'] = undefined;
/**
- * Mapped Electronic Verification response code for the customer’s street address.
+ * Mapped Electronic Verification response code for the customer’s street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} street
*/
exports.prototype['street'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.js
index 86eaf9f2..2a3c929f 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.js
@@ -73,12 +73,12 @@
}
/**
- * Reason the recurring payment transaction was declined. For some processors, this field is used only for Mastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this field is not implemented. Possible values: - **00**: Response not provided. - **01**: New account information is available. Obtain the new information. - **02**: Try again later. - **03**: Do not try again. Obtain another type of payment from the customer. - **04**: Problem with a token or a partial shipment indicator. - **21**: Recurring payment cancellation service. - **99**: An unknown value was returned from the processor.
+ * Reason the recurring payment transaction was declined. For some processors, this field is used only for Mastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this field is not implemented. Possible values: - `00`: Response not provided. - `01`: New account information is available. Obtain the new information. - `02`: Try again later. - `03`: Do not try again. Obtain another type of payment from the customer. - `04`: Problem with a token or a partial shipment indicator. - `21`: Recurring payment cancellation service. - `99`: An unknown value was returned from the processor. For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} code
*/
exports.prototype['code'] = undefined;
/**
- * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. For processor-specific information, see the auth_merchant_advice_code_raw field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code For processor-specific information, see the `auth_merchant_advice_code_raw` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} codeRaw
*/
exports.prototype['codeRaw'] = undefined;
diff --git a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.js b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.js
index 79bb7ddf..4371d89a 100644
--- a/src/model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.js
+++ b/src/model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.js
@@ -77,17 +77,17 @@
}
/**
- * Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit network. Possible values: - C: Credit network - D: Debit network (without signature) - S: STAR signature debit network This field is supported only on FDC Nashville Global.
+ * Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit network. Possible values: - `C`: Credit network - `D`: Debit network (without signature) - `S`: STAR signature debit network This field is supported only on FDC Nashville Global. For details, see the `routing_network_type` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} network
*/
exports.prototype['network'] = undefined;
/**
- * Name of the network on which the transaction was routed. This field is supported only on FDC Nashville Global.
+ * Name of the network on which the transaction was routed. This field is supported only on FDC Nashville Global. For details, see the `routing_network_label` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} networkName
*/
exports.prototype['networkName'] = undefined;
/**
- * Indicates whether you need to obtain the cardholder's signature. Possible values: - Y: You need to obtain the cardholder's signature. - N: You do not need to obtain the cardholder's signature. This field is supported only on FDC Nashville Global.
+ * Indicates whether you need to obtain the cardholder's signature. Possible values: - `Y`: You need to obtain the cardholder's signature. - `N`: You do not need to obtain the cardholder's signature. This field is supported only on FDC Nashville Global. For details, see the `routing_signature_cvm_required` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} customerSignatureRequired
*/
exports.prototype['customerSignatureRequired'] = undefined;
diff --git a/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js b/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js
index 5cfc8715..04530908 100644
--- a/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js
+++ b/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js
@@ -100,7 +100,7 @@
*/
exports.prototype['merchantNumber'] = undefined;
/**
- * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization.
+ * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.
* @member {String} responseCode
*/
exports.prototype['responseCode'] = undefined;
diff --git a/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js b/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js
index d7890591..75da815f 100644
--- a/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js
+++ b/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js
@@ -78,7 +78,7 @@
*/
exports.prototype['refundAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PaymentsRefundPost400Response.js b/src/model/PtsV2PaymentsRefundPost400Response.js
index 0edf06d9..0c271563 100644
--- a/src/model/PtsV2PaymentsRefundPost400Response.js
+++ b/src/model/PtsV2PaymentsRefundPost400Response.js
@@ -153,6 +153,11 @@
* @const
*/
"INVALID_MERCHANT_CONFIGURATION": "INVALID_MERCHANT_CONFIGURATION",
+ /**
+ * value: "INVALID_AMOUNT"
+ * @const
+ */
+ "INVALID_AMOUNT": "INVALID_AMOUNT",
/**
* value: "CAPTURE_ALREADY_VOIDED"
* @const
diff --git a/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js b/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js
index f79c850b..0e1faa7d 100644
--- a/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js
+++ b/src/model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.js
@@ -94,12 +94,12 @@
*/
exports.prototype['transactionId'] = undefined;
/**
- * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization.
+ * For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.
* @member {String} responseCode
*/
exports.prototype['responseCode'] = undefined;
/**
- * Processor-defined response category code. The associated detail error code is in the auth_auth_response field or the auth_reversal_auth_ response field depending on which service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3
+ * Processor-defined response category code. The associated detail error code is in the `responseCode` field of the service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3
* @member {String} responseCategoryCode
*/
exports.prototype['responseCategoryCode'] = undefined;
@@ -109,12 +109,12 @@
*/
exports.prototype['forwardedAcquirerCode'] = undefined;
/**
- * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service
+ * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet.
* @member {String} masterCardServiceCode
*/
exports.prototype['masterCardServiceCode'] = undefined;
/**
- * Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - **C**: Service completed successfully. - **F**: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - **I**: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - **T**: Invalid combination of token requestor ID and token. - **U**: Expired token. - **W**: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**.
+ * Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - `C`: Service completed successfully. - `F`: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - `I`: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - `T`: Invalid combination of token requestor ID and token. - `U`: Expired token. - `W`: Primary account number (PAN) listed in electronic warning bulletin. **Note** This field is returned only for **CyberSource through VisaNet**.
* @member {String} masterCardServiceReplyCode
*/
exports.prototype['masterCardServiceReplyCode'] = undefined;
diff --git a/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js b/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js
index 16531bea..b3281ccc 100644
--- a/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js
+++ b/src/model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.js
@@ -77,17 +77,17 @@
}
/**
- * Total reversed amount.
+ * Total reversed amount. For details, see `auth_reversal_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} reversedAmount
*/
exports.prototype['reversedAmount'] = undefined;
/**
- * Amount of the original transaction.
+ * Amount of the original transaction. For details, see `original_transaction_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} originalTransactionAmount
*/
exports.prototype['originalTransactionAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PaymentsReversalsPost400Response.js b/src/model/PtsV2PaymentsReversalsPost400Response.js
index 35d3c42c..294c0c99 100644
--- a/src/model/PtsV2PaymentsReversalsPost400Response.js
+++ b/src/model/PtsV2PaymentsReversalsPost400Response.js
@@ -148,11 +148,26 @@
* @const
*/
"INVALID_MERCHANT_CONFIGURATION": "INVALID_MERCHANT_CONFIGURATION",
+ /**
+ * value: "PROCESSOR_UNAVAILABLE"
+ * @const
+ */
+ "PROCESSOR_UNAVAILABLE": "PROCESSOR_UNAVAILABLE",
/**
* value: "AUTH_ALREADY_REVERSED"
* @const
*/
"AUTH_ALREADY_REVERSED": "AUTH_ALREADY_REVERSED",
+ /**
+ * value: "TRANSACTION_ALREADY_SETTLED"
+ * @const
+ */
+ "TRANSACTION_ALREADY_SETTLED": "TRANSACTION_ALREADY_SETTLED",
+ /**
+ * value: "INVALID_AMOUNT"
+ * @const
+ */
+ "INVALID_AMOUNT": "INVALID_AMOUNT",
/**
* value: "MISSING_AUTH"
* @const
diff --git a/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js b/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js
index 8c56d999..bcb8174f 100644
--- a/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js
+++ b/src/model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.js
@@ -87,7 +87,7 @@
*/
exports.prototype['originalTransactionAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.js b/src/model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.js
index 9181ab4e..e4934b17 100644
--- a/src/model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.js
+++ b/src/model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.js
@@ -77,17 +77,17 @@
}
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22)
+ * Merchant's name. For more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.
* @member {String} name
*/
exports.prototype['name'] = undefined;
/**
- * Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Merchant's City. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} locality
*/
exports.prototype['locality'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Merchant's country. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} country
*/
exports.prototype['country'] = undefined;
diff --git a/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js b/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js
index 90dafd80..4bc34555 100644
--- a/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js
+++ b/src/model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.js
@@ -81,12 +81,12 @@
}
/**
- * 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. This information is covered in: Table 15, \"Authorization Information for Specific Processors,\" on page 43 Table 19, \"Capture Information for Specific Processors,\" on page 58 Table 23, \"Credit Information for Specific Processors,\" on page 75 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. See \"Zero Amount Authorizations,\" page 247. **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 offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used.
+ * 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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used.
* @member {String} totalAmount
*/
exports.prototype['totalAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
diff --git a/src/model/PtsV2PayoutsPost201ResponseProcessorInformation.js b/src/model/PtsV2PayoutsPost201ResponseProcessorInformation.js
index 4a6d48db..a83b4dec 100644
--- a/src/model/PtsV2PayoutsPost201ResponseProcessorInformation.js
+++ b/src/model/PtsV2PayoutsPost201ResponseProcessorInformation.js
@@ -100,7 +100,7 @@
*/
exports.prototype['transactionId'] = undefined;
/**
- * This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt.
+ * This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} systemTraceAuditNumber
*/
exports.prototype['systemTraceAuditNumber'] = undefined;
diff --git a/src/model/Ptsv2creditsPointOfSaleInformation.js b/src/model/Ptsv2creditsPointOfSaleInformation.js
index e6e48b10..5ba02002 100644
--- a/src/model/Ptsv2creditsPointOfSaleInformation.js
+++ b/src/model/Ptsv2creditsPointOfSaleInformation.js
@@ -127,7 +127,7 @@
*/
exports.prototype['terminalInputCapability'] = undefined;
/**
- * Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.
+ * Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. For details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} terminalSerialNumber
*/
exports.prototype['terminalSerialNumber'] = undefined;
diff --git a/src/model/Ptsv2creditsPointOfSaleInformationEmv.js b/src/model/Ptsv2creditsPointOfSaleInformationEmv.js
index 3770d51f..2006b473 100644
--- a/src/model/Ptsv2creditsPointOfSaleInformationEmv.js
+++ b/src/model/Ptsv2creditsPointOfSaleInformationEmv.js
@@ -77,7 +77,7 @@
}
/**
- * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. See \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
+ * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
* @member {String} tags
*/
exports.prototype['tags'] = undefined;
@@ -88,7 +88,7 @@
*/
exports.prototype['fallback'] = false;
/**
- * Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. **NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.
+ * Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Number} fallbackCondition
*/
exports.prototype['fallbackCondition'] = undefined;
diff --git a/src/model/Ptsv2creditsProcessingInformation.js b/src/model/Ptsv2creditsProcessingInformation.js
index de004d19..f88fbc70 100644
--- a/src/model/Ptsv2creditsProcessingInformation.js
+++ b/src/model/Ptsv2creditsProcessingInformation.js
@@ -115,7 +115,7 @@
*/
exports.prototype['processorId'] = undefined;
/**
- * Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.
+ * Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay.
* @member {String} paymentSolution
*/
exports.prototype['paymentSolution'] = undefined;
@@ -125,17 +125,17 @@
*/
exports.prototype['reconciliationId'] = undefined;
/**
- * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations: See \"Partial Authorizations,\" page 88. - Split shipments: See \"Split Shipments,\" page 210.
+ * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} linkId
*/
exports.prototype['linkId'] = undefined;
/**
- * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. See \"Report Groups,\" page 234.
+ * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} reportGroup
*/
exports.prototype['reportGroup'] = undefined;
/**
- * Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. For more details, see Visa Checkout Using the SCMP API.
+ * Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} visaCheckoutId
*/
exports.prototype['visaCheckoutId'] = undefined;
diff --git a/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js b/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js
index a06faae2..e3cf358c 100644
--- a/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js
+++ b/src/model/Ptsv2creditsProcessingInformationBankTransferOptions.js
@@ -98,7 +98,7 @@
*/
exports.prototype['customerMemo'] = undefined;
/**
- * Authorization method used for the transaction. See \"SEC Codes,\" page 89. TeleCheck Accepts only the following values: - **PPD** - **TEL** - **WEB**
+ * Authorization method used for the transaction. #### TeleCheck Accepts only the following values: - `PPD` - `TEL` - `WEB` For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} secCode
*/
exports.prototype['secCode'] = undefined;
@@ -118,12 +118,12 @@
*/
exports.prototype['effectiveDate'] = undefined;
/**
- * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. See \"Multiple Partial Credits,\" page 41.
+ * Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} partialPaymentId
*/
exports.prototype['partialPaymentId'] = undefined;
/**
- * Method used for settlement. Possible values: - **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars) - **F**: Facsimile draft (U.S. dollars only) - **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) See \"Settlement Delivery Methods,\" page 44.
+ * Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} settlementMethod
*/
exports.prototype['settlementMethod'] = undefined;
diff --git a/src/model/Ptsv2paymentsAggregatorInformation.js b/src/model/Ptsv2paymentsAggregatorInformation.js
index ef283181..987cac11 100644
--- a/src/model/Ptsv2paymentsAggregatorInformation.js
+++ b/src/model/Ptsv2paymentsAggregatorInformation.js
@@ -77,7 +77,7 @@
}
/**
- * Value that identifies you as a payment aggregator. Get this value from the processor. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. ccAuthService\\ **American Express Direct**: R for all aggregator transactions.\\ **CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\ **FDC Compass**: R for all aggregator transactions.\\ **FDC Nashville Global**: R for all aggregator transactions. For processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Value that identifies you as a payment aggregator. Get this value from the processor. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. ccAuthService\\ **American Express Direct**: R for all aggregator transactions.\\ **CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\ **FDC Compass**: R for all aggregator transactions.\\ **FDC Nashville Global**: R for all aggregator transactions. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} aggregatorId
*/
exports.prototype['aggregatorId'] = undefined;
diff --git a/src/model/Ptsv2paymentsAggregatorInformationSubMerchant.js b/src/model/Ptsv2paymentsAggregatorInformationSubMerchant.js
index d50fc27a..06dd7f8f 100644
--- a/src/model/Ptsv2paymentsAggregatorInformationSubMerchant.js
+++ b/src/model/Ptsv2paymentsAggregatorInformationSubMerchant.js
@@ -115,12 +115,12 @@
*/
exports.prototype['name'] = undefined;
/**
- * First line of the sub-merchant’s street address. See \"Aggregator Support,\" page 100. **CyberSource through VisaNet**\\ The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters.
+ * First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
* @member {String} address1
*/
exports.prototype['address1'] = undefined;
/**
- * Sub-merchant’s city. **CyberSource through VisaNet**\\ The value for this field does not map to the TC 33 capture file. **FDC Compass**\\ This value must consist of uppercase characters. For details, see \"Aggregator Support,\" page 100.
+ * Sub-merchant’s city. For processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
* @member {String} locality
*/
exports.prototype['locality'] = undefined;
diff --git a/src/model/Ptsv2paymentsBuyerInformation.js b/src/model/Ptsv2paymentsBuyerInformation.js
index 97613aee..6ca8e53b 100644
--- a/src/model/Ptsv2paymentsBuyerInformation.js
+++ b/src/model/Ptsv2paymentsBuyerInformation.js
@@ -89,12 +89,12 @@
}
/**
- * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} merchantCustomerId
*/
exports.prototype['merchantCustomerId'] = undefined;
/**
- * Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see \"Recipients,\" page 224.
+ * Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} dateOfBirth
*/
exports.prototype['dateOfBirth'] = undefined;
@@ -104,7 +104,7 @@
*/
exports.prototype['vatRegistrationNumber'] = undefined;
/**
- * Company’s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used
+ * Company’s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used.
* @member {String} companyTaxId
*/
exports.prototype['companyTaxId'] = undefined;
@@ -113,7 +113,7 @@
*/
exports.prototype['personalIdentification'] = undefined;
/**
- * The description for this field is not available.
+ * The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)
* @member {String} hashedPassword
*/
exports.prototype['hashedPassword'] = undefined;
diff --git a/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js b/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js
index aff4de12..67178cbe 100644
--- a/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js
+++ b/src/model/Ptsv2paymentsBuyerInformationPersonalIdentification.js
@@ -77,17 +77,17 @@
}
/**
- * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.
+ * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.
* @member {module:model/Ptsv2paymentsBuyerInformationPersonalIdentification.TypeEnum} type
*/
exports.prototype['type'] = undefined;
/**
- * The value of the identification type. This field is supported only on the following processors. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If type = PASSPORT, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
+ * The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
* @member {String} id
*/
exports.prototype['id'] = undefined;
/**
- * If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy.
+ * The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer’s driver’s license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. Use the two-character State, Province, and Territory Codes for the United States and Canada. #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} issuedBy
*/
exports.prototype['issuedBy'] = undefined;
diff --git a/src/model/Ptsv2paymentsClientReferenceInformation.js b/src/model/Ptsv2paymentsClientReferenceInformation.js
index 62d6325e..e5f9d26f 100644
--- a/src/model/Ptsv2paymentsClientReferenceInformation.js
+++ b/src/model/Ptsv2paymentsClientReferenceInformation.js
@@ -81,12 +81,12 @@
}
/**
- * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
+ * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
* @member {String} code
*/
exports.prototype['code'] = undefined;
/**
- * Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. See page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)
+ * Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. For details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} transactionId
*/
exports.prototype['transactionId'] = undefined;
diff --git a/src/model/Ptsv2paymentsClientReferenceInformationPartner.js b/src/model/Ptsv2paymentsClientReferenceInformationPartner.js
index a2f60844..c53a9cea 100644
--- a/src/model/Ptsv2paymentsClientReferenceInformationPartner.js
+++ b/src/model/Ptsv2paymentsClientReferenceInformationPartner.js
@@ -82,12 +82,12 @@
*/
exports.prototype['originalTransactionId'] = undefined;
/**
- * Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. Note When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.
+ * Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.
* @member {String} developerId
*/
exports.prototype['developerId'] = undefined;
/**
- * Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. Note When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.
+ * Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.
* @member {String} solutionId
*/
exports.prototype['solutionId'] = undefined;
diff --git a/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js b/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js
index 155eaf9c..ffb54aee 100644
--- a/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js
+++ b/src/model/Ptsv2paymentsConsumerAuthenticationInformation.js
@@ -102,7 +102,7 @@
*/
exports.prototype['cavv'] = undefined;
/**
- * Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard Identity Check.
+ * Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check.
* @member {String} cavvAlgorithm
*/
exports.prototype['cavvAlgorithm'] = undefined;
diff --git a/src/model/Ptsv2paymentsDeviceInformation.js b/src/model/Ptsv2paymentsDeviceInformation.js
index 82f306fe..93ea6362 100644
--- a/src/model/Ptsv2paymentsDeviceInformation.js
+++ b/src/model/Ptsv2paymentsDeviceInformation.js
@@ -77,17 +77,17 @@
}
/**
- * Host name reported by the customer’s browser to your Web server identified via the HTTP header.
+ * DNS resolved hostname from `ipAddress`.
* @member {String} hostName
*/
exports.prototype['hostName'] = undefined;
/**
- * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information.
+ * IP address of the customer.
* @member {String} ipAddress
*/
exports.prototype['ipAddress'] = undefined;
/**
- * Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser.
+ * Customer’s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.
* @member {String} userAgent
*/
exports.prototype['userAgent'] = undefined;
diff --git a/src/model/Ptsv2paymentsInstallmentInformation.js b/src/model/Ptsv2paymentsInstallmentInformation.js
index 65cfe09e..1fa0fae9 100644
--- a/src/model/Ptsv2paymentsInstallmentInformation.js
+++ b/src/model/Ptsv2paymentsInstallmentInformation.js
@@ -105,52 +105,52 @@
}
/**
- * Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.
+ * Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} amount
*/
exports.prototype['amount'] = undefined;
/**
- * Installment Frequency of the installment payments. This field is supported only for CyberSource through VisaNet. Possible values: - B: Biweekly - M: Monthly - W: Weekly See \"Installment Payments,\" page 127.
+ * Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} frequency
*/
exports.prototype['frequency'] = undefined;
/**
- * **American Express Direct, Cielo, and CyberSource Latin American Processing**\\ Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - 1: Merchant-funded installment plan - 2: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. See \"Installment Payments,\" page 136. **CyberSource through VisaNet and American Express**\\ Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field See \"Installment Payments,\" page 125. For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. **CyberSource through VisaNet with Visa or Mastercard**\\ Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil See \"Installment Payments on CyberSource through VisaNet,\" page 142. For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant)
+ * #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant)
* @member {String} planType
*/
exports.prototype['planType'] = undefined;
/**
- * Installment number when making payments in installments. Used along with _totalCount_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. See \"Installment Payments,\" page 125. **Chase Paymentech Solutions and FDC Compass**\\ This field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech Solutions Merchant Descriptors,\" page 142, and \"FDC Compass Merchant Descriptors,\" page 153. **CyberSource through VisaNet**\\ When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
+ * Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
* @member {Number} sequence
*/
exports.prototype['sequence'] = undefined;
/**
- * Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.
+ * Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} totalAmount
*/
exports.prototype['totalAmount'] = undefined;
/**
- * Total number of installments when making payments in installments. See \"Installment Payments,\" page 127. **Chase Paymentech Solutions and FDC Compass**\\ This field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech Solutions Merchant Descriptors,\" page 144, and \"FDC Compass Merchant Descriptors,\" page 155. **American Express Direct, Cielo, and Comercio Latino**\\ This value is the total number of installments you approved. **CyberSource Latin American Processing in Brazil**\\ This value is the total number of installments that you approved. The default is 1. **All Other Processors**\\ This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. **CyberSource through VisaNet**\\ For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
+ * Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
* @member {Number} totalCount
*/
exports.prototype['totalCount'] = undefined;
/**
- * Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment
+ * Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment
* @member {String} firstInstallmentDate
*/
exports.prototype['firstInstallmentDate'] = undefined;
/**
- * Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. See Installment Payments on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification
+ * Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification
* @member {String} invoiceData
*/
exports.prototype['invoiceData'] = undefined;
/**
- * Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. See Installment Payments on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information
+ * Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information
* @member {String} paymentType
*/
exports.prototype['paymentType'] = undefined;
/**
- * Indicates whether the authorization request is a Crediario eligibility inquiry. See Installment Payments on CyberSource through VisaNet. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.
+ * Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.
* @member {String} eligibilityInquiry
*/
exports.prototype['eligibilityInquiry'] = undefined;
diff --git a/src/model/Ptsv2paymentsIssuerInformation.js b/src/model/Ptsv2paymentsIssuerInformation.js
index b3ba7ae1..0f1e95a8 100644
--- a/src/model/Ptsv2paymentsIssuerInformation.js
+++ b/src/model/Ptsv2paymentsIssuerInformation.js
@@ -69,7 +69,7 @@
}
/**
- * Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.
+ * Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} discretionaryData
*/
exports.prototype['discretionaryData'] = undefined;
diff --git a/src/model/Ptsv2paymentsMerchantDefinedInformation.js b/src/model/Ptsv2paymentsMerchantDefinedInformation.js
index 6603fabc..ae63e3f9 100644
--- a/src/model/Ptsv2paymentsMerchantDefinedInformation.js
+++ b/src/model/Ptsv2paymentsMerchantDefinedInformation.js
@@ -73,12 +73,12 @@
}
/**
- * The name you assign for your merchant-defined data field. **CyberSource through VisaNet**\\ For installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and merchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the transaction. See \"Installment Payments on CyberSource through VisaNet,\" page 142.
+ * The name you assign for your merchant-defined data field. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} key
*/
exports.prototype['key'] = undefined;
/**
- * The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. **CyberSource through VisaNet**\\ For installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and merchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the transaction. See \"Installment Payments on CyberSource through VisaNet,\" page 142. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3
+ * The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3
* @member {String} value
*/
exports.prototype['value'] = undefined;
diff --git a/src/model/Ptsv2paymentsMerchantInformation.js b/src/model/Ptsv2paymentsMerchantInformation.js
index 56e833e1..22837f98 100644
--- a/src/model/Ptsv2paymentsMerchantInformation.js
+++ b/src/model/Ptsv2paymentsMerchantInformation.js
@@ -105,37 +105,37 @@
*/
exports.prototype['merchantDescriptor'] = undefined;
/**
- * Company ID assigned to an independent sales organization. Get this value from Mastercard. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the sales_organization_ID field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} salesOrganizationId
*/
exports.prototype['salesOrganizationId'] = undefined;
/**
- * Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) See \"Aggregator Support,\" page 100. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code
+ * The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code
* @member {Number} categoryCode
*/
exports.prototype['categoryCode'] = undefined;
/**
- * Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the merchantCategoryCode field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct.
+ * Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct.
* @member {Number} categoryCodeDomestic
*/
exports.prototype['categoryCodeDomestic'] = undefined;
/**
- * Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1
+ * Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} taxId
*/
exports.prototype['taxId'] = undefined;
/**
- * Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} vatRegistrationNumber
*/
exports.prototype['vatRegistrationNumber'] = undefined;
/**
- * Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} cardAcceptorReferenceNumber
*/
exports.prototype['cardAcceptorReferenceNumber'] = undefined;
/**
- * Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the transaction_local_date_time field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) `Format: YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds For processor-specific information, see the _transaction_local_date_time_ field in Credit Card Services Using the SCMP API.
+ * Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the `transaction_local_date_time` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Format: `YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds For processor-specific information, see the `transaction_local_date_time` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} transactionLocalDateTime
*/
exports.prototype['transactionLocalDateTime'] = undefined;
diff --git a/src/model/Ptsv2paymentsMerchantInformationMerchantDescriptor.js b/src/model/Ptsv2paymentsMerchantInformationMerchantDescriptor.js
index 7e700b14..5226dfa3 100644
--- a/src/model/Ptsv2paymentsMerchantInformationMerchantDescriptor.js
+++ b/src/model/Ptsv2paymentsMerchantInformationMerchantDescriptor.js
@@ -97,42 +97,42 @@
}
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22)
+ * Merchant's name. For more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.
* @member {String} name
*/
exports.prototype['name'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->
* @member {String} alternateName
*/
exports.prototype['alternateName'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13)
+ * For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13)
* @member {String} contact
*/
exports.prototype['contact'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} address1
*/
exports.prototype['address1'] = undefined;
/**
- * Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Merchant's City. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} locality
*/
exports.prototype['locality'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Merchant's country. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} country
*/
exports.prototype['country'] = undefined;
/**
- * For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Merchant's postal code. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} postalCode
*/
exports.prototype['postalCode'] = undefined;
/**
- * Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * The state where the merchant is located. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} administrativeArea
*/
exports.prototype['administrativeArea'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationAmountDetails.js b/src/model/Ptsv2paymentsOrderInformationAmountDetails.js
index b33c9b72..e7334d7a 100644
--- a/src/model/Ptsv2paymentsOrderInformationAmountDetails.js
+++ b/src/model/Ptsv2paymentsOrderInformationAmountDetails.js
@@ -153,12 +153,12 @@
}
/**
- * 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. This information is covered in: Table 15, \"Authorization Information for Specific Processors,\" on page 43 Table 19, \"Capture Information for Specific Processors,\" on page 58 Table 23, \"Credit Information for Specific Processors,\" on page 75 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. See \"Zero Amount Authorizations,\" page 247. **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 offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used.
+ * 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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used.
* @member {String} totalAmount
*/
exports.prototype['totalAmount'] = undefined;
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
@@ -203,17 +203,17 @@
*/
exports.prototype['freightAmount'] = undefined;
/**
- * Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. For processor-specific information, see the foreign_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} foreignAmount
*/
exports.prototype['foreignAmount'] = undefined;
/**
- * Your customer’s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} foreignCurrency
*/
exports.prototype['foreignCurrency'] = undefined;
/**
- * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` 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) For processor-specific information, see the `exchange_rate` field description in [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} exchangeRate
*/
exports.prototype['exchangeRate'] = undefined;
@@ -250,12 +250,12 @@
*/
exports.prototype['serviceFeeAmount'] = undefined;
/**
- * Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. For details, see Dynamic Currency Conversion with a Third Party Provider.
+ * Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. For details, see the `original_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} originalAmount
*/
exports.prototype['originalAmount'] = undefined;
/**
- * Your local pricing currency code. For the possible values, see the ISO Standard Currency Codes. For details, see Dynamic Currency Conversion with a Third Party Provider.
+ * Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about converting a foreign cardholder’s purchase from your local pricing currency to the cardholder’s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
* @member {String} originalCurrency
*/
exports.prototype['originalCurrency'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js b/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js
index a37e041d..9b5889eb 100644
--- a/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js
+++ b/src/model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.js
@@ -73,7 +73,7 @@
}
/**
- * Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the additional_amount_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} code
*/
exports.prototype['code'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.js b/src/model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.js
index 81bb8ced..dab970ae 100644
--- a/src/model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.js
+++ b/src/model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.js
@@ -93,37 +93,37 @@
}
/**
- * This is used to determine what type of tax related data should be inclued under _taxDetails_ object. Possible values: - alternate - local - national - vat
+ * Indicates the type of tax data for the _taxDetails_ object. Possible values: For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {module:model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.TypeEnum} type
*/
exports.prototype['type'] = undefined;
/**
- * Please see below table for related decription based on above _type_ field. | type | type description | |-----------|--------------------| | alternate | Total amount of alternate tax for the order. | | local | Sales tax for the order. | | national | National tax for the order. | | vat | Total amount of VAT or other tax included in the order. | | other | Other tax. |
+ * Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | |-----------|--------------------| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of Value Added Tax (VAT) included in the order. | | `other` | Other tax. | For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} amount
*/
exports.prototype['amount'] = undefined;
/**
- * Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated)
+ * Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} rate
*/
exports.prototype['rate'] = undefined;
/**
- * Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax (VAT) - 0011: goods and services tax (GST) - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - 0023: city tax - 0024: county or parish sales tax - 0025: county tax - 0026: environment tax - 0027: state and local sales tax (combined) - Blank: Tax not supported on line item.
+ * Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator`
* @member {String} code
*/
exports.prototype['code'] = undefined;
/**
- * Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount.
+ * Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} taxId
*/
exports.prototype['taxId'] = undefined;
/**
- * The tax is applied. Valid value is `true` or `false`.
+ * Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Boolean} applied
*/
exports.prototype['applied'] = undefined;
/**
- * Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values, see Exemption Status Values. See Numbered Elements. Important For information about using this field, see Item-Level Tax Fields.
+ * Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values and important information for using this field, see _Appendix B, \"Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} exemptionCode
*/
exports.prototype['exemptionCode'] = undefined;
@@ -154,7 +154,12 @@
* value: "vat"
* @const
*/
- "vat": "vat" };
+ "vat": "vat",
+ /**
+ * value: "other"
+ * @const
+ */
+ "other": "other" };
return exports;
diff --git a/src/model/Ptsv2paymentsOrderInformationBillTo.js b/src/model/Ptsv2paymentsOrderInformationBillTo.js
index b4d51bb8..3124c6ff 100644
--- a/src/model/Ptsv2paymentsOrderInformationBillTo.js
+++ b/src/model/Ptsv2paymentsOrderInformationBillTo.js
@@ -64,6 +64,8 @@
+
+
};
/**
@@ -101,6 +103,12 @@
if (data.hasOwnProperty('address2')) {
obj['address2'] = ApiClient.convertToType(data['address2'], 'String');
}
+ if (data.hasOwnProperty('address3')) {
+ obj['address3'] = ApiClient.convertToType(data['address3'], 'String');
+ }
+ if (data.hasOwnProperty('address4')) {
+ obj['address4'] = ApiClient.convertToType(data['address4'], 'String');
+ }
if (data.hasOwnProperty('locality')) {
obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
}
@@ -133,12 +141,12 @@
}
/**
- * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer’s first name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_firstname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} firstName
*/
exports.prototype['firstName'] = undefined;
/**
- * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer’s last name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `customer_lastname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} lastName
*/
exports.prototype['lastName'] = undefined;
@@ -162,32 +170,42 @@
*/
exports.prototype['company'] = undefined;
/**
- * First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * First line of the billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_address1` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} address1
*/
exports.prototype['address1'] = undefined;
/**
- * Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Additional address information. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_address2` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} address2
*/
exports.prototype['address2'] = undefined;
/**
- * City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Additional address information (third line of the billing address)
+ * @member {String} address3
+ */
+ exports.prototype['address3'] = undefined;
+ /**
+ * Additional address information (fourth line of the billing address)
+ * @member {String} address4
+ */
+ exports.prototype['address4'] = undefined;
+ /**
+ * Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `bill_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} locality
*/
exports.prototype['locality'] = undefined;
/**
- * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} administrativeArea
*/
exports.prototype['administrativeArea'] = undefined;
/**
- * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_zip` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} postalCode
*/
exports.prototype['postalCode'] = undefined;
/**
- * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Payment card billing country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} country
*/
exports.prototype['country'] = undefined;
@@ -202,17 +220,17 @@
*/
exports.prototype['buildingNumber'] = undefined;
/**
- * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} email
*/
exports.prototype['email'] = undefined;
/**
- * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
+ * Customer’s phone number. #### For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
* @member {String} phoneNumber
*/
exports.prototype['phoneNumber'] = undefined;
/**
- * Customer's phone number type. For Payouts: This field may be sent only for FDC Compass. Possible Values - * day * home * night * work
+ * Customer's phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work
* @member {module:model/Ptsv2paymentsOrderInformationBillTo.PhoneTypeEnum} phoneType
*/
exports.prototype['phoneType'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationBillToCompany.js b/src/model/Ptsv2paymentsOrderInformationBillToCompany.js
index eabc3aa9..c5fc9cb2 100644
--- a/src/model/Ptsv2paymentsOrderInformationBillToCompany.js
+++ b/src/model/Ptsv2paymentsOrderInformationBillToCompany.js
@@ -93,7 +93,7 @@
}
/**
- * Name of the customer’s company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Name of the customer’s company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} name
*/
exports.prototype['name'] = undefined;
@@ -118,12 +118,12 @@
*/
exports.prototype['administrativeArea'] = undefined;
/**
- * Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits. When the company country is the U.S., the 9-digit postal code must follow this format: **[5 digits][dash][4 digits]** Example 12345-6789 When the company country is Canada, the 6-digit postal code must follow this format: **[alpha][numeric][alpha][space][numeric][alpha][numeric]** Example A1B 2C3
+ * Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits. When the company country is the U.S., the 9-digit postal code must follow this format: **[5 digits][dash][4 digits]** #### Example `12345-6789` When the company country is Canada, the 6-digit postal code must follow this format: **[alpha][numeric][alpha][space][numeric][alpha][numeric]** #### Example `A1B 2C3`
* @member {String} postalCode
*/
exports.prototype['postalCode'] = undefined;
/**
- * Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.
+ * Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)
* @member {String} country
*/
exports.prototype['country'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationInvoiceDetails.js b/src/model/Ptsv2paymentsOrderInformationInvoiceDetails.js
index a7fdb2f8..6d993cd4 100644
--- a/src/model/Ptsv2paymentsOrderInformationInvoiceDetails.js
+++ b/src/model/Ptsv2paymentsOrderInformationInvoiceDetails.js
@@ -132,32 +132,32 @@
*/
exports.prototype['expirationDate'] = undefined;
/**
- * Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the user_po field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} purchaseOrderNumber
*/
exports.prototype['purchaseOrderNumber'] = undefined;
/**
- * Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the purchaser_order_date field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} purchaseOrderDate
*/
exports.prototype['purchaseOrderDate'] = undefined;
/**
- * The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the authorized_contact_name field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} purchaseContactName
*/
exports.prototype['purchaseContactName'] = undefined;
/**
- * Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include _invoiceDetails.taxable_ in the data it sends to the processor. For processor-specific information, see the tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false**
+ * Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false**
* @member {Boolean} taxable
*/
exports.prototype['taxable'] = undefined;
/**
- * VAT invoice number associated with the transaction. For processor-specific information, see the vat_invoice_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} vatInvoiceReferenceNumber
*/
exports.prototype['vatInvoiceReferenceNumber'] = undefined;
/**
- * International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the summary_commodity_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
+ * International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
* @member {String} commodityCode
*/
exports.prototype['commodityCode'] = undefined;
@@ -171,12 +171,12 @@
*/
exports.prototype['transactionAdviceAddendum'] = undefined;
/**
- * Code that identifies the value of the reference_data_number field. For the possible values, see Reference Data Codes. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
+ * Code that identifies the value of the `referenceDataNumber` field. For the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
* @member {String} referenceDataCode
*/
exports.prototype['referenceDataCode'] = undefined;
/**
- * Reference number. The meaning of this value is identified by the value of the referenceDataCode field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
+ * Reference number. The meaning of this value is identified by the value of the `referenceDataCode` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
* @member {String} referenceDataNumber
*/
exports.prototype['referenceDataNumber'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationLineItems.js b/src/model/Ptsv2paymentsOrderInformationLineItems.js
index 6adf78df..610fbe52 100644
--- a/src/model/Ptsv2paymentsOrderInformationLineItems.js
+++ b/src/model/Ptsv2paymentsOrderInformationLineItems.js
@@ -169,7 +169,7 @@
}
/**
- * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.
+ * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} productCode
*/
exports.prototype['productCode'] = undefined;
@@ -184,12 +184,12 @@
*/
exports.prototype['productSku'] = undefined;
/**
- * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.
+ * Number of units for this order. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is \"gift_card\", this is the total count of individual prepaid gift cards purchased.
* @member {Number} quantity
*/
exports.prototype['quantity'] = undefined;
/**
- * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ 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. See \"Zero Amount Authorizations,\" page 220.
+ * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} unitPrice
*/
exports.prototype['unitPrice'] = undefined;
@@ -199,7 +199,7 @@
*/
exports.prototype['unitOfMeasure'] = undefined;
/**
- * Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123
+ * Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123
* @member {String} totalAmount
*/
exports.prototype['totalAmount'] = undefined;
@@ -209,7 +209,7 @@
*/
exports.prototype['taxAmount'] = undefined;
/**
- * Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).
+ * Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).
* @member {String} taxRate
*/
exports.prototype['taxRate'] = undefined;
@@ -224,7 +224,7 @@
*/
exports.prototype['taxStatusIndicator'] = undefined;
/**
- * Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax (VAT) - 0011: goods and services tax (GST) - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - 0023: city tax - 0024: county or parish sales tax - 0025: county tax - 0026: environment tax - 0027: state and local sales tax (combined) - Blank: Tax not supported on line item.
+ * Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator`
* @member {String} taxTypeCode
*/
exports.prototype['taxTypeCode'] = undefined;
diff --git a/src/model/Ptsv2paymentsOrderInformationShippingDetails.js b/src/model/Ptsv2paymentsOrderInformationShippingDetails.js
index 51d26f68..00af85e4 100644
--- a/src/model/Ptsv2paymentsOrderInformationShippingDetails.js
+++ b/src/model/Ptsv2paymentsOrderInformationShippingDetails.js
@@ -65,7 +65,7 @@
obj = obj || new exports();
if (data.hasOwnProperty('giftWrap')) {
- obj['giftWrap'] = ApiClient.convertToType(data['giftWrap'], 'String');
+ obj['giftWrap'] = ApiClient.convertToType(data['giftWrap'], 'Boolean');
}
if (data.hasOwnProperty('shippingMethod')) {
obj['shippingMethod'] = ApiClient.convertToType(data['shippingMethod'], 'String');
@@ -78,8 +78,8 @@
}
/**
- * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping.
- * @member {String} giftWrap
+ * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping.
+ * @member {Boolean} giftWrap
*/
exports.prototype['giftWrap'] = undefined;
/**
diff --git a/src/model/Ptsv2paymentsPaymentInformationCard.js b/src/model/Ptsv2paymentsPaymentInformationCard.js
index 46ff9a6a..0a64f9e7 100644
--- a/src/model/Ptsv2paymentsPaymentInformationCard.js
+++ b/src/model/Ptsv2paymentsPaymentInformationCard.js
@@ -117,37 +117,37 @@
}
/**
- * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} number
*/
exports.prototype['number'] = undefined;
/**
- * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationMonth
*/
exports.prototype['expirationMonth'] = undefined;
/**
- * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Four-digit year in which the credit card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationYear
*/
exports.prototype['expirationYear'] = undefined;
/**
- * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International)
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} type
*/
exports.prototype['type'] = undefined;
/**
- * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. **Cielo** and **Comercio Latino** Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet.
+ * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. #### Cielo and Comercio Latino Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier This field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet.
* @member {String} useAs
*/
exports.prototype['useAs'] = undefined;
/**
- * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note**\\ Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - **CHECKING**: Checking account - **CREDIT**: Credit card account - **SAVING**: Saving account - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card - **PREPAID**: Prepaid card account or prepaid portion of combo card - **UNIVERSAL**: Universal account
+ * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account
* @member {String} sourceAccountType
*/
exports.prototype['sourceAccountType'] = undefined;
/**
- * Card Verification Number. **Ingenico ePayments** Do not include this field when _commerceIndicator=recurring_. **Note** Ingenico ePayments was previously called Global Collect.
+ * Card Verification Number. #### Ingenico ePayments Do not include this field when **commerceIndicator**`=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_.
* @member {String} securityCode
*/
exports.prototype['securityCode'] = undefined;
@@ -177,7 +177,7 @@
*/
exports.prototype['startYear'] = undefined;
/**
- * Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data
+ * Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. For details, see `card_product_name` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data
* @member {String} productName
*/
exports.prototype['productName'] = undefined;
diff --git a/src/model/Ptsv2paymentsPaymentInformationCustomer.js b/src/model/Ptsv2paymentsPaymentInformationCustomer.js
index 5a5942f8..a43d3438 100644
--- a/src/model/Ptsv2paymentsPaymentInformationCustomer.js
+++ b/src/model/Ptsv2paymentsPaymentInformationCustomer.js
@@ -69,7 +69,7 @@
}
/**
- * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer’s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. See \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.
+ * Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer’s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. For details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} customerId
*/
exports.prototype['customerId'] = undefined;
diff --git a/src/model/Ptsv2paymentsPaymentInformationFluidData.js b/src/model/Ptsv2paymentsPaymentInformationFluidData.js
index 0a1962cc..eb0b73cd 100644
--- a/src/model/Ptsv2paymentsPaymentInformationFluidData.js
+++ b/src/model/Ptsv2paymentsPaymentInformationFluidData.js
@@ -81,17 +81,17 @@
}
/**
- * The name of the merchant-defined data field. The range of this field starts at 1 and terminiates at 100.
+ * The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html)
* @member {String} key
*/
exports.prototype['key'] = undefined;
/**
- * The specific string for identifying the payment solution that is sending the encrypted payment data to CyberSource. Valid values: - `Apple Pay` - `Samsung Pay` **NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.
+ * The identifier for a payment solution, which is sending the encrypted payment data to CyberSource for decryption. Valid values: - Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=` **NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. For details about the list of payment solution identifiers, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html). For details about the encrypted payment data, see the `encrypted_payment_descriptor` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
* @member {String} descriptor
*/
exports.prototype['descriptor'] = undefined;
/**
- * Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses. Valid values: - Apple Pay: `RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U` - Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=` **NOTE**: For other payment solutions, the value of the descriptor may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.
+ * Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses. For details, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) for the specific payment- solution entry.
* @member {String} value
*/
exports.prototype['value'] = undefined;
diff --git a/src/model/Ptsv2paymentsPaymentInformationTokenizedCard.js b/src/model/Ptsv2paymentsPaymentInformationTokenizedCard.js
index 2ec30504..1589a790 100644
--- a/src/model/Ptsv2paymentsPaymentInformationTokenizedCard.js
+++ b/src/model/Ptsv2paymentsPaymentInformationTokenizedCard.js
@@ -110,17 +110,17 @@
*/
exports.prototype['number'] = undefined;
/**
- * Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationMonth
*/
exports.prototype['expirationMonth'] = undefined;
/**
- * Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationYear
*/
exports.prototype['expirationYear'] = undefined;
/**
- * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International)
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} type
*/
exports.prototype['type'] = undefined;
@@ -130,7 +130,7 @@
*/
exports.prototype['cryptogram'] = undefined;
/**
- * Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
+ * Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
* @member {String} requestorId
*/
exports.prototype['requestorId'] = undefined;
@@ -140,17 +140,17 @@
*/
exports.prototype['transactionType'] = undefined;
/**
- * Confidence level of the tokenization. This value is assigned by the token service provider. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
+ * Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.
* @member {String} assuranceLevel
*/
exports.prototype['assuranceLevel'] = undefined;
/**
- * Type of technology used in the device to store token data. Possible values: - 001: Secure Element (SE) Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. `Note` This field is supported only for **FDC Compass**. - 002: Host Card Emulation (HCE) Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. `Note` This field is supported only for **FDC Compass**.
+ * Type of technology used in the device to store token data. Possible values: - `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. **Note** This field is supported only for _FDC Compass_. - 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. **Note** This field is supported only for _FDC Compass_.
* @member {String} storageMethod
*/
exports.prototype['storageMethod'] = undefined;
/**
- * Card Verification Number. **Ingenico ePayments** Do not include this field when _commerceIndicator=recurring_. **Note** Ingenico ePayments was previously called Global Collect. CVN.
+ * Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator**`=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} securityCode
*/
exports.prototype['securityCode'] = undefined;
diff --git a/src/model/Ptsv2paymentsPointOfSaleInformation.js b/src/model/Ptsv2paymentsPointOfSaleInformation.js
index e857f49b..70e03e6f 100644
--- a/src/model/Ptsv2paymentsPointOfSaleInformation.js
+++ b/src/model/Ptsv2paymentsPointOfSaleInformation.js
@@ -153,42 +153,42 @@
}
/**
- * Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. For Payouts: This field is applicable for CtV.
+ * Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. For details, see the `terminal_id` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **For Payouts**: This field is applicable for CtV.
* @member {String} terminalId
*/
exports.prototype['terminalId'] = undefined;
/**
- * Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.
+ * Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. For details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} terminalSerialNumber
*/
exports.prototype['terminalSerialNumber'] = undefined;
/**
- * Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this _alternateTerminalID_ field to identify the terminal used for the transaction. This field is a pass-through, which means that CyberSource does not check the value or modify the value in any way before sending it to the processor.
+ * Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Use the `terminalId` field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this `laneNumber` field to identify the terminal used for the transaction. This field is a pass-through, which means that CyberSource does not check the value or modify the value in any way before sending it to the processor.
* @member {String} laneNumber
*/
exports.prototype['laneNumber'] = undefined;
/**
- * Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network * Applicable only for CTV for Payouts.
+ * Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network #### Chase Paymentech Solutions Only values 1, 2, and 3 are supported. #### FDC Nashville Global Only values 7, 8, and 9 are supported. #### GPN Only values 6, 7, 8, and 9 are supported. #### TSYS Acquiring Solutions Only value 6 is supported. For details, see the `cat_level` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Number} catLevel
*/
exports.prototype['catLevel'] = undefined;
/**
- * Method of entering credit card information into the POS terminal. Possible values: - contact: Read from direct contact with chip card. - contactless: Read from a contactless interface using chip data. - keyed: Manually keyed into POS terminal. - msd: Read from a contactless interface using magnetic stripe data (MSD). - swiped: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. * Applicable only for CTV for Payouts.
+ * Method of entering credit card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). - `swiped`: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. For details, see the `pos_entry_mode` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} entryMode
*/
exports.prototype['entryMode'] = undefined;
/**
- * POS terminal’s capability. Possible values: - 1: Terminal has a magnetic stripe reader only. - 2: Terminal has a magnetic stripe reader and manual entry capability. - 3: Terminal has manual entry capability only. - 4: Terminal can read chip cards. - 5: Terminal can read contactless chip cards. The values of 4 and 5 are supported only for EMV transactions. * Applicable only for CTV for Payouts.
+ * POS terminal’s capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards. The values of 4 and 5 are supported only for EMV transactions. * Applicable only for CTV for Payouts. For processor-specific details, see the `terminal_capability` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Number} terminalCapability
*/
exports.prototype['terminalCapability'] = undefined;
/**
- * A one-digit code that identifies the capability of terminal to capture PINs. This code does not necessarily mean that a PIN was entered or is included in this message. For Payouts: This field is applicable for CtV.
+ * A one-digit code that identifies the capability of terminal to capture PINs. This code does not necessarily mean that a PIN was entered or is included in this message. POS terminal’s capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards.* - `5`: Terminal can read contactless chip cards.* * The values of 4 and 5 are supported only for EMV transactions. For Payouts: This field is applicable for CtV. For details, see the `terminal_capability` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Number} pinEntryCapability
*/
exports.prototype['pinEntryCapability'] = undefined;
/**
- * Operating environment. Possible values: - 0: No terminal used or unknown environment. - 1: On merchant premises, attended. - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for MasterCard transactions on **CyberSource through VisaNet**. - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource through VisaNet**. - 5: On premises of cardholder, unattended. - 9: Unknown delivery mode. - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. This field is supported only for **American Express Direct** and **CyberSource through VisaNet**. **CyberSource through VisaNet**\\ For MasterCard transactions, the only valid values are 2 and 4.
+ * Operating environment. Possible values for all card types except Mastercard: - `0`: No terminal used or unknown environment. - `1`: On merchant premises, attended. - `2`: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA). - `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - `4`: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA. - `5`: On premises of cardholder, unattended. - `9`: Unknown delivery mode. - `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. #### Possible values for Mastercard: - `2`: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. - `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. This field is supported only for American Express Direct and CyberSource through VisaNet.
* @member {String} operatingEnvironment
*/
exports.prototype['operatingEnvironment'] = undefined;
@@ -197,7 +197,7 @@
*/
exports.prototype['emv'] = undefined;
/**
- * Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value.
+ * Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} amexCapnData
*/
exports.prototype['amexCapnData'] = undefined;
diff --git a/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js b/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js
index 1facfa7a..ad6bf379 100644
--- a/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js
+++ b/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js
@@ -85,7 +85,7 @@
}
/**
- * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. See \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
+ * EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
* @member {String} tags
*/
exports.prototype['tags'] = undefined;
@@ -95,7 +95,7 @@
*/
exports.prototype['cardholderVerificationMethodUsed'] = undefined;
/**
- * Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. See \"Europay, MasterCard, Visa (EMV),\" page 10.
+ * Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. For details, see `emv_request_card_sequence_number` field description in the [Card-Present Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} cardSequenceNumber
*/
exports.prototype['cardSequenceNumber'] = undefined;
@@ -106,7 +106,7 @@
*/
exports.prototype['fallback'] = false;
/**
- * Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. **NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.
+ * Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {Number} fallbackCondition
*/
exports.prototype['fallbackCondition'] = undefined;
diff --git a/src/model/Ptsv2paymentsProcessingInformation.js b/src/model/Ptsv2paymentsProcessingInformation.js
index 2618d378..2089a2be 100644
--- a/src/model/Ptsv2paymentsProcessingInformation.js
+++ b/src/model/Ptsv2paymentsProcessingInformation.js
@@ -142,7 +142,7 @@
*/
exports.prototype['commerceIndicator'] = undefined;
/**
- * Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.
+ * Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay.
* @member {String} paymentSolution
*/
exports.prototype['paymentSolution'] = undefined;
@@ -152,7 +152,7 @@
*/
exports.prototype['reconciliationId'] = undefined;
/**
- * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations: See \"Partial Authorizations,\" page 88. - Split shipments: See \"Split Shipments,\" page 210.
+ * Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} linkId
*/
exports.prototype['linkId'] = undefined;
@@ -162,12 +162,12 @@
*/
exports.prototype['purchaseLevel'] = undefined;
/**
- * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. See \"Report Groups,\" page 234.
+ * Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} reportGroup
*/
exports.prototype['reportGroup'] = undefined;
/**
- * Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. For more details, see Visa Checkout Using the SCMP API.
+ * Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} visaCheckoutId
*/
exports.prototype['visaCheckoutId'] = undefined;
diff --git a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js
index 9ec5d721..23c0cce6 100644
--- a/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js
+++ b/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js
@@ -113,27 +113,27 @@
}
/**
- * Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. **Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\ Set this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33. **Forced Capture**\\ Set this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123. **Verbal Authorization**\\ Set this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). For processor-specific information, see the `auth_type` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} authType
*/
exports.prototype['authType'] = undefined;
/**
- * Authorization code. **Forced Capture**\\ Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. **Verbal Authorization**\\ Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).
* @member {String} verbalAuthCode
*/
exports.prototype['verbalAuthCode'] = undefined;
/**
- * Transaction ID (TID).
+ * Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). For more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} verbalAuthTransactionId
*/
exports.prototype['verbalAuthTransactionId'] = undefined;
/**
- * Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. See \"Final Authorization Indicator,\" page 119. Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. For processor-specific information, see the auth_indicator field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. For processor-specific information, see the `auth_indicator` field in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).
* @member {String} authIndicator
*/
exports.prototype['authIndicator'] = undefined;
/**
- * Flag that indicates whether the transaction is enabled for partial authorization or not. When your request includes this field, this value overrides the information in your CyberSource account. For processor-specific information, see the _auth_partial_auth_indicator_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet**\\ To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization.
+ * Flag that indicates whether the transaction is enabled for partial authorization or not. When your request includes this field, this value overrides the information in your CyberSource account. For processor-specific information, see the `auth_partial_auth_indicator` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet**\\ To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization.
* @member {Boolean} partialAuthIndicator
*/
exports.prototype['partialAuthIndicator'] = undefined;
@@ -149,7 +149,7 @@
*/
exports.prototype['ignoreAvsResult'] = false;
/**
- * An array of AVS flags that cause the reply flag to be returned. `Important` To receive declines for the AVS code N, include the value N in the array. Possible values: - D - A - V - S - N - O
+ * Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.Request.
+ * @alias module:model/Request
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Request from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Request} obj Optional instance to populate.
+ * @return {module:model/Request} The populated Request instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('clientReferenceInformation')) {
+ obj['clientReferenceInformation'] = Riskv1authenticationsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
+ }
+ if (data.hasOwnProperty('orderInformation')) {
+ obj['orderInformation'] = Riskv1authenticationresultsOrderInformation.constructFromObject(data['orderInformation']);
+ }
+ if (data.hasOwnProperty('paymentInformation')) {
+ obj['paymentInformation'] = Riskv1authenticationresultsPaymentInformation.constructFromObject(data['paymentInformation']);
+ }
+ if (data.hasOwnProperty('consumerAuthenticationInformation')) {
+ obj['consumerAuthenticationInformation'] = Riskv1authenticationresultsConsumerAuthenticationInformation.constructFromObject(data['consumerAuthenticationInformation']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationsClientReferenceInformation} clientReferenceInformation
+ */
+ exports.prototype['clientReferenceInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationresultsOrderInformation} orderInformation
+ */
+ exports.prototype['orderInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationresultsPaymentInformation} paymentInformation
+ */
+ exports.prototype['paymentInformation'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationresultsConsumerAuthenticationInformation} consumerAuthenticationInformation
+ */
+ exports.prototype['consumerAuthenticationInformation'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/ResponseStatus.js b/src/model/ResponseStatus.js
new file mode 100644
index 00000000..588e7fae
--- /dev/null
+++ b/src/model/ResponseStatus.js
@@ -0,0 +1,117 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/InlineResponseDefaultResponseStatusDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./InlineResponseDefaultResponseStatusDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.ResponseStatus = factory(root.CyberSource.ApiClient, root.CyberSource.InlineResponseDefaultResponseStatusDetails);
+ }
+}(this, function(ApiClient, InlineResponseDefaultResponseStatusDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The ResponseStatus model module.
+ * @module model/ResponseStatus
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new ResponseStatus.
+ * @alias module:model/ResponseStatus
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a ResponseStatus from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ResponseStatus} obj Optional instance to populate.
+ * @return {module:model/ResponseStatus} The populated ResponseStatus instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'Number');
+ }
+ if (data.hasOwnProperty('reason')) {
+ obj['reason'] = ApiClient.convertToType(data['reason'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('correlationId')) {
+ obj['correlationId'] = ApiClient.convertToType(data['correlationId'], 'String');
+ }
+ if (data.hasOwnProperty('details')) {
+ obj['details'] = ApiClient.convertToType(data['details'], [InlineResponseDefaultResponseStatusDetails]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * HTTP Status code.
+ * @member {Number} status
+ */
+ exports.prototype['status'] = undefined;
+ /**
+ * Error Reason Code.
+ * @member {String} reason
+ */
+ exports.prototype['reason'] = undefined;
+ /**
+ * Error Message.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * API correlation ID.
+ * @member {String} correlationId
+ */
+ exports.prototype['correlationId'] = undefined;
+ /**
+ * @member {Array.ResponseStatusDetails.
+ * @alias module:model/ResponseStatusDetails
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a ResponseStatusDetails from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ResponseStatusDetails} obj Optional instance to populate.
+ * @return {module:model/ResponseStatusDetails} The populated ResponseStatusDetails instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('location')) {
+ obj['location'] = ApiClient.convertToType(data['location'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Field name referred to for validation issues.
+ * @member {String} location
+ */
+ exports.prototype['location'] = undefined;
+ /**
+ * Description or code of any error response.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationResultsPost201Response.js b/src/model/RiskV1AuthenticationResultsPost201Response.js
new file mode 100644
index 00000000..4c51da3b
--- /dev/null
+++ b/src/model/RiskV1AuthenticationResultsPost201Response.js
@@ -0,0 +1,159 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/PtsV2PaymentsPost201ResponseErrorInformation', 'model/PtsV2PaymentsReversalsPost201ResponseLinks', 'model/Ptsv2payoutsClientReferenceInformation', 'model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./PtsV2PaymentsPost201ResponseErrorInformation'), require('./PtsV2PaymentsReversalsPost201ResponseLinks'), require('./Ptsv2payoutsClientReferenceInformation'), require('./RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationResultsPost201Response = factory(root.CyberSource.ApiClient, root.CyberSource.PtsV2PaymentsPost201ResponseErrorInformation, root.CyberSource.PtsV2PaymentsReversalsPost201ResponseLinks, root.CyberSource.Ptsv2payoutsClientReferenceInformation, root.CyberSource.RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation);
+ }
+}(this, function(ApiClient, PtsV2PaymentsPost201ResponseErrorInformation, PtsV2PaymentsReversalsPost201ResponseLinks, Ptsv2payoutsClientReferenceInformation, RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationResultsPost201Response model module.
+ * @module model/RiskV1AuthenticationResultsPost201Response
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationResultsPost201Response.
+ * @alias module:model/RiskV1AuthenticationResultsPost201Response
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationResultsPost201Response from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationResultsPost201Response} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationResultsPost201Response} The populated RiskV1AuthenticationResultsPost201Response instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = PtsV2PaymentsReversalsPost201ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('submitTimeUtc')) {
+ obj['submitTimeUtc'] = ApiClient.convertToType(data['submitTimeUtc'], 'String');
+ }
+ if (data.hasOwnProperty('submitTimeLocal')) {
+ obj['submitTimeLocal'] = ApiClient.convertToType(data['submitTimeLocal'], 'String');
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('reason')) {
+ obj['reason'] = ApiClient.convertToType(data['reason'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('clientReferenceInformation')) {
+ obj['clientReferenceInformation'] = Ptsv2payoutsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
+ }
+ if (data.hasOwnProperty('consumerAuthenticationInformation')) {
+ obj['consumerAuthenticationInformation'] = RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.constructFromObject(data['consumerAuthenticationInformation']);
+ }
+ if (data.hasOwnProperty('errorInformation')) {
+ obj['errorInformation'] = PtsV2PaymentsPost201ResponseErrorInformation.constructFromObject(data['errorInformation']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/PtsV2PaymentsReversalsPost201ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.
+ * @member {String} submitTimeUtc
+ */
+ exports.prototype['submitTimeUtc'] = undefined;
+ /**
+ * Time that the transaction was submitted in local time.
+ * @member {String} submitTimeLocal
+ */
+ exports.prototype['submitTimeLocal'] = undefined;
+ /**
+ * The status for payerAuthentication 201 enroll and validate calls. Possible values are: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION
+ * @member {String} status
+ */
+ exports.prototype['status'] = undefined;
+ /**
+ * The reason of the status. Possible values are: - Authentication_Completed_Or_Skipped_Sucessfully - Pending_Authentication
+ * @member {String} reason
+ */
+ exports.prototype['reason'] = undefined;
+ /**
+ * The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * @member {module:model/Ptsv2payoutsClientReferenceInformation} clientReferenceInformation
+ */
+ exports.prototype['clientReferenceInformation'] = undefined;
+ /**
+ * @member {module:model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation} consumerAuthenticationInformation
+ */
+ exports.prototype['consumerAuthenticationInformation'] = undefined;
+ /**
+ * @member {module:model/PtsV2PaymentsPost201ResponseErrorInformation} errorInformation
+ */
+ exports.prototype['errorInformation'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.js b/src/model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.js
new file mode 100644
index 00000000..cfadae5b
--- /dev/null
+++ b/src/model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.js
@@ -0,0 +1,181 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation model module.
+ * @module model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.
+ * @alias module:model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation} The populated RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('authenticationResult')) {
+ obj['authenticationResult'] = ApiClient.convertToType(data['authenticationResult'], 'String');
+ }
+ if (data.hasOwnProperty('authenticationStatusMsg')) {
+ obj['authenticationStatusMsg'] = ApiClient.convertToType(data['authenticationStatusMsg'], 'String');
+ }
+ if (data.hasOwnProperty('cavv')) {
+ obj['cavv'] = ApiClient.convertToType(data['cavv'], 'String');
+ }
+ if (data.hasOwnProperty('cavvAlgorithm')) {
+ obj['cavvAlgorithm'] = ApiClient.convertToType(data['cavvAlgorithm'], 'String');
+ }
+ if (data.hasOwnProperty('indicator')) {
+ obj['indicator'] = ApiClient.convertToType(data['indicator'], 'String');
+ }
+ if (data.hasOwnProperty('eci')) {
+ obj['eci'] = ApiClient.convertToType(data['eci'], 'String');
+ }
+ if (data.hasOwnProperty('eciRaw')) {
+ obj['eciRaw'] = ApiClient.convertToType(data['eciRaw'], 'String');
+ }
+ if (data.hasOwnProperty('paresStatus')) {
+ obj['paresStatus'] = ApiClient.convertToType(data['paresStatus'], 'String');
+ }
+ if (data.hasOwnProperty('specificationVersion')) {
+ obj['specificationVersion'] = ApiClient.convertToType(data['specificationVersion'], 'String');
+ }
+ if (data.hasOwnProperty('ucafAuthenticationData')) {
+ obj['ucafAuthenticationData'] = ApiClient.convertToType(data['ucafAuthenticationData'], 'String');
+ }
+ if (data.hasOwnProperty('ucafCollectionIndicator')) {
+ obj['ucafCollectionIndicator'] = ApiClient.convertToType(data['ucafCollectionIndicator'], 'Number');
+ }
+ if (data.hasOwnProperty('xid')) {
+ obj['xid'] = ApiClient.convertToType(data['xid'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication.
+ * @member {String} authenticationResult
+ */
+ exports.prototype['authenticationResult'] = undefined;
+ /**
+ * Message that explains the authenticationResult reply field.
+ * @member {String} authenticationStatusMsg
+ */
+ exports.prototype['authenticationStatusMsg'] = undefined;
+ /**
+ * Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor.
+ * @member {String} cavv
+ */
+ exports.prototype['cavv'] = undefined;
+ /**
+ * Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard
+ * @member {String} cavvAlgorithm
+ */
+ exports.prototype['cavvAlgorithm'] = undefined;
+ /**
+ * Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard SecureCode authentication verified successfully. - `spa_failure`: Mastercard SecureCode failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable.
+ * @member {String} indicator
+ */
+ exports.prototype['indicator'] = undefined;
+ /**
+ * Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.)
+ * @member {String} eci
+ */
+ exports.prototype['eci'] = undefined;
+ /**
+ * ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)
+ * @member {String} eciRaw
+ */
+ exports.prototype['eciRaw'] = undefined;
+ /**
+ * Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `B`: Bypassed authentication. - `N`: Customer failed or canceled authentication. Transaction denied. - `R`: Authentication rejected (used for 3D Secure 2.0 transactions only) - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated.
+ * @member {String} paresStatus
+ */
+ exports.prototype['paresStatus'] = undefined;
+ /**
+ * This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.
+ * @member {String} specificationVersion
+ */
+ exports.prototype['specificationVersion'] = undefined;
+ /**
+ * AAV is a unique identifier generated by the cardissuing bank for Mastercard SecureCode transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request.
+ * @member {String} ucafAuthenticationData
+ */
+ exports.prototype['ucafAuthenticationData'] = undefined;
+ /**
+ * For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard SecureCode transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication.
+ * @member {Number} ucafCollectionIndicator
+ */
+ exports.prototype['ucafCollectionIndicator'] = undefined;
+ /**
+ * Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`)
+ * @member {String} xid
+ */
+ exports.prototype['xid'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationsPost201Response.js b/src/model/RiskV1AuthenticationsPost201Response.js
new file mode 100644
index 00000000..af4aef9c
--- /dev/null
+++ b/src/model/RiskV1AuthenticationsPost201Response.js
@@ -0,0 +1,167 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/PtsV2PaymentsPost201ResponseErrorInformation', 'model/PtsV2PaymentsReversalsPost201ResponseLinks', 'model/Ptsv2payoutsClientReferenceInformation', 'model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation', 'model/RiskV1AuthenticationsPost201ResponseOrderInformation'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./PtsV2PaymentsPost201ResponseErrorInformation'), require('./PtsV2PaymentsReversalsPost201ResponseLinks'), require('./Ptsv2payoutsClientReferenceInformation'), require('./RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation'), require('./RiskV1AuthenticationsPost201ResponseOrderInformation'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationsPost201Response = factory(root.CyberSource.ApiClient, root.CyberSource.PtsV2PaymentsPost201ResponseErrorInformation, root.CyberSource.PtsV2PaymentsReversalsPost201ResponseLinks, root.CyberSource.Ptsv2payoutsClientReferenceInformation, root.CyberSource.RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation, root.CyberSource.RiskV1AuthenticationsPost201ResponseOrderInformation);
+ }
+}(this, function(ApiClient, PtsV2PaymentsPost201ResponseErrorInformation, PtsV2PaymentsReversalsPost201ResponseLinks, Ptsv2payoutsClientReferenceInformation, RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation, RiskV1AuthenticationsPost201ResponseOrderInformation) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationsPost201Response model module.
+ * @module model/RiskV1AuthenticationsPost201Response
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationsPost201Response.
+ * @alias module:model/RiskV1AuthenticationsPost201Response
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationsPost201Response from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationsPost201Response} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationsPost201Response} The populated RiskV1AuthenticationsPost201Response instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('_links')) {
+ obj['_links'] = PtsV2PaymentsReversalsPost201ResponseLinks.constructFromObject(data['_links']);
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('submitTimeUtc')) {
+ obj['submitTimeUtc'] = ApiClient.convertToType(data['submitTimeUtc'], 'String');
+ }
+ if (data.hasOwnProperty('submitTimeLocal')) {
+ obj['submitTimeLocal'] = ApiClient.convertToType(data['submitTimeLocal'], 'String');
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('reason')) {
+ obj['reason'] = ApiClient.convertToType(data['reason'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('clientReferenceInformation')) {
+ obj['clientReferenceInformation'] = Ptsv2payoutsClientReferenceInformation.constructFromObject(data['clientReferenceInformation']);
+ }
+ if (data.hasOwnProperty('orderInformation')) {
+ obj['orderInformation'] = RiskV1AuthenticationsPost201ResponseOrderInformation.constructFromObject(data['orderInformation']);
+ }
+ if (data.hasOwnProperty('consumerAuthenticationInformation')) {
+ obj['consumerAuthenticationInformation'] = RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation.constructFromObject(data['consumerAuthenticationInformation']);
+ }
+ if (data.hasOwnProperty('errorInformation')) {
+ obj['errorInformation'] = PtsV2PaymentsPost201ResponseErrorInformation.constructFromObject(data['errorInformation']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/PtsV2PaymentsReversalsPost201ResponseLinks} _links
+ */
+ exports.prototype['_links'] = undefined;
+ /**
+ * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.
+ * @member {String} id
+ */
+ exports.prototype['id'] = undefined;
+ /**
+ * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.
+ * @member {String} submitTimeUtc
+ */
+ exports.prototype['submitTimeUtc'] = undefined;
+ /**
+ * Time that the transaction was submitted in local time.
+ * @member {String} submitTimeLocal
+ */
+ exports.prototype['submitTimeLocal'] = undefined;
+ /**
+ * The status for payerAuthentication 201 enroll and validate calls. Possible values are: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION
+ * @member {String} status
+ */
+ exports.prototype['status'] = undefined;
+ /**
+ * The reason of the status. Possible values are: - Authentication_Completed_Or_Skipped_Sucessfully - Pending_Authentication
+ * @member {String} reason
+ */
+ exports.prototype['reason'] = undefined;
+ /**
+ * The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * @member {module:model/Ptsv2payoutsClientReferenceInformation} clientReferenceInformation
+ */
+ exports.prototype['clientReferenceInformation'] = undefined;
+ /**
+ * @member {module:model/RiskV1AuthenticationsPost201ResponseOrderInformation} orderInformation
+ */
+ exports.prototype['orderInformation'] = undefined;
+ /**
+ * @member {module:model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation} consumerAuthenticationInformation
+ */
+ exports.prototype['consumerAuthenticationInformation'] = undefined;
+ /**
+ * @member {module:model/PtsV2PaymentsPost201ResponseErrorInformation} errorInformation
+ */
+ exports.prototype['errorInformation'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation.js b/src/model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation.js
new file mode 100644
index 00000000..99e48638
--- /dev/null
+++ b/src/model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation.js
@@ -0,0 +1,235 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation model module.
+ * @module model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation.
+ * @alias module:model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation} The populated RiskV1AuthenticationsPost201ResponseConsumerAuthenticationInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('acsUrl')) {
+ obj['acsUrl'] = ApiClient.convertToType(data['acsUrl'], 'String');
+ }
+ if (data.hasOwnProperty('authenticationPath')) {
+ obj['authenticationPath'] = ApiClient.convertToType(data['authenticationPath'], 'String');
+ }
+ if (data.hasOwnProperty('authenticationTransactionId')) {
+ obj['authenticationTransactionId'] = ApiClient.convertToType(data['authenticationTransactionId'], 'String');
+ }
+ if (data.hasOwnProperty('cavv')) {
+ obj['cavv'] = ApiClient.convertToType(data['cavv'], 'String');
+ }
+ if (data.hasOwnProperty('cavvAlgorithm')) {
+ obj['cavvAlgorithm'] = ApiClient.convertToType(data['cavvAlgorithm'], 'String');
+ }
+ if (data.hasOwnProperty('challengeRequired')) {
+ obj['challengeRequired'] = ApiClient.convertToType(data['challengeRequired'], 'Boolean');
+ }
+ if (data.hasOwnProperty('ecommerceIndicator')) {
+ obj['ecommerceIndicator'] = ApiClient.convertToType(data['ecommerceIndicator'], 'String');
+ }
+ if (data.hasOwnProperty('eci')) {
+ obj['eci'] = ApiClient.convertToType(data['eci'], 'String');
+ }
+ if (data.hasOwnProperty('eciRaw')) {
+ obj['eciRaw'] = ApiClient.convertToType(data['eciRaw'], 'String');
+ }
+ if (data.hasOwnProperty('pareq')) {
+ obj['pareq'] = ApiClient.convertToType(data['pareq'], 'String');
+ }
+ if (data.hasOwnProperty('paresStatus')) {
+ obj['paresStatus'] = ApiClient.convertToType(data['paresStatus'], 'String');
+ }
+ if (data.hasOwnProperty('proofXml')) {
+ obj['proofXml'] = ApiClient.convertToType(data['proofXml'], 'String');
+ }
+ if (data.hasOwnProperty('proxyPan')) {
+ obj['proxyPan'] = ApiClient.convertToType(data['proxyPan'], 'String');
+ }
+ if (data.hasOwnProperty('specificationVersion')) {
+ obj['specificationVersion'] = ApiClient.convertToType(data['specificationVersion'], 'String');
+ }
+ if (data.hasOwnProperty('ucafAuthenticationData')) {
+ obj['ucafAuthenticationData'] = ApiClient.convertToType(data['ucafAuthenticationData'], 'String');
+ }
+ if (data.hasOwnProperty('ucafCollectionIndicator')) {
+ obj['ucafCollectionIndicator'] = ApiClient.convertToType(data['ucafCollectionIndicator'], 'Number');
+ }
+ if (data.hasOwnProperty('veresEnrolled')) {
+ obj['veresEnrolled'] = ApiClient.convertToType(data['veresEnrolled'], 'String');
+ }
+ if (data.hasOwnProperty('xid')) {
+ obj['xid'] = ApiClient.convertToType(data['xid'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * URL for the card-issuing bank’s authentication form that you receive when the card is enrolled. The value can be very large.
+ * @member {String} acsUrl
+ */
+ exports.prototype['acsUrl'] = undefined;
+ /**
+ * Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer’s authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ * @member {String} authenticationPath
+ */
+ exports.prototype['authenticationPath'] = undefined;
+ /**
+ * Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.
+ * @member {String} authenticationTransactionId
+ */
+ exports.prototype['authenticationTransactionId'] = undefined;
+ /**
+ * Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor.
+ * @member {String} cavv
+ */
+ exports.prototype['cavv'] = undefined;
+ /**
+ * Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard
+ * @member {String} cavvAlgorithm
+ */
+ exports.prototype['cavvAlgorithm'] = undefined;
+ /**
+ * Indicates whether a challenge is required to complete authentication (region mandates).
+ * @member {Boolean} challengeRequired
+ */
+ exports.prototype['challengeRequired'] = undefined;
+ /**
+ * Commerce indicator for cards not enrolled. This field contains one of these values: - `internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa’s directory service is not available. No liability shift.
+ * @member {String} ecommerceIndicator
+ */
+ exports.prototype['ecommerceIndicator'] = undefined;
+ /**
+ * Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see \"Interpreting the Reply,\" page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.)
+ * @member {String} eci
+ */
+ exports.prototype['eci'] = undefined;
+ /**
+ * ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)
+ * @member {String} eciRaw
+ */
+ exports.prototype['eciRaw'] = undefined;
+ /**
+ * Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64.
+ * @member {String} pareq
+ */
+ exports.prototype['pareq'] = undefined;
+ /**
+ * Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `B`: Bypassed authentication. - `N`: Customer failed or canceled authentication. Transaction denied. - `R`: Authentication rejected (used for 3D Secure 2.0 transactions only) - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated.
+ * @member {String} paresStatus
+ */
+ exports.prototype['paresStatus'] = undefined;
+ /**
+ * Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.
+ * @member {String} proofXml
+ */
+ exports.prototype['proofXml'] = undefined;
+ /**
+ * Encrypted version of the card number used in the payer authentication request message.
+ * @member {String} proxyPan
+ */
+ exports.prototype['proxyPan'] = undefined;
+ /**
+ * This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.
+ * @member {String} specificationVersion
+ */
+ exports.prototype['specificationVersion'] = undefined;
+ /**
+ * AAV is a unique identifier generated by the cardissuing bank for Mastercard SecureCode transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request.
+ * @member {String} ucafAuthenticationData
+ */
+ exports.prototype['ucafAuthenticationData'] = undefined;
+ /**
+ * For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard SecureCode transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication.
+ * @member {Number} ucafCollectionIndicator
+ */
+ exports.prototype['ucafCollectionIndicator'] = undefined;
+ /**
+ * Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ * @member {String} veresEnrolled
+ */
+ exports.prototype['veresEnrolled'] = undefined;
+ /**
+ * Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`)
+ * @member {String} xid
+ */
+ exports.prototype['xid'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationsPost201ResponseOrderInformation.js b/src/model/RiskV1AuthenticationsPost201ResponseOrderInformation.js
new file mode 100644
index 00000000..c052e780
--- /dev/null
+++ b/src/model/RiskV1AuthenticationsPost201ResponseOrderInformation.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationsPost201ResponseOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails);
+ }
+}(this, function(ApiClient, RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationsPost201ResponseOrderInformation model module.
+ * @module model/RiskV1AuthenticationsPost201ResponseOrderInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationsPost201ResponseOrderInformation.
+ * @alias module:model/RiskV1AuthenticationsPost201ResponseOrderInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationsPost201ResponseOrderInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationsPost201ResponseOrderInformation} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationsPost201ResponseOrderInformation} The populated RiskV1AuthenticationsPost201ResponseOrderInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('amountDetails')) {
+ obj['amountDetails'] = RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails.constructFromObject(data['amountDetails']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails} amountDetails
+ */
+ exports.prototype['amountDetails'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails.js b/src/model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails.js
new file mode 100644
index 00000000..b3552510
--- /dev/null
+++ b/src/model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails model module.
+ * @module model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails.
+ * @alias module:model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails} The populated RiskV1AuthenticationsPost201ResponseOrderInformationAmountDetails instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('currency')) {
+ obj['currency'] = ApiClient.convertToType(data['currency'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
+ * @member {String} currency
+ */
+ exports.prototype['currency'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1AuthenticationsPost400Response.js b/src/model/RiskV1AuthenticationsPost400Response.js
new file mode 100644
index 00000000..9501500f
--- /dev/null
+++ b/src/model/RiskV1AuthenticationsPost400Response.js
@@ -0,0 +1,117 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/PtsV2PaymentsPost201ResponseErrorInformationDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./PtsV2PaymentsPost201ResponseErrorInformationDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1AuthenticationsPost400Response = factory(root.CyberSource.ApiClient, root.CyberSource.PtsV2PaymentsPost201ResponseErrorInformationDetails);
+ }
+}(this, function(ApiClient, PtsV2PaymentsPost201ResponseErrorInformationDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1AuthenticationsPost400Response model module.
+ * @module model/RiskV1AuthenticationsPost400Response
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1AuthenticationsPost400Response.
+ * @alias module:model/RiskV1AuthenticationsPost400Response
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1AuthenticationsPost400Response from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1AuthenticationsPost400Response} obj Optional instance to populate.
+ * @return {module:model/RiskV1AuthenticationsPost400Response} The populated RiskV1AuthenticationsPost400Response instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('submitTimeUtc')) {
+ obj['submitTimeUtc'] = ApiClient.convertToType(data['submitTimeUtc'], 'String');
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('reason')) {
+ obj['reason'] = ApiClient.convertToType(data['reason'], 'String');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('details')) {
+ obj['details'] = ApiClient.convertToType(data['details'], [PtsV2PaymentsPost201ResponseErrorInformationDetails]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.
+ * @member {String} submitTimeUtc
+ */
+ exports.prototype['submitTimeUtc'] = undefined;
+ /**
+ * The status for payerAuthentication 201 enroll and validate calls. Value is: - AUTHENTICATION_FAILED
+ * @member {String} status
+ */
+ exports.prototype['status'] = undefined;
+ /**
+ * The reason of the status. Value is Failed_Authentication.
+ * @member {String} reason
+ */
+ exports.prototype['reason'] = undefined;
+ /**
+ * The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated.
+ * @member {String} message
+ */
+ exports.prototype['message'] = undefined;
+ /**
+ * @member {Array.RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.
+ * Constructs a new RiskV1DecisionsPost201ResponsePaymentInformation.
* Contains response information about the payment.
- * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation
+ * @alias module:model/RiskV1DecisionsPost201ResponsePaymentInformation
* @class
*/
var exports = function() {
@@ -56,11 +56,11 @@
};
/**
- * Constructs a RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation from a plain JavaScript object, optionally creating a new instance.
+ * Constructs a RiskV1DecisionsPost201ResponsePaymentInformation from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from data to obj if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation} obj Optional instance to populate.
- * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation} The populated RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation instance.
+ * @param {module:model/RiskV1DecisionsPost201ResponsePaymentInformation} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponsePaymentInformation} The populated RiskV1DecisionsPost201ResponsePaymentInformation instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
@@ -86,27 +86,27 @@
}
/**
- * Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center.
+ * Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} binCountry
*/
exports.prototype['binCountry'] = undefined;
/**
- * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type.
+ * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} accountType
*/
exports.prototype['accountType'] = undefined;
/**
- * Name of the bank or entity that issued the card account.
+ * Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} issuer
*/
exports.prototype['issuer'] = undefined;
/**
- * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron *Note:* Additional values may be present.
+ * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} scheme
*/
exports.prototype['scheme'] = undefined;
/**
- * Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field or from the first six characters of the `number` field.
+ * Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} bin
*/
exports.prototype['bin'] = undefined;
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformation.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformation.js
index 0419eab7..4b2c7008 100644
--- a/src/model/RiskV1DecisionsPost201ResponseRiskInformation.js
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformation.js
@@ -16,18 +16,18 @@
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
- define(['ApiClient', 'model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes', 'model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress', 'model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation', 'model/RiskV1DecisionsPost201ResponseRiskInformationProfile', 'model/RiskV1DecisionsPost201ResponseRiskInformationProviders', 'model/RiskV1DecisionsPost201ResponseRiskInformationRules', 'model/RiskV1DecisionsPost201ResponseRiskInformationScore', 'model/RiskV1DecisionsPost201ResponseRiskInformationVelocity'], factory);
+ define(['ApiClient', 'model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes', 'model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress', 'model/RiskV1DecisionsPost201ResponseRiskInformationProfile', 'model/RiskV1DecisionsPost201ResponseRiskInformationProviders', 'model/RiskV1DecisionsPost201ResponseRiskInformationRules', 'model/RiskV1DecisionsPost201ResponseRiskInformationScore', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravel', 'model/RiskV1DecisionsPost201ResponseRiskInformationVelocity'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
- module.exports = factory(require('../ApiClient'), require('./RiskV1DecisionsPost201ResponseRiskInformationInfoCodes'), require('./RiskV1DecisionsPost201ResponseRiskInformationIpAddress'), require('./RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation'), require('./RiskV1DecisionsPost201ResponseRiskInformationProfile'), require('./RiskV1DecisionsPost201ResponseRiskInformationProviders'), require('./RiskV1DecisionsPost201ResponseRiskInformationRules'), require('./RiskV1DecisionsPost201ResponseRiskInformationScore'), require('./RiskV1DecisionsPost201ResponseRiskInformationVelocity'));
+ module.exports = factory(require('../ApiClient'), require('./RiskV1DecisionsPost201ResponseRiskInformationInfoCodes'), require('./RiskV1DecisionsPost201ResponseRiskInformationIpAddress'), require('./RiskV1DecisionsPost201ResponseRiskInformationProfile'), require('./RiskV1DecisionsPost201ResponseRiskInformationProviders'), require('./RiskV1DecisionsPost201ResponseRiskInformationRules'), require('./RiskV1DecisionsPost201ResponseRiskInformationScore'), require('./RiskV1DecisionsPost201ResponseRiskInformationTravel'), require('./RiskV1DecisionsPost201ResponseRiskInformationVelocity'));
} else {
// Browser globals (root is window)
if (!root.CyberSource) {
root.CyberSource = {};
}
- root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformation = factory(root.CyberSource.ApiClient, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationIpAddress, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationProfile, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationProviders, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationRules, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationScore, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationVelocity);
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformation = factory(root.CyberSource.ApiClient, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationIpAddress, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationProfile, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationProviders, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationRules, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationScore, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravel, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationVelocity);
}
-}(this, function(ApiClient, RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, RiskV1DecisionsPost201ResponseRiskInformationIpAddress, RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation, RiskV1DecisionsPost201ResponseRiskInformationProfile, RiskV1DecisionsPost201ResponseRiskInformationProviders, RiskV1DecisionsPost201ResponseRiskInformationRules, RiskV1DecisionsPost201ResponseRiskInformationScore, RiskV1DecisionsPost201ResponseRiskInformationVelocity) {
+}(this, function(ApiClient, RiskV1DecisionsPost201ResponseRiskInformationInfoCodes, RiskV1DecisionsPost201ResponseRiskInformationIpAddress, RiskV1DecisionsPost201ResponseRiskInformationProfile, RiskV1DecisionsPost201ResponseRiskInformationProviders, RiskV1DecisionsPost201ResponseRiskInformationRules, RiskV1DecisionsPost201ResponseRiskInformationScore, RiskV1DecisionsPost201ResponseRiskInformationTravel, RiskV1DecisionsPost201ResponseRiskInformationVelocity) {
'use strict';
@@ -89,9 +89,6 @@
if (data.hasOwnProperty('localTime')) {
obj['localTime'] = ApiClient.convertToType(data['localTime'], 'String');
}
- if (data.hasOwnProperty('paymentInformation')) {
- obj['paymentInformation'] = RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.constructFromObject(data['paymentInformation']);
- }
if (data.hasOwnProperty('score')) {
obj['score'] = RiskV1DecisionsPost201ResponseRiskInformationScore.constructFromObject(data['score']);
}
@@ -101,6 +98,9 @@
if (data.hasOwnProperty('providers')) {
obj['providers'] = RiskV1DecisionsPost201ResponseRiskInformationProviders.constructFromObject(data['providers']);
}
+ if (data.hasOwnProperty('travel')) {
+ obj['travel'] = RiskV1DecisionsPost201ResponseRiskInformationTravel.constructFromObject(data['travel']);
+ }
}
return obj;
}
@@ -122,19 +122,15 @@
*/
exports.prototype['velocity'] = undefined;
/**
- * You receive this field only if you subscribe to the Enhanced Case Management service. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\".
+ * You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order. For all possible values, see the `decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {Number} casePriority
*/
exports.prototype['casePriority'] = undefined;
/**
- * The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the customer's billing address.
+ * The customer's local time (`hh:mm:ss`), which is calculated from the transaction request time and the customer's billing address. For details, see the `score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/)
* @member {String} localTime
*/
exports.prototype['localTime'] = undefined;
- /**
- * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation} paymentInformation
- */
- exports.prototype['paymentInformation'] = undefined;
/**
* @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationScore} score
*/
@@ -147,6 +143,10 @@
* @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationProviders} providers
*/
exports.prototype['providers'] = undefined;
+ /**
+ * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravel} travel
+ */
+ exports.prototype['travel'] = undefined;
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.js
index 871c83de..71e8fa57 100644
--- a/src/model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.js
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.js
@@ -97,42 +97,42 @@
}
/**
- * List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules.
+ * List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. For all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {Array.RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.
- * Name of the 3rd party provider, for example, Emailage.
+ * Name of the 3rd party provider, for example, Emailage. For all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName
* @class
*/
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationScore.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationScore.js
index 4231b164..7baf2ebc 100644
--- a/src/model/RiskV1DecisionsPost201ResponseRiskInformationScore.js
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationScore.js
@@ -81,12 +81,12 @@
*/
exports.prototype['factorCodes'] = undefined;
/**
- * Name of the score model used for the transaction. If you did not include a custom model in your request, this field contains the name of CyberSource’s default model.
+ * Name of the score model used for the transaction. If you did not include a custom model in your request, this field contains the name of CyberSource’s default model. For all possible values, see the `score_model_used` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} modelUsed
*/
exports.prototype['modelUsed'] = undefined;
/**
- * Total score calculated for this order. The value cannot be negative.
+ * Total score calculated for this order. The value cannot be negative. For all possible values, see the `score_score_result` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {String} result
*/
exports.prototype['result'] = undefined;
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravel.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravel.js
new file mode 100644
index 00000000..c68bb3c8
--- /dev/null
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravel.js
@@ -0,0 +1,105 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination', 'model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination'), require('./RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture'), require('./RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination'), require('./RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravel = factory(root.CyberSource.ApiClient, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination, root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination);
+ }
+}(this, function(ApiClient, RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination, RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture, RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination, RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1DecisionsPost201ResponseRiskInformationTravel model module.
+ * @module model/RiskV1DecisionsPost201ResponseRiskInformationTravel
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1DecisionsPost201ResponseRiskInformationTravel.
+ * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationTravel
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1DecisionsPost201ResponseRiskInformationTravel from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravel} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravel} The populated RiskV1DecisionsPost201ResponseRiskInformationTravel instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('actualFinalDestination')) {
+ obj['actualFinalDestination'] = RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.constructFromObject(data['actualFinalDestination']);
+ }
+ if (data.hasOwnProperty('firstDeparture')) {
+ obj['firstDeparture'] = RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.constructFromObject(data['firstDeparture']);
+ }
+ if (data.hasOwnProperty('firstDestination')) {
+ obj['firstDestination'] = RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.constructFromObject(data['firstDestination']);
+ }
+ if (data.hasOwnProperty('lastDestination')) {
+ obj['lastDestination'] = RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.constructFromObject(data['lastDestination']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination} actualFinalDestination
+ */
+ exports.prototype['actualFinalDestination'] = undefined;
+ /**
+ * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture} firstDeparture
+ */
+ exports.prototype['firstDeparture'] = undefined;
+ /**
+ * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination} firstDestination
+ */
+ exports.prototype['firstDestination'] = undefined;
+ /**
+ * @member {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination} lastDestination
+ */
+ exports.prototype['lastDestination'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.js
new file mode 100644
index 00000000..1902b165
--- /dev/null
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.js
@@ -0,0 +1,109 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination model module.
+ * @module model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.
+ * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination} The populated RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('latitude')) {
+ obj['latitude'] = ApiClient.convertToType(data['latitude'], 'String');
+ }
+ if (data.hasOwnProperty('longitude')) {
+ obj['longitude'] = ApiClient.convertToType(data['longitude'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Country of actual final destination on the route.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * City of actual final destination on the route.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * Latitude of actual final destination on the route.
+ * @member {String} latitude
+ */
+ exports.prototype['latitude'] = undefined;
+ /**
+ * Longitude of actual final destination on the route.
+ * @member {String} longitude
+ */
+ exports.prototype['longitude'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.js
new file mode 100644
index 00000000..5206f308
--- /dev/null
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.js
@@ -0,0 +1,109 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture model module.
+ * @module model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.
+ * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture} The populated RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('latitude')) {
+ obj['latitude'] = ApiClient.convertToType(data['latitude'], 'String');
+ }
+ if (data.hasOwnProperty('longitude')) {
+ obj['longitude'] = ApiClient.convertToType(data['longitude'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Country of first departure on the route.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * City of first departure on the route.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * Latitude of first departure on the route.
+ * @member {String} latitude
+ */
+ exports.prototype['latitude'] = undefined;
+ /**
+ * Longitude of first departure on the route.
+ * @member {String} longitude
+ */
+ exports.prototype['longitude'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.js
new file mode 100644
index 00000000..9379e8a9
--- /dev/null
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.js
@@ -0,0 +1,109 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination model module.
+ * @module model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.
+ * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination} The populated RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('latitude')) {
+ obj['latitude'] = ApiClient.convertToType(data['latitude'], 'String');
+ }
+ if (data.hasOwnProperty('longitude')) {
+ obj['longitude'] = ApiClient.convertToType(data['longitude'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Country of first destination on the route.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * City of first destination on the route.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * Latitude of first destination on the route.
+ * @member {String} latitude
+ */
+ exports.prototype['latitude'] = undefined;
+ /**
+ * Longitude of first destination on the route.
+ * @member {String} longitude
+ */
+ exports.prototype['longitude'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.js
new file mode 100644
index 00000000..68b6ba31
--- /dev/null
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.js
@@ -0,0 +1,109 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination model module.
+ * @module model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.
+ * @alias module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination} obj Optional instance to populate.
+ * @return {module:model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination} The populated RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('latitude')) {
+ obj['latitude'] = ApiClient.convertToType(data['latitude'], 'String');
+ }
+ if (data.hasOwnProperty('longitude')) {
+ obj['longitude'] = ApiClient.convertToType(data['longitude'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Country of last destination on the route.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * City of last destination on the route.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * Latitude of last destination on the route.
+ * @member {String} latitude
+ */
+ exports.prototype['latitude'] = undefined;
+ /**
+ * Longitude of last destination on the route.
+ * @member {String} longitude
+ */
+ exports.prototype['longitude'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.js b/src/model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.js
index 3b7be6d2..4a2eecc3 100644
--- a/src/model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.js
+++ b/src/model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.js
@@ -73,6 +73,7 @@
}
/**
+ * List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. For all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
* @member {Array.Riskv1authenticationresultsConsumerAuthenticationInformation.
+ * @alias module:model/Riskv1authenticationresultsConsumerAuthenticationInformation
+ * @class
+ * @param signedPares {String} Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see \"Storing Payer Authentication Data,\" page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request.
+ */
+ var exports = function(signedPares) {
+ var _this = this;
+
+
+ _this['signedPares'] = signedPares;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsConsumerAuthenticationInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsConsumerAuthenticationInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsConsumerAuthenticationInformation} The populated Riskv1authenticationresultsConsumerAuthenticationInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('authenticationTransactionId')) {
+ obj['authenticationTransactionId'] = ApiClient.convertToType(data['authenticationTransactionId'], 'String');
+ }
+ if (data.hasOwnProperty('signedPares')) {
+ obj['signedPares'] = ApiClient.convertToType(data['signedPares'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages. **Note**: Required for Standard integration for enroll service. Required for Hybrid integration for validate service.
+ * @member {String} authenticationTransactionId
+ */
+ exports.prototype['authenticationTransactionId'] = undefined;
+ /**
+ * Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see \"Storing Payer Authentication Data,\" page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request.
+ * @member {String} signedPares
+ */
+ exports.prototype['signedPares'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationresultsOrderInformation.js b/src/model/Riskv1authenticationresultsOrderInformation.js
new file mode 100644
index 00000000..338f2cf4
--- /dev/null
+++ b/src/model/Riskv1authenticationresultsOrderInformation.js
@@ -0,0 +1,89 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationresultsOrderInformationLineItems', 'model/Riskv1decisionsOrderInformationAmountDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationresultsOrderInformationLineItems'), require('./Riskv1decisionsOrderInformationAmountDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationresultsOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationresultsOrderInformationLineItems, root.CyberSource.Riskv1decisionsOrderInformationAmountDetails);
+ }
+}(this, function(ApiClient, Riskv1authenticationresultsOrderInformationLineItems, Riskv1decisionsOrderInformationAmountDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationresultsOrderInformation model module.
+ * @module model/Riskv1authenticationresultsOrderInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationresultsOrderInformation.
+ * @alias module:model/Riskv1authenticationresultsOrderInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsOrderInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsOrderInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsOrderInformation} The populated Riskv1authenticationresultsOrderInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('amountDetails')) {
+ obj['amountDetails'] = Riskv1decisionsOrderInformationAmountDetails.constructFromObject(data['amountDetails']);
+ }
+ if (data.hasOwnProperty('lineItems')) {
+ obj['lineItems'] = ApiClient.convertToType(data['lineItems'], [Riskv1authenticationresultsOrderInformationLineItems]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1decisionsOrderInformationAmountDetails} amountDetails
+ */
+ exports.prototype['amountDetails'] = undefined;
+ /**
+ * @member {Array.Riskv1authenticationresultsOrderInformationLineItems.
+ * @alias module:model/Riskv1authenticationresultsOrderInformationLineItems
+ * @class
+ * @param unitPrice {String} Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ */
+ var exports = function(unitPrice) {
+ var _this = this;
+
+ _this['unitPrice'] = unitPrice;
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsOrderInformationLineItems from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsOrderInformationLineItems} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsOrderInformationLineItems} The populated Riskv1authenticationresultsOrderInformationLineItems instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('unitPrice')) {
+ obj['unitPrice'] = ApiClient.convertToType(data['unitPrice'], 'String');
+ }
+ if (data.hasOwnProperty('quantity')) {
+ obj['quantity'] = ApiClient.convertToType(data['quantity'], 'Number');
+ }
+ if (data.hasOwnProperty('taxAmount')) {
+ obj['taxAmount'] = ApiClient.convertToType(data['taxAmount'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ * @member {String} unitPrice
+ */
+ exports.prototype['unitPrice'] = undefined;
+ /**
+ * Number of units for this order. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is \"gift_card\", this is the total count of individual prepaid gift cards purchased.
+ * @member {Number} quantity
+ */
+ exports.prototype['quantity'] = undefined;
+ /**
+ * Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. This field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.
+ * @member {String} taxAmount
+ */
+ exports.prototype['taxAmount'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationresultsPaymentInformation.js b/src/model/Riskv1authenticationresultsPaymentInformation.js
new file mode 100644
index 00000000..96b8e4e5
--- /dev/null
+++ b/src/model/Riskv1authenticationresultsPaymentInformation.js
@@ -0,0 +1,89 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationresultsPaymentInformationCard', 'model/Riskv1authenticationresultsPaymentInformationTokenizedCard'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationresultsPaymentInformationCard'), require('./Riskv1authenticationresultsPaymentInformationTokenizedCard'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationresultsPaymentInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationresultsPaymentInformationCard, root.CyberSource.Riskv1authenticationresultsPaymentInformationTokenizedCard);
+ }
+}(this, function(ApiClient, Riskv1authenticationresultsPaymentInformationCard, Riskv1authenticationresultsPaymentInformationTokenizedCard) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationresultsPaymentInformation model module.
+ * @module model/Riskv1authenticationresultsPaymentInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationresultsPaymentInformation.
+ * @alias module:model/Riskv1authenticationresultsPaymentInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsPaymentInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsPaymentInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsPaymentInformation} The populated Riskv1authenticationresultsPaymentInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = Riskv1authenticationresultsPaymentInformationCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('tokenizedCard')) {
+ obj['tokenizedCard'] = Riskv1authenticationresultsPaymentInformationTokenizedCard.constructFromObject(data['tokenizedCard']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationresultsPaymentInformationCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationresultsPaymentInformationTokenizedCard} tokenizedCard
+ */
+ exports.prototype['tokenizedCard'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationresultsPaymentInformationCard.js b/src/model/Riskv1authenticationresultsPaymentInformationCard.js
new file mode 100644
index 00000000..ad57a686
--- /dev/null
+++ b/src/model/Riskv1authenticationresultsPaymentInformationCard.js
@@ -0,0 +1,110 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationresultsPaymentInformationCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationresultsPaymentInformationCard model module.
+ * @module model/Riskv1authenticationresultsPaymentInformationCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationresultsPaymentInformationCard.
+ * @alias module:model/Riskv1authenticationresultsPaymentInformationCard
+ * @class
+ * @param type {String} Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ */
+ var exports = function(type) {
+ var _this = this;
+
+ _this['type'] = type;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsPaymentInformationCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsPaymentInformationCard} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsPaymentInformationCard} The populated Riskv1authenticationresultsPaymentInformationCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('expirationMonth')) {
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('expirationYear')) {
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationMonth
+ */
+ exports.prototype['expirationMonth'] = undefined;
+ /**
+ * Four-digit year in which the credit card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationYear
+ */
+ exports.prototype['expirationYear'] = undefined;
+ /**
+ * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationresultsPaymentInformationTokenizedCard.js b/src/model/Riskv1authenticationresultsPaymentInformationTokenizedCard.js
new file mode 100644
index 00000000..efd2a7d8
--- /dev/null
+++ b/src/model/Riskv1authenticationresultsPaymentInformationTokenizedCard.js
@@ -0,0 +1,110 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationresultsPaymentInformationTokenizedCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationresultsPaymentInformationTokenizedCard model module.
+ * @module model/Riskv1authenticationresultsPaymentInformationTokenizedCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationresultsPaymentInformationTokenizedCard.
+ * @alias module:model/Riskv1authenticationresultsPaymentInformationTokenizedCard
+ * @class
+ * @param type {String} Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ */
+ var exports = function(type) {
+ var _this = this;
+
+ _this['type'] = type;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationresultsPaymentInformationTokenizedCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationresultsPaymentInformationTokenizedCard} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationresultsPaymentInformationTokenizedCard} The populated Riskv1authenticationresultsPaymentInformationTokenizedCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('expirationMonth')) {
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('expirationYear')) {
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationMonth
+ */
+ exports.prototype['expirationMonth'] = undefined;
+ /**
+ * One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationYear
+ */
+ exports.prototype['expirationYear'] = undefined;
+ /**
+ * Customer’s payment network token value.
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsBuyerInformation.js b/src/model/Riskv1authenticationsBuyerInformation.js
new file mode 100644
index 00000000..f7d88e56
--- /dev/null
+++ b/src/model/Riskv1authenticationsBuyerInformation.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Ptsv2paymentsBuyerInformationPersonalIdentification'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsBuyerInformationPersonalIdentification'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsBuyerInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsBuyerInformationPersonalIdentification);
+ }
+}(this, function(ApiClient, Ptsv2paymentsBuyerInformationPersonalIdentification) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsBuyerInformation model module.
+ * @module model/Riskv1authenticationsBuyerInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsBuyerInformation.
+ * @alias module:model/Riskv1authenticationsBuyerInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsBuyerInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsBuyerInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsBuyerInformation} The populated Riskv1authenticationsBuyerInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('personalIdentification')) {
+ obj['personalIdentification'] = ApiClient.convertToType(data['personalIdentification'], [Ptsv2paymentsBuyerInformationPersonalIdentification]);
+ }
+ if (data.hasOwnProperty('mobilePhone')) {
+ obj['mobilePhone'] = ApiClient.convertToType(data['mobilePhone'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * This array contains detailed information about the buyer's form of persoanl identification.
+ * @member {Array.Riskv1authenticationsClientReferenceInformation.
+ * @alias module:model/Riskv1authenticationsClientReferenceInformation
+ * @class
+ * @param code {String} Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
+ */
+ var exports = function(code) {
+ var _this = this;
+
+ _this['code'] = code;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsClientReferenceInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsClientReferenceInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsClientReferenceInformation} The populated Riskv1authenticationsClientReferenceInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('code')) {
+ obj['code'] = ApiClient.convertToType(data['code'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
+ * @member {String} code
+ */
+ exports.prototype['code'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsConsumerAuthenticationInformation.js b/src/model/Riskv1authenticationsConsumerAuthenticationInformation.js
new file mode 100644
index 00000000..440d7c3e
--- /dev/null
+++ b/src/model/Riskv1authenticationsConsumerAuthenticationInformation.js
@@ -0,0 +1,247 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsConsumerAuthenticationInformation = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsConsumerAuthenticationInformation model module.
+ * @module model/Riskv1authenticationsConsumerAuthenticationInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsConsumerAuthenticationInformation.
+ * @alias module:model/Riskv1authenticationsConsumerAuthenticationInformation
+ * @class
+ * @param mcc {String} Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
+ * @param referenceId {String} Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
+ * @param transactionMode {String} Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `MOTO` - MOTO (Mail Order Telephone Order) - `RETAIL` - Retail - `ECOMMERCE` - eCommerce - `MOBILE` - Mobile Device - `TABLET` - Tablet
+ */
+ var exports = function(mcc, referenceId, transactionMode) {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+ _this['mcc'] = mcc;
+
+
+
+
+
+
+ _this['referenceId'] = referenceId;
+ _this['transactionMode'] = transactionMode;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsConsumerAuthenticationInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsConsumerAuthenticationInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsConsumerAuthenticationInformation} The populated Riskv1authenticationsConsumerAuthenticationInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('alternateAuthenticationData')) {
+ obj['alternateAuthenticationData'] = ApiClient.convertToType(data['alternateAuthenticationData'], 'String');
+ }
+ if (data.hasOwnProperty('alternateAuthenticationDate')) {
+ obj['alternateAuthenticationDate'] = ApiClient.convertToType(data['alternateAuthenticationDate'], 'String');
+ }
+ if (data.hasOwnProperty('alternateAuthenticationMethod')) {
+ obj['alternateAuthenticationMethod'] = ApiClient.convertToType(data['alternateAuthenticationMethod'], 'String');
+ }
+ if (data.hasOwnProperty('authenticationTransactionId')) {
+ obj['authenticationTransactionId'] = ApiClient.convertToType(data['authenticationTransactionId'], 'String');
+ }
+ if (data.hasOwnProperty('challengeCode')) {
+ obj['challengeCode'] = ApiClient.convertToType(data['challengeCode'], 'String');
+ }
+ if (data.hasOwnProperty('customerCardAlias')) {
+ obj['customerCardAlias'] = ApiClient.convertToType(data['customerCardAlias'], 'String');
+ }
+ if (data.hasOwnProperty('defaultCard')) {
+ obj['defaultCard'] = ApiClient.convertToType(data['defaultCard'], 'Boolean');
+ }
+ if (data.hasOwnProperty('installmentTotalCount')) {
+ obj['installmentTotalCount'] = ApiClient.convertToType(data['installmentTotalCount'], 'Number');
+ }
+ if (data.hasOwnProperty('marketingOptIn')) {
+ obj['marketingOptIn'] = ApiClient.convertToType(data['marketingOptIn'], 'Boolean');
+ }
+ if (data.hasOwnProperty('marketingSource')) {
+ obj['marketingSource'] = ApiClient.convertToType(data['marketingSource'], 'String');
+ }
+ if (data.hasOwnProperty('mcc')) {
+ obj['mcc'] = ApiClient.convertToType(data['mcc'], 'String');
+ }
+ if (data.hasOwnProperty('messageCategory')) {
+ obj['messageCategory'] = ApiClient.convertToType(data['messageCategory'], 'String');
+ }
+ if (data.hasOwnProperty('npaCode')) {
+ obj['npaCode'] = ApiClient.convertToType(data['npaCode'], 'String');
+ }
+ if (data.hasOwnProperty('overridePaymentMethod')) {
+ obj['overridePaymentMethod'] = ApiClient.convertToType(data['overridePaymentMethod'], 'String');
+ }
+ if (data.hasOwnProperty('productCode')) {
+ obj['productCode'] = ApiClient.convertToType(data['productCode'], 'String');
+ }
+ if (data.hasOwnProperty('requestorId')) {
+ obj['requestorId'] = ApiClient.convertToType(data['requestorId'], 'String');
+ }
+ if (data.hasOwnProperty('requestorName')) {
+ obj['requestorName'] = ApiClient.convertToType(data['requestorName'], 'String');
+ }
+ if (data.hasOwnProperty('referenceId')) {
+ obj['referenceId'] = ApiClient.convertToType(data['referenceId'], 'String');
+ }
+ if (data.hasOwnProperty('transactionMode')) {
+ obj['transactionMode'] = ApiClient.convertToType(data['transactionMode'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Data that documents and supports a specific authentication process.
+ * @member {String} alternateAuthenticationData
+ */
+ exports.prototype['alternateAuthenticationData'] = undefined;
+ /**
+ * Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM
+ * @member {String} alternateAuthenticationDate
+ */
+ exports.prototype['alternateAuthenticationDate'] = undefined;
+ /**
+ * Mechanism used by the cardholder to authenticate to the 3D Secure requestor. Possible values: - `01`: No authentication occurred - `02`: Login using merchant system credentials - `03`: Login using Federated ID - `04`: Login using FIDO Authenticator
+ * @member {String} alternateAuthenticationMethod
+ */
+ exports.prototype['alternateAuthenticationMethod'] = undefined;
+ /**
+ * Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages. **Note**: Required for Standard integration for enroll service. Required for Hybrid integration for validate service.
+ * @member {String} authenticationTransactionId
+ */
+ exports.prototype['authenticationTransactionId'] = undefined;
+ /**
+ * Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use For details, see `pa_challenge_code` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ * @member {String} challengeCode
+ */
+ exports.prototype['challengeCode'] = undefined;
+ /**
+ * An alias that uniquely identifies the customer's account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings.
+ * @member {String} customerCardAlias
+ */
+ exports.prototype['customerCardAlias'] = undefined;
+ /**
+ * Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy.
+ * @member {Boolean} defaultCard
+ */
+ exports.prototype['defaultCard'] = undefined;
+ /**
+ * An integer value greater than 1 indicating the max number of permitted authorizations for installment payments. **Note** This is required if the merchant and cardholder have agreed to installment payments.
+ * @member {Number} installmentTotalCount
+ */
+ exports.prototype['installmentTotalCount'] = undefined;
+ /**
+ * Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy.
+ * @member {Boolean} marketingOptIn
+ */
+ exports.prototype['marketingOptIn'] = undefined;
+ /**
+ * Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.
+ * @member {String} marketingSource
+ */
+ exports.prototype['marketingSource'] = undefined;
+ /**
+ * Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
+ * @member {String} mcc
+ */
+ exports.prototype['mcc'] = undefined;
+ /**
+ * Category of the message for a specific use case. Possible values: - `01`: PA- payment authentication - `02`: NPA- non-payment authentication - `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use
+ * @member {String} messageCategory
+ */
+ exports.prototype['messageCategory'] = undefined;
+ /**
+ * Non-Payer Authentication Indicator. Possible values: - `01`: Add card - `02`: Maintain card information - `03`: Cardholder verification for EMV token - `04-80` Reserved for EMVCo - `80-90` Reserved DS
+ * @member {String} npaCode
+ */
+ exports.prototype['npaCode'] = undefined;
+ /**
+ * Specifies the Brazilian payment account type used for the transaction. This field overrides other payment types that might be specified in the request. Use one of the following values for this field: - `NA`: Not applicable. Do not override other payment types that are specified in the request. - `CR`: Credit card. - `DB`: Debit card. - `VSAVR`: Visa Vale Refeicao - `VSAVA`: Visa Vale Alimentacao **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
+ * @member {String} overridePaymentMethod
+ */
+ exports.prototype['overridePaymentMethod'] = undefined;
+ /**
+ * Specifies the product code, which designates the type of transaction. Specify one of the following values for this field: - AIR: Airline purchase Important Required for American Express SafeKey (U.S.). - `ACC`: Accommodation Rental - `ACF`: Account funding - `CHA`: Check acceptance - `DIG`: Digital Goods - `DSP`: Cash Dispensing - `GAS`: Fuel - `GEN`: General Retail - `LUX`: Luxury Retail - `PAL`: Prepaid activation and load - `PHY`: Goods or services purchase - `QCT`: Quasi-cash transaction - `REN`: Car Rental - `RES`: Restaurant - `SVC`: Services - `TBD`: Other - `TRA`: Travel **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.
+ * @member {String} productCode
+ */
+ exports.prototype['productCode'] = undefined;
+ /**
+ * Cardinal's directory server assigned 3DS Requestor ID value
+ * @member {String} requestorId
+ */
+ exports.prototype['requestorId'] = undefined;
+ /**
+ * Cardinal's directory server assigned 3DS Requestor Name value
+ * @member {String} requestorName
+ */
+ exports.prototype['requestorName'] = undefined;
+ /**
+ * Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
+ * @member {String} referenceId
+ */
+ exports.prototype['referenceId'] = undefined;
+ /**
+ * Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `MOTO` - MOTO (Mail Order Telephone Order) - `RETAIL` - Retail - `ECOMMERCE` - eCommerce - `MOBILE` - Mobile Device - `TABLET` - Tablet
+ * @member {String} transactionMode
+ */
+ exports.prototype['transactionMode'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsDeviceInformation.js b/src/model/Riskv1authenticationsDeviceInformation.js
new file mode 100644
index 00000000..c1d7c1f6
--- /dev/null
+++ b/src/model/Riskv1authenticationsDeviceInformation.js
@@ -0,0 +1,117 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsDeviceInformationRawData'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsDeviceInformationRawData'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsDeviceInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsDeviceInformationRawData);
+ }
+}(this, function(ApiClient, Riskv1authenticationsDeviceInformationRawData) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsDeviceInformation model module.
+ * @module model/Riskv1authenticationsDeviceInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsDeviceInformation.
+ * @alias module:model/Riskv1authenticationsDeviceInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsDeviceInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsDeviceInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsDeviceInformation} The populated Riskv1authenticationsDeviceInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('ipAddress')) {
+ obj['ipAddress'] = ApiClient.convertToType(data['ipAddress'], 'String');
+ }
+ if (data.hasOwnProperty('rawData')) {
+ obj['rawData'] = ApiClient.convertToType(data['rawData'], [Riskv1authenticationsDeviceInformationRawData]);
+ }
+ if (data.hasOwnProperty('httpAcceptBrowserValue')) {
+ obj['httpAcceptBrowserValue'] = ApiClient.convertToType(data['httpAcceptBrowserValue'], 'String');
+ }
+ if (data.hasOwnProperty('httpAcceptContent')) {
+ obj['httpAcceptContent'] = ApiClient.convertToType(data['httpAcceptContent'], 'String');
+ }
+ if (data.hasOwnProperty('userAgentBrowserValue')) {
+ obj['userAgentBrowserValue'] = ApiClient.convertToType(data['userAgentBrowserValue'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * IP address of the customer.
+ * @member {String} ipAddress
+ */
+ exports.prototype['ipAddress'] = undefined;
+ /**
+ * @member {Array.Riskv1authenticationsDeviceInformationRawData.
+ * @alias module:model/Riskv1authenticationsDeviceInformationRawData
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsDeviceInformationRawData from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsDeviceInformationRawData} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsDeviceInformationRawData} The populated Riskv1authenticationsDeviceInformationRawData instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('data')) {
+ obj['data'] = ApiClient.convertToType(data['data'], 'String');
+ }
+ if (data.hasOwnProperty('provider')) {
+ obj['provider'] = ApiClient.convertToType(data['provider'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Field that contains the device fingerprint data from the specified provider. The value should be Base64 encoded.
+ * @member {String} data
+ */
+ exports.prototype['data'] = undefined;
+ /**
+ * Possible values: - cardinal - inauth - threatmetrix
+ * @member {String} provider
+ */
+ exports.prototype['provider'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsMerchantInformation.js b/src/model/Riskv1authenticationsMerchantInformation.js
new file mode 100644
index 00000000..2d70652f
--- /dev/null
+++ b/src/model/Riskv1authenticationsMerchantInformation.js
@@ -0,0 +1,82 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsMerchantInformation = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsMerchantInformation model module.
+ * @module model/Riskv1authenticationsMerchantInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsMerchantInformation.
+ * @alias module:model/Riskv1authenticationsMerchantInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsMerchantInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsMerchantInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsMerchantInformation} The populated Riskv1authenticationsMerchantInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('merchantName')) {
+ obj['merchantName'] = ApiClient.convertToType(data['merchantName'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank.
+ * @member {String} merchantName
+ */
+ exports.prototype['merchantName'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsOrderInformation.js b/src/model/Riskv1authenticationsOrderInformation.js
new file mode 100644
index 00000000..ca5c7450
--- /dev/null
+++ b/src/model/Riskv1authenticationsOrderInformation.js
@@ -0,0 +1,133 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsOrderInformationBillTo', 'model/Riskv1authenticationsOrderInformationLineItems', 'model/Riskv1authenticationsOrderInformationShipTo', 'model/Riskv1decisionsOrderInformationAmountDetails'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsOrderInformationBillTo'), require('./Riskv1authenticationsOrderInformationLineItems'), require('./Riskv1authenticationsOrderInformationShipTo'), require('./Riskv1decisionsOrderInformationAmountDetails'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsOrderInformationBillTo, root.CyberSource.Riskv1authenticationsOrderInformationLineItems, root.CyberSource.Riskv1authenticationsOrderInformationShipTo, root.CyberSource.Riskv1decisionsOrderInformationAmountDetails);
+ }
+}(this, function(ApiClient, Riskv1authenticationsOrderInformationBillTo, Riskv1authenticationsOrderInformationLineItems, Riskv1authenticationsOrderInformationShipTo, Riskv1decisionsOrderInformationAmountDetails) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsOrderInformation model module.
+ * @module model/Riskv1authenticationsOrderInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsOrderInformation.
+ * @alias module:model/Riskv1authenticationsOrderInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsOrderInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsOrderInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsOrderInformation} The populated Riskv1authenticationsOrderInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('amountDetails')) {
+ obj['amountDetails'] = Riskv1decisionsOrderInformationAmountDetails.constructFromObject(data['amountDetails']);
+ }
+ if (data.hasOwnProperty('preOrder')) {
+ obj['preOrder'] = ApiClient.convertToType(data['preOrder'], 'String');
+ }
+ if (data.hasOwnProperty('preOrderDate')) {
+ obj['preOrderDate'] = ApiClient.convertToType(data['preOrderDate'], 'String');
+ }
+ if (data.hasOwnProperty('reordered')) {
+ obj['reordered'] = ApiClient.convertToType(data['reordered'], 'Boolean');
+ }
+ if (data.hasOwnProperty('shipTo')) {
+ obj['shipTo'] = Riskv1authenticationsOrderInformationShipTo.constructFromObject(data['shipTo']);
+ }
+ if (data.hasOwnProperty('lineItems')) {
+ obj['lineItems'] = ApiClient.convertToType(data['lineItems'], [Riskv1authenticationsOrderInformationLineItems]);
+ }
+ if (data.hasOwnProperty('billTo')) {
+ obj['billTo'] = Riskv1authenticationsOrderInformationBillTo.constructFromObject(data['billTo']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1decisionsOrderInformationAmountDetails} amountDetails
+ */
+ exports.prototype['amountDetails'] = undefined;
+ /**
+ * Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability
+ * @member {String} preOrder
+ */
+ exports.prototype['preOrder'] = undefined;
+ /**
+ * Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD
+ * @member {String} preOrderDate
+ */
+ exports.prototype['preOrderDate'] = undefined;
+ /**
+ * Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered
+ * @member {Boolean} reordered
+ */
+ exports.prototype['reordered'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsOrderInformationShipTo} shipTo
+ */
+ exports.prototype['shipTo'] = undefined;
+ /**
+ * This array contains detailed information about individual products in the order.
+ * @member {Array.Riskv1authenticationsOrderInformationBillTo.
+ * @alias module:model/Riskv1authenticationsOrderInformationBillTo
+ * @class
+ * @param address1 {String} First line of the billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_address1` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param administrativeArea {String} State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param country {String} Payment card billing country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param locality {String} Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `bill_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param firstName {String} Customer’s first name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_firstname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param lastName {String} Customer’s last name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `customer_lastname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param email {String} Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param postalCode {String} Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_zip` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ */
+ var exports = function(address1, administrativeArea, country, locality, firstName, lastName, email, postalCode) {
+ var _this = this;
+
+ _this['address1'] = address1;
+
+ _this['administrativeArea'] = administrativeArea;
+ _this['country'] = country;
+ _this['locality'] = locality;
+ _this['firstName'] = firstName;
+ _this['lastName'] = lastName;
+
+ _this['email'] = email;
+ _this['postalCode'] = postalCode;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsOrderInformationBillTo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsOrderInformationBillTo} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsOrderInformationBillTo} The populated Riskv1authenticationsOrderInformationBillTo instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('address1')) {
+ obj['address1'] = ApiClient.convertToType(data['address1'], 'String');
+ }
+ if (data.hasOwnProperty('address2')) {
+ obj['address2'] = ApiClient.convertToType(data['address2'], 'String');
+ }
+ if (data.hasOwnProperty('administrativeArea')) {
+ obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String');
+ }
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('firstName')) {
+ obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
+ }
+ if (data.hasOwnProperty('lastName')) {
+ obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
+ }
+ if (data.hasOwnProperty('phoneNumber')) {
+ obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
+ }
+ if (data.hasOwnProperty('email')) {
+ obj['email'] = ApiClient.convertToType(data['email'], 'String');
+ }
+ if (data.hasOwnProperty('postalCode')) {
+ obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * First line of the billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_address1` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} address1
+ */
+ exports.prototype['address1'] = undefined;
+ /**
+ * Additional address information. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_address2` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} address2
+ */
+ exports.prototype['address2'] = undefined;
+ /**
+ * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} administrativeArea
+ */
+ exports.prototype['administrativeArea'] = undefined;
+ /**
+ * Payment card billing country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `bill_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * Customer’s first name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_firstname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} firstName
+ */
+ exports.prototype['firstName'] = undefined;
+ /**
+ * Customer’s last name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `customer_lastname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} lastName
+ */
+ exports.prototype['lastName'] = undefined;
+ /**
+ * Customer’s phone number. #### For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
+ * @member {String} phoneNumber
+ */
+ exports.prototype['phoneNumber'] = undefined;
+ /**
+ * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} email
+ */
+ exports.prototype['email'] = undefined;
+ /**
+ * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_zip` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} postalCode
+ */
+ exports.prototype['postalCode'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsOrderInformationLineItems.js b/src/model/Riskv1authenticationsOrderInformationLineItems.js
new file mode 100644
index 00000000..c3916ef0
--- /dev/null
+++ b/src/model/Riskv1authenticationsOrderInformationLineItems.js
@@ -0,0 +1,154 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1decisionsOrderInformationPassenger'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1decisionsOrderInformationPassenger'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsOrderInformationLineItems = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1decisionsOrderInformationPassenger);
+ }
+}(this, function(ApiClient, Riskv1decisionsOrderInformationPassenger) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsOrderInformationLineItems model module.
+ * @module model/Riskv1authenticationsOrderInformationLineItems
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsOrderInformationLineItems.
+ * @alias module:model/Riskv1authenticationsOrderInformationLineItems
+ * @class
+ * @param unitPrice {String} Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ */
+ var exports = function(unitPrice) {
+ var _this = this;
+
+
+ _this['unitPrice'] = unitPrice;
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsOrderInformationLineItems from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsOrderInformationLineItems} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsOrderInformationLineItems} The populated Riskv1authenticationsOrderInformationLineItems instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('totalAmount')) {
+ obj['totalAmount'] = ApiClient.convertToType(data['totalAmount'], 'String');
+ }
+ if (data.hasOwnProperty('unitPrice')) {
+ obj['unitPrice'] = ApiClient.convertToType(data['unitPrice'], 'String');
+ }
+ if (data.hasOwnProperty('quantity')) {
+ obj['quantity'] = ApiClient.convertToType(data['quantity'], 'Number');
+ }
+ if (data.hasOwnProperty('giftCardCurrency')) {
+ obj['giftCardCurrency'] = ApiClient.convertToType(data['giftCardCurrency'], 'Number');
+ }
+ if (data.hasOwnProperty('productSKU')) {
+ obj['productSKU'] = ApiClient.convertToType(data['productSKU'], 'String');
+ }
+ if (data.hasOwnProperty('productDescription')) {
+ obj['productDescription'] = ApiClient.convertToType(data['productDescription'], 'String');
+ }
+ if (data.hasOwnProperty('productName')) {
+ obj['productName'] = ApiClient.convertToType(data['productName'], 'String');
+ }
+ if (data.hasOwnProperty('passenger')) {
+ obj['passenger'] = Riskv1decisionsOrderInformationPassenger.constructFromObject(data['passenger']);
+ }
+ if (data.hasOwnProperty('taxAmount')) {
+ obj['taxAmount'] = ApiClient.convertToType(data['taxAmount'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123
+ * @member {String} totalAmount
+ */
+ exports.prototype['totalAmount'] = undefined;
+ /**
+ * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
+ * @member {String} unitPrice
+ */
+ exports.prototype['unitPrice'] = undefined;
+ /**
+ * Number of units for this order. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is \"gift_card\", this is the total count of individual prepaid gift cards purchased.
+ * @member {Number} quantity
+ */
+ exports.prototype['quantity'] = undefined;
+ /**
+ * When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
+ * @member {Number} giftCardCurrency
+ */
+ exports.prototype['giftCardCurrency'] = undefined;
+ /**
+ * Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.
+ * @member {String} productSKU
+ */
+ exports.prototype['productSKU'] = undefined;
+ /**
+ * Brief description of item.
+ * @member {String} productDescription
+ */
+ exports.prototype['productDescription'] = undefined;
+ /**
+ * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.
+ * @member {String} productName
+ */
+ exports.prototype['productName'] = undefined;
+ /**
+ * @member {module:model/Riskv1decisionsOrderInformationPassenger} passenger
+ */
+ exports.prototype['passenger'] = undefined;
+ /**
+ * Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. This field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.
+ * @member {String} taxAmount
+ */
+ exports.prototype['taxAmount'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsOrderInformationShipTo.js b/src/model/Riskv1authenticationsOrderInformationShipTo.js
new file mode 100644
index 00000000..19a4b4ef
--- /dev/null
+++ b/src/model/Riskv1authenticationsOrderInformationShipTo.js
@@ -0,0 +1,172 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsOrderInformationShipTo = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsOrderInformationShipTo model module.
+ * @module model/Riskv1authenticationsOrderInformationShipTo
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsOrderInformationShipTo.
+ * @alias module:model/Riskv1authenticationsOrderInformationShipTo
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsOrderInformationShipTo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsOrderInformationShipTo} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsOrderInformationShipTo} The populated Riskv1authenticationsOrderInformationShipTo instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('address1')) {
+ obj['address1'] = ApiClient.convertToType(data['address1'], 'String');
+ }
+ if (data.hasOwnProperty('address2')) {
+ obj['address2'] = ApiClient.convertToType(data['address2'], 'String');
+ }
+ if (data.hasOwnProperty('administrativeArea')) {
+ obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String');
+ }
+ if (data.hasOwnProperty('country')) {
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
+ }
+ if (data.hasOwnProperty('locality')) {
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
+ }
+ if (data.hasOwnProperty('firstName')) {
+ obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
+ }
+ if (data.hasOwnProperty('lastName')) {
+ obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
+ }
+ if (data.hasOwnProperty('phoneNumber')) {
+ obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
+ }
+ if (data.hasOwnProperty('postalCode')) {
+ obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String');
+ }
+ if (data.hasOwnProperty('destinationCode')) {
+ obj['destinationCode'] = ApiClient.convertToType(data['destinationCode'], 'Number');
+ }
+ if (data.hasOwnProperty('method')) {
+ obj['method'] = ApiClient.convertToType(data['method'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * First line of the shipping address.
+ * @member {String} address1
+ */
+ exports.prototype['address1'] = undefined;
+ /**
+ * Second line of the shipping address.
+ * @member {String} address2
+ */
+ exports.prototype['address2'] = undefined;
+ /**
+ * State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.
+ * @member {String} administrativeArea
+ */
+ exports.prototype['administrativeArea'] = undefined;
+ /**
+ * Country of the shipping address. Use the two-character ISO Standard Country Codes.
+ * @member {String} country
+ */
+ exports.prototype['country'] = undefined;
+ /**
+ * City of the shipping address.
+ * @member {String} locality
+ */
+ exports.prototype['locality'] = undefined;
+ /**
+ * First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60
+ * @member {String} firstName
+ */
+ exports.prototype['firstName'] = undefined;
+ /**
+ * Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60
+ * @member {String} lastName
+ */
+ exports.prototype['lastName'] = undefined;
+ /**
+ * Phone number associated with the shipping address.
+ * @member {String} phoneNumber
+ */
+ exports.prototype['phoneNumber'] = undefined;
+ /**
+ * Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.
+ * @member {String} postalCode
+ */
+ exports.prototype['postalCode'] = undefined;
+ /**
+ * Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other
+ * @member {Number} destinationCode
+ */
+ exports.prototype['destinationCode'] = undefined;
+ /**
+ * Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.).
+ * @member {String} method
+ */
+ exports.prototype['method'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsPaymentInformation.js b/src/model/Riskv1authenticationsPaymentInformation.js
new file mode 100644
index 00000000..9336396e
--- /dev/null
+++ b/src/model/Riskv1authenticationsPaymentInformation.js
@@ -0,0 +1,89 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsPaymentInformationCard', 'model/Riskv1authenticationsPaymentInformationTokenizedCard'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsPaymentInformationCard'), require('./Riskv1authenticationsPaymentInformationTokenizedCard'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsPaymentInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsPaymentInformationCard, root.CyberSource.Riskv1authenticationsPaymentInformationTokenizedCard);
+ }
+}(this, function(ApiClient, Riskv1authenticationsPaymentInformationCard, Riskv1authenticationsPaymentInformationTokenizedCard) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsPaymentInformation model module.
+ * @module model/Riskv1authenticationsPaymentInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsPaymentInformation.
+ * @alias module:model/Riskv1authenticationsPaymentInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsPaymentInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsPaymentInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsPaymentInformation} The populated Riskv1authenticationsPaymentInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('card')) {
+ obj['card'] = Riskv1authenticationsPaymentInformationCard.constructFromObject(data['card']);
+ }
+ if (data.hasOwnProperty('tokenizedCard')) {
+ obj['tokenizedCard'] = Riskv1authenticationsPaymentInformationTokenizedCard.constructFromObject(data['tokenizedCard']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationsPaymentInformationCard} card
+ */
+ exports.prototype['card'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsPaymentInformationTokenizedCard} tokenizedCard
+ */
+ exports.prototype['tokenizedCard'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsPaymentInformationCard.js b/src/model/Riskv1authenticationsPaymentInformationCard.js
new file mode 100644
index 00000000..04c3775b
--- /dev/null
+++ b/src/model/Riskv1authenticationsPaymentInformationCard.js
@@ -0,0 +1,113 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsPaymentInformationCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsPaymentInformationCard model module.
+ * @module model/Riskv1authenticationsPaymentInformationCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsPaymentInformationCard.
+ * @alias module:model/Riskv1authenticationsPaymentInformationCard
+ * @class
+ * @param type {String} Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param expirationMonth {String} Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param expirationYear {String} Four-digit year in which the credit card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param _number {String} The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ */
+ var exports = function(type, expirationMonth, expirationYear, _number) {
+ var _this = this;
+
+ _this['type'] = type;
+ _this['expirationMonth'] = expirationMonth;
+ _this['expirationYear'] = expirationYear;
+ _this['number'] = _number;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsPaymentInformationCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsPaymentInformationCard} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsPaymentInformationCard} The populated Riskv1authenticationsPaymentInformationCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('expirationMonth')) {
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('expirationYear')) {
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationMonth
+ */
+ exports.prototype['expirationMonth'] = undefined;
+ /**
+ * Four-digit year in which the credit card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationYear
+ */
+ exports.prototype['expirationYear'] = undefined;
+ /**
+ * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsPaymentInformationTokenizedCard.js b/src/model/Riskv1authenticationsPaymentInformationTokenizedCard.js
new file mode 100644
index 00000000..727a44da
--- /dev/null
+++ b/src/model/Riskv1authenticationsPaymentInformationTokenizedCard.js
@@ -0,0 +1,113 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsPaymentInformationTokenizedCard = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsPaymentInformationTokenizedCard model module.
+ * @module model/Riskv1authenticationsPaymentInformationTokenizedCard
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsPaymentInformationTokenizedCard.
+ * @alias module:model/Riskv1authenticationsPaymentInformationTokenizedCard
+ * @class
+ * @param type {String} Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param expirationMonth {String} One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param expirationYear {String} One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @param _number {String} Customer’s payment network token value.
+ */
+ var exports = function(type, expirationMonth, expirationYear, _number) {
+ var _this = this;
+
+ _this['type'] = type;
+ _this['expirationMonth'] = expirationMonth;
+ _this['expirationYear'] = expirationYear;
+ _this['number'] = _number;
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsPaymentInformationTokenizedCard from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsPaymentInformationTokenizedCard} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsPaymentInformationTokenizedCard} The populated Riskv1authenticationsPaymentInformationTokenizedCard instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('expirationMonth')) {
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
+ }
+ if (data.hasOwnProperty('expirationYear')) {
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
+ }
+ if (data.hasOwnProperty('number')) {
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} type
+ */
+ exports.prototype['type'] = undefined;
+ /**
+ * One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationMonth
+ */
+ exports.prototype['expirationMonth'] = undefined;
+ /**
+ * One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * @member {String} expirationYear
+ */
+ exports.prototype['expirationYear'] = undefined;
+ /**
+ * Customer’s payment network token value.
+ * @member {String} number
+ */
+ exports.prototype['number'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsRecurringPaymentInformation.js b/src/model/Riskv1authenticationsRecurringPaymentInformation.js
new file mode 100644
index 00000000..7a752eb2
--- /dev/null
+++ b/src/model/Riskv1authenticationsRecurringPaymentInformation.js
@@ -0,0 +1,101 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsRecurringPaymentInformation = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsRecurringPaymentInformation model module.
+ * @module model/Riskv1authenticationsRecurringPaymentInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsRecurringPaymentInformation.
+ * This object contains recurring payment information.
+ * @alias module:model/Riskv1authenticationsRecurringPaymentInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsRecurringPaymentInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsRecurringPaymentInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsRecurringPaymentInformation} The populated Riskv1authenticationsRecurringPaymentInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('endDate')) {
+ obj['endDate'] = ApiClient.convertToType(data['endDate'], 'String');
+ }
+ if (data.hasOwnProperty('frequency')) {
+ obj['frequency'] = ApiClient.convertToType(data['frequency'], 'Number');
+ }
+ if (data.hasOwnProperty('originalPurchaseDate')) {
+ obj['originalPurchaseDate'] = ApiClient.convertToType(data['originalPurchaseDate'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The date after which no further recurring authorizations should be performed. Format: `YYYYMMDD` **Note** This field is required for recurring transactions.
+ * @member {String} endDate
+ */
+ exports.prototype['endDate'] = undefined;
+ /**
+ * Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 **Note** This field is required for recurring transactions.
+ * @member {Number} frequency
+ */
+ exports.prototype['frequency'] = undefined;
+ /**
+ * Date of original purchase. Required for recurring transactions. Format: `YYYYMMDD:HH:MM:SS` **Note**: If this field is empty, the current date is used.
+ * @member {String} originalPurchaseDate
+ */
+ exports.prototype['originalPurchaseDate'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsRiskInformation.js b/src/model/Riskv1authenticationsRiskInformation.js
new file mode 100644
index 00000000..b844e5fc
--- /dev/null
+++ b/src/model/Riskv1authenticationsRiskInformation.js
@@ -0,0 +1,81 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsRiskInformationBuyerHistory'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsRiskInformationBuyerHistory'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsRiskInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistory);
+ }
+}(this, function(ApiClient, Riskv1authenticationsRiskInformationBuyerHistory) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsRiskInformation model module.
+ * @module model/Riskv1authenticationsRiskInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsRiskInformation.
+ * @alias module:model/Riskv1authenticationsRiskInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsRiskInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsRiskInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsRiskInformation} The populated Riskv1authenticationsRiskInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('buyerHistory')) {
+ obj['buyerHistory'] = Riskv1authenticationsRiskInformationBuyerHistory.constructFromObject(data['buyerHistory']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationsRiskInformationBuyerHistory} buyerHistory
+ */
+ exports.prototype['buyerHistory'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsRiskInformationBuyerHistory.js b/src/model/Riskv1authenticationsRiskInformationBuyerHistory.js
new file mode 100644
index 00000000..7daedaec
--- /dev/null
+++ b/src/model/Riskv1authenticationsRiskInformationBuyerHistory.js
@@ -0,0 +1,152 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory', 'model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory'), require('./Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistory = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory, root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount);
+ }
+}(this, function(ApiClient, Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory, Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsRiskInformationBuyerHistory model module.
+ * @module model/Riskv1authenticationsRiskInformationBuyerHistory
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsRiskInformationBuyerHistory.
+ * @alias module:model/Riskv1authenticationsRiskInformationBuyerHistory
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsRiskInformationBuyerHistory from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsRiskInformationBuyerHistory} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsRiskInformationBuyerHistory} The populated Riskv1authenticationsRiskInformationBuyerHistory instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('customerAccount')) {
+ obj['customerAccount'] = Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount.constructFromObject(data['customerAccount']);
+ }
+ if (data.hasOwnProperty('accountHistory')) {
+ obj['accountHistory'] = Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory.constructFromObject(data['accountHistory']);
+ }
+ if (data.hasOwnProperty('accountPurchases')) {
+ obj['accountPurchases'] = ApiClient.convertToType(data['accountPurchases'], 'Number');
+ }
+ if (data.hasOwnProperty('addCardAttempts')) {
+ obj['addCardAttempts'] = ApiClient.convertToType(data['addCardAttempts'], 'Number');
+ }
+ if (data.hasOwnProperty('priorSuspiciousActivity')) {
+ obj['priorSuspiciousActivity'] = ApiClient.convertToType(data['priorSuspiciousActivity'], 'Boolean');
+ }
+ if (data.hasOwnProperty('paymentAccountHistory')) {
+ obj['paymentAccountHistory'] = ApiClient.convertToType(data['paymentAccountHistory'], 'String');
+ }
+ if (data.hasOwnProperty('paymentAccountDate')) {
+ obj['paymentAccountDate'] = ApiClient.convertToType(data['paymentAccountDate'], 'Number');
+ }
+ if (data.hasOwnProperty('transactionCountDay')) {
+ obj['transactionCountDay'] = ApiClient.convertToType(data['transactionCountDay'], 'Number');
+ }
+ if (data.hasOwnProperty('transactionCountYear')) {
+ obj['transactionCountYear'] = ApiClient.convertToType(data['transactionCountYear'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {module:model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount} customerAccount
+ */
+ exports.prototype['customerAccount'] = undefined;
+ /**
+ * @member {module:model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory} accountHistory
+ */
+ exports.prototype['accountHistory'] = undefined;
+ /**
+ * Number of purchases with this cardholder account during the previous six months. Recommended for Discover ProtectBuy.
+ * @member {Number} accountPurchases
+ */
+ exports.prototype['accountPurchases'] = undefined;
+ /**
+ * Number of add card attempts in the last 24 hours. Recommended for Discover ProtectBuy.
+ * @member {Number} addCardAttempts
+ */
+ exports.prototype['addCardAttempts'] = undefined;
+ /**
+ * Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. Recommended for Discover ProtectBuy.
+ * @member {Boolean} priorSuspiciousActivity
+ */
+ exports.prototype['priorSuspiciousActivity'] = undefined;
+ /**
+ * This only applies for NEW_ACCOUNT and EXISTING_ACCOUNT in creationHistory. Possible values are: - PAYMENT_ACCOUNT_EXISTS - PAYMENT_ACCOUNT_ADDED_NOW
+ * @member {String} paymentAccountHistory
+ */
+ exports.prototype['paymentAccountHistory'] = undefined;
+ /**
+ * Date applicable only for PAYMENT_ACCOUNT_EXISTS in paymentAccountHistory
+ * @member {Number} paymentAccountDate
+ */
+ exports.prototype['paymentAccountDate'] = undefined;
+ /**
+ * Number of transaction (successful or abandoned) for this cardholder account within the last 24 hours. Recommended for Discover ProtectBuy.
+ * @member {Number} transactionCountDay
+ */
+ exports.prototype['transactionCountDay'] = undefined;
+ /**
+ * Number of transaction (successful or abandoned) for this cardholder account within the last year. Recommended for Discover ProtectBuy.
+ * @member {Number} transactionCountYear
+ */
+ exports.prototype['transactionCountYear'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory.js b/src/model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory.js
new file mode 100644
index 00000000..c2a8287b
--- /dev/null
+++ b/src/model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory model module.
+ * @module model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory.
+ * @alias module:model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory} The populated Riskv1authenticationsRiskInformationBuyerHistoryAccountHistory instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('firstUseOfShippingAddress')) {
+ obj['firstUseOfShippingAddress'] = ApiClient.convertToType(data['firstUseOfShippingAddress'], 'Boolean');
+ }
+ if (data.hasOwnProperty('shippingAddressUsageDate')) {
+ obj['shippingAddressUsageDate'] = ApiClient.convertToType(data['shippingAddressUsageDate'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Applicable when this is not a guest account.
+ * @member {Boolean} firstUseOfShippingAddress
+ */
+ exports.prototype['firstUseOfShippingAddress'] = undefined;
+ /**
+ * Date when the shipping address for this transaction was first used. Recommended for Discover ProtectBuy. If `firstUseOfShippingAddress` is false and not a guest account, then this date is entered.
+ * @member {String} shippingAddressUsageDate
+ */
+ exports.prototype['shippingAddressUsageDate'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount.js b/src/model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount.js
new file mode 100644
index 00000000..b765bf4b
--- /dev/null
+++ b/src/model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount.js
@@ -0,0 +1,127 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount model module.
+ * @module model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount.
+ * @alias module:model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount} The populated Riskv1authenticationsRiskInformationBuyerHistoryCustomerAccount instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('lastChangeDate')) {
+ obj['lastChangeDate'] = ApiClient.convertToType(data['lastChangeDate'], 'String');
+ }
+ if (data.hasOwnProperty('creationHistory')) {
+ obj['creationHistory'] = ApiClient.convertToType(data['creationHistory'], 'String');
+ }
+ if (data.hasOwnProperty('modificationHistory')) {
+ obj['modificationHistory'] = ApiClient.convertToType(data['modificationHistory'], 'String');
+ }
+ if (data.hasOwnProperty('passwordHistory')) {
+ obj['passwordHistory'] = ApiClient.convertToType(data['passwordHistory'], 'String');
+ }
+ if (data.hasOwnProperty('createDate')) {
+ obj['createDate'] = ApiClient.convertToType(data['createDate'], 'String');
+ }
+ if (data.hasOwnProperty('passwordChangeDate')) {
+ obj['passwordChangeDate'] = ApiClient.convertToType(data['passwordChangeDate'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Date the cardholder’s account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Recommended for Discover ProtectBuy.
+ * @member {String} lastChangeDate
+ */
+ exports.prototype['lastChangeDate'] = undefined;
+ /**
+ * The values from the enum can be: - GUEST - NEW_ACCOUNT - EXISTING_ACCOUNT
+ * @member {String} creationHistory
+ */
+ exports.prototype['creationHistory'] = undefined;
+ /**
+ * This field is applicable only in case of EXISTING_ACCOUNT in creationHistory. Possible values: - ACCOUNT_UPDATED_NOW - ACCOUNT_UPDATED_PAST
+ * @member {String} modificationHistory
+ */
+ exports.prototype['modificationHistory'] = undefined;
+ /**
+ * This only applies for EXISTING_ACCOUNT in creationHistory. The values from the enum can be: - PASSWORD_CHANGED_NOW - PASSWORD_CHANGED_PAST - PASSWORD_NEVER_CHANGED
+ * @member {String} passwordHistory
+ */
+ exports.prototype['passwordHistory'] = undefined;
+ /**
+ * Date the cardholder opened the account. Recommended for Discover ProtectBuy. This only applies for EXISTING_ACCOUNT in creationHistory.
+ * @member {String} createDate
+ */
+ exports.prototype['createDate'] = undefined;
+ /**
+ * Date the cardholder last changed or reset password on account. Recommended for Discover ProtectBuy. This only applies for PASSWORD_CHANGED_PAST in passwordHistory.
+ * @member {String} passwordChangeDate
+ */
+ exports.prototype['passwordChangeDate'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsTravelInformation.js b/src/model/Riskv1authenticationsTravelInformation.js
new file mode 100644
index 00000000..c25d4c6a
--- /dev/null
+++ b/src/model/Riskv1authenticationsTravelInformation.js
@@ -0,0 +1,98 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Riskv1authenticationsTravelInformationLegs', 'model/Riskv1authenticationsTravelInformationPassengers'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Riskv1authenticationsTravelInformationLegs'), require('./Riskv1authenticationsTravelInformationPassengers'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsTravelInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Riskv1authenticationsTravelInformationLegs, root.CyberSource.Riskv1authenticationsTravelInformationPassengers);
+ }
+}(this, function(ApiClient, Riskv1authenticationsTravelInformationLegs, Riskv1authenticationsTravelInformationPassengers) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsTravelInformation model module.
+ * @module model/Riskv1authenticationsTravelInformation
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsTravelInformation.
+ * @alias module:model/Riskv1authenticationsTravelInformation
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsTravelInformation from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsTravelInformation} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsTravelInformation} The populated Riskv1authenticationsTravelInformation instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('legs')) {
+ obj['legs'] = ApiClient.convertToType(data['legs'], [Riskv1authenticationsTravelInformationLegs]);
+ }
+ if (data.hasOwnProperty('numberOfPassengers')) {
+ obj['numberOfPassengers'] = ApiClient.convertToType(data['numberOfPassengers'], 'Number');
+ }
+ if (data.hasOwnProperty('passengers')) {
+ obj['passengers'] = ApiClient.convertToType(data['passengers'], [Riskv1authenticationsTravelInformationPassengers]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {Array.Riskv1authenticationsTravelInformationLegs.
+ * @alias module:model/Riskv1authenticationsTravelInformationLegs
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsTravelInformationLegs from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsTravelInformationLegs} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsTravelInformationLegs} The populated Riskv1authenticationsTravelInformationLegs instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('origination')) {
+ obj['origination'] = ApiClient.convertToType(data['origination'], 'String');
+ }
+ if (data.hasOwnProperty('destination')) {
+ obj['destination'] = ApiClient.convertToType(data['destination'], 'String');
+ }
+ if (data.hasOwnProperty('carrierCode')) {
+ obj['carrierCode'] = ApiClient.convertToType(data['carrierCode'], 'String');
+ }
+ if (data.hasOwnProperty('departureDate')) {
+ obj['departureDate'] = ApiClient.convertToType(data['departureDate'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.origination=SFO` `travelInformation.legs.1.origination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)
+ * @member {String} origination
+ */
+ exports.prototype['origination'] = undefined;
+ /**
+ * Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.destination=SFO` `travelInformation.legs.1.destination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)
+ * @member {String} destination
+ */
+ exports.prototype['destination'] = undefined;
+ /**
+ * International Air Transport Association (IATA) code for the carrier for this leg of the trip. Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests. For details, see `airline_leg#_carrier_code` in [Airline Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Airline_SCMP_API/Airline_SCMP_API.pdf)
+ * @member {String} carrierCode
+ */
+ exports.prototype['carrierCode'] = undefined;
+ /**
+ * Departure date for the first leg of the trip. Format: YYYYMMDD. Required for American Express SafeKey (U.S.) for travel-related requests. For details, see `airline_leg#_leg_departure_date` in [Airline Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Airline_SCMP_API/Airline_SCMP_API.pdf)
+ * @member {String} departureDate
+ */
+ exports.prototype['departureDate'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1authenticationsTravelInformationPassengers.js b/src/model/Riskv1authenticationsTravelInformationPassengers.js
new file mode 100644
index 00000000..6325c3c6
--- /dev/null
+++ b/src/model/Riskv1authenticationsTravelInformationPassengers.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.Riskv1authenticationsTravelInformationPassengers = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The Riskv1authenticationsTravelInformationPassengers model module.
+ * @module model/Riskv1authenticationsTravelInformationPassengers
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new Riskv1authenticationsTravelInformationPassengers.
+ * @alias module:model/Riskv1authenticationsTravelInformationPassengers
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a Riskv1authenticationsTravelInformationPassengers from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/Riskv1authenticationsTravelInformationPassengers} obj Optional instance to populate.
+ * @return {module:model/Riskv1authenticationsTravelInformationPassengers} The populated Riskv1authenticationsTravelInformationPassengers instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('firstName')) {
+ obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
+ }
+ if (data.hasOwnProperty('lastName')) {
+ obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * First name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests.
+ * @member {String} firstName
+ */
+ exports.prototype['firstName'] = undefined;
+ /**
+ * Last name of the passenger to whom the ticket was issued. If there are multiple passengers, include all listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Required for American Express SafeKey (U.S.) for travel-related requests.
+ * @member {String} lastName
+ */
+ exports.prototype['lastName'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/Riskv1decisionsBuyerInformation.js b/src/model/Riskv1decisionsBuyerInformation.js
index 3b5c357d..309ffb66 100644
--- a/src/model/Riskv1decisionsBuyerInformation.js
+++ b/src/model/Riskv1decisionsBuyerInformation.js
@@ -51,6 +51,7 @@
+
};
/**
@@ -64,6 +65,9 @@
if (data) {
obj = obj || new exports();
+ if (data.hasOwnProperty('username')) {
+ obj['username'] = ApiClient.convertToType(data['username'], 'String');
+ }
if (data.hasOwnProperty('hashedPassword')) {
obj['hashedPassword'] = ApiClient.convertToType(data['hashedPassword'], 'String');
}
@@ -78,12 +82,17 @@
}
/**
- * The description for this field is not available.
+ * Specifies the customer account user name.
+ * @member {String} username
+ */
+ exports.prototype['username'] = undefined;
+ /**
+ * The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)
* @member {String} hashedPassword
*/
exports.prototype['hashedPassword'] = undefined;
/**
- * Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see \"Recipients,\" page 224.
+ * Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} dateOfBirth
*/
exports.prototype['dateOfBirth'] = undefined;
diff --git a/src/model/Riskv1decisionsCardVerification.js b/src/model/Riskv1decisionsCardVerification.js
index 1ce8cff2..9c28f14c 100644
--- a/src/model/Riskv1decisionsCardVerification.js
+++ b/src/model/Riskv1decisionsCardVerification.js
@@ -69,7 +69,7 @@
}
/**
- * Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code.
+ * CVN result code. For details, see the `auth_cv_result` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For a description of the card verification check, see \"Card Verification Numbers (CVNs)\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For a list of possible values, see \"CVN Codes\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} resultCode
*/
exports.prototype['resultCode'] = undefined;
diff --git a/src/model/Riskv1decisionsClientReferenceInformation.js b/src/model/Riskv1decisionsClientReferenceInformation.js
index b7b8ad98..21e0a2f2 100644
--- a/src/model/Riskv1decisionsClientReferenceInformation.js
+++ b/src/model/Riskv1decisionsClientReferenceInformation.js
@@ -73,7 +73,7 @@
}
/**
- * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
+ * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
* @member {String} code
*/
exports.prototype['code'] = undefined;
diff --git a/src/model/Riskv1decisionsDeviceInformation.js b/src/model/Riskv1decisionsDeviceInformation.js
index 5e8c1a0f..6df0e2b1 100644
--- a/src/model/Riskv1decisionsDeviceInformation.js
+++ b/src/model/Riskv1decisionsDeviceInformation.js
@@ -89,22 +89,22 @@
}
/**
- * Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies.
+ * Whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies.
* @member {String} cookiesAccepted
*/
exports.prototype['cookiesAccepted'] = undefined;
/**
- * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information.
+ * IP address of the customer.
* @member {String} ipAddress
*/
exports.prototype['ipAddress'] = undefined;
/**
- * Host name reported by the customer’s browser to your Web server identified via the HTTP header.
+ * DNS resolved hostname from `ipAddress`.
* @member {String} hostName
*/
exports.prototype['hostName'] = undefined;
/**
- * Contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID.The session ID must be unique for each page load, regardless of an individual’s web session ID. If the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. An example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page.
+ * Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual’s web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page.
* @member {String} fingerprintSessionId
*/
exports.prototype['fingerprintSessionId'] = undefined;
@@ -114,7 +114,7 @@
*/
exports.prototype['httpBrowserEmail'] = undefined;
/**
- * Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser.
+ * Customer’s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.
* @member {String} userAgent
*/
exports.prototype['userAgent'] = undefined;
diff --git a/src/model/Riskv1decisionsMerchantDefinedInformation.js b/src/model/Riskv1decisionsMerchantDefinedInformation.js
index fc698f1c..50ed01df 100644
--- a/src/model/Riskv1decisionsMerchantDefinedInformation.js
+++ b/src/model/Riskv1decisionsMerchantDefinedInformation.js
@@ -74,7 +74,7 @@
}
/**
- * Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.
+ * Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.
* @member {String} key
*/
exports.prototype['key'] = undefined;
diff --git a/src/model/Riskv1decisionsOrderInformation.js b/src/model/Riskv1decisionsOrderInformation.js
index 1408325d..49c7535b 100644
--- a/src/model/Riskv1decisionsOrderInformation.js
+++ b/src/model/Riskv1decisionsOrderInformation.js
@@ -77,7 +77,7 @@
obj['shipTo'] = Riskv1decisionsOrderInformationShipTo.constructFromObject(data['shipTo']);
}
if (data.hasOwnProperty('returnsAccepted')) {
- obj['returnsAccepted'] = ApiClient.convertToType(data['returnsAccepted'], 'String');
+ obj['returnsAccepted'] = ApiClient.convertToType(data['returnsAccepted'], 'Boolean');
}
if (data.hasOwnProperty('lineItems')) {
obj['lineItems'] = ApiClient.convertToType(data['lineItems'], [Riskv1decisionsOrderInformationLineItems]);
@@ -102,8 +102,8 @@
*/
exports.prototype['shipTo'] = undefined;
/**
- * Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - `yes`: Returns are accepted for this order. - `no`: Returns are not accepted for this order.
- * @member {String} returnsAccepted
+ * Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order.
+ * @member {Boolean} returnsAccepted
*/
exports.prototype['returnsAccepted'] = undefined;
/**
diff --git a/src/model/Riskv1decisionsOrderInformationAmountDetails.js b/src/model/Riskv1decisionsOrderInformationAmountDetails.js
index 2c8a03ce..4691345e 100644
--- a/src/model/Riskv1decisionsOrderInformationAmountDetails.js
+++ b/src/model/Riskv1decisionsOrderInformationAmountDetails.js
@@ -44,7 +44,7 @@
* Contains `currency` and `totalAmount` for this order.
* @alias module:model/Riskv1decisionsOrderInformationAmountDetails
* @class
- * @param currency {String} Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * @param currency {String} Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
*/
var exports = function(currency) {
var _this = this;
@@ -75,12 +75,12 @@
}
/**
- * Currency used for the order. Use the three-character ISO Standard Currency Codes. 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 request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
+ * Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### 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).
* @member {String} currency
*/
exports.prototype['currency'] = undefined;
/**
- * 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. This information is covered in: Table 15, \"Authorization Information for Specific Processors,\" on page 43 Table 19, \"Capture Information for Specific Processors,\" on page 58 Table 23, \"Credit Information for Specific Processors,\" on page 75 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. See \"Zero Amount Authorizations,\" page 247. **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 offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used.
+ * 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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"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/wwhelp/wwhimpl/js/html/wwhelp.htm). 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used.
* @member {String} totalAmount
*/
exports.prototype['totalAmount'] = undefined;
diff --git a/src/model/Riskv1decisionsOrderInformationBillTo.js b/src/model/Riskv1decisionsOrderInformationBillTo.js
index 4291ba9c..910f598f 100644
--- a/src/model/Riskv1decisionsOrderInformationBillTo.js
+++ b/src/model/Riskv1decisionsOrderInformationBillTo.js
@@ -105,52 +105,52 @@
}
/**
- * First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * First line of the billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_address1` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} address1
*/
exports.prototype['address1'] = undefined;
/**
- * Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Additional address information. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_address2` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} address2
*/
exports.prototype['address2'] = undefined;
/**
- * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} administrativeArea
*/
exports.prototype['administrativeArea'] = undefined;
/**
- * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Payment card billing country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} country
*/
exports.prototype['country'] = undefined;
/**
- * City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `bill_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} locality
*/
exports.prototype['locality'] = undefined;
/**
- * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer’s first name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_firstname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} firstName
*/
exports.prototype['firstName'] = undefined;
/**
- * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer’s last name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `customer_lastname` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} lastName
*/
exports.prototype['lastName'] = undefined;
/**
- * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
+ * Customer’s phone number. #### For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
* @member {String} phoneNumber
*/
exports.prototype['phoneNumber'] = undefined;
/**
- * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} email
*/
exports.prototype['email'] = undefined;
/**
- * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_zip` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} postalCode
*/
exports.prototype['postalCode'] = undefined;
diff --git a/src/model/Riskv1decisionsOrderInformationLineItems.js b/src/model/Riskv1decisionsOrderInformationLineItems.js
index a97c79d4..4a270086 100644
--- a/src/model/Riskv1decisionsOrderInformationLineItems.js
+++ b/src/model/Riskv1decisionsOrderInformationLineItems.js
@@ -88,7 +88,7 @@
obj['productCode'] = ApiClient.convertToType(data['productCode'], 'String');
}
if (data.hasOwnProperty('gift')) {
- obj['gift'] = ApiClient.convertToType(data['gift'], 'String');
+ obj['gift'] = ApiClient.convertToType(data['gift'], 'Boolean');
}
if (data.hasOwnProperty('distributorProductSku')) {
obj['distributorProductSku'] = ApiClient.convertToType(data['distributorProductSku'], 'String');
@@ -101,12 +101,12 @@
}
/**
- * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ 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. See \"Zero Amount Authorizations,\" page 220.
+ * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Zero Amount Authorizations 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. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} unitPrice
*/
exports.prototype['unitPrice'] = undefined;
/**
- * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.
+ * Number of units for this order. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is \"gift_card\", this is the total count of individual prepaid gift cards purchased.
* @member {Number} quantity
*/
exports.prototype['quantity'] = undefined;
@@ -126,16 +126,15 @@
*/
exports.prototype['productName'] = undefined;
/**
- * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.
+ * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
* @member {String} productCode
*/
exports.prototype['productCode'] = undefined;
/**
- * Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different. - `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different. - `off`: Differences between billing and shipping addresses do not affect the score.
- * @member {String} gift
- * @default 'no'
+ * Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different.
+ * @member {Boolean} gift
*/
- exports.prototype['gift'] = 'no';
+ exports.prototype['gift'] = undefined;
/**
* Product’s identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules.
* @member {String} distributorProductSku
diff --git a/src/model/Riskv1decisionsOrderInformationPassenger.js b/src/model/Riskv1decisionsOrderInformationPassenger.js
index 0d953cb8..196fb9f2 100644
--- a/src/model/Riskv1decisionsOrderInformationPassenger.js
+++ b/src/model/Riskv1decisionsOrderInformationPassenger.js
@@ -55,6 +55,7 @@
+
};
/**
@@ -89,6 +90,9 @@
if (data.hasOwnProperty('email')) {
obj['email'] = ApiClient.convertToType(data['email'], 'String');
}
+ if (data.hasOwnProperty('nationality')) {
+ obj['nationality'] = ApiClient.convertToType(data['nationality'], 'String');
+ }
}
return obj;
}
@@ -104,7 +108,7 @@
*/
exports.prototype['status'] = undefined;
/**
- * Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code.
+ * Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)
* @member {String} phone
*/
exports.prototype['phone'] = undefined;
@@ -128,6 +132,11 @@
* @member {String} email
*/
exports.prototype['email'] = undefined;
+ /**
+ * Passenger's nationality country. Use the two character ISO Standard Country Codes.
+ * @member {String} nationality
+ */
+ exports.prototype['nationality'] = undefined;
diff --git a/src/model/Riskv1decisionsOrderInformationShippingDetails.js b/src/model/Riskv1decisionsOrderInformationShippingDetails.js
index 7afad86a..b5c7d598 100644
--- a/src/model/Riskv1decisionsOrderInformationShippingDetails.js
+++ b/src/model/Riskv1decisionsOrderInformationShippingDetails.js
@@ -64,7 +64,7 @@
obj = obj || new exports();
if (data.hasOwnProperty('giftWrap')) {
- obj['giftWrap'] = ApiClient.convertToType(data['giftWrap'], 'String');
+ obj['giftWrap'] = ApiClient.convertToType(data['giftWrap'], 'Boolean');
}
if (data.hasOwnProperty('shippingMethod')) {
obj['shippingMethod'] = ApiClient.convertToType(data['shippingMethod'], 'String');
@@ -74,8 +74,8 @@
}
/**
- * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping.
- * @member {String} giftWrap
+ * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping.
+ * @member {Boolean} giftWrap
*/
exports.prototype['giftWrap'] = undefined;
/**
diff --git a/src/model/Riskv1decisionsPaymentInformationCard.js b/src/model/Riskv1decisionsPaymentInformationCard.js
index f6cd669f..18fcf926 100644
--- a/src/model/Riskv1decisionsPaymentInformationCard.js
+++ b/src/model/Riskv1decisionsPaymentInformationCard.js
@@ -86,12 +86,12 @@
}
/**
- * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} number
*/
exports.prototype['number'] = undefined;
/**
- * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International)
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} type
*/
exports.prototype['type'] = undefined;
@@ -101,12 +101,12 @@
*/
exports.prototype['bin'] = undefined;
/**
- * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationMonth
*/
exports.prototype['expirationMonth'] = undefined;
/**
- * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * Four-digit year in which the credit card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationYear
*/
exports.prototype['expirationYear'] = undefined;
diff --git a/src/model/Riskv1decisionsPaymentInformationTokenizedCard.js b/src/model/Riskv1decisionsPaymentInformationTokenizedCard.js
index f48e5a49..d5320b8e 100644
--- a/src/model/Riskv1decisionsPaymentInformationTokenizedCard.js
+++ b/src/model/Riskv1decisionsPaymentInformationTokenizedCard.js
@@ -82,7 +82,7 @@
}
/**
- * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International)
+ * Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} type
*/
exports.prototype['type'] = undefined;
@@ -92,12 +92,12 @@
*/
exports.prototype['number'] = undefined;
/**
- * Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationMonth
*/
exports.prototype['expirationMonth'] = undefined;
/**
- * Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
+ * One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
* @member {String} expirationYear
*/
exports.prototype['expirationYear'] = undefined;
diff --git a/src/model/Riskv1decisionsRiskInformation.js b/src/model/Riskv1decisionsRiskInformation.js
index 3ab94be2..31d75ff5 100644
--- a/src/model/Riskv1decisionsRiskInformation.js
+++ b/src/model/Riskv1decisionsRiskInformation.js
@@ -48,6 +48,7 @@
var _this = this;
+
};
/**
@@ -64,6 +65,9 @@
if (data.hasOwnProperty('profile')) {
obj['profile'] = Riskv1decisionsRiskInformationProfile.constructFromObject(data['profile']);
}
+ if (data.hasOwnProperty('eventType')) {
+ obj['eventType'] = ApiClient.convertToType(data['eventType'], 'String');
+ }
}
return obj;
}
@@ -72,6 +76,11 @@
* @member {module:model/Riskv1decisionsRiskInformationProfile} profile
*/
exports.prototype['profile'] = undefined;
+ /**
+ * Specifies one of the following types of events: - login - account_creation - account_update For regular payment transactions, do not send this field.
+ * @member {String} eventType
+ */
+ exports.prototype['eventType'] = undefined;
diff --git a/src/model/Riskv1decisionsRiskInformationProfile.js b/src/model/Riskv1decisionsRiskInformationProfile.js
index fa5d16f0..599df813 100644
--- a/src/model/Riskv1decisionsRiskInformationProfile.js
+++ b/src/model/Riskv1decisionsRiskInformationProfile.js
@@ -70,7 +70,7 @@
}
/**
- * Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen.
+ * Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. **Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field only if you want to specify the name of a different profile. The passed-in profile will then become the active profile.
* @member {String} name
*/
exports.prototype['name'] = undefined;
diff --git a/src/model/Riskv1decisionsTravelInformation.js b/src/model/Riskv1decisionsTravelInformation.js
index 0fb0c238..5a57d2fc 100644
--- a/src/model/Riskv1decisionsTravelInformation.js
+++ b/src/model/Riskv1decisionsTravelInformation.js
@@ -51,6 +51,7 @@
+
};
/**
@@ -64,6 +65,9 @@
if (data) {
obj = obj || new exports();
+ if (data.hasOwnProperty('actualFinalDestination')) {
+ obj['actualFinalDestination'] = ApiClient.convertToType(data['actualFinalDestination'], 'String');
+ }
if (data.hasOwnProperty('completeRoute')) {
obj['completeRoute'] = ApiClient.convertToType(data['completeRoute'], 'String');
}
@@ -80,6 +84,11 @@
return obj;
}
+ /**
+ * IATA Code for the actual final destination that the customer intends to travel to. It should be a destination on the completeRoute.
+ * @member {String} actualFinalDestination
+ */
+ exports.prototype['actualFinalDestination'] = undefined;
/**
* Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields.
* @member {String} completeRoute
diff --git a/src/model/Riskv1decisionsTravelInformationLegs.js b/src/model/Riskv1decisionsTravelInformationLegs.js
index a4feb103..78e8834c 100644
--- a/src/model/Riskv1decisionsTravelInformationLegs.js
+++ b/src/model/Riskv1decisionsTravelInformationLegs.js
@@ -49,6 +49,7 @@
+
};
/**
@@ -68,20 +69,28 @@
if (data.hasOwnProperty('destination')) {
obj['destination'] = ApiClient.convertToType(data['destination'], 'String');
}
+ if (data.hasOwnProperty('departureDateTime')) {
+ obj['departureDateTime'] = ApiClient.convertToType(data['departureDateTime'], 'String');
+ }
}
return obj;
}
/**
- * Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_orig=SFO decision_manager_travel_leg1_orig=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs.
+ * Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.origination=SFO` `travelInformation.legs.1.origination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)
* @member {String} origination
*/
exports.prototype['origination'] = undefined;
/**
- * Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_dest=SFO decision_manager_travel_leg1_dest=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs.
+ * Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a positive integer from 0 to N. For example: `travelInformation.legs.0.destination=SFO` `travelInformation.legs.1.destination=SFO` **Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)
* @member {String} destination
*/
exports.prototype['destination'] = undefined;
+ /**
+ * Departure date and time for the nth leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z `HH` = hour in 24-hour format `hh` = hour in 12-hour format `a` = am or pm (case insensitive) `z` = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. **Important** For travel information, use GMT instead of UTC, or use the local time zone. #### Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST **Note** When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset.
+ * @member {String} departureDateTime
+ */
+ exports.prototype['departureDateTime'] = undefined;
diff --git a/src/model/SelfLinkBean.js b/src/model/SelfLinkBean.js
new file mode 100644
index 00000000..bbb46ea7
--- /dev/null
+++ b/src/model/SelfLinkBean.js
@@ -0,0 +1,89 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.SelfLinkBean = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The SelfLinkBean model module.
+ * @module model/SelfLinkBean
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new SelfLinkBean.
+ * @alias module:model/SelfLinkBean
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+ };
+
+ /**
+ * Constructs a SelfLinkBean from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/SelfLinkBean} obj Optional instance to populate.
+ * @return {module:model/SelfLinkBean} The populated SelfLinkBean instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('href')) {
+ obj['href'] = ApiClient.convertToType(data['href'], 'String');
+ }
+ if (data.hasOwnProperty('method')) {
+ obj['method'] = ApiClient.convertToType(data['method'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * @member {String} href
+ */
+ exports.prototype['href'] = undefined;
+ /**
+ * @member {String} method
+ */
+ exports.prototype['method'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/TokenizeParameters.js b/src/model/TokenizeParameters.js
new file mode 100644
index 00000000..31e32853
--- /dev/null
+++ b/src/model/TokenizeParameters.js
@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient', 'model/Flexv1tokensCardInfo'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'), require('./Flexv1tokensCardInfo'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.TokenizeParameters = factory(root.CyberSource.ApiClient, root.CyberSource.Flexv1tokensCardInfo);
+ }
+}(this, function(ApiClient, Flexv1tokensCardInfo) {
+ 'use strict';
+
+
+
+
+ /**
+ * The TokenizeParameters model module.
+ * @module model/TokenizeParameters
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new TokenizeParameters.
+ * @alias module:model/TokenizeParameters
+ * @class
+ * @param keyId {String} Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples](http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
+ */
+ var exports = function(keyId) {
+ var _this = this;
+
+ _this['keyId'] = keyId;
+
+ };
+
+ /**
+ * Constructs a TokenizeParameters from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/TokenizeParameters} obj Optional instance to populate.
+ * @return {module:model/TokenizeParameters} The populated TokenizeParameters instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('keyId')) {
+ obj['keyId'] = ApiClient.convertToType(data['keyId'], 'String');
+ }
+ if (data.hasOwnProperty('cardInfo')) {
+ obj['cardInfo'] = Flexv1tokensCardInfo.constructFromObject(data['cardInfo']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples](http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
+ * @member {String} keyId
+ */
+ exports.prototype['keyId'] = undefined;
+ /**
+ * @member {module:model/Flexv1tokensCardInfo} cardInfo
+ */
+ exports.prototype['cardInfo'] = undefined;
+
+
+
+ return exports;
+}));
+
+
diff --git a/src/model/TokenizeRequest.js b/src/model/TokenizeRequest.js
index ed2d24eb..92ea551f 100644
--- a/src/model/TokenizeRequest.js
+++ b/src/model/TokenizeRequest.js
@@ -43,7 +43,7 @@
* Constructs a new TokenizeRequest.
* @alias module:model/TokenizeRequest
* @class
- * @param keyId {String} Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
+ * @param keyId {String} Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples](http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
*/
var exports = function(keyId) {
var _this = this;
@@ -74,7 +74,7 @@
}
/**
- * Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
+ * Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples](http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.
* @member {String} keyId
*/
exports.prototype['keyId'] = undefined;
diff --git a/src/model/TokenizeResult.js b/src/model/TokenizeResult.js
new file mode 100644
index 00000000..aad06dd3
--- /dev/null
+++ b/src/model/TokenizeResult.js
@@ -0,0 +1,144 @@
+/**
+ * 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
+ *
+ * Swagger Codegen version: 2.3.0
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['ApiClient'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('../ApiClient'));
+ } else {
+ // Browser globals (root is window)
+ if (!root.CyberSource) {
+ root.CyberSource = {};
+ }
+ root.CyberSource.TokenizeResult = factory(root.CyberSource.ApiClient);
+ }
+}(this, function(ApiClient) {
+ 'use strict';
+
+
+
+
+ /**
+ * The TokenizeResult model module.
+ * @module model/TokenizeResult
+ * @version 0.0.1
+ */
+
+ /**
+ * Constructs a new TokenizeResult.
+ * @alias module:model/TokenizeResult
+ * @class
+ */
+ var exports = function() {
+ var _this = this;
+
+
+
+
+
+
+
+
+
+ };
+
+ /**
+ * Constructs a TokenizeResult from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/TokenizeResult} obj Optional instance to populate.
+ * @return {module:model/TokenizeResult} The populated TokenizeResult instance.
+ */
+ exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('keyId')) {
+ obj['keyId'] = ApiClient.convertToType(data['keyId'], 'String');
+ }
+ if (data.hasOwnProperty('token')) {
+ obj['token'] = ApiClient.convertToType(data['token'], 'String');
+ }
+ if (data.hasOwnProperty('maskedPan')) {
+ obj['maskedPan'] = ApiClient.convertToType(data['maskedPan'], 'String');
+ }
+ if (data.hasOwnProperty('cardType')) {
+ obj['cardType'] = ApiClient.convertToType(data['cardType'], 'String');
+ }
+ if (data.hasOwnProperty('timestamp')) {
+ obj['timestamp'] = ApiClient.convertToType(data['timestamp'], 'Number');
+ }
+ if (data.hasOwnProperty('signedFields')) {
+ obj['signedFields'] = ApiClient.convertToType(data['signedFields'], 'String');
+ }
+ if (data.hasOwnProperty('signature')) {
+ obj['signature'] = ApiClient.convertToType(data['signature'], 'String');
+ }
+ if (data.hasOwnProperty('discoverableServices')) {
+ obj['discoverableServices'] = ApiClient.convertToType(data['discoverableServices'], {'String': Object});
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The Key ID.
+ * @member {String} keyId
+ */
+ exports.prototype['keyId'] = undefined;
+ /**
+ * The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API.
+ * @member {String} token
+ */
+ exports.prototype['token'] = undefined;
+ /**
+ * The masked card number displaying the first 6 digits and the last 4 digits.
+ * @member {String} maskedPan
+ */
+ exports.prototype['maskedPan'] = undefined;
+ /**
+ * The card type.
+ * @member {String} cardType
+ */
+ exports.prototype['cardType'] = undefined;
+ /**
+ * The UTC date and time in milliseconds at which the signature was generated.
+ * @member {Number} timestamp
+ */
+ exports.prototype['timestamp'] = undefined;
+ /**
+ * Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature.
+ * @member {String} signedFields
+ */
+ exports.prototype['signedFields'] = undefined;
+ /**
+ * Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource.
+ * @member {String} signature
+ */
+ exports.prototype['signature'] = undefined;
+ /**
+ * @member {Object.