header : merchantConfig.getDefaultHeaders().entrySet()) {
- addDefaultHeader(header.getKey(), header.getValue());
+ if(!header.getKey().equalsIgnoreCase("Authorization") && !header.getKey().equalsIgnoreCase("Signature")){
+ addDefaultHeader(header.getKey(), header.getValue());
+ }
}
}
diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
index 5af49fdb7..5e9dc0778 100644
--- a/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
+++ b/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
@@ -180,7 +180,8 @@ public class {{classname}} {
/**
* {{summary}}
- * {{notes}}{{#allParams}}
+ * {{notes}}{{#vendorExtensions.x-devcenter-metaData.SDK_ONLY_AddDisclaimer}}
+ * DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
{{/vendorExtensions.x-devcenter-metaData.SDK_ONLY_AddDisclaimer}}{{#allParams}}
* @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}{{#returnType}}
* @return {{returnType}}{{/returnType}}
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json
index 025fb8c03..d7b2f9402 100644
--- a/generator/cybersource-rest-spec.json
+++ b/generator/cybersource-rest-spec.json
@@ -23,11 +23,11 @@
},
{
"name": "capture",
- "description": "When you are ready to fulfill a customer\u2019s order and transfer funds from the customer\u2019s\nbank to your bank, capture the payment for that order.\n"
+ "description": "When you are ready to fulfill a customer's order and transfer funds from the customer's\nbank to your bank, capture the payment for that order.\n"
},
{
"name": "reversal",
- "description": "An authorization reversal releases the hold that the payment placed on the customer\u2019s funds."
+ "description": "An authorization reversal releases the hold that the payment placed on the customer's funds."
},
{
"name": "refund",
@@ -229,7 +229,7 @@
"description": "Create a new webhook connection\n"
},
{
- "name": "Manage_Webhooks",
+ "name": "Manage Webhooks",
"description": "- Create and manage your webhooks. This will allow for you to set up new webhooks, update existing webhooks, test webhooks, or delete them.\n"
},
{
@@ -411,7 +411,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -456,7 +456,7 @@
},
"enableEscrowOption": {
"type": "boolean",
- "description": "Indicates whether to use the customer\u2019s escrow agreement.\nPossible values:\n- `true`: yes, use the customer\u2019s escrow agreement.\n- `false`: no, do not use the customer\u2019s escrow agreement. \n"
+ "description": "Indicates whether to use the customer's escrow agreement.\nPossible values:\n- `true`: yes, use the customer's escrow agreement.\n- `false`: no, do not use the customer's escrow agreement. \n"
},
"actionTokenTypes": {
"type": "array",
@@ -486,12 +486,12 @@
"commerceIndicator": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"commerceIndicatorLabel": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"paymentSolution": {
"type": "string",
@@ -576,7 +576,7 @@
},
"declineAvsFlags": {
"type": "array",
- "description": "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated\nlist.\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.\n In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America.\n The information in this section is for the specific processing connection called CyberSource Latin American Processing.\n 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\nAVS 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\nAVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for\nthe 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\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",
+ "description": "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated\nlist.\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.\n In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America.\n The information in this section is for the specific processing connection called CyberSource Latin American Processing.\n 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\nAVS 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\nAVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for\nthe 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\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's 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's 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's 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's 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's name, street address, and postal code do not match.|\n|O|Partial match: card member's 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's 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's 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"
}
@@ -595,7 +595,7 @@
},
"credentialStoredOnFile": {
"type": "boolean",
- "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/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\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's 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's 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/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n"
},
"storedCredentialUsed": {
"type": "boolean",
@@ -708,7 +708,7 @@
"declineAvsFlags": {
"type": "string",
"maxLength": 15,
- "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"
+ "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'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 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's 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's 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's 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's 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's name, street address, and postal code do not match.|\n|O|Partial match: card member's 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's 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's 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",
@@ -738,7 +738,7 @@
"customerMemo": {
"type": "string",
"maxLength": 80,
- "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n"
+ "description": "Payment related information.\n\nThis information is included on the customer's statement.\n"
},
"paymentCategoryCode": {
"type": "string",
@@ -809,7 +809,7 @@
"walletType": {
"type": "string",
"maxLength": 5,
- "description": "This field carries the wallet type in authorization requests and credit requests. Possible value are:\n- `101`: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet.\n- `102`: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet.\n- `103`: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet.\n- `216`: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet.\n- `217`: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet.\n- `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.\n- `VCIND`: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below.\nFor all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nMasterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer\u2019s checkout information.\n\nVisa Checkout:\nThis field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations.\nFor Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring\nSolutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nFor incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102.\nPayment card companies can introduce new values without notice. Your order management system should be able to process new values without problems.\n\nCyberSource through VisaNet\nWhen the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier.\nWhen the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.\n"
+ "description": "This field carries the wallet type in authorization requests and credit requests. Possible value are:\n- `101`: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet.\n- `102`: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet.\n- `103`: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet.\n- `216`: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet.\n- `217`: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet.\n- `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.\n- `VCIND`: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below.\nFor all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nMasterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer's checkout information.\n\nVisa Checkout:\nThis field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations.\nFor Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring\nSolutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nFor incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102.\nPayment card companies can introduce new values without notice. Your order management system should be able to process new values without problems.\n\nCyberSource through VisaNet\nWhen the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier.\nWhen the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.\n"
},
"nationalNetDomesticData": {
"type": "string",
@@ -894,7 +894,7 @@
"mobileRemotePaymentType": {
"type": "string",
"maxLength": 1,
- "description": "Type of payment initiated from a cardholder's mobile device. Possible values:\n- `1` : Consumer-initiated remote purchase, face-to-face\n- `2` : Consumer-initiated remote purchase, e-commerce\n- `3` : Consumer-initiated remote purchase, mail order / telephone order\n- `4` : Consumer-initiated bill pay\n- `5` : Consumer-initiated top up\n- `6` : Consumer-initiated cash out\n- `7` : ATM triggered or agent-initiated cash out\n- `8` : Merchant-initiated remote purchase, face-to-face\n- `9` : Merchant-initiated remote purchase, e-commerce\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nOptional field.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the\nTC 33 capture file:\n- Record: CP01 TCR6\n- Position: 94\n- Field: Mastercard Mobile Remote Payment Program Indicator\n\nThe 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\nmerchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
+ "description": "Type of payment initiated from a cardholder's mobile device. Possible values:\n- `1` : Consumer-initiated remote purchase, face-to-face\n- `2` : Consumer-initiated remote purchase, e-commerce\n- `3` : Consumer-initiated remote purchase, mail order / telephone order\n- `4` : Consumer-initiated bill pay\n- `5` : Consumer-initiated top up\n- `6` : Consumer-initiated cash out\n- `7` : ATM triggered or agent-initiated cash out\n- `8` : Merchant-initiated remote purchase, face-to-face\n- `9` : Merchant-initiated remote purchase, e-commerce\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nOptional field.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the\nTC 33 capture file:\n- Record: CP01 TCR6\n- Position: 94\n- Field: Mastercard Mobile Remote Payment Program Indicator\n\nThe 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\nmerchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
},
"extendedCreditTotalCount": {
"type": "string",
@@ -904,7 +904,7 @@
"networkRoutingOrder": {
"type": "string",
"maxLength": 30,
- "description": "On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority.\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code.\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,\nVisaNet makes a selection based on the acquirer\u2019s routing priorities.\n\n#### PIN debit\nPriority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes:\n\n| Network | Code |\n| --- | --- |\n| Accel | E |\n| AFFN | U |\n| Alaska Option | 3 |\n| CU24 | C |\n| Interlink | G |\n| Maestro | 8 |\n| NETS | P |\n| NYCE | F |\n| Pulse | H |\n| Shazam | 7 |\n| Star | M |\n| Visa | V |\n\nFor example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of `MH`.\n\nWhen you do not include this value in your PIN debit request, the list of network codes from your account is used.\n**Note** This field is supported only for businesses located in the U.S.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority.\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference.\nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists,\nVisaNet makes a selection based on the acquirer's routing priorities.\n\n#### PIN debit\nPriority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes:\n\n| Network | Code |\n| --- | --- |\n| Accel | E |\n| AFFN | U |\n| Alaska Option | 3 |\n| CU24 | C |\n| Interlink | G |\n| Maestro | 8 |\n| NETS | P |\n| NYCE | F |\n| Pulse | H |\n| Shazam | 7 |\n| Star | M |\n| Visa | V |\n\nFor example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of `MH`.\n\nWhen you do not include this value in your PIN debit request, the list of network codes from your account is used.\n**Note** This field is supported only for businesses located in the U.S.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"payByPointsIndicator": {
"type": "boolean",
@@ -940,7 +940,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"expirationMonth": {
"type": "string",
@@ -984,7 +984,7 @@
"accountEncoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n"
+ "description": "Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.\n"
},
"issueNumber": {
"type": "string",
@@ -1019,7 +1019,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"expirationMonth": {
"type": "string",
@@ -1043,12 +1043,12 @@
"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\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"assuranceLevel": {
"type": "string",
@@ -1106,7 +1106,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -1179,7 +1179,7 @@
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"checkNumber": {
"type": "string",
@@ -1205,12 +1205,12 @@
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
},
"code": {
"type": "string",
"maxLength": 50,
- "description": "Bank code of the consumer\u2019s account\n"
+ "description": "Bank code of the consumer's account\n"
}
}
},
@@ -1234,7 +1234,7 @@
},
"type": {
"type": "string",
- "description": "The payment channel that facilitates the transactions. This parameter can be used if the payment channels are listed on the merchant\u2019s site, and the payment channel is known.\n\nPossible Values:\n\n#### Via PPRO\n- `alfaVa`\n- `kredivo`\n- `consumerBarCode`\n- `merchantQrCode`\n- `dokuWallet`\n"
+ "description": "The payment channel that facilitates the transactions. This parameter can be used if the payment channels are listed on the merchant's site, and the payment channel is known.\n\nPossible Values:\n\n#### Via PPRO\n- `alfaVa`\n- `kredivo`\n- `consumerBarCode`\n- `merchantQrCode`\n- `dokuWallet`\n"
}
}
}
@@ -1360,7 +1360,7 @@
"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.\nThis field is returned for OCT transactions.\n"
+ "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account.\nThis field is returned for OCT transactions.\n"
},
"settlementCurrency": {
"type": "string",
@@ -1444,7 +1444,7 @@
"cashbackAmount": {
"type": "string",
"maxLength": 13,
- "description": "Cashback amount in the acquirer\u2019s currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
+ "description": "Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
},
"currencyConversion": {
"type": "object",
@@ -1474,22 +1474,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\n"
},
"nameSuffix": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s name suffix.\n"
+ "description": "Customer's name suffix.\n"
},
"title": {
"type": "string",
@@ -1502,7 +1502,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's 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",
@@ -1539,7 +1539,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -1584,7 +1584,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"buildingNumber": {
"type": "string",
@@ -1604,7 +1604,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"phoneType": {
"type": "string",
@@ -1617,12 +1617,12 @@
"alternatePhoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "#### Visa Platform Connect\ncontains customer\u2019s alternate phone number.\n"
+ "description": "#### Visa Platform Connect\ncontains customer's alternate phone number.\n"
},
"alternateEmail": {
"type": "string",
"maxLength": 255,
- "description": "#### Visa Platform Connect\ncontains customer\u2019s alternate email address.\n"
+ "description": "#### Visa Platform Connect\ncontains customer's alternate email address.\n"
}
}
},
@@ -1652,31 +1652,31 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"district": {
@@ -1697,7 +1697,7 @@
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\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's company.\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"
},
"destinationTypes": {
"type": "string",
@@ -1724,7 +1724,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"productName": {
"type": "string",
@@ -1954,7 +1954,7 @@
"type": "array",
"items": {
"type": "string",
- "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government\u2019s country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
+ "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
}
},
"restrictedExportCountries": {
@@ -2009,7 +2009,7 @@
"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's 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": "integer",
@@ -2023,7 +2023,7 @@
"data": {
"type": "string",
"maxLength": 40,
- "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
+ "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer's American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
}
}
}
@@ -2118,22 +2118,22 @@
"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#### 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"
+ "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's 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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"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's 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",
@@ -2151,7 +2151,7 @@
},
"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](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\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's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\n"
},
"verificationResults": {
"type": "string",
@@ -2178,7 +2178,7 @@
"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"
+ "description": "Cardholder's 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"
}
}
},
@@ -2188,27 +2188,27 @@
"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 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/)\n"
+ "description": "Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's 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/)\n"
},
"lastName": {
"type": "string",
"maxLength": 35,
- "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/)\n"
+ "description": "Recipient's 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/)\n"
},
"middleName": {
"type": "string",
"maxLength": 35,
- "description": "Recipient\u2019s middle 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_middlename` 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/)\n"
+ "description": "Recipient's middle 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_middlename` 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/)\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "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/)\n"
+ "description": "Partial postal code for the recipient's 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/)\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 `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/)\n"
+ "description": "Recipient's 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/)\n"
}
}
},
@@ -2228,11 +2228,11 @@
"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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
},
"fingerprintSessionId": {
"type": "string",
- "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"
+ "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's 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"
},
"useRawFingerprintSessionId": {
"type": "boolean",
@@ -2267,7 +2267,7 @@
"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"
+ "description": "Value of the Accept header sent by the customer's web browser.\n**Note** If the customer's browser provides a value, you must include it in your request.\n"
},
"httpAcceptContent": {
"type": "string",
@@ -2276,7 +2276,7 @@
},
"httpBrowserEmail": {
"type": "string",
- "description": "Email address set in the customer\u2019s browser, which may differ from customer email.\n"
+ "description": "Email address set in the customer's browser, which may differ from customer email.\n"
},
"httpBrowserLanguage": {
"type": "string",
@@ -2314,7 +2314,7 @@
"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": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n"
}
}
},
@@ -2326,7 +2326,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"alternateName": {
"type": "string",
@@ -2346,21 +2346,21 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"phone": {
"type": "string",
@@ -2392,17 +2392,17 @@
"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 description 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's 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": "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"
+ "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's 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 `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"
+ "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's 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",
@@ -2430,17 +2430,17 @@
"name": {
"type": "string",
"maxLength": 22,
- "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \"Service Fee.\"\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\"1 of 5\" or \"3 of 7.\" For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder's statement.\n"
},
"contact": {
"type": "string",
"maxLength": 11,
- "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder's statement.\n"
},
"state": {
"type": "string",
"maxLength": 20,
- "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder's statement.\n"
}
}
},
@@ -2476,29 +2476,29 @@
"locality": {
"type": "string",
"maxLength": 20,
- "description": "#### Visa Platform Connect\n\nMerchant\u2019s service location city name. When merchant provides services from a location other than the location identified as merchant location.\n"
+ "description": "#### Visa Platform Connect\n\nMerchant's service location city name. When merchant provides services from a location other than the location identified as merchant location.\n"
},
"countrySubdivisionCode": {
"type": "string",
"maxLength": 9,
- "description": "#### Visa Platform Connect\n\nMerchant\u2019s service location country subdivision code. When merchant provides services from a location other than the location identified as merchant location.\n"
+ "description": "#### Visa Platform Connect\n\nMerchant's service location country subdivision code. When merchant provides services from a location other than the location identified as merchant location.\n"
},
"countryCode": {
"type": "string",
"maxLength": 3,
- "description": "#### Visa Platform Connect\n\nMerchant\u2019s service location country code. When merchant provides services from a location other than the location identified as merchant location.\n"
+ "description": "#### Visa Platform Connect\n\nMerchant's service location country code. When merchant provides services from a location other than the location identified as merchant location.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "#### Visa Platform Connect\n\nMerchant\u2019s service location postal code. When merchant provides services from a location other than the location identified as merchant location.\n"
+ "description": "#### Visa Platform Connect\n\nMerchant's service location postal code. When merchant provides services from a location other than the location identified as merchant location.\n"
}
}
},
"merchantName": {
"type": "string",
"maxLength": 25,
- "description": "Use this field only if you are requesting payment with Payer Authentication service together.\n\nYour 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": "Use this field only if you are requesting payment with Payer Authentication service together.\n\nYour company's name as you want it to appear to the customer in the issuing bank's authentication form.\nThis value overrides the value specified by your merchant bank.\n"
}
}
},
@@ -2531,47 +2531,47 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"region": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
}
}
}
@@ -2836,7 +2836,7 @@
"returnUrl": {
"type": "string",
"maxLength": 2048,
- "description": "The URL of the merchant\u2019s return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session\u2019s transactionId. The merchant\u2019s return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
+ "description": "The URL of the merchant's return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session's transactionId. The merchant's return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
},
"requestorId": {
"type": "string",
@@ -2930,7 +2930,7 @@
"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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
+ "description": "POS terminal's 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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
},
"operatingEnvironment": {
"type": "string",
@@ -2943,7 +2943,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"cardholderVerificationMethodUsed": {
"type": "integer",
@@ -2965,7 +2965,7 @@
},
"isRepeat": {
"type": "boolean",
- "description": "#### Visa Platform Connect\nValue \u201ctrue\u201d indicates this transaction is intentionally duplicated . The field contains value \u201ctrue\u201d which\nindicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending\na duplicate auth request for a single tap txn because the issuer requested a PIN.\n"
+ "description": "#### Visa Platform Connect\nValue \"true\" indicates this transaction is intentionally duplicated . The field contains value \"true\" which\nindicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending\na duplicate auth request for a single tap txn because the issuer requested a PIN.\n"
}
}
},
@@ -2976,7 +2976,7 @@
},
"trackData": {
"type": "string",
- "description": "Card\u2019s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n\n#### Used by\n**Authorization**\nRequired for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global,\nJCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values:\n- `contact`\n- `contactless`\n- `msd`\n- `swiped`\nOtherwise, this field not used.\n\nRequired for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used.\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### PIN debit\nTrack 2 data from the debit card. The sentinels are required.\nRequired field for a PIN debit purchase and a PIN debit credit.\n"
+ "description": "Card's track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n\n#### Used by\n**Authorization**\nRequired for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global,\nJCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values:\n- `contact`\n- `contactless`\n- `msd`\n- `swiped`\nOtherwise, this field not used.\n\nRequired for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used.\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### PIN debit\nTrack 2 data from the debit card. The sentinels are required.\nRequired field for a PIN debit purchase and a PIN debit credit.\n"
},
"storeAndForwardIndicator": {
"type": "string",
@@ -3053,12 +3053,12 @@
"terminalCompliance": {
"type": "string",
"maxLength": 2,
- "description": "Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India.\n\nFormat:\n- First character indicates whether the terminal supports terminal line encryption (TLE). Possible values:\n - 1: Not certified\n - 2: Certified\n- Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values:\n - 1: Not certified\n - 2: Certified\n\n**Example** `21` indicates that the terminal supports TLE but does not support UKPT/DUKPT.\n\nYou and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer.\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 92-93\n- Field: Mastercard Terminal Compliance Indicator\n\nThe 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 networks.\n\n#### Used by\n**Authorization**\nRequired for card-present transactions in India. Otherwise, not used.\n"
+ "description": "Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India.\n\nFormat:\n- First character indicates whether the terminal supports terminal line encryption (TLE). Possible values:\n - 1: Not certified\n - 2: Certified\n- Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values:\n - 1: Not certified\n - 2: Certified\n\n**Example** `21` indicates that the terminal supports TLE but does not support UKPT/DUKPT.\n\nYou and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer.\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 92-93\n- Field: Mastercard Terminal Compliance Indicator\n\nThe 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.\n\n#### Used by\n**Authorization**\nRequired for card-present transactions in India. Otherwise, not used.\n"
},
"isDedicatedHardwareTerminal": {
"type": "string",
"maxLength": 1,
- "description": "Type of mPOS device. Possible values:\n- 0: Dongle\n- 1: Phone or tablet\n\nThis optional field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 141\n- Field: Mastercard mPOS Transaction\n\nThe 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\nacquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
+ "description": "Type of mPOS device. Possible values:\n- 0: Dongle\n- 1: Phone or tablet\n\nThis optional field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 141\n- Field: Mastercard mPOS Transaction\n\nThe 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's\nacquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
},
"terminalModel": {
"type": "string",
@@ -3138,12 +3138,12 @@
"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.\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/)\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/)\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/)\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's 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/)\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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"totalAmount": {
"type": "string",
@@ -3153,7 +3153,7 @@
"totalCount": {
"type": "integer",
"maximum": 99,
- "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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"firstInstallmentDate": {
"type": "string",
@@ -3250,7 +3250,7 @@
"distanceUnit": {
"type": "string",
"maxLength": 1,
- "description": "Miles/Kilometers Indicator shows whether the \u201cmiles\u201d fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
+ "description": "Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
},
"returnDateTime": {
"type": "string",
@@ -3274,7 +3274,7 @@
"programCode": {
"type": "string",
"maxLength": 2,
- "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\u201d or \u201dshow\u201d.\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
+ "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\".\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
},
"returnAddress": {
"type": "object",
@@ -3349,7 +3349,7 @@
"agreementNumber": {
"type": "string",
"maxLength": 25,
- "description": "Auto rental agency\u2019s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
+ "description": "Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
},
"odometerReading": {
"type": "string",
@@ -3379,7 +3379,7 @@
"specialProgramCode": {
"type": "string",
"maxLength": 2,
- "description": "Program code used to identify special circumstances, such as \u201cfrequent renter\u201d or \u201cno show\u201d status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
+ "description": "Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
},
"vehicleMake": {
"type": "string",
@@ -3913,7 +3913,7 @@
"processIdentifier": {
"type": "string",
"maxLength": 3,
- "description": "Airline process identifier. This value is the airline\u2019s three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
+ "description": "Airline process identifier. This value is the airline's three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
},
"ticketIssueDate": {
"type": "string",
@@ -4007,7 +4007,7 @@
"stopoverIndicator": {
"type": "integer",
"maxLength": 1,
- "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \u201cO\u201d) (default): Stopover allowed\n- `X` (capital letter \u201cX\u201d): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
+ "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \"O\") (default): Stopover allowed\n- `X` (capital letter \"X\"): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
},
"departureDate": {
"type": "integer",
@@ -4098,7 +4098,7 @@
"passengerName": {
"type": "string",
"maxLength": 20,
- "description": "Name of the passenger. If the passenger\u2019s name is not available, this value is the cardholder\u2019s name. If neither the passenger\u2019s name nor the cardholder\u2019s name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
+ "description": "Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
},
"connectedTicketNumber": {
"type": "string",
@@ -4289,7 +4289,7 @@
"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"
+ "description": "Date the cardholder's 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",
@@ -4476,7 +4476,7 @@
"properties": {
"addressOperator": {
"type": "string",
- "description": "Parts of the customer\u2019s information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer\u2019s name or company and the customer\u2019s address must appear in the database.\n- OR: The customer\u2019s name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer\u2019s name or company but not of the address.\n"
+ "description": "Parts of the customer's information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer's name or company and the customer's address must appear in the database.\n- OR: The customer's name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer's name or company but not of the address.\n"
},
"weights": {
"type": "object",
@@ -4484,7 +4484,7 @@
"address": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
},
"company": {
"type": "string",
@@ -4494,7 +4494,7 @@
"name": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
}
}
},
@@ -4860,92 +4860,92 @@
"code": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"codeRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s last name"
+ "description": "Raw Electronic Verification response code from the processor for the customer's last name"
},
"email": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"emailRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address."
+ "description": "Raw Electronic Verification response code from the processor for the customer's email address."
},
"phoneNumber": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"phoneNumberRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number."
+ "description": "Raw Electronic Verification response code from the processor for the customer's phone number."
},
"postalCode": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"postalCodeRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code."
+ "description": "Raw Electronic Verification response code from the processor for the customer's postal code."
},
"street": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"streetRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address."
+ "description": "Raw Electronic Verification response code from the processor for the customer's street address."
},
"name": {
"type": "string",
"maxLength": 30,
- "description": "#### Visa Platform Connect\nMapped Electronic Verification response code for the customer\u2019s name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
+ "description": "#### Visa Platform Connect\nMapped Electronic Verification response code for the customer's name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
},
"nameRaw": {
"type": "string",
"maxLength": 30,
- "description": "#### Visa Platform Connect\nRaw Electronic Verification response code from the processor for the customer\u2019s name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
+ "description": "#### Visa Platform Connect\nRaw Electronic Verification response code from the processor for the customer's name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
},
"firstNameRaw": {
"type": "string",
"maxLength": 2,
- "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer\u2019s first name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
+ "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer's first name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
},
"firstName": {
"type": "string",
"maxLength": 1,
- "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer\u2019s first name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
+ "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer's first name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
},
"middleNameRaw": {
"type": "string",
"maxLength": 2,
- "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer\u2019s middle name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
+ "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer's middle name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
},
"middleName": {
"type": "string",
"maxLength": 1,
- "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer\u2019s middle name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
+ "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer's middle name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
},
"lastNameRaw": {
"type": "string",
"maxLength": 2,
- "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer\u2019s last name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
+ "description": "#### Visa Platform Connect\nRaw electronic verification response code from the processor for the customer's last name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
},
"lastName": {
"type": "string",
"maxLength": 1,
- "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer\u2019s last name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
+ "description": "#### Visa Platform Connect\nMapped electronic verification response code from the processor for the customer's last name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
}
}
},
@@ -4992,17 +4992,17 @@
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\nReturned by authorization and incremental authorization services.\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**.\nReturned by authorization and incremental authorization services.\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's receipt.\n"
},
"paymentAccountReferenceNumber": {
"type": "string",
"maxLength": 32,
- "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.\nThis reply field is returned only for CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR8\n- Position: 79-110\n- Field: Payment Account Reference\n\nThe 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,\nwho uses this information to facilitate end-of-day clearing processing with payment networks.\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.\nThis reply field is returned only for CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR8\n- Position: 79-110\n- Field: Payment Account Reference\n\nThe 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's acquirer,\nwho uses this information to facilitate end-of-day clearing processing with payment networks.\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\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"
+ "description": "Transaction integrity classification provided by Mastercard. This value specifies Mastercard's evaluation of\nthe transaction's 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's acquirer, who uses\nthis information to facilitate end-of-day clearing processing with payment networks.\n"
},
"amexVerbalAuthReferenceNumber": {
"type": "string",
@@ -5103,7 +5103,7 @@
"pinRequestIndicator": {
"type": "string",
"maxLength": 1,
- "description": "This field contains value \u20181\u2019 which is sent by Issuer in the response when PIN is requested by issuer, \n\nThis field is only supported for Visa Platform Connect.\n"
+ "description": "This field contains value '1' which is sent by Issuer in the response when PIN is requested by issuer, \n\nThis field is only supported for Visa Platform Connect.\n"
}
}
},
@@ -5115,7 +5115,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
+ "description": "Last four digits of the cardholder's account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
},
"expirationMonth": {
"type": "string",
@@ -5153,7 +5153,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
+ "description": "Last four digits of the cardholder's account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
},
"expirationMonth": {
"type": "string",
@@ -5216,7 +5216,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\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
},
"assuranceMethod": {
"type": "string",
@@ -5369,7 +5369,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -5439,7 +5439,7 @@
"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"
+ "description": "Country (two-digit country code) associated with the BIN of the customer's 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"
}
}
},
@@ -5561,7 +5561,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"chipValidationType": {
"type": "string",
@@ -5673,12 +5673,12 @@
"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.\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/)\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/)\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/)\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's 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/)\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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"taxes": {
"type": "string",
@@ -5698,7 +5698,7 @@
"totalCount": {
"type": "integer",
"maximum": 99,
- "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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"minimumTotalCount": {
"type": "string",
@@ -5785,17 +5785,17 @@
"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#### 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"
+ "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's 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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"vatRegistrationNumber": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"personalIdentification": {
"type": "array",
@@ -5813,7 +5813,7 @@
},
"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](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\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's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\n"
},
"verificationResults": {
"type": "string",
@@ -5883,7 +5883,7 @@
},
"address": {
"type": "array",
- "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.\n",
+ "description": "Indicates a mismatch between the customer's billing and shipping addresses.\n",
"items": {
"type": "string"
}
@@ -5911,14 +5911,14 @@
},
"internet": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.\n",
+ "description": "Indicates a problem with the customer's email address, IP address, or billing address.\n",
"items": {
"type": "string"
}
},
"phone": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s phone number.\n",
+ "description": "Indicates a problem with the customer's phone number.\n",
"items": {
"type": "string"
}
@@ -5999,7 +5999,7 @@
"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\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"
+ "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's 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"
},
"result": {
"type": "string",
@@ -6186,11 +6186,11 @@
"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"
+ "description": "URL for the card-issuing bank's 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/)\n"
+ "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's 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/)\n"
},
"authorizationPayload": {
"type": "string",
@@ -6204,7 +6204,7 @@
"cardholderMessage": {
"type": "string",
"maxLength": 128,
- "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \u201cAdditional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\u201d.\nThe Issuing Bank can optionally support this value.\n"
+ "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \"Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\".\nThe Issuing Bank can optionally support this value.\n"
},
"cavv": {
"type": "string",
@@ -6243,7 +6243,7 @@
"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"
+ "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's directory service is not available. No liability shift.\n"
},
"eci": {
"type": "string",
@@ -6524,7 +6524,7 @@
"type": "integer",
"minimum": -1,
"maximum": 100,
- "description": "Likelihood that the country associated with the customer\u2019s IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
+ "description": "Likelihood that the country associated with the customer's IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
},
"infoCodes": {
"type": "array",
@@ -8850,6 +8850,47 @@
"parentTag": "Card Present with Visa Platform Connect"
},
"example55": {
+ "summary": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect",
+ "sample-name": "Pin Debit Purchase Using EMV Contact with Visa Platform Connect",
+ "value": {
+ "clientReferenceInformation": {
+ "code": "Pin Debit Purchase Using EMV Contact",
+ "partner": {
+ "thirdPartyCertificationNumber": "PTP1234"
+ }
+ },
+ "pointOfSaleInformation": {
+ "entryMode": "contact",
+ "terminalCapability": 4,
+ "emv": {
+ "tags": "9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000",
+ "cardSequenceNumber": 1
+ },
+ "trackData": "%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?",
+ "pinBlockEncodingFormat": 1,
+ "encryptedPin": "52F20658C04DB351",
+ "encryptedKeySerialNumber": "FFFF1B1D140000000005"
+ },
+ "processingInformation": {
+ "commerceIndicator": "retail",
+ "networkRoutingOrder": "VMHF"
+ },
+ "orderInformation": {
+ "amountDetails": {
+ "totalAmount": "202.00",
+ "currency": "USD"
+ }
+ },
+ "paymentInformation": {
+ "paymentType": {
+ "name": "CARD",
+ "subTypeName": "DEBIT"
+ }
+ }
+ },
+ "parentTag": "Card Present with Visa Platform Connect"
+ },
+ "example56": {
"summary": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect",
"sample-name": "Pin Debit Purchase Using EMV Technology with Contactless Read with Visa Platform Connect",
"value": {
@@ -8887,7 +8928,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example56": {
+ "example57": {
"summary": "Pin Debit Purchase with Cashback Request with Visa Platform Connect",
"sample-name": "Pin Debit Purchase with Cashback Request with Visa Platform Connect",
"value": {
@@ -8926,7 +8967,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example57": {
+ "example58": {
"summary": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect",
"sample-name": "Pin Debit Purchase Using EMV Contactless Balance Inquiry with Visa Platform Connect",
"value": {
@@ -8967,7 +9008,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example58": {
+ "example59": {
"summary": "EBT - Purchase from SNAP Account with Visa Platform Connect",
"sample-name": "EBT - Purchase from SNAP Account with Visa Platform Connect",
"value": {
@@ -9013,7 +9054,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example59": {
+ "example60": {
"summary": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect",
"sample-name": "EBT - Purchase from SNAP Account with Available Balance In Response with Visa Platform Connect",
"value": {
@@ -9059,7 +9100,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example60": {
+ "example61": {
"summary": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect",
"sample-name": "EBT - Electronic Voucher Purchase from SNAP Account with Visa Platform Connect",
"value": {
@@ -9108,7 +9149,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example61": {
+ "example62": {
"summary": "EBT - Purchase from Cash Benefits Account with Cashback",
"sample-name": "EBT - Purchase from Cash Benefits Account with Cashback",
"value": {
@@ -9158,7 +9199,7 @@
},
"parentTag": "Card Present with Visa Platform Connect"
},
- "example62": {
+ "example63": {
"summary": "SI Completion Amount>0",
"sample-name": "SI Completion",
"value": {
@@ -9220,7 +9261,7 @@
}
}
},
- "example63": {
+ "example64": {
"summary": "Redirectional SI Completion Amount > 0",
"sample-name": "S2S SI Completion",
"value": {
@@ -9324,7 +9365,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -9542,7 +9583,7 @@
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\nReturned by authorization and incremental authorization services.\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**.\nReturned by authorization and incremental authorization services.\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's receipt.\n"
},
"responseDetails": {
"type": "string",
@@ -9924,7 +9965,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -10102,7 +10143,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -10323,7 +10364,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -10464,7 +10505,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -10657,7 +10698,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -10818,7 +10859,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -10965,7 +11006,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -11145,7 +11186,7 @@
"cashbackAmount": {
"type": "string",
"maxLength": 13,
- "description": "Cashback amount in the acquirer\u2019s currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
+ "description": "Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
}
}
},
@@ -11160,17 +11201,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"company": {
"type": "object",
@@ -11178,7 +11219,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's 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",
@@ -11215,7 +11256,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -11230,7 +11271,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"administrativeArea": {
"type": "string",
@@ -11260,7 +11301,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -11270,17 +11311,17 @@
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -11292,7 +11333,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"productName": {
"type": "string",
@@ -11522,7 +11563,7 @@
"type": "array",
"items": {
"type": "string",
- "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government\u2019s country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
+ "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
}
},
"restrictedExportCountries": {
@@ -11565,7 +11606,7 @@
"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's 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",
@@ -11575,7 +11616,7 @@
"data": {
"type": "string",
"maxLength": 40,
- "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
+ "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer's American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
}
}
}
@@ -11600,17 +11641,17 @@
"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#### 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"
+ "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's 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",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"gender": {
"type": "string",
@@ -11653,7 +11694,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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -11665,7 +11706,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"alternateName": {
"type": "string",
@@ -11685,21 +11726,21 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"phone": {
"type": "string",
@@ -11731,7 +11772,7 @@
"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"
+ "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's 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",
@@ -11744,17 +11785,17 @@
"name": {
"type": "string",
"maxLength": 22,
- "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \"Service Fee.\"\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\"1 of 5\" or \"3 of 7.\" For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder's statement.\n"
},
"contact": {
"type": "string",
"maxLength": 11,
- "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder's statement.\n"
},
"state": {
"type": "string",
"maxLength": 20,
- "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder's statement.\n"
}
}
},
@@ -11784,42 +11825,42 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
},
"id": {
"type": "string",
@@ -11839,7 +11880,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"fallback": {
"type": "boolean",
@@ -11916,12 +11957,12 @@
"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.\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/)\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/)\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/)\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's 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/)\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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"totalAmount": {
"type": "string",
@@ -11931,7 +11972,7 @@
"totalCount": {
"type": "integer",
"maximum": 99,
- "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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"firstInstallmentDate": {
"type": "string",
@@ -12078,7 +12119,7 @@
"distanceUnit": {
"type": "string",
"maxLength": 1,
- "description": "Miles/Kilometers Indicator shows whether the \u201cmiles\u201d fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
+ "description": "Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
},
"returnDateTime": {
"type": "string",
@@ -12102,7 +12143,7 @@
"programCode": {
"type": "string",
"maxLength": 2,
- "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\u201d or \u201dshow\u201d.\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
+ "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\".\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
},
"returnAddress": {
"type": "object",
@@ -12177,7 +12218,7 @@
"agreementNumber": {
"type": "string",
"maxLength": 25,
- "description": "Auto rental agency\u2019s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
+ "description": "Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
},
"odometerReading": {
"type": "string",
@@ -12207,7 +12248,7 @@
"specialProgramCode": {
"type": "string",
"maxLength": 2,
- "description": "Program code used to identify special circumstances, such as \u201cfrequent renter\u201d or \u201cno show\u201d status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
+ "description": "Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
},
"vehicleMake": {
"type": "string",
@@ -12741,7 +12782,7 @@
"processIdentifier": {
"type": "string",
"maxLength": 3,
- "description": "Airline process identifier. This value is the airline\u2019s three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
+ "description": "Airline process identifier. This value is the airline's three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
},
"ticketIssueDate": {
"type": "string",
@@ -12835,7 +12876,7 @@
"stopoverIndicator": {
"type": "integer",
"maxLength": 1,
- "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \u201cO\u201d) (default): Stopover allowed\n- `X` (capital letter \u201cX\u201d): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
+ "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \"O\") (default): Stopover allowed\n- `X` (capital letter \"X\"): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
},
"departureDate": {
"type": "integer",
@@ -12926,7 +12967,7 @@
"passengerName": {
"type": "string",
"maxLength": 20,
- "description": "Name of the passenger. If the passenger\u2019s name is not available, this value is the cardholder\u2019s name. If neither the passenger\u2019s name nor the cardholder\u2019s name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
+ "description": "Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
},
"connectedTicketNumber": {
"type": "string",
@@ -13545,7 +13586,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -13657,7 +13698,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"expirationMonth": {
"type": "string",
@@ -13676,7 +13717,7 @@
"accountEncoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n"
+ "description": "Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.\n"
},
"issueNumber": {
"type": "string",
@@ -13734,7 +13775,7 @@
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"checkNumber": {
"type": "string",
@@ -13760,7 +13801,7 @@
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
}
}
},
@@ -13770,7 +13811,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"expirationMonth": {
"type": "string",
@@ -13794,12 +13835,12 @@
"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\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"assuranceLevel": {
"type": "string",
@@ -13857,7 +13898,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -14098,7 +14139,7 @@
"cashbackAmount": {
"type": "string",
"maxLength": 13,
- "description": "Cashback amount in the acquirer\u2019s currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
+ "description": "Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
}
}
},
@@ -14113,17 +14154,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"company": {
"type": "object",
@@ -14131,7 +14172,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's 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",
@@ -14168,7 +14209,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -14183,7 +14224,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"administrativeArea": {
"type": "string",
@@ -14213,7 +14254,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -14223,17 +14264,17 @@
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -14245,7 +14286,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"productName": {
"type": "string",
@@ -14411,7 +14452,7 @@
"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's 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",
@@ -14421,7 +14462,7 @@
"data": {
"type": "string",
"maxLength": 40,
- "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
+ "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer's American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
}
}
}
@@ -14446,17 +14487,17 @@
"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#### 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"
+ "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's 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",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"gender": {
"type": "string",
@@ -14499,7 +14540,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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -14511,7 +14552,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"alternateName": {
"type": "string",
@@ -14531,21 +14572,21 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"phone": {
"type": "string",
@@ -14572,7 +14613,7 @@
"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"
+ "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's 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",
@@ -14610,42 +14651,42 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
},
"id": {
"type": "string",
@@ -14665,7 +14706,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"fallback": {
"type": "boolean",
@@ -14743,7 +14784,7 @@
"distanceUnit": {
"type": "string",
"maxLength": 1,
- "description": "Miles/Kilometers Indicator shows whether the \u201cmiles\u201d fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
+ "description": "Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
},
"returnDateTime": {
"type": "string",
@@ -14767,7 +14808,7 @@
"programCode": {
"type": "string",
"maxLength": 2,
- "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\u201d or \u201dshow\u201d.\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
+ "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\".\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
},
"returnAddress": {
"type": "object",
@@ -14842,7 +14883,7 @@
"agreementNumber": {
"type": "string",
"maxLength": 25,
- "description": "Auto rental agency\u2019s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
+ "description": "Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
},
"odometerReading": {
"type": "string",
@@ -14872,7 +14913,7 @@
"specialProgramCode": {
"type": "string",
"maxLength": 2,
- "description": "Program code used to identify special circumstances, such as \u201cfrequent renter\u201d or \u201cno show\u201d status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
+ "description": "Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
},
"vehicleMake": {
"type": "string",
@@ -15406,7 +15447,7 @@
"processIdentifier": {
"type": "string",
"maxLength": 3,
- "description": "Airline process identifier. This value is the airline\u2019s three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
+ "description": "Airline process identifier. This value is the airline's three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
},
"ticketIssueDate": {
"type": "string",
@@ -15500,7 +15541,7 @@
"stopoverIndicator": {
"type": "integer",
"maxLength": 1,
- "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \u201cO\u201d) (default): Stopover allowed\n- `X` (capital letter \u201cX\u201d): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
+ "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \"O\") (default): Stopover allowed\n- `X` (capital letter \"X\"): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
},
"departureDate": {
"type": "integer",
@@ -15591,7 +15632,7 @@
"passengerName": {
"type": "string",
"maxLength": 20,
- "description": "Name of the passenger. If the passenger\u2019s name is not available, this value is the cardholder\u2019s name. If neither the passenger\u2019s name nor the cardholder\u2019s name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
+ "description": "Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
},
"connectedTicketNumber": {
"type": "string",
@@ -15771,7 +15812,7 @@
"creditAmount": {
"type": "string",
"maxLength": 15,
- "description": "Amount that was credited to the cardholder\u2019s account.\n\nReturned by PIN debit credit.\n"
+ "description": "Amount that was credited to the cardholder's account.\n\nReturned by PIN debit credit.\n"
},
"currency": {
"type": "string",
@@ -16071,7 +16112,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -16183,7 +16224,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"expirationMonth": {
"type": "string",
@@ -16202,7 +16243,7 @@
"accountEncoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n"
+ "description": "Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.\n"
},
"issueNumber": {
"type": "string",
@@ -16260,7 +16301,7 @@
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"checkNumber": {
"type": "string",
@@ -16286,7 +16327,7 @@
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
}
}
},
@@ -16296,7 +16337,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"expirationMonth": {
"type": "string",
@@ -16320,12 +16361,12 @@
"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\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"assuranceLevel": {
"type": "string",
@@ -16383,7 +16424,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -16624,7 +16665,7 @@
"cashbackAmount": {
"type": "string",
"maxLength": 13,
- "description": "Cashback amount in the acquirer\u2019s currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
+ "description": "Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
}
}
},
@@ -16639,17 +16680,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"company": {
"type": "object",
@@ -16657,7 +16698,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's 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",
@@ -16694,7 +16735,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -16709,7 +16750,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"administrativeArea": {
"type": "string",
@@ -16739,7 +16780,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -16749,17 +16790,17 @@
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -16771,7 +16812,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"productName": {
"type": "string",
@@ -16937,7 +16978,7 @@
"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's 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",
@@ -16947,7 +16988,7 @@
"data": {
"type": "string",
"maxLength": 40,
- "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
+ "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer's American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
}
}
}
@@ -16972,17 +17013,17 @@
"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#### 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"
+ "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's 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",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"gender": {
"type": "string",
@@ -17025,7 +17066,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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -17037,7 +17078,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"alternateName": {
"type": "string",
@@ -17057,21 +17098,21 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"phone": {
"type": "string",
@@ -17098,7 +17139,7 @@
"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"
+ "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's 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",
@@ -17136,42 +17177,42 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
},
"id": {
"type": "string",
@@ -17191,7 +17232,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"fallback": {
"type": "boolean",
@@ -17269,7 +17310,7 @@
"distanceUnit": {
"type": "string",
"maxLength": 1,
- "description": "Miles/Kilometers Indicator shows whether the \u201cmiles\u201d fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
+ "description": "Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
},
"returnDateTime": {
"type": "string",
@@ -17293,7 +17334,7 @@
"programCode": {
"type": "string",
"maxLength": 2,
- "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\u201d or \u201dshow\u201d.\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
+ "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\".\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
},
"returnAddress": {
"type": "object",
@@ -17368,7 +17409,7 @@
"agreementNumber": {
"type": "string",
"maxLength": 25,
- "description": "Auto rental agency\u2019s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
+ "description": "Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
},
"odometerReading": {
"type": "string",
@@ -17398,7 +17439,7 @@
"specialProgramCode": {
"type": "string",
"maxLength": 2,
- "description": "Program code used to identify special circumstances, such as \u201cfrequent renter\u201d or \u201cno show\u201d status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
+ "description": "Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
},
"vehicleMake": {
"type": "string",
@@ -17932,7 +17973,7 @@
"processIdentifier": {
"type": "string",
"maxLength": 3,
- "description": "Airline process identifier. This value is the airline\u2019s three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
+ "description": "Airline process identifier. This value is the airline's three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
},
"ticketIssueDate": {
"type": "string",
@@ -18026,7 +18067,7 @@
"stopoverIndicator": {
"type": "integer",
"maxLength": 1,
- "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \u201cO\u201d) (default): Stopover allowed\n- `X` (capital letter \u201cX\u201d): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
+ "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \"O\") (default): Stopover allowed\n- `X` (capital letter \"X\"): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
},
"departureDate": {
"type": "integer",
@@ -18117,7 +18158,7 @@
"passengerName": {
"type": "string",
"maxLength": 20,
- "description": "Name of the passenger. If the passenger\u2019s name is not available, this value is the cardholder\u2019s name. If neither the passenger\u2019s name nor the cardholder\u2019s name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
+ "description": "Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
},
"connectedTicketNumber": {
"type": "string",
@@ -18297,7 +18338,7 @@
"creditAmount": {
"type": "string",
"maxLength": 15,
- "description": "Amount that was credited to the cardholder\u2019s account.\n\nReturned by PIN debit credit.\n"
+ "description": "Amount that was credited to the cardholder's account.\n\nReturned by PIN debit credit.\n"
},
"currency": {
"type": "string",
@@ -18571,7 +18612,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -18610,7 +18651,7 @@
"commerceIndicator": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"processorId": {
"type": "string",
@@ -18655,7 +18696,7 @@
"walletType": {
"type": "string",
"maxLength": 5,
- "description": "This field carries the wallet type in authorization requests and credit requests. Possible value are:\n- `101`: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet.\n- `102`: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet.\n- `103`: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet.\n- `216`: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet.\n- `217`: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet.\n- `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.\n- `VCIND`: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below.\nFor all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nMasterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer\u2019s checkout information.\n\nVisa Checkout:\nThis field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations.\nFor Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring\nSolutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nFor incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102.\nPayment card companies can introduce new values without notice. Your order management system should be able to process new values without problems.\n\nCyberSource through VisaNet\nWhen the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier.\nWhen the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.\n"
+ "description": "This field carries the wallet type in authorization requests and credit requests. Possible value are:\n- `101`: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet.\n- `102`: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet.\n- `103`: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet.\n- `216`: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet.\n- `217`: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet.\n- `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.\n- `VCIND`: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below.\nFor all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nMasterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer's checkout information.\n\nVisa Checkout:\nThis field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations.\nFor Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring\nSolutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor.\nFor incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102.\nPayment card companies can introduce new values without notice. Your order management system should be able to process new values without problems.\n\nCyberSource through VisaNet\nWhen the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier.\nWhen the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.\n"
},
"nationalNetDomesticData": {
"type": "string",
@@ -18665,7 +18706,7 @@
"networkRoutingOrder": {
"type": "string",
"maxLength": 30,
- "description": "On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority.\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code.\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,\nVisaNet makes a selection based on the acquirer\u2019s routing priorities.\n\n#### PIN debit\nPriority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes:\n\n| Network | Code |\n| --- | --- |\n| Accel | E |\n| AFFN | U |\n| Alaska Option | 3 |\n| CU24 | C |\n| Interlink | G |\n| Maestro | 8 |\n| NETS | P |\n| NYCE | F |\n| Pulse | H |\n| Shazam | 7 |\n| Star | M |\n| Visa | V |\n\nFor example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of `MH`.\n\nWhen you do not include this value in your PIN debit request, the list of network codes from your account is used.\n**Note** This field is supported only for businesses located in the U.S.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority.\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference.\nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists,\nVisaNet makes a selection based on the acquirer's routing priorities.\n\n#### PIN debit\nPriority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes:\n\n| Network | Code |\n| --- | --- |\n| Accel | E |\n| AFFN | U |\n| Alaska Option | 3 |\n| CU24 | C |\n| Interlink | G |\n| Maestro | 8 |\n| NETS | P |\n| NYCE | F |\n| Pulse | H |\n| Shazam | 7 |\n| Star | M |\n| Visa | V |\n\nFor example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of `MH`.\n\nWhen you do not include this value in your PIN debit request, the list of network codes from your account is used.\n**Note** This field is supported only for businesses located in the U.S.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"recurringOptions": {
"type": "object",
@@ -18683,7 +18724,7 @@
"customerMemo": {
"type": "string",
"maxLength": 80,
- "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n"
+ "description": "Payment related information.\n\nThis information is included on the customer's statement.\n"
},
"secCode": {
"type": "string",
@@ -18777,7 +18818,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"expirationMonth": {
"type": "string",
@@ -18796,7 +18837,7 @@
"accountEncoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n"
+ "description": "Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.\n"
},
"issueNumber": {
"type": "string",
@@ -18854,7 +18895,7 @@
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"checkNumber": {
"type": "string",
@@ -18880,7 +18921,7 @@
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
}
}
},
@@ -18890,7 +18931,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"expirationMonth": {
"type": "string",
@@ -18914,12 +18955,12 @@
"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\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n\n#### PIN debit\nOptional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"assuranceLevel": {
"type": "string",
@@ -18977,7 +19018,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -19218,7 +19259,7 @@
"cashbackAmount": {
"type": "string",
"maxLength": 13,
- "description": "Cashback amount in the acquirer\u2019s currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
+ "description": "Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included\nin the `orderInformation.amountDetails.totalAmount` value.\n\nThis field is supported only on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional.\n**Authorization Reversal**\nOptional.\n\n#### PIN debit\nOptional field for PIN debit purchase, PIN debit credit or PIN debit reversal.\n"
}
}
},
@@ -19233,17 +19274,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"company": {
"type": "object",
@@ -19251,7 +19292,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's 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",
@@ -19288,7 +19329,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -19303,7 +19344,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"administrativeArea": {
"type": "string",
@@ -19333,7 +19374,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -19343,17 +19384,17 @@
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -19365,7 +19406,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"productName": {
"type": "string",
@@ -19531,7 +19572,7 @@
"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's 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",
@@ -19541,7 +19582,7 @@
"data": {
"type": "string",
"maxLength": 40,
- "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
+ "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer's American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"
}
}
}
@@ -19566,17 +19607,17 @@
"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#### 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"
+ "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's 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",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
},
"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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"gender": {
"type": "string",
@@ -19619,7 +19660,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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
}
}
},
@@ -19631,7 +19672,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"alternateName": {
"type": "string",
@@ -19651,21 +19692,21 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"phone": {
"type": "string",
@@ -19692,7 +19733,7 @@
"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"
+ "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's 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",
@@ -19730,42 +19771,42 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
},
"id": {
"type": "string",
@@ -19813,7 +19854,7 @@
"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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
+ "description": "POS terminal's 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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
},
"operatingEnvironment": {
"type": "string",
@@ -19826,7 +19867,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
},
"cardholderVerificationMethodUsed": {
"type": "integer",
@@ -19848,7 +19889,7 @@
},
"isRepeat": {
"type": "boolean",
- "description": "#### Visa Platform Connect\nValue \u201ctrue\u201d indicates this transaction is intentionally duplicated . The field contains value \u201ctrue\u201d which\nindicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending\na duplicate auth request for a single tap txn because the issuer requested a PIN.\n"
+ "description": "#### Visa Platform Connect\nValue \"true\" indicates this transaction is intentionally duplicated . The field contains value \"true\" which\nindicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending\na duplicate auth request for a single tap txn because the issuer requested a PIN.\n"
}
}
},
@@ -19859,7 +19900,7 @@
},
"trackData": {
"type": "string",
- "description": "Card\u2019s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n\n#### Used by\n**Authorization**\nRequired for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global,\nJCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values:\n- `contact`\n- `contactless`\n- `msd`\n- `swiped`\nOtherwise, this field not used.\n\nRequired for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used.\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### PIN debit\nTrack 2 data from the debit card. The sentinels are required.\nRequired field for a PIN debit purchase and a PIN debit credit.\n"
+ "description": "Card's track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n\n#### Used by\n**Authorization**\nRequired for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global,\nJCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values:\n- `contact`\n- `contactless`\n- `msd`\n- `swiped`\nOtherwise, this field not used.\n\nRequired for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used.\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### PIN debit\nTrack 2 data from the debit card. The sentinels are required.\nRequired field for a PIN debit purchase and a PIN debit credit.\n"
},
"storeAndForwardIndicator": {
"type": "string",
@@ -19936,12 +19977,12 @@
"terminalCompliance": {
"type": "string",
"maxLength": 2,
- "description": "Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India.\n\nFormat:\n- First character indicates whether the terminal supports terminal line encryption (TLE). Possible values:\n - 1: Not certified\n - 2: Certified\n- Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values:\n - 1: Not certified\n - 2: Certified\n\n**Example** `21` indicates that the terminal supports TLE but does not support UKPT/DUKPT.\n\nYou and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer.\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 92-93\n- Field: Mastercard Terminal Compliance Indicator\n\nThe 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 networks.\n\n#### Used by\n**Authorization**\nRequired for card-present transactions in India. Otherwise, not used.\n"
+ "description": "Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India.\n\nFormat:\n- First character indicates whether the terminal supports terminal line encryption (TLE). Possible values:\n - 1: Not certified\n - 2: Certified\n- Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values:\n - 1: Not certified\n - 2: Certified\n\n**Example** `21` indicates that the terminal supports TLE but does not support UKPT/DUKPT.\n\nYou and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer.\n\nThis field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 92-93\n- Field: Mastercard Terminal Compliance Indicator\n\nThe 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.\n\n#### Used by\n**Authorization**\nRequired for card-present transactions in India. Otherwise, not used.\n"
},
"isDedicatedHardwareTerminal": {
"type": "string",
"maxLength": 1,
- "description": "Type of mPOS device. Possible values:\n- 0: Dongle\n- 1: Phone or tablet\n\nThis optional field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 141\n- Field: Mastercard mPOS Transaction\n\nThe 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\nacquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
+ "description": "Type of mPOS device. Possible values:\n- 0: Dongle\n- 1: Phone or tablet\n\nThis optional field is supported only for Mastercard transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 141\n- Field: Mastercard mPOS Transaction\n\nThe 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's\nacquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.\n"
},
"terminalModel": {
"type": "string",
@@ -20011,7 +20052,7 @@
"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.\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/)\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/)\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/)\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's 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/)\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"
}
}
},
@@ -20063,7 +20104,7 @@
"distanceUnit": {
"type": "string",
"maxLength": 1,
- "description": "Miles/Kilometers Indicator shows whether the \u201cmiles\u201d fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
+ "description": "Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers.\n\nAllowed values:\n- `K` - Kilometers\n- `M` - Miles\n"
},
"returnDateTime": {
"type": "string",
@@ -20087,7 +20128,7 @@
"programCode": {
"type": "string",
"maxLength": 2,
- "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\u201d or \u201dshow\u201d.\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
+ "description": "Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\".\n\nThis code is `2 digit` value agreed by Merchant and processor.\n"
},
"returnAddress": {
"type": "object",
@@ -20162,7 +20203,7 @@
"agreementNumber": {
"type": "string",
"maxLength": 25,
- "description": "Auto rental agency\u2019s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
+ "description": "Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions.\nThis field is supported for Visa, MasterCard, and American Express.\nThis Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become\npart of the descriptive bill on the Cardmember's statement.\n"
},
"odometerReading": {
"type": "string",
@@ -20192,7 +20233,7 @@
"specialProgramCode": {
"type": "string",
"maxLength": 2,
- "description": "Program code used to identify special circumstances, such as \u201cfrequent renter\u201d or \u201cno show\u201d status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
+ "description": "Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter.\nPossible values:\n- `0`: not applicable (default)\n- `1`: frequent renter\n- `2`: no show\n\nFor authorizations, this field is supported only for Visa.\n\nFor captures, this field is supported for Visa, MasterCard, and American Express.\n\nCode for special programs applicable to the Card Transaction or the Cardholder.\n"
},
"vehicleMake": {
"type": "string",
@@ -20726,7 +20767,7 @@
"processIdentifier": {
"type": "string",
"maxLength": 3,
- "description": "Airline process identifier. This value is the airline\u2019s three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
+ "description": "Airline process identifier. This value is the airline's three-digit IATA1 code\nwhich is used to process extended payment airline tickets.\n"
},
"ticketIssueDate": {
"type": "string",
@@ -20820,7 +20861,7 @@
"stopoverIndicator": {
"type": "integer",
"maxLength": 1,
- "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \u201cO\u201d) (default): Stopover allowed\n- `X` (capital letter \u201cX\u201d): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
+ "description": "Code that indicates whether a stopover is allowed on this leg of the trip. Possible values:\n- `O` (capital letter \"O\") (default): Stopover allowed\n- `X` (capital letter \"X\"): Stopover not allowed\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included.\nOptional request field for travel legs.\n"
},
"departureDate": {
"type": "integer",
@@ -20911,7 +20952,7 @@
"passengerName": {
"type": "string",
"maxLength": 20,
- "description": "Name of the passenger. If the passenger\u2019s name is not available, this value is the cardholder\u2019s name. If neither the passenger\u2019s name nor the cardholder\u2019s name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
+ "description": "Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available,\nthis value is a description of the ancillary purchase.\n**Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)\nprogram.\nFormat: English characters only.\nOptional field for ancillary service.\n"
},
"connectedTicketNumber": {
"type": "string",
@@ -21094,7 +21135,7 @@
"creditAmount": {
"type": "string",
"maxLength": 15,
- "description": "Amount that was credited to the cardholder\u2019s account.\n\nReturned by PIN debit credit.\n"
+ "description": "Amount that was credited to the cardholder's account.\n\nReturned by PIN debit credit.\n"
},
"currency": {
"type": "string",
@@ -21204,7 +21245,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -23283,7 +23324,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -24465,7 +24506,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\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/)\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'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.\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/)\n"
}
}
},
@@ -24606,7 +24647,7 @@
"properties": {
"type": {
"type": "string",
- "description": "The payment channel that facilitates the transactions. This parameter can be used if the payment channels are listed on the merchant\u2019s site, and the payment channel is known.\n\nPossible Values:\n\n#### Via PPRO\n- `alfaVa`\n- `kredivo`\n- `consumerBarCode`\n- `merchantQrCode`\n- `dokuWallet`\n"
+ "description": "The payment channel that facilitates the transactions. This parameter can be used if the payment channels are listed on the merchant's site, and the payment channel is known.\n\nPossible Values:\n\n#### Via PPRO\n- `alfaVa`\n- `kredivo`\n- `consumerBarCode`\n- `merchantQrCode`\n- `dokuWallet`\n"
}
}
}
@@ -24617,7 +24658,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\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/)\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'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.\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/)\n"
}
}
},
@@ -24646,22 +24687,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"nameSuffix": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s name suffix.\n"
+ "description": "Customer's name suffix.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -24715,31 +24756,31 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"phoneNumber": {
@@ -24886,7 +24927,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -24943,47 +24984,47 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"region": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
}
}
}
@@ -25019,7 +25060,7 @@
"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"
+ "description": "Value of the Accept header sent by the customer's web browser.\n**Note** If the customer's browser provides a value, you must include it in your request.\n"
},
"ipAddress": {
"type": "string",
@@ -25029,7 +25070,7 @@
"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": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n"
}
}
},
@@ -25079,7 +25120,7 @@
"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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
},
@@ -25092,7 +25133,7 @@
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"contact": {
"type": "string",
@@ -25102,22 +25143,22 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
}
}
},
"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"
+ "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's 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"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"transactionLocalDateTime": {
"type": "string",
@@ -25150,7 +25191,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -25180,7 +25221,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"email": {
"type": "string",
@@ -25190,12 +25231,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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"locality": {
"type": "string",
@@ -25205,7 +25246,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
"type": "string",
@@ -25235,7 +25276,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"securityCode": {
"type": "string",
@@ -25269,12 +25310,12 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -25691,7 +25732,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -25748,47 +25789,47 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
+ "description": "Sub-merchant's business name.\n\n#### American Express Direct\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n#### CyberSource through VisaNet\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The 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\n#### FDC Nashville Global\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "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/)\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's 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/)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"region": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\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"
},
"country": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\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 the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
+ "description": "Sub-merchant's telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### CyberSource through VisaNet\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n"
}
}
}
@@ -25824,7 +25865,7 @@
"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"
+ "description": "Value of the Accept header sent by the customer's web browser.\n**Note** If the customer's browser provides a value, you must include it in your request.\n"
},
"ipAddress": {
"type": "string",
@@ -25834,7 +25875,7 @@
"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": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n"
}
}
},
@@ -25884,7 +25925,7 @@
"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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
},
@@ -25897,7 +25938,7 @@
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"contact": {
"type": "string",
@@ -25907,22 +25948,22 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
}
}
},
"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"
+ "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's 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"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"transactionLocalDateTime": {
"type": "string",
@@ -25955,7 +25996,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -25985,7 +26026,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"email": {
"type": "string",
@@ -25995,12 +26036,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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"locality": {
"type": "string",
@@ -26010,7 +26051,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
"type": "string",
@@ -26040,7 +26081,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"securityCode": {
"type": "string",
@@ -26074,12 +26115,12 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -26539,7 +26580,7 @@
"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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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 these processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n\nOptional field.\n"
},
"developerId": {
"type": "string",
@@ -26618,7 +26659,7 @@
"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\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/)\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/)\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/)\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/)\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
},
@@ -26631,7 +26672,7 @@
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"contact": {
"type": "string",
@@ -26641,22 +26682,22 @@
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
}
}
},
"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"
+ "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's 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"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"transactionLocalDateTime": {
"type": "string",
@@ -26689,7 +26730,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -26719,7 +26760,7 @@
"district": {
"type": "string",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"
},
"email": {
"type": "string",
@@ -26729,12 +26770,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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"locality": {
"type": "string",
@@ -26744,7 +26785,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
"type": "string",
@@ -26774,7 +26815,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"securityCode": {
"type": "string",
@@ -26808,12 +26849,12 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -27313,12 +27354,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -27330,7 +27371,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -27362,7 +27403,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -27378,22 +27419,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -27428,7 +27469,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -27459,7 +27500,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -27555,7 +27596,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -27641,20 +27682,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -27709,7 +27750,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -28178,12 +28219,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -28195,7 +28236,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -28227,7 +28268,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -28243,22 +28284,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -28293,7 +28334,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -28324,7 +28365,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -28420,7 +28461,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -28506,20 +28547,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -28574,7 +28615,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -29361,12 +29402,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -29378,7 +29419,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -29410,7 +29451,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -29426,22 +29467,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -29476,7 +29517,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -29507,7 +29548,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -29603,7 +29644,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -29689,20 +29730,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -29757,7 +29798,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -30541,12 +30582,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -30558,7 +30599,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -30590,7 +30631,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -30606,22 +30647,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -30656,7 +30697,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -30687,7 +30728,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -30783,7 +30824,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -30869,20 +30910,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -30937,7 +30978,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -31415,12 +31456,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -31432,7 +31473,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -31464,7 +31505,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -31480,22 +31521,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -31530,7 +31571,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -31561,7 +31602,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -31657,7 +31698,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -31743,20 +31784,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -31811,7 +31852,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -35819,12 +35860,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -35836,7 +35877,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -35868,7 +35909,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -35884,22 +35925,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -35934,7 +35975,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -35965,7 +36006,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -36061,7 +36102,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -36147,20 +36188,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -36215,7 +36256,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -36432,12 +36473,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -36449,7 +36490,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -36481,7 +36522,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -36497,22 +36538,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -36547,7 +36588,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -36578,7 +36619,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -36674,7 +36715,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -36760,20 +36801,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -36828,7 +36869,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -37578,12 +37619,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -37595,7 +37636,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -37627,7 +37668,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -37643,22 +37684,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -37693,7 +37734,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -37724,7 +37765,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -37820,7 +37861,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -37906,20 +37947,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -37974,7 +38015,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -38539,12 +38580,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -38556,7 +38597,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -38588,7 +38629,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -38604,22 +38645,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -38654,7 +38695,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -38685,7 +38726,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -38781,7 +38822,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -38867,20 +38908,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -38935,7 +38976,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -39463,12 +39504,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -39480,7 +39521,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -39512,7 +39553,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -39528,22 +39569,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -39578,7 +39619,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -39609,7 +39650,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -39705,7 +39746,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -39791,20 +39832,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -39859,7 +39900,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -40072,12 +40113,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -40089,7 +40130,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -40121,7 +40162,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -40137,22 +40178,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -40187,7 +40228,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -40218,7 +40259,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -40314,7 +40355,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -40400,20 +40441,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -40468,7 +40509,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -41532,12 +41573,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -41549,7 +41590,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -41581,7 +41622,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -41597,22 +41638,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -41647,7 +41688,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -41678,7 +41719,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -41774,7 +41815,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -41860,20 +41901,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -41928,7 +41969,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -42127,12 +42168,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -42144,7 +42185,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -42176,7 +42217,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -42192,22 +42233,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -42242,7 +42283,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -42273,7 +42314,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -42369,7 +42410,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -42455,20 +42496,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -42523,7 +42564,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -43123,12 +43164,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -43140,7 +43181,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -43172,7 +43213,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -43188,22 +43229,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -43238,7 +43279,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -43269,7 +43310,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -43365,7 +43406,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -43451,20 +43492,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -43519,7 +43560,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -44038,12 +44079,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -44055,7 +44096,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -44087,7 +44128,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -44103,22 +44144,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -44153,7 +44194,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -44184,7 +44225,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -44280,7 +44321,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -44366,20 +44407,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -44434,7 +44475,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -44647,12 +44688,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -44664,7 +44705,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -44696,7 +44737,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -44712,22 +44753,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -44762,7 +44803,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -44793,7 +44834,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -44889,7 +44930,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -44975,20 +45016,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -45043,7 +45084,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -45916,7 +45957,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -46002,20 +46043,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -46070,7 +46111,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -46206,7 +46247,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -46292,20 +46333,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -46360,7 +46401,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -46484,7 +46525,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -46570,20 +46611,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -46638,7 +46679,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -47108,7 +47149,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -47194,20 +47235,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -47262,7 +47303,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -47719,7 +47760,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -47805,20 +47846,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -47873,7 +47914,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -48023,7 +48064,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -48109,20 +48150,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -48177,7 +48218,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -49274,12 +49315,12 @@
"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 through **VisaNet** and **FDC Nashville Global**.\n"
+ "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n"
},
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n"
}
}
}
@@ -49291,7 +49332,7 @@
"companyTaxID": {
"type": "string",
"maxLength": 9,
- "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n"
+ "description": "Company's tax identifier. This is only used for eCheck service.\n"
},
"currency": {
"type": "string",
@@ -49323,7 +49364,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "description": "The State or province where the customer\u2019s driver\u2019s license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
+ "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n",
"maxLength": 20
}
}
@@ -49339,22 +49380,22 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n"
},
"lastName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\n"
+ "description": "Name of the customer's company.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -49389,7 +49430,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
}
}
},
@@ -49420,7 +49461,7 @@
"properties": {
"alternateName": {
"type": "string",
- "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder\u2019s statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
+ "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n",
"maxLength": 13
}
}
@@ -49516,7 +49557,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -49602,20 +49643,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -49670,7 +49711,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -50129,7 +50170,7 @@
"type": "string",
"minLength": 12,
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n"
},
"expirationMonth": {
"type": "string",
@@ -50215,20 +50256,20 @@
"suffix": {
"type": "string",
"readOnly": true,
- "description": "The customer\u2019s latest payment card number suffix\n",
+ "description": "The customer's latest payment card number suffix\n",
"example": "1111"
},
"expirationMonth": {
"type": "string",
"readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer\u2019s latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
"readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer\u2019s latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
}
}
}
@@ -50283,7 +50324,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -51038,8 +51079,6 @@
}
},
"/microform/v2/sessions": {
- "x-name": "Generate Capture Context",
- "x-description": "This API is used to generate the Capture Context data structure for the Microform Integration. Microform is a browser-based acceptance solution that allows a seller to capture payment information is a secure manner from their website. For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=) This API is a server-to-server API to generate the capture context that can be used to initiate instance of microform on a acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. ",
"post": {
"tags": [
"Microform Integration"
@@ -51435,7 +51474,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"type": {
"type": "string",
@@ -51465,7 +51504,7 @@
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -51474,7 +51513,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
},
"expirationMonth": {
"type": "string",
@@ -51493,7 +51532,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -51522,7 +51561,7 @@
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
},
"checkNumber": {
"type": "string",
@@ -51548,12 +51587,12 @@
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
},
"code": {
"type": "string",
"maxLength": 50,
- "description": "Bank code of the consumer\u2019s account\n"
+ "description": "Bank code of the consumer's account\n"
}
}
},
@@ -51625,26 +51664,26 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address3": {
"type": "string",
"maxLength": 60,
- "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"destinationTypes": {
@@ -51655,7 +51694,7 @@
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"firstName": {
"type": "string",
@@ -51680,7 +51719,7 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"destinationCode": {
"type": "integer",
@@ -51748,7 +51787,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"gift": {
"type": "boolean",
@@ -51757,7 +51796,7 @@
"distributorProductSku": {
"type": "string",
"maxLength": 15,
- "description": "Product\u2019s identifier code. This field is inserted into the outgoing message without being parsed or formatted.\nThis field is included as Distributor product SKU (Offer) in the list of API fields with which you can create\ncustom rules.\n"
+ "description": "Product's identifier code. This field is inserted into the outgoing message without being parsed or formatted.\nThis field is included as Distributor product SKU (Offer) in the list of API fields with which you can create\ncustom rules.\n"
},
"passenger": {
"type": "object",
@@ -51819,7 +51858,7 @@
"type": "array",
"items": {
"type": "string",
- "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government\u2019s country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
+ "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
}
},
"restrictedExportCountries": {
@@ -51838,7 +51877,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -51863,17 +51902,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"email": {
"type": "string",
@@ -51901,7 +51940,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#### 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"
+ "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's 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"
},
"username": {
"type": "string",
@@ -51916,7 +51955,7 @@
"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 `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/)\n"
+ "description": "Recipient's 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/)\n"
},
"personalIdentification": {
"type": "array",
@@ -51934,7 +51973,7 @@
},
"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](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\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's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\n"
},
"verificationResults": {
"type": "string",
@@ -51950,7 +51989,7 @@
"properties": {
"cookiesAccepted": {
"type": "string",
- "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"
+ "description": "Whether the customer's browser accepts cookies. This field can contain one of the following values:\n- `yes`: The customer's browser accepts cookies.\n- `no`: The customer's browser does not accept cookies.\n"
},
"ipAddress": {
"type": "string",
@@ -51964,16 +52003,16 @@
},
"fingerprintSessionId": {
"type": "string",
- "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"
+ "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's 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",
- "description": "Email address set in the customer\u2019s browser, which may differ from customer email.\n"
+ "description": "Email address set in the customer's browser, which may differ from customer email.\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's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies\nthe Netscape browser.\n"
},
"rawData": {
"type": "array",
@@ -51995,7 +52034,7 @@
"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"
+ "description": "Value of the Accept header sent by the customer's web browser.\n**Note** If the customer's browser provides a value, you must include it in your request.\n"
},
"httpAcceptContent": {
"type": "string",
@@ -52038,7 +52077,7 @@
"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": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n"
}
}
},
@@ -52070,7 +52109,7 @@
"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"
+ "description": "Date the cardholder's 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",
@@ -52268,7 +52307,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"url": {
"type": "string",
@@ -52280,7 +52319,7 @@
"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": "Your company's name as you want it to appear to the customer in the issuing bank's authentication form.\nThis value overrides the value specified by your merchant bank.\n"
}
}
},
@@ -52535,7 +52574,7 @@
"returnUrl": {
"type": "string",
"maxLength": 2048,
- "description": "The URL of the merchant\u2019s return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session\u2019s transactionId. The merchant\u2019s return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
+ "description": "The URL of the merchant's return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session's transactionId. The merchant's return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
},
"requestorId": {
"type": "string",
@@ -52587,7 +52626,7 @@
"properties": {
"addressOperator": {
"type": "string",
- "description": "Parts of the customer\u2019s information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer\u2019s name or company and the customer\u2019s address must appear in the database.\n- OR: The customer\u2019s name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer\u2019s name or company but not of the address.\n"
+ "description": "Parts of the customer's information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer's name or company and the customer's address must appear in the database.\n- OR: The customer's name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer's name or company but not of the address.\n"
},
"weights": {
"type": "object",
@@ -52595,7 +52634,7 @@
"address": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
},
"company": {
"type": "string",
@@ -52605,7 +52644,7 @@
"name": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
}
}
},
@@ -52812,7 +52851,7 @@
},
"address": {
"type": "array",
- "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.\n",
+ "description": "Indicates a mismatch between the customer's billing and shipping addresses.\n",
"items": {
"type": "string"
}
@@ -52840,14 +52879,14 @@
},
"internet": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.\n",
+ "description": "Indicates a problem with the customer's email address, IP address, or billing address.\n",
"items": {
"type": "string"
}
},
"phone": {
"type": "array",
- "description": "Indicates a problem with the customer\u2019s phone number.\n",
+ "description": "Indicates a problem with the customer's phone number.\n",
"items": {
"type": "string"
}
@@ -52928,7 +52967,7 @@
"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\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"
+ "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's 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"
},
"result": {
"type": "string",
@@ -53103,7 +53142,7 @@
"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"
+ "description": "Country (two-digit country code) associated with the BIN of the customer's 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",
@@ -53191,11 +53230,11 @@
"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"
+ "description": "URL for the card-issuing bank's 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/)\n"
+ "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's 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/)\n"
},
"authorizationPayload": {
"type": "string",
@@ -53224,7 +53263,7 @@
"cardholderMessage": {
"type": "string",
"maxLength": 128,
- "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \u201cAdditional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\u201d.\nThe Issuing Bank can optionally support this value.\n"
+ "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \"Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\".\nThe Issuing Bank can optionally support this value.\n"
},
"cavv": {
"type": "string",
@@ -53263,7 +53302,7 @@
"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"
+ "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's directory service is not available. No liability shift.\n"
},
"eci": {
"type": "string",
@@ -53424,7 +53463,7 @@
"type": "integer",
"minimum": -1,
"maximum": 100,
- "description": "Likelihood that the country associated with the customer\u2019s IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
+ "description": "Likelihood that the country associated with the customer's IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
},
"infoCodes": {
"type": "array",
@@ -54320,7 +54359,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
}
}
},
@@ -54337,7 +54376,7 @@
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -54356,7 +54395,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
}
}
},
@@ -54827,26 +54866,26 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address3": {
"type": "string",
"maxLength": 60,
- "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"destinationTypes": {
@@ -54857,7 +54896,7 @@
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"firstName": {
"type": "string",
@@ -54882,7 +54921,7 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"destinationCode": {
"type": "integer",
@@ -55063,7 +55102,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -55093,17 +55132,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"email": {
"type": "string",
@@ -55158,7 +55197,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
}
}
},
@@ -55177,7 +55216,7 @@
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -55206,7 +55245,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
}
}
},
@@ -55242,7 +55281,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -55292,7 +55331,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#### 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"
+ "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's 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"
},
"personalIdentification": {
"description": "This array contains detailed information about the buyer's form of persoanl identification.",
@@ -55311,7 +55350,7 @@
},
"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](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\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's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\n"
},
"verificationResults": {
"type": "string",
@@ -55323,7 +55362,7 @@
"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"
+ "description": "Cardholder's 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"
},
"workPhone": {
"type": "integer",
@@ -55360,7 +55399,7 @@
"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"
+ "description": "Value of the Accept header sent by the customer's web browser.\n**Note** If the customer's browser provides a value, you must include it in your request.\n"
},
"httpAcceptContent": {
"type": "string",
@@ -55403,7 +55442,7 @@
"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": "Value of the User-Agent header sent by the customer's web browser.\nNote If the customer's browser provides a value, you must include it in your request.\n"
}
}
},
@@ -55415,7 +55454,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"url": {
"type": "string",
@@ -55427,7 +55466,7 @@
"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": "Your company's name as you want it to appear to the customer in the issuing bank's authentication form.\nThis value overrides the value specified by your merchant bank.\n"
}
}
},
@@ -55682,7 +55721,7 @@
"returnUrl": {
"type": "string",
"maxLength": 2048,
- "description": "The URL of the merchant\u2019s return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session\u2019s transactionId. The merchant\u2019s return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
+ "description": "The URL of the merchant's return page. CyberSource adds this return URL to the step-up JWT and returns it in the\nresponse of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL.\nOnce the bank session completes, the merchant receives a POST to their URL. This response contains the completed\nbank session's transactionId. The merchant's return page should capture the transaction ID and send it in the\nPayer Authentication validation call.\n"
},
"requestorId": {
"type": "string",
@@ -55741,7 +55780,7 @@
"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"
+ "description": "Date the cardholder's 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",
@@ -56006,11 +56045,11 @@
"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"
+ "description": "URL for the card-issuing bank's 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/)\n"
+ "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's 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/)\n"
},
"authorizationPayload": {
"type": "string",
@@ -56039,7 +56078,7 @@
"cardholderMessage": {
"type": "string",
"maxLength": 128,
- "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \u201cAdditional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\u201d.\nThe Issuing Bank can optionally support this value.\n"
+ "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.\nFor example, \"Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.\".\nThe Issuing Bank can optionally support this value.\n"
},
"cavv": {
"type": "string",
@@ -56078,7 +56117,7 @@
"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"
+ "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's directory service is not available. No liability shift.\n"
},
"eci": {
"type": "string",
@@ -56778,7 +56817,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
}
}
},
@@ -56788,7 +56827,7 @@
"transactionType": {
"type": "string",
"maxLength": 1,
- "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer\u2019s mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
+ "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that\nprovided you with information about the token.\n\nPossible value:\n- `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring\ntransactions, use this value if the original transaction was a contactless EMV transaction.\n\n#### Visa Platform Connect\n- `1`: For Rupay and In App tokenization. Example: InApp apple pay.\n- `3`: Card/Credential On File Tokenization.\n\n**NOTE** No CyberSource through VisaNet acquirers support EMV at this time.\n\nRequired field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.\n\n#### Rupay\n- `3`: Card/Credential On File Tokenization.\n- `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.\n"
},
"type": {
"type": "string",
@@ -56807,7 +56846,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s payment network token value.\n"
+ "description": "Customer's payment network token value.\n"
}
}
},
@@ -56840,7 +56879,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -57344,7 +57383,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -57374,17 +57413,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"email": {
"type": "string",
@@ -57405,32 +57444,32 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -57460,7 +57499,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"type": {
"type": "string",
@@ -57484,7 +57523,7 @@
},
"code": {
"type": "string",
- "description": "Country-specific code used to identify the customer\u2019s bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For specific requirements, see \"Required Bank Account Information by Country,\"\n",
+ "description": "Country-specific code used to identify the customer's bank. Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction. For specific requirements, see \"Required Bank Account Information by Country,\"\n",
"maxLength": 15
},
"country": {
@@ -57568,12 +57607,12 @@
},
"recordName": {
"type": "string",
- "description": "Name of the customer\u2019s record entered in the list.\nFor the positive list, it is required if `action_\ncode`=`add_positive`. If absent from the request, `ics_risk_update` creates the value for this field by concatenating the customer\u2019s first and last names.\nFor the negative and the review lists, `record_name`, `customer_firstname`, and `customer_lastname` are optional.\n",
+ "description": "Name of the customer's record entered in the list.\nFor the positive list, it is required if `action_\ncode`=`add_positive`. If absent from the request, `ics_risk_update` creates the value for this field by concatenating the customer's first and last names.\nFor the negative and the review lists, `record_name`, `customer_firstname`, and `customer_lastname` are optional.\n",
"maxLength": 255
},
"action": {
"type": "string",
- "description": "Indicates whether to add to or remove a customer\u2019s identity from the negative or positive list. This field can\ncontain one of the following values:\n- add: Add information to the list.\n- convert: moves the data.\n- delete: deletes the data from the list.\n"
+ "description": "Indicates whether to add to or remove a customer's identity from the negative or positive list. This field can\ncontain one of the following values:\n- add: Add information to the list.\n- convert: moves the data.\n- delete: deletes the data from the list.\n"
}
}
}
@@ -57599,7 +57638,7 @@
},
"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](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\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's driver's license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder's passport. Recommended for Discover ProtectBuy.\n\nUse the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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/)\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/)\n"
},
"verificationResults": {
"type": "string",
@@ -58873,7 +58912,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -58922,17 +58961,17 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address3": {
"type": "string",
"maxLength": 60,
- "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address4": {
"type": "string",
@@ -58942,22 +58981,22 @@
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -58999,7 +59038,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
}
}
}
@@ -59012,7 +59051,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Optional customer\u2019s account ID, tracking number, reward number, or other unique number\nthat you assign to the customer for the purpose that you choose\n"
+ "description": "Optional customer's account ID, tracking number, reward number, or other unique number\nthat you assign to the customer for the purpose that you choose\n"
}
}
}
@@ -59765,7 +59804,7 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -59815,12 +59854,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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"email": {
"type": "string",
@@ -59834,7 +59873,7 @@
"properties": {
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"firstName": {
@@ -59866,7 +59905,7 @@
"type": "array",
"items": {
"type": "string",
- "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government\u2019s country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
+ "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n"
}
},
"restrictedExportCountries": {
@@ -59901,7 +59940,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
}
}
}
@@ -59914,7 +59953,7 @@
"merchantCustomerId": {
"type": "string",
"maxLength": 100,
- "description": "Optional customer\u2019s account ID, tracking number, reward number, or other unique number\nthat you assign to the customer for the purpose that you choose\n"
+ "description": "Optional customer's account ID, tracking number, reward number, or other unique number\nthat you assign to the customer for the purpose that you choose\n"
}
}
},
@@ -59938,7 +59977,7 @@
"properties": {
"addressOperator": {
"type": "string",
- "description": "Parts of the customer\u2019s information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer\u2019s name or company and the customer\u2019s address must appear in the database.\n- OR: The customer\u2019s name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer\u2019s name or company but not of the address.\n"
+ "description": "Parts of the customer's information that must match with an entry in the DPL (denied parties list)\nbefore a match occurs. This field can contain one of the following values:\n- AND: (default) The customer's name or company and the customer's address must appear in the database.\n- OR: The customer's name must appear in the database.\n- IGNORE: You want the service to detect a match only of the customer's name or company but not of the address.\n"
},
"weights": {
"type": "object",
@@ -59946,7 +59985,7 @@
"address": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's address and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The address must be identical to the entry in the DPL.\n- high: (default) The address cannot differ significantly from the entry in the DPL.\n- medium: The address can differ slightly more from the entry in the DPL.\n- low: The address can differ significantly from the entry in the DPL.\n"
},
"company": {
"type": "string",
@@ -59956,7 +59995,7 @@
"name": {
"type": "string",
"maxLength": 6,
- "description": "Degree of correlation between a customer\u2019s name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
+ "description": "Degree of correlation between a customer's name and an entry in the DPL\nbefore a match occurs. This field can contain one of the following values:\n- exact: The name must be identical to the entry in the DPL.\n- high: (default) The name cannot differ significantly from the entry in the DPL.\n- medium: The name can differ slightly more from the entry in the DPL.\n- low: The name can differ significantly the entry in the DPL.\n"
}
}
},
@@ -60057,7 +60096,7 @@
"type": "integer",
"minimum": -1,
"maximum": 100,
- "description": "Likelihood that the country associated with the customer\u2019s IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
+ "description": "Likelihood that the country associated with the customer's IP address was identified correctly.\nReturns a value from 1\u2013100, where 100 indicates the highest likelihood.\nIf the country cannot be determined, the value is \u20131.\n"
},
"infoCodes": {
"type": "array",
@@ -60624,17 +60663,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -60664,7 +60703,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"phoneType": {
"type": "string",
@@ -60684,7 +60723,7 @@
"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"
+ "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's 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"
},
"submitLocalDateTime": {
"type": "string",
@@ -60700,26 +60739,26 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"administrativeArea": {
"type": "string",
- "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "The state where the merchant is located.\n\n#### PIN debit\nState code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's postal code.\n\n#### PIN debit\nPostal code for your business location. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: `12345-6789`\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: `A1B 2C3`\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\n**Note** This field is supported only for businesses located in the U.S. or Canada.\n**Important** Mastercard requires a postal code for any country that uses postal codes.\nYou can provide the postal code in your account or you can include this field in your request.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
},
"contact": {
"type": "string",
@@ -60751,7 +60790,7 @@
"middleName": {
"type": "string",
"maxLength": 35,
- "description": "Recipient\u2019s middle 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"
+ "description": "Recipient's middle 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"
},
"lastName": {
"type": "string",
@@ -60816,7 +60855,7 @@
"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"
+ "description": "The account number of the entity funding the transaction. It is the sender's 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"
}
}
},
@@ -60833,7 +60872,7 @@
"middleName": {
"type": "string",
"maxLength": 35,
- "description": "Sender\u2019s middle 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"
+ "description": "Sender's middle 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"
},
"lastName": {
"type": "string",
@@ -60858,7 +60897,7 @@
"administrativeArea": {
"type": "string",
"maxLength": 2,
- "description": "Sender\u2019s state. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n"
+ "description": "Sender's state. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\n"
},
"countryCode": {
"type": "string",
@@ -60868,18 +60907,18 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Sender\u2019s postal code. Required only for FDCCompass."
+ "description": "Sender's postal code. Required only for FDCCompass."
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sender\u2019s phone number. Required only for FDCCompass."
+ "description": "Sender's 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."
+ "description": "Sender's date of birth in YYYYMMDD format. Required only for FDCCompass."
},
"vatRegistrationNumber": {
"type": "string",
@@ -60914,7 +60953,7 @@
"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\nFor details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/)\n"
+ "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's 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's routing priorities. \n\nFor details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/)\n"
},
"commerceIndicator": {
"type": "string",
@@ -60996,7 +61035,7 @@
"number": {
"type": "string",
"maxLength": 20,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n"
},
"expirationMonth": {
"type": "string",
@@ -61020,7 +61059,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -61225,17 +61264,17 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
+ "description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder\u2019s statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
+ "description": "Merchant's country.\n\n#### PIN debit\nCountry code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\nThis value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n**Note** If your business is located in the U.S. or Canada and you include this field in a\nrequest, you must also include `merchantInformation.merchantDescriptor.administrativeArea`.\n\nOptional field for PIN debit credit or PIN debit purchase.\n"
}
}
}
@@ -61260,7 +61299,7 @@
"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.\nThis field is returned for OCT transactions.\n"
+ "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account.\nThis field is returned for OCT transactions.\n"
},
"settlementCurrency": {
"type": "string",
@@ -61292,7 +61331,7 @@
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\nReturned by authorization and incremental authorization services.\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**.\nReturned by authorization and incremental authorization services.\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's receipt.\n"
},
"responseCodeSource": {
"type": "string",
@@ -61634,7 +61673,7 @@
"networkRoutingOrder": {
"type": "string",
"maxLength": 30,
- "description": "Visa Platform Connect\nThis field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: 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. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. If 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\nFor details, see the network_order field description in BIN Lookup Service Using the SCMP API.\n"
+ "description": "Visa Platform Connect\nThis field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: 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. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If 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's routing priorities.\n\nFor details, see the network_order field description in BIN Lookup Service Using the SCMP API.\n"
},
"payoutsOptions": {
"type": "object",
@@ -61723,7 +61762,7 @@
"minLength": 13,
"maxLength": 19,
"x-nullable": true,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN).\n\nConditional: this field is required if not using tokens.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nConditional: this field is required if not using tokens.\n"
},
"expirationMonth": {
"type": "string",
@@ -61812,7 +61851,7 @@
"type": "string",
"maxLength": 40,
"x-nullable": true,
- "description": "Sender\u2019s middle name. This field is a passthrough, which means that CyberSource 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.\n"
+ "description": "Sender's middle name. This field is a passthrough, which means that CyberSource 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.\n"
},
"middleInitial": {
"type": "string",
@@ -61887,7 +61926,7 @@
"type": "string",
"maxLength": 10,
"x-nullable": true,
- "description": "Sender\u2019s postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nRequired for FDCCompass.\n"
+ "description": "Sender's postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.\n\nRequired for FDCCompass.\n"
},
"address1": {
"type": "string",
@@ -61911,7 +61950,7 @@
"type": "string",
"maxLength": 3,
"x-nullable": true,
- "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n"
+ "description": "Sender's state. Use the State, Province, and Territory Codes for the United States and Canada.The sender's province, state or territory. Conditional, required if sender's country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n"
},
"country": {
"type": "string",
@@ -61927,13 +61966,13 @@
"dateOfBirth": {
"type": "string",
"maxLength": 8,
- "description": "Sender\u2019s date of birth in YYYYMMDD format.\n"
+ "description": "Sender's date of birth in YYYYMMDD format.\n"
},
"phoneNumber": {
"type": "string",
"x-nullable": true,
"maxLength": 20,
- "description": "Sender\u2019s phone number.\n"
+ "description": "Sender's phone number.\n"
},
"paymentInformation": {
"type": "object",
@@ -61959,7 +61998,7 @@
"number": {
"type": "string",
"maxLength": 19,
- "description": "The customer\u2019s payment card number, also known as the Primary Account Number (PAN).\n\nThis field is supported in Mastercard Send.\n"
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n\nThis field is supported in Mastercard Send.\n"
},
"expirationMonth": {
"type": "string",
@@ -61993,7 +62032,7 @@
"number": {
"type": "string",
"maxLength": 34,
- "description": "The account number of the entity funding the transaction. It is the sender\u2019s account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n\nFDC Compass (<= 19)\nChase Paymentech (<= 16)\n"
+ "description": "The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number.\n\nFunds disbursements\n\nThis field is optional.\n\nAll other transactions\n\nThis field is required when the sender funds the transaction with a financial instrument, for example debit card. Length:\n\nFDC Compass (<= 19)\nChase Paymentech (<= 16)\n"
}
}
},
@@ -62044,42 +62083,42 @@
"name": {
"type": "string",
"maxLength": 37,
- "description": "Sub-merchant\u2019s business name.\n\nVisa Platform Connect\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "Sub-merchant's business name.\n\nVisa Platform Connect\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"address1": {
"type": "string",
"maxLength": 38,
- "description": "First line of the sub-merchant\u2019s street address.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "First line of the sub-merchant's street address.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"locality": {
"type": "string",
"maxLength": 21,
- "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "Sub-merchant's city.\n\nFor processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"administrativeArea": {
"type": "string",
"maxLength": 3,
- "description": "Sub-merchant\u2019s state or province.\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "Sub-merchant's state or province.\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"postalCode": {
"type": "string",
"maxLength": 15,
- "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file5.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"country": {
"type": "string",
"maxLength": 2,
- "description": "Sub-merchant\u2019s country. Use the ISO Standard numeric Country Codes.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
+ "description": "Sub-merchant's country. Use the ISO Standard numeric Country Codes.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nVisa Platform Connect\nThe value for this field does not map to the TC 33 capture file.\n\nFDC Compass\nThis value must consist of uppercase characters.\n"
},
"email": {
"type": "string",
"maxLength": 40,
- "description": "Sub-merchant\u2019s email address.\n\nCyberSource through VisaNet |\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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": "Sub-merchant's email address.\n\nCyberSource through VisaNet |\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\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's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 20,
- "description": "Sub-merchant\u2019s telephone number.\n\nMaximum length for procesors\n\nVisa Platform Connect: 20\nFDC Compass: 13\n\nFDC Compass\nThis value must consist of uppercase characters. Use one of these recommended formats:\nNNN-NNN-NNNN\nNNN-AAAAAAA\n"
+ "description": "Sub-merchant's telephone number.\n\nMaximum length for procesors\n\nVisa Platform Connect: 20\nFDC Compass: 13\n\nFDC Compass\nThis value must consist of uppercase characters. Use one of these recommended formats:\nNNN-NNN-NNNN\nNNN-AAAAAAA\n"
}
}
}
@@ -62106,7 +62145,7 @@
"categoryCode": {
"type": "integer",
"maxLength": 4,
- "description": "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\u2019s cards. When 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 description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n\nRecord: CP01 TCR4\nPosition: 150-153\nField: Merchant Category Code\n"
+ "description": "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.\n\nFor processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API.\n\nVisa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n\nRecord: CP01 TCR4\nPosition: 150-153\nField: Merchant Category Code\n"
},
"submitLocalDateTime": {
"type": "string",
@@ -62134,22 +62173,22 @@
"country": {
"type": "string",
"maxLength": 2,
- "description": "Merchant's country.\n\nCountry code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder\u2019s statement.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nNote If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea.\n"
+ "description": "Merchant's country.\n\nCountry code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder's statement.\n\nSee https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf\n\nNote If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea.\n"
},
"locality": {
"type": "string",
"maxLength": 13,
- "description": "Merchant's City.\n\nCity for your business location. This value might be displayed on the cardholder\u2019s statement.\n"
+ "description": "Merchant's City.\n\nCity for your business location. This value might be displayed on the cardholder's statement.\n"
},
"name": {
"type": "string",
"maxLength": 23,
- "description": "Merchant's business name. This name is displayed on the cardholder\u2019s statement.\n\nChase Paymentech, Visa Platform Connect: length 22\n"
+ "description": "Merchant's business name. This name is displayed on the cardholder's statement.\n\nChase Paymentech, Visa Platform Connect: length 22\n"
},
"postalCode": {
"type": "string",
"maxLength": 14,
- "description": "Merchant's postal code. This value might be displayed on the cardholder\u2019s statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3\n"
+ "description": "Merchant's postal code. This value might be displayed on the cardholder's statement.\n\nIf your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789\n\nIf your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3\n"
}
}
}
@@ -62181,7 +62220,7 @@
"terminalCapability": {
"type": "integer",
"maxLength": 1,
- "description": "integer [ 1 .. 5 ]\nPOS 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; cannot use contact to read chip cards.\nFor an EMV transaction, the value of this field must be 4 or 5.\n\nUsed by\nAuthorization Required for the following processors:\nChase Paymentech Solutions\n\nOptional for the following processors:\nVisa Platform Connect\n"
+ "description": "integer [ 1 .. 5 ]\nPOS terminal's 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; cannot use contact to read chip cards.\nFor an EMV transaction, the value of this field must be 4 or 5.\n\nUsed by\nAuthorization Required for the following processors:\nChase Paymentech Solutions\n\nOptional for the following processors:\nVisa Platform Connect\n"
}
}
}
@@ -62517,7 +62556,7 @@
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "System audit number. Returned by authorization and incremental authorization services.\n\nVisa Platform Connect\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n"
+ "description": "System audit number. Returned by authorization and incremental authorization services.\n\nVisa Platform Connect\n\nSystem trace number that must be printed on the customer's receipt.\n"
},
"responseCodeSource": {
"type": "string",
@@ -62554,7 +62593,7 @@
"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. This field is returned for OCT transactions.\n"
+ "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions.\n"
},
"settlementCurrency": {
"type": "string",
@@ -65482,12 +65521,12 @@
"type": "object",
"properties": {
"firstName": {
- "description": "Customer\u2019s first name.\n",
+ "description": "Customer's first name.\n",
"type": "string",
"maxLength": 60
},
"lastName": {
- "description": "Customer\u2019s last name.\n",
+ "description": "Customer's last name.\n",
"type": "string",
"maxLength": 60
}
@@ -65785,12 +65824,12 @@
"type": "object",
"properties": {
"firstName": {
- "description": "Customer\u2019s first name.\n",
+ "description": "Customer's first name.\n",
"type": "string",
"maxLength": 60
},
"lastName": {
- "description": "Customer\u2019s last name.\n",
+ "description": "Customer's last name.\n",
"type": "string",
"maxLength": 60
}
@@ -67013,7 +67052,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#### 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"
+ "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's 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"
},
"hashedPassword": {
"type": "string",
@@ -67133,7 +67172,7 @@
},
"cookiesAccepted": {
"type": "string",
- "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"
+ "description": "Whether the customer's browser accepts cookies. This field can contain one of the following values:\n- `yes`: The customer's browser accepts cookies.\n- `no`: The customer's browser does not accept cookies.\n"
}
}
},
@@ -67240,7 +67279,7 @@
"properties": {
"name": {
"type": "string",
- "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder\u2019s statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder\u2019s statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
+ "description": "Your merchant name.\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n\n#### PIN debit\nYour business name. This name is displayed on the cardholder's statement. When you\ninclude more than one consecutive space, extra spaces are removed.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n\n#### Airline processing\nYour merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed.\n\n**Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field.\n\n**Important** This value must consist of English characters.\n\nRequired for captures and credits.\n"
}
}
}
@@ -67255,27 +67294,27 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"middleName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\n"
},
"nameSuffix": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s name suffix.\n"
+ "description": "Customer's name suffix.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"address2": {
"type": "string",
@@ -67300,7 +67339,7 @@
"company": {
"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's 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"
},
"email": {
"type": "string",
@@ -67320,7 +67359,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -67340,17 +67379,17 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"administrativeArea": {
"type": "string",
@@ -67360,16 +67399,16 @@
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"company": {
"type": "string",
"maxLength": 60,
- "description": "Name of the customer\u2019s company.\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's company.\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"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"phoneNumber": {
@@ -67450,7 +67489,7 @@
"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.\nThis field is returned for OCT transactions.\n"
+ "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account.\nThis field is returned for OCT transactions.\n"
},
"settlementCurrency": {
"type": "string",
@@ -67520,7 +67559,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\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/)\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'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.\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/)\n"
},
"id": {
"type": "string",
@@ -67535,7 +67574,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
+ "description": "Last four digits of the cardholder's account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
},
"prefix": {
"type": "string",
@@ -67583,7 +67622,7 @@
"accountEncoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n"
+ "description": "Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.\n"
},
"useAs": {
"type": "string",
@@ -67710,15 +67749,15 @@
},
"branchCode": {
"type": "string",
- "description": "Code used to identify the branch of the customer\u2019s bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n\nFor all possible values, see the `branch_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"
+ "description": "Code used to identify the branch of the customer's bank.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN. Use this field only when\nscoring a direct debit transaction.\n\nFor all possible values, see the `branch_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"
},
"swiftCode": {
"type": "string",
- "description": "Bank\u2019s SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
+ "description": "Bank's SWIFT code. You can use this field only when scoring a direct debit transaction.\nRequired only for crossborder transactions.\n\nFor all possible values, see the `bank_swiftcode` 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"
},
"bankCode": {
"type": "string",
- "description": "Country-specific code used to identify the customer\u2019s\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_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"
+ "description": "Country-specific code used to identify the customer's\nbank. Required for some countries if you do not or are not\nallowed to provide the IBAN instead. You can use this field\nonly when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_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"
},
"iban": {
"type": "string",
@@ -67730,7 +67769,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the customer\u2019s payment account number.\n"
+ "description": "Last four digits of the customer's payment account number.\n"
},
"prefix": {
"type": "string",
@@ -67752,12 +67791,12 @@
},
"checkDigit": {
"type": "string",
- "description": "Code used to validate the customer\u2019s account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_check_digit` 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"
+ "description": "Code used to validate the customer's account number.\nRequired for some countries if you do not or are not\nallowed to provide the IBAN instead. You may use this\nfield only when scoring a direct debit transaction.\n\nFor all possible values, see the `bank_check_digit` 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"
},
"encoderId": {
"type": "string",
"maxLength": 3,
- "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
+ "description": "Identifier for the bank that provided the customer's encoded account number.\n\nTo obtain the bank identifier, contact your processor.\n\nFor details, see `account_encoder_id` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n"
}
}
},
@@ -67895,12 +67934,12 @@
"commerceIndicator": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"commerceIndicatorLabel": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"businessApplicationId": {
"type": "string",
@@ -67923,7 +67962,7 @@
},
"credentialStoredOnFile": {
"type": "string",
- "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- `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `N` 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/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\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's 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's file for future transactions.\n\nValid values:\n- `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `N` 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/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n"
},
"storedCredentialUsed": {
"type": "string",
@@ -68103,59 +68142,59 @@
"email": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"emailRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address."
+ "description": "Raw Electronic Verification response code from the processor for the customer's email address."
},
"name": {
"type": "string",
"maxLength": 30,
- "description": "#### Visa Platform Connect\nMapped Electronic Verification response code for the customer\u2019s name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
+ "description": "#### Visa Platform Connect\nMapped Electronic Verification response code for the customer's name.\n\nValid values :\n\n'Y' Yes, the data Matches\n'N' No Match\n'O' Partial Match\n"
},
"nameRaw": {
"type": "string",
"maxLength": 30,
- "description": "#### Visa Platform Connect\nRaw Electronic Verification response code from the processor for the customer\u2019s name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
+ "description": "#### Visa Platform Connect\nRaw Electronic Verification response code from the processor for the customer's name.\n\nValid values :\n\n'01' Match\n'50' Partial Match\n'99' No Match\n"
},
"phoneNumber": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"phoneNumberRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number."
+ "description": "Raw Electronic Verification response code from the processor for the customer's phone number."
},
"street": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"streetRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address."
+ "description": "Raw Electronic Verification response code from the processor for the customer's street address."
},
"postalCode": {
"type": "string",
"maxLength": 1,
- "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/)\n"
+ "description": "Mapped Electronic Verification response code for the customer's 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/)\n"
},
"postalCodeRaw": {
"type": "string",
"maxLength": 1,
- "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code."
+ "description": "Raw Electronic Verification response code from the processor for the customer's postal code."
}
}
},
"systemTraceAuditNumber": {
"type": "string",
"maxLength": 6,
- "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\nReturned by authorization and incremental authorization services.\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**.\nReturned by authorization and incremental authorization services.\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's receipt.\n"
},
"responseCodeSource": {
"type": "string",
@@ -68165,7 +68204,7 @@
"paymentAccountReferenceNumber": {
"type": "string",
"maxLength": 32,
- "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.\nThis reply field is returned only for CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR8\n- Position: 79-110\n- Field: Payment Account Reference\n\nThe 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,\nwho uses this information to facilitate end-of-day clearing processing with payment networks.\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.\nThis reply field is returned only for CyberSource through VisaNet.\n\n**Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR8\n- Position: 79-110\n- Field: Payment Account Reference\n\nThe 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's acquirer,\nwho uses this information to facilitate end-of-day clearing processing with payment networks.\n"
}
}
},
@@ -68186,7 +68225,7 @@
"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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
+ "description": "POS terminal's 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; cannot use contact to read chip cards.\n\nFor an EMV transaction, the value of this field must be `4` or `5`.\n\n#### PIN debit\nRequired for PIN debit purchase and PIN debit credit request.\n\n#### Used by\n**Authorization**\nRequired for the following processors:\n- American Express Direct\n- Chase Paymentech Solutions\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- FDMS Nashville\n- OmniPay Direct\n- SIX\n- Worldpay VAP\n\nOptional for the following processors:\n- CyberSource through VisaNet\n- GPN\n- GPX\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n"
},
"cardholderVerificationMethodUsed": {
"type": "integer",
@@ -68198,7 +68237,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -68950,7 +68989,7 @@
"emvRequestCombinedTags": {
"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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -69063,7 +69102,7 @@
},
"timezone": {
"type": "string",
- "description": "Merchant\u2019s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
+ "description": "Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
},
"query": {
"type": "string",
@@ -69116,7 +69155,7 @@
},
"timezone": {
"type": "string",
- "description": "Merchant\u2019s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
+ "description": "Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
},
"query": {
"type": "string",
@@ -69243,7 +69282,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#### 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"
+ "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's 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"
}
}
},
@@ -69360,17 +69399,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"email": {
"type": "string",
@@ -69385,7 +69424,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -69405,11 +69444,11 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"phoneNumber": {
@@ -69457,7 +69496,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\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/)\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'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.\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/)\n"
}
}
},
@@ -69466,7 +69505,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
+ "description": "Last four digits of the cardholder's account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
},
"prefix": {
"type": "string",
@@ -69487,7 +69526,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the customer\u2019s payment account number.\n"
+ "description": "Last four digits of the customer's payment account number.\n"
},
"prefix": {
"type": "string",
@@ -69514,12 +69553,12 @@
"commerceIndicator": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"commerceIndicatorLabel": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
}
}
},
@@ -69566,7 +69605,7 @@
"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"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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"
}
}
},
@@ -69576,7 +69615,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -69594,7 +69633,7 @@
"true_ipaddress": {
"type": "string",
"maxLength": 255,
- "description": "Customer\u2019s true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n"
+ "description": "Customer's true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n"
},
"hash": {
"type": "string",
@@ -69957,7 +69996,7 @@
},
"timezone": {
"type": "string",
- "description": "Merchant\u2019s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
+ "description": "Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago`\n"
},
"query": {
"type": "string",
@@ -70084,7 +70123,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#### 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"
+ "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's 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"
}
}
},
@@ -70201,17 +70240,17 @@
"firstName": {
"type": "string",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's first name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\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**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### RBS WorldPay Atlanta\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "Payment card 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 orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\n**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,\nCyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,\nCyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.\nTruncating 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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII characters for transmission to the credit card networks.\n\n#### FDMS Nashville\nWhen the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_,\nit must be sent as _1 1st Street_.\n\nRequired if keyed; not used if swiped.\n\nString (20)\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional.\nString (60)\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"
},
"email": {
"type": "string",
@@ -70226,7 +70265,7 @@
"phoneNumber": {
"type": "string",
"maxLength": 15,
- "description": "Customer\u2019s phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
+ "description": "Customer's phone number.\n\nIt is recommended that you include the country code when the order is from outside the U.S.\n\n#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\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#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nOptional field.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
}
}
},
@@ -70246,11 +70285,11 @@
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"phoneNumber": {
@@ -70298,7 +70337,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\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/)\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'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.\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/)\n"
}
}
},
@@ -70307,7 +70346,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the cardholder\u2019s account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
+ "description": "Last four digits of the cardholder's account number. This field is included in the reply message when the client software\nthat is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.\n\nYou must contact customer support to have your account enabled to receive these fields in the credit reply message.\n\n#### Google Pay transactions\nFor PAN-based Google Pay transactions, this field is returned in the API response.\n\n#### PIN debit\nThis field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.\n\nReturned by PIN debit credit and PIN debit purchase.\n\nThis field is supported only by the following processors:\n- American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- OmniPay Direct\n- SIX\n"
},
"prefix": {
"type": "string",
@@ -70328,7 +70367,7 @@
"properties": {
"suffix": {
"type": "string",
- "description": "Last four digits of the customer\u2019s payment account number.\n"
+ "description": "Last four digits of the customer's payment account number.\n"
},
"prefix": {
"type": "string",
@@ -70355,12 +70394,12 @@
"commerceIndicator": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
},
"commerceIndicatorLabel": {
"type": "string",
"maxLength": 20,
- "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \u201cmoto\"\n"
+ "description": "Type of transaction. Some payment card companies use this information when determining discount rates.\n\n#### Used by\n**Authorization**\nRequired payer authentication transactions; otherwise, optional.\n**Credit**\nRequired for standalone credits on Chase Paymentech solutions; otherwise, optional.\n\nThe list of valid values in this field depends on your processor.\nSee Appendix I, \"Commerce Indicators,\" on page 441 of the Cybersource Credit Card Guide.\n\n#### Ingenico ePayments\nWhen you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you\ninstead of the default value (listed in Appendix I, \"Commerce Indicators,\" on page 441.)\n\n#### Payer Authentication Transactions\nFor the possible values and requirements, see \"Payer Authentication,\" page 195.\n\n#### Card Present\nYou must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be\nused when the cardholder and card are present at the time of the transaction.\nFor all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator\nshould be submitted as \"moto\"\n"
}
}
},
@@ -70407,7 +70446,7 @@
"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"
+ "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's software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's\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"
}
}
},
@@ -70417,7 +70456,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\nFor information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\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 information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is available only\non FDC Nashville Global.\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 Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, 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\n\n#### CyberSource through VisaNet\n- In Japan: 199 bytes\n- In other countries: String (252)\n\n#### GPX\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n\n#### JCN Gateway\nThe following tags must be included:\n- `4F`: Application identifier\n- `84`: Dedicated file name\n\nData length: 199 bytes\n\n#### All other processors:\nString (999)\n\n#### Used by\nAuthorization: Optional\nAuthorization Reversal: Optional\nCredit: Optional\nPIN Debit processing (purchase, credit and reversal): Optional\n"
}
}
}
@@ -70435,7 +70474,7 @@
"true_ipaddress": {
"type": "string",
"maxLength": 255,
- "description": "Customer\u2019s true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n"
+ "description": "Customer's true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n"
},
"hash": {
"type": "string",
@@ -71787,7 +71826,7 @@
"Reports"
],
"summary": "Get Report Based on Report Id",
- "description": "Download a report using the reportId value. If you don\u2019t already know this value, you can obtain it using the Retrieve available reports call.\n",
+ "description": "Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.\n",
"operationId": "getReportByReportId",
"x-devcenter-metaData": {
"categoryTag": "Reporting",
@@ -73484,7 +73523,7 @@
"Report Subscriptions"
],
"summary": "Get Subscription for Report Name",
- "description": "View the details of a report subscription, such as the report format or report frequency, using the report\u2019s unique name.\n",
+ "description": "View the details of a report subscription, such as the report format or report frequency, using the report's unique name.\n",
"operationId": "getSubscription",
"x-devcenter-metaData": {
"categoryTag": "Reporting"
@@ -77578,7 +77617,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -77586,7 +77625,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's 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"
}
}
}
@@ -77910,7 +77949,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -77918,7 +77957,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's 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"
}
}
}
@@ -78755,7 +78794,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#### 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"
+ "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's 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"
}
}
},
@@ -79251,7 +79290,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -79259,7 +79298,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's 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"
}
}
}
@@ -79662,7 +79701,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -79670,7 +79709,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's 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"
}
}
}
@@ -79985,7 +80024,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -79993,7 +80032,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's 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"
}
}
}
@@ -80575,7 +80614,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -80583,7 +80622,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's 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"
}
}
}
@@ -81112,7 +81151,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#### 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"
+ "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's 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"
},
"company": {
"type": "object",
@@ -81120,7 +81159,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's 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"
}
}
}
@@ -82559,7 +82598,7 @@
},
"commitIndicator": {
"type": "boolean",
- "description": "Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \u201cCommitted.\u201d For an uncommitted tax transaction, the status in the Tax Detail Report is \u201cUncommitted.\u201d Possible values:\n- `true`: This is a committed tax transaction.\n- `false` (default): This is not a committed tax transaction.\n\nA committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed.\nThe committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit.\n\nUse a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders.\n\nOptional for U.S., Canadian, international tax, and value added taxes.\nFor more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).\n"
+ "description": "Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values:\n- `true`: This is a committed tax transaction.\n- `false` (default): This is not a committed tax transaction.\n\nA committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed.\nThe committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit.\n\nUse a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders.\n\nOptional for U.S., Canadian, international tax, and value added taxes.\nFor more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).\n"
},
"refundIndicator": {
"type": "boolean",
@@ -82645,38 +82684,38 @@
"properties": {
"country": {
"type": "string",
- "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n",
+ "description": "Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n",
"maxLength": 2
},
"administrativeArea": {
"type": "string",
"maxLength": 20,
- "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"locality": {
"type": "string",
"maxLength": 50,
- "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "City of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S. or\nCanada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
"maxLength": 10,
- "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address1": {
"type": "string",
"maxLength": 60,
- "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "First line of the shipping address.\n\nRequired field for authorization if any shipping address information is included in the request; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address2": {
"type": "string",
"maxLength": 60,
- "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Second line of the shipping address.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address3": {
"type": "string",
"maxLength": 60,
- "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder\u2019s location when shipTo objects are not present.\n"
+ "description": "Third line of the shipping address.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
},
@@ -82693,7 +82732,7 @@
"productCode": {
"type": "string",
"maxLength": 255,
- "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don\u2019t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you\u2019ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
+ "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\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/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n"
},
"quantity": {
"type": "integer",
@@ -82792,7 +82831,7 @@
"buyerVatRegistrationNumber": {
"type": "string",
"maxLength": 25,
- "description": "Buyer\u2019s VAT registration number.\n\n**NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.\n\n#### Tax Calculation\nOptional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n"
+ "description": "Buyer's VAT registration number.\n\n**NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.\n\n#### Tax Calculation\nOptional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n"
},
"sellerVatRegistrationNumber": {
"type": "string",
@@ -82882,7 +82921,7 @@
"vatRegistrationNumber": {
"type": "string",
"maxLength": 20,
- "description": "Customer\u2019s government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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": "Customer's government-assigned tax identification number.\n\n#### Tax Calculation\nOptional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n\nFor processor-specific information, see the purchaser_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"
}
}
}
@@ -82952,7 +82991,7 @@
"properties": {
"commitIndicator": {
"type": "boolean",
- "description": "Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \u201cCommitted.\u201d For an uncommitted tax transaction, the status in the Tax Detail Report is \u201cUncommitted.\u201d Possible values:\n- `true`: This is a committed tax transaction.\n- `false` (default): This is not a committed tax transaction.\n\nA committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed.\nThe committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit.\n\nUse a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders.\n\nOptional for U.S., Canadian, international tax, and value added taxes.\nFor more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).\n"
+ "description": "Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is \"Committed.\" For an uncommitted tax transaction, the status in the Tax Detail Report is \"Uncommitted.\" Possible values:\n- `true`: This is a committed tax transaction.\n- `false` (default): This is not a committed tax transaction.\n\nA committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed.\nThe committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit.\n\nUse a void service request to cancel a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders.\n\nOptional for U.S., Canadian, international tax, and value added taxes.\nFor more information on Tax Detail Report features refer the [Tax Service Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).\n"
},
"refundIndicator": {
"type": "boolean",
@@ -83686,7 +83725,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
}
}
}
@@ -83756,7 +83795,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -84086,7 +84125,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -84322,7 +84361,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"cert": {
"type": "string",
@@ -84391,7 +84430,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -84575,7 +84614,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -84870,7 +84909,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -84935,7 +84974,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -85112,7 +85151,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"digestAlgorithm": {
"type": "string",
@@ -85191,7 +85230,7 @@
},
"referenceNumber": {
"type": "string",
- "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
+ "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n"
},
"keyId": {
"type": "string",
@@ -85927,7 +85966,8 @@
"Json Web Token"
],
"overrideMerchantCredential": "apitester00",
- "developerGuides": "https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html"
+ "developerGuides": "https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Create a boarding registration",
"description": "Create a registration to board merchant\n\nIf you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.\nYou may unselect attributes from the Request Builder tree which you do not need in the request.\nFor VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request.\ne.g. replace VPC with <your vpc processor>\n",
@@ -86751,8 +86791,8 @@
"type": "object",
"properties": {
"payments": {
+ "title": "paymentsProducts",
"type": "object",
- "title": "paymentProducts",
"properties": {
"cardProcessing": {
"type": "object",
@@ -87326,7 +87366,7 @@
},
"avsFormat": {
"type": "string",
- "description": "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction\u2019s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
+ "description": "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
},
"enableLongTransRefNo": {
"type": "boolean",
@@ -87338,11 +87378,11 @@
},
"enableMultipleTransactionAdviceAddendum": {
"type": "boolean",
- "description": "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement.\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cp, cnp, hybrid | No | No |
\n
\n"
+ "description": "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement.\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cp, cnp, hybrid | No | No |
\n
\n"
},
"amexTransactionAdviceAddendum1": {
"type": "string",
- "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement.\nApplicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
\n| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
\n
\n"
+ "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement.\nApplicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
\n| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
\n
\n"
},
"enableMultiLineItems": {
"type": "boolean",
@@ -87387,7 +87427,7 @@
},
"softDescriptorType": {
"type": "string",
- "description": "A soft descriptor is a text, rendered on a cardholder\u2019s statement, describing a particular product or service, purchased by the cardholder.\nDescriptors are intended to help the cardholder identify the products or services purchased.\nValid values:\n`1` - trans_ref_no\n`2` - merchant_descriptor\n`3` - trans_ref_no and merchant_descriptor\nApplicable for TSYS (tsys) processor.\n"
+ "description": "A soft descriptor is a text, rendered on a cardholder's statement, describing a particular product or service, purchased by the cardholder.\nDescriptors are intended to help the cardholder identify the products or services purchased.\nValid values:\n`1` - trans_ref_no\n`2` - merchant_descriptor\n`3` - trans_ref_no and merchant_descriptor\nApplicable for TSYS (tsys) processor.\n"
},
"vitalNumber": {
"type": "string",
@@ -87407,7 +87447,7 @@
},
"merchantLocationNumber": {
"type": "string",
- "description": "5 digit merchant location number. Unless otherwise specified by merchant\u2019s bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor."
+ "description": "5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor."
},
"storeID": {
"type": "string",
@@ -87439,7 +87479,7 @@
},
"enablePosNetworkSwitching": {
"type": "boolean",
- "description": "\u2018POS Network Switching\u2019 or \u2018Alternate Routing\u2019 means merchant can process PIN Debit transactions without a PIN. Set the value to \u2018Yes\u2019 if it is supported. Applicable for FDI Global (fdiglobal) processor."
+ "description": "'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor."
},
"enableDynamicCurrencyConversion": {
"type": "boolean",
@@ -87501,7 +87541,7 @@
},
"visaDelegatedAuthenticationId": {
"type": "string",
- "description": "Identifier provided to merchants who opt for Visa\u2019s delegated authorization program. Applicable for VPC processors."
+ "description": "Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors."
},
"creditCardRefundLimitPercent": {
"type": "string",
@@ -87541,7 +87581,7 @@
},
"merchantDescriptorInformation": {
"type": "object",
- "description": "A merchant descriptor is the line of copy that identifies transactions on a cardholder\u2019s account activity and statement. If this information is not populated, the data will be retrieved from OMS.",
+ "description": "A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.",
"properties": {
"name": {
"type": "string",
@@ -87888,7 +87928,7 @@
},
"amexTransactionAdviceAddendum1": {
"type": "string",
- "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors."
+ "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors."
},
"installment": {
"type": "object",
@@ -88212,7 +88252,7 @@
"standardEntryClassCodes": {
"type": "string",
"default": "CCD,PPD,TEL,WEB",
- "description": "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD \u2014 Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD \u2014 Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer\u2019s checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL \u2014 Telephone-Initiated Entry, or TEL, is a one-time charge against a customer\u2019s checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB \u2014 Internet-Initiated Entry or WEB is a charge against a customer\u2019s checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
+ "description": "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD \u2014 Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD \u2014 Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer's checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL \u2014 Telephone-Initiated Entry, or TEL, is a one-time charge against a customer's checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB \u2014 Internet-Initiated Entry or WEB is a charge against a customer's checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
},
"enableHold": {
"type": "boolean",
@@ -88241,7 +88281,7 @@
},
"riskReserveMethod": {
"type": "string",
- "description": "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant\u2019s available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
+ "description": "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant's available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
},
"riskReserveRate": {
"type": "number",
@@ -88251,7 +88291,7 @@
"riskReserveTargetAmount": {
"type": "number",
"format": "currency",
- "description": "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant\u2019s\nbank account\n12 digit including decimal\n"
+ "description": "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant's\nbank account\n12 digit including decimal\n"
},
"solutionOrganizationId": {
"type": "string",
@@ -90116,8 +90156,8 @@
}
},
"risk": {
- "type": "object",
"title": "riskProducts",
+ "type": "object",
"properties": {
"fraudManagementEssentials": {
"type": "object",
@@ -90396,8 +90436,8 @@
}
},
"commerceSolutions": {
- "type": "object",
"title": "commerceSolutionsProducts",
+ "type": "object",
"properties": {
"tokenManagement": {
"type": "object",
@@ -90590,8 +90630,8 @@
}
},
"valueAddedServices": {
- "type": "object",
"title": "valueAddedServicesProducts",
+ "type": "object",
"properties": {
"reporting": {
"type": "object",
@@ -94742,7 +94782,8 @@
"Json Web Token"
],
"overrideMerchantCredential": "apitester00",
- "developerGuides": "https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html"
+ "developerGuides": "https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"tags": [
"Merchant Boarding"
@@ -95591,6 +95632,7 @@
"type": "object",
"properties": {
"payments": {
+ "title": "paymentsProducts",
"type": "object",
"properties": {
"cardProcessing": {
@@ -96165,7 +96207,7 @@
},
"avsFormat": {
"type": "string",
- "description": "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction\u2019s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
+ "description": "Enables Enhanced AVS/Automated Address Verification Plus (AAV+).\n\nValid values:\n\"basic\" - Standard address verification system.\n When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address.\n When a customer provides incorrect information, the transaction might be fraudulent.\n\"basic + name\" - Enhanced address verification system.\n Consists of the standard AVS functionality plus verification of some additional fields.\n The additional fields that are verified for Enhanced AVS are:\n - customer_firstname\n - customer_lastname\n\"basic + name + shipto\" - Automated address verification plus.\n Consists of the Enhanced AVS functionality plus verification of some additional fields.\n AAV+ intended for merchants who deliver physical goods to a different address than the billing address.\n AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first.\n For information about Enhanced AVS - The additional fields that are verified for AAV+ are:\n - ship_to_firstname\n - ship_to_lastname\n - ship_to_address1\n - ship_to_country\n - ship_to_zip\n - ship_to_phone\n - customer_phone(American Express Direct only)\n\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cnp, cp, hybrid | Yes | basic |
\n
\n"
},
"enableLongTransRefNo": {
"type": "boolean",
@@ -96177,11 +96219,11 @@
},
"enableMultipleTransactionAdviceAddendum": {
"type": "boolean",
- "description": "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement.\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cp, cnp, hybrid | No | No |
\n
\n"
+ "description": "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement.\nApplicable for American Express Direct (amexdirect) processor.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Default Value |
|---|
\n| American Express Direct | cp, cnp, hybrid | No | No |
\n
\n"
},
"amexTransactionAdviceAddendum1": {
"type": "string",
- "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement.\nApplicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
\n| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
\n
\n"
+ "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement.\nApplicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.\n\nValidation details (for selected processors)...\n\n\n| Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
\n| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
\n
\n"
},
"enableMultiLineItems": {
"type": "boolean",
@@ -96226,7 +96268,7 @@
},
"softDescriptorType": {
"type": "string",
- "description": "A soft descriptor is a text, rendered on a cardholder\u2019s statement, describing a particular product or service, purchased by the cardholder.\nDescriptors are intended to help the cardholder identify the products or services purchased.\nValid values:\n`1` - trans_ref_no\n`2` - merchant_descriptor\n`3` - trans_ref_no and merchant_descriptor\nApplicable for TSYS (tsys) processor.\n"
+ "description": "A soft descriptor is a text, rendered on a cardholder's statement, describing a particular product or service, purchased by the cardholder.\nDescriptors are intended to help the cardholder identify the products or services purchased.\nValid values:\n`1` - trans_ref_no\n`2` - merchant_descriptor\n`3` - trans_ref_no and merchant_descriptor\nApplicable for TSYS (tsys) processor.\n"
},
"vitalNumber": {
"type": "string",
@@ -96246,7 +96288,7 @@
},
"merchantLocationNumber": {
"type": "string",
- "description": "5 digit merchant location number. Unless otherwise specified by merchant\u2019s bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor."
+ "description": "5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor."
},
"storeID": {
"type": "string",
@@ -96278,7 +96320,7 @@
},
"enablePosNetworkSwitching": {
"type": "boolean",
- "description": "\u2018POS Network Switching\u2019 or \u2018Alternate Routing\u2019 means merchant can process PIN Debit transactions without a PIN. Set the value to \u2018Yes\u2019 if it is supported. Applicable for FDI Global (fdiglobal) processor."
+ "description": "'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor."
},
"enableDynamicCurrencyConversion": {
"type": "boolean",
@@ -96340,7 +96382,7 @@
},
"visaDelegatedAuthenticationId": {
"type": "string",
- "description": "Identifier provided to merchants who opt for Visa\u2019s delegated authorization program. Applicable for VPC processors."
+ "description": "Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors."
},
"creditCardRefundLimitPercent": {
"type": "string",
@@ -96380,7 +96422,7 @@
},
"merchantDescriptorInformation": {
"type": "object",
- "description": "A merchant descriptor is the line of copy that identifies transactions on a cardholder\u2019s account activity and statement. If this information is not populated, the data will be retrieved from OMS.",
+ "description": "A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.",
"properties": {
"name": {
"type": "string",
@@ -96727,7 +96769,7 @@
},
"amexTransactionAdviceAddendum1": {
"type": "string",
- "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer\u2019s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors."
+ "description": "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors."
},
"installment": {
"type": "object",
@@ -97051,7 +97093,7 @@
"standardEntryClassCodes": {
"type": "string",
"default": "CCD,PPD,TEL,WEB",
- "description": "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD \u2014 Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD \u2014 Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer\u2019s checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL \u2014 Telephone-Initiated Entry, or TEL, is a one-time charge against a customer\u2019s checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB \u2014 Internet-Initiated Entry or WEB is a charge against a customer\u2019s checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
+ "description": "Mandatory \nFree-text (csv) \nPossible values (combination):\n\nCCD \u2014 Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.\nPPD \u2014 Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer's checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\nTEL \u2014 Telephone-Initiated Entry, or TEL, is a one-time charge against a customer's checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone.\nWEB \u2014 Internet-Initiated Entry or WEB is a charge against a customer's checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.\n"
},
"enableHold": {
"type": "boolean",
@@ -97080,7 +97122,7 @@
},
"riskReserveMethod": {
"type": "string",
- "description": "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant\u2019s available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
+ "description": "Mandatory\nReserve Method \nPossible value:\n- fixed\n- none\nMost merchants do not have a reserve attached to their account so the default value would be \"none.\" \n\nFor a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump\nsum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for\nthe account from each batch settlement until the reserve balance is equal to a set\nReserve Target. A Fixed Reserve may also be established by a combination of lump\nsum deposit and withholding of settlement funds.\n\nA Rolling Reserve balance is established by withholding from a merchant's available\nsettlement funds at a Reserve Rate (percentage) and no Reserve Target is specified.\nRather, each amount withheld is retained for a specified number of Reserve Holding\nDays and then released back to the merchant.\n"
},
"riskReserveRate": {
"type": "number",
@@ -97090,7 +97132,7 @@
"riskReserveTargetAmount": {
"type": "number",
"format": "currency",
- "description": "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant\u2019s\nbank account\n12 digit including decimal\n"
+ "description": "Mandatory \nReserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY\n\nThe maximum dollar amount that can be held in Risk Reserve for a\nfixed reserve. Once risk withholdings reach the Reserve Target established for the\neCheck.Net account, a portion of available funds will be deposited to the merchant's\nbank account\n12 digit including decimal\n"
},
"solutionOrganizationId": {
"type": "string",
@@ -98955,6 +98997,7 @@
}
},
"risk": {
+ "title": "riskProducts",
"type": "object",
"properties": {
"fraudManagementEssentials": {
@@ -99234,6 +99277,7 @@
}
},
"commerceSolutions": {
+ "title": "commerceSolutionsProducts",
"type": "object",
"properties": {
"tokenManagement": {
@@ -99427,6 +99471,7 @@
}
},
"valueAddedServices": {
+ "title": "valueAddedServicesProducts",
"type": "object",
"properties": {
"reporting": {
@@ -101975,12 +102020,19 @@
"tags": [
"Create New Webhooks"
],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Create Webhook Security Keys",
"description": "Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.\n\nSelect the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.\n",
@@ -102201,9 +102253,9 @@
"clientRequestAction": "CREATE",
"keyInformation": {
"provider": "nrtd",
- "tenant": "merchantName",
+ "tenant": "",
"keyType": "sharedSecret",
- "organizationId": "merchantName"
+ "organizationId": ""
}
}
},
@@ -102212,12 +102264,12 @@
"value": {
"clientRequestAction": "STORE",
"keyInformation": {
- "provider": "merchantName",
+ "provider": "",
"tenant": "nrtd",
"keyType": "oAuthClientCredentials",
"clientKeyId": "client username",
"key": "client secret",
- "organizationId": "merchantName",
+ "organizationId": "",
"expiryDuration": "365"
}
}
@@ -102230,16 +102282,20 @@
"tags": [
"Create New Webhooks"
],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Find Products You Can Subscribe To",
"description": "Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.",
- "operationId": "findProductToSubscribe",
+ "operationId": "findProductsToSubscribe",
"parameters": [
{
"name": "organizationId",
@@ -102319,19 +102375,26 @@
"tags": [
"Create New Webhooks"
],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Create a Webhook",
"description": "Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section.\nYou will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.\n",
- "operationId": "createWebhook",
+ "operationId": "createWebhookSubscription",
"parameters": [
{
- "name": "createWebhook",
+ "name": "createWebhookRequest",
"in": "body",
"description": "The webhook payload",
"schema": {
@@ -102626,7 +102689,7 @@
},
"example": {
"webhookId": "b555a545-58a9-47c7-aef9-10a8e17f201a",
- "organizationId": "123456",
+ "organizationId": "",
"productId": "payments",
"eventTypes": [
"payments.payments.accept",
@@ -102671,7 +102734,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "tokenManagement",
"eventTypes": [
"tms.networktoken.provisioned",
@@ -102703,7 +102766,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "cns",
"eventTypes": [
"cns.outage.notify.freeform",
@@ -102732,7 +102795,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "alternativePaymentMethods",
"eventTypes": [
"payments.payments.updated"
@@ -102760,7 +102823,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "recurringBilling",
"eventTypes": [
"rbs.subscriptions.charge.pre-notified",
@@ -102790,7 +102853,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "secureAcceptance",
"eventTypes": [
"sa.orders.rawtransactionresults",
@@ -102820,7 +102883,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "customerInvoicing",
"eventTypes": [
"invoicing.customer.invoice.cancel",
@@ -102854,7 +102917,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "terminalManagement",
"eventTypes": [
"terminalManagement.assignment.update",
@@ -102884,7 +102947,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "fraudManagementEssentials",
"eventTypes": [
"risk.profile.decision.review",
@@ -102917,7 +102980,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "decisionManager",
"eventTypes": [
"risk.profile.decision.reject",
@@ -102948,7 +103011,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "terminalManagement",
"eventTypes": [
"terminalManagement.assignment.update"
@@ -102981,7 +103044,7 @@
"value": {
"name": "My Custom Webhook",
"description": "Sample Webhook from Developer Center",
- "organizationId": "organizationId",
+ "organizationId": "",
"productId": "terminalManagement",
"eventTypes": [
"terminalManagement.assignment.update"
@@ -103021,16 +103084,20 @@
"tags": [
"Manage Webhooks"
],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Get Details On All Created Webhooks",
"description": "Retrieve a list of all previously created webhooks.",
- "operationId": "getAllWebhooks",
+ "operationId": "getWebhookSubscriptionsByOrg",
"parameters": [
{
"name": "organizationId",
@@ -103229,7 +103296,7 @@
},
"example": {
"webhookId": "b555a545-58a9-47c7-aef9-10a8e17f201a",
- "organizationId": "123456",
+ "organizationId": "",
"productId": "payments",
"eventTypes": [
"payments.payments.accept",
@@ -103273,12 +103340,19 @@
"tags": [
"Manage Webhooks"
],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Update a Webhook Subscription",
"description": "Update the webhook subscription using PATCH.",
@@ -103292,7 +103366,7 @@
"required": true
},
{
- "name": "updateWebhook",
+ "name": "updateWebhookRequest",
"in": "body",
"description": "The webhook payload or changes to apply.",
"schema": {
@@ -103485,7 +103559,7 @@
"value": {
"name": "My Sample Webhook",
"description": "Update to my sample webhook",
- "organizationId": "testOrgId",
+ "organizationId": "",
"productId": "terminalManagement",
"eventTypes": [
"terminalManagement.assignment.update",
@@ -103502,16 +103576,20 @@
"tags": [
"Manage Webhooks"
],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Get Details On a Single Webhook",
"description": "Retrieve the details of a specific webhook by supplying the webhook ID in the path.",
- "operationId": "getWebhookDetails",
+ "operationId": "getWebhookSubscriptionById",
"parameters": [
{
"name": "webhookId",
@@ -103694,7 +103772,7 @@
},
"example": {
"webhookId": "b555a545-58a9-47c7-aef9-10a8e17f201a",
- "organizationId": "123456",
+ "organizationId": "",
"productId": "payments",
"eventTypes": [
"payments.payments.accept",
@@ -103738,12 +103816,16 @@
"tags": [
"Manage Webhooks"
],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Delete a Webhook Subscription",
"description": "Delete the webhook. Please note that deleting a particular webhook does not delete the history of the webhook notifications.",
@@ -103778,16 +103860,23 @@
"tags": [
"Manage Webhooks"
],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Replay Previous Webhooks",
"description": "Initiate a webhook replay request to replay transactions that happened in the past.\n\nCannot execute more than 1 replay request at a time. While one request is processing, you will not be allowed to execute another replay.\n\nThe difference between Start and End time cannot exceed a 24 hour window, and 1 month is the farthest date back that is eligible for replay.\n",
- "operationId": "replayPreviousWebhook",
+ "operationId": "replayPreviousWebhooks",
"parameters": [
{
"name": "webhookId",
@@ -103797,7 +103886,7 @@
"description": "The webhook uuid identifier."
},
{
- "name": "replayWebhooks",
+ "name": "replayWebhooksRequest",
"in": "body",
"description": "The request query",
"schema": {
@@ -103923,12 +104012,19 @@
"tags": [
"Manage Webhooks"
],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Webhooks",
"firstLevelApiLifeCycle": "beta",
"secondLevelApiLifeCycle": "beta",
"apiLifeCycle": "beta",
- "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html"
+ "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html",
+ "SDK_ONLY_AddDisclaimer": true
},
"summary": "Message Level Encryption",
"description": "Store and manage certificates that will be used to preform Message Level Encryption (MLE).\nEach new webhook will need its own unique asymmetric certificate.\nYou can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide.\n",
@@ -104120,10 +104216,10 @@
"value": {
"clientRequestAction": "STORE",
"keyInformation": {
- "provider": "merchantName",
+ "provider": "",
"tenant": "nrtd",
"keyType": "publickey",
- "organizationId": "merchantName",
+ "organizationId": "",
"pub": "MIIDbDCCAlQCCQD4lcSlmasmCTANBgkqhkiG9w0BAQsFADB4MQswCQYDVQQGEwJVUzELMAkGA1UECAwCVFgxDzANBgNVBAcMBkF1c3RpbjENMAsGA1UECgwEVGVzdDEOMAwGA1UECwwFVGVzdDIxDjAMBgNVBAMMBVRlc3QzMRwwGgYJKoZIhvcNAQkBFg10ZXN0QHRlc3QuY29tMB4XDTIxMDgwOTE0MTcxNFoXDTIyMDgwOTE0MTcxNFoweDELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlRYMQ8wDQYDVQQHDAZBdXN0aW4xDTALBgNVBAoMBFRlc3QxDjAMBgNVBAsMBVRlc3QyMQ4wDAYDVQQDDAVUZXN0MzEcMBoGCSqGSIb3DQEJARYNdGVzdEB0ZXN0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMcHQWZRETqim3XzUQlAiujFEvsHIi1uJZKj+1lvPH36Ucqo3ORcoh/MM/zxVdahjhSyyp7MHuKBWnzft6bFeDEul6qKWGPAAzaxG/2xZSV3FggA9SyAZEDUpJ6mblwqm/EY4KmZi1FrNBUHfW2wwaqDexHPRDesRG6aI7Wuu4GdQUUqoTa2+Nv7kVgEDmGcfIjoWkGKHe+Yan95EITrq4jEFCE5Tg/vERnMvHfK2SovENZ13/pnwFYbeh1kfJSBzWW7yq8AyQAgAE9iqJXbJ/MAasir2vjUQ2+Hcl7WbkpoVjLqDt3rzV1T0Bsd4T9SC3wij9qjJSxa6vAgV4xn6bECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEADuMrtYW1Sf0IsZ4ZD9ipjUrFuTxqh+0M5Jk8h0QqAXEHA/MawedlU3JmE3NB/UR82/XUwdmtObGnFANuUQQ+8WMFpcNo/Sq2kg7juneHZroRh72o73UUMtHWHzo8s0fXElNal8h3SaAAnjMblCiN+gM1RvWMvhGrMTXp2XAcdIezXf8/FOZLlzOF9QylbSk1U4ayWBag6MydkxgHjkPKdShZROEm0oz/O7J/gNp/r7J8F42Rw9MmJh9qH3SFre13nQa8V7Kg+dJHZ/jpGtSlDHAxO0SSTrPXkwB+iBJ6hSkiL/J2Ep+lYHqVe3p5NXMOlTtJdbU4enHeLkD6PazKTw",
"expiryDuration": "365"
}
@@ -104133,8 +104229,6 @@
}
},
"/up/v1/capture-contexts": {
- "x-name": "Generate Unified Checkout Capture Context",
- "x-description": "Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout within a merchant web page",
"post": {
"tags": [
"Unified Checkout Capture Context"
@@ -104255,7 +104349,7 @@
"type": "string",
"example": "277 Park Avenue",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -104297,7 +104391,7 @@
"type": "string",
"example": "district",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n"
},
"locality": {
"type": "string",
@@ -104318,13 +104412,13 @@
"type": "string",
"example": "Visa Inc",
"maxLength": 60,
- "description": "Name of the customer\u2019s company."
+ "description": "Name of the customer's company."
},
"address1": {
"type": "string",
"example": "277 Park Avenue",
"maxLength": 60,
- "description": "Payment card billing street address as it appears on the credit card issuer\u2019s records.\n"
+ "description": "Payment card billing street address as it appears on the credit card issuer's records.\n"
},
"address2": {
"type": "string",
@@ -104366,7 +104460,7 @@
"type": "string",
"example": "district",
"maxLength": 50,
- "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n"
+ "description": "Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality\n"
},
"locality": {
"type": "string",
@@ -104392,25 +104486,25 @@
"type": "string",
"example": "John",
"maxLength": 60,
- "description": "Customer\u2019s first name. This name must be the same as the name on the card"
+ "description": "Customer's first name. This name must be the same as the name on the card"
},
"lastName": {
"type": "string",
"example": "Doe",
"maxLength": 60,
- "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n"
+ "description": "Customer's last name. This name must be the same as the name on the card.\n"
},
"middleName": {
"type": "string",
"example": "F",
"maxLength": 60,
- "description": "Customer\u2019s middle name.\n"
+ "description": "Customer's middle name.\n"
},
"nameSuffix": {
"type": "string",
"example": "Jr",
"maxLength": 60,
- "description": "Customer\u2019s name suffix.\n"
+ "description": "Customer's name suffix.\n"
},
"title": {
"type": "string",
@@ -104421,7 +104515,7 @@
"phoneNumber": {
"type": "string",
"example": 1234567890,
- "description": "Customer\u2019s phone number.\n"
+ "description": "Customer's phone number.\n"
},
"phoneType": {
"type": "string",
@@ -104804,8 +104898,6 @@
}
},
"/up/v1/payment-details/{transientToken}": {
- "x-name": "Get Transient Token Data",
- "x-description": "Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN).",
"get": {
"summary": "Get Transient Token Data",
"description": "Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN). Include the Request ID in the GET request to retrieve the transaction details.",
diff --git a/src/main/java/Api/CreateNewWebhooksApi.java b/src/main/java/Api/CreateNewWebhooksApi.java
index 2b7333c55..c64a6699a 100644
--- a/src/main/java/Api/CreateNewWebhooksApi.java
+++ b/src/main/java/Api/CreateNewWebhooksApi.java
@@ -28,7 +28,7 @@
import java.io.InputStream;
-import Model.CreateWebhook;
+import Model.CreateWebhookRequest;
import Model.InlineResponse2003;
import Model.InlineResponse2012;
import Model.InlineResponse2013;
@@ -66,16 +66,16 @@ public void setApiClient(ApiClient apiClient) {
}
/**
- * Build call for createWebhook
- * @param createWebhook The webhook payload (optional)
+ * Build call for createWebhookSubscription
+ * @param createWebhookRequest The webhook payload (optional)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call createWebhookCall(CreateWebhook createWebhook, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call createWebhookSubscriptionCall(CreateWebhookRequest createWebhookRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
- Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(createWebhook, CreateWebhook.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
+ Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(createWebhookRequest, CreateWebhookRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
// create path and map variables
String localVarPath = "/notification-subscriptions/v1/webhooks";
@@ -87,7 +87,7 @@ public okhttp3.Call createWebhookCall(CreateWebhook createWebhook, final Progres
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -115,10 +115,10 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call createWebhookValidateBeforeCall(CreateWebhook createWebhook, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call createWebhookSubscriptionValidateBeforeCall(CreateWebhookRequest createWebhookRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
- okhttp3.Call call = createWebhookCall(createWebhook, progressListener, progressRequestListener);
+ okhttp3.Call call = createWebhookSubscriptionCall(createWebhookRequest, progressListener, progressRequestListener);
return call;
@@ -131,27 +131,27 @@ private okhttp3.Call createWebhookValidateBeforeCall(CreateWebhook createWebhook
* Create a Webhook
* Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.
* DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
- * @param createWebhook The webhook payload (optional)
+ * @param createWebhookRequest The webhook payload (optional)
* @return InlineResponse2013
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public InlineResponse2013 createWebhook(CreateWebhook createWebhook) throws ApiException {
- logger.info("CALL TO METHOD 'createWebhook' STARTED");
+ public InlineResponse2013 createWebhookSubscription(CreateWebhookRequest createWebhookRequest) throws ApiException {
+ logger.info("CALL TO METHOD 'createWebhookSubscription' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = createWebhookWithHttpInfo(createWebhook);
- logger.info("CALL TO METHOD 'createWebhook' ENDED");
+ ApiResponse resp = createWebhookSubscriptionWithHttpInfo(createWebhookRequest);
+ logger.info("CALL TO METHOD 'createWebhookSubscription' ENDED");
return resp.getData();
}
/**
* Create a Webhook
* Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.
- * @param createWebhook The webhook payload (optional)
+ * @param createWebhookRequest The webhook payload (optional)
* @return ApiResponse<InlineResponse2013>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse createWebhookWithHttpInfo(CreateWebhook createWebhook) throws ApiException {
- okhttp3.Call call = createWebhookValidateBeforeCall(createWebhook, null, null);
+ public ApiResponse createWebhookSubscriptionWithHttpInfo(CreateWebhookRequest createWebhookRequest) throws ApiException {
+ okhttp3.Call call = createWebhookSubscriptionValidateBeforeCall(createWebhookRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -159,12 +159,12 @@ public ApiResponse createWebhookWithHttpInfo(CreateWebhook c
/**
* Create a Webhook (asynchronously)
* Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.
- * @param createWebhook The webhook payload (optional)
+ * @param createWebhookRequest The webhook payload (optional)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call createWebhookAsync(CreateWebhook createWebhook, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call createWebhookSubscriptionAsync(CreateWebhookRequest createWebhookRequest, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -186,20 +186,20 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = createWebhookValidateBeforeCall(createWebhook, progressListener, progressRequestListener);
+ okhttp3.Call call = createWebhookSubscriptionValidateBeforeCall(createWebhookRequest, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
}
/**
- * Build call for findProductToSubscribe
+ * Build call for findProductsToSubscribe
* @param organizationId The Organization Identifier. (required)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call findProductToSubscribeCall(String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call findProductsToSubscribeCall(String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = null;
if ("GET".equalsIgnoreCase("POST")) {
@@ -217,7 +217,7 @@ public okhttp3.Call findProductToSubscribeCall(String organizationId, final Prog
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -245,16 +245,16 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call findProductToSubscribeValidateBeforeCall(String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call findProductsToSubscribeValidateBeforeCall(String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'organizationId' is set
if (organizationId == null) {
- logger.error("Missing the required parameter 'organizationId' when calling findProductToSubscribe(Async)");
- throw new ApiException("Missing the required parameter 'organizationId' when calling findProductToSubscribe(Async)");
+ logger.error("Missing the required parameter 'organizationId' when calling findProductsToSubscribe(Async)");
+ throw new ApiException("Missing the required parameter 'organizationId' when calling findProductsToSubscribe(Async)");
}
- okhttp3.Call call = findProductToSubscribeCall(organizationId, progressListener, progressRequestListener);
+ okhttp3.Call call = findProductsToSubscribeCall(organizationId, progressListener, progressRequestListener);
return call;
@@ -271,11 +271,11 @@ private okhttp3.Call findProductToSubscribeValidateBeforeCall(String organizatio
* @return List<InlineResponse2003>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public List findProductToSubscribe(String organizationId) throws ApiException {
- logger.info("CALL TO METHOD 'findProductToSubscribe' STARTED");
+ public List findProductsToSubscribe(String organizationId) throws ApiException {
+ logger.info("CALL TO METHOD 'findProductsToSubscribe' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse> resp = findProductToSubscribeWithHttpInfo(organizationId);
- logger.info("CALL TO METHOD 'findProductToSubscribe' ENDED");
+ ApiResponse> resp = findProductsToSubscribeWithHttpInfo(organizationId);
+ logger.info("CALL TO METHOD 'findProductsToSubscribe' ENDED");
return resp.getData();
}
@@ -286,8 +286,8 @@ public List findProductToSubscribe(String organizationId) th
* @return ApiResponse<List<InlineResponse2003>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse> findProductToSubscribeWithHttpInfo(String organizationId) throws ApiException {
- okhttp3.Call call = findProductToSubscribeValidateBeforeCall(organizationId, null, null);
+ public ApiResponse> findProductsToSubscribeWithHttpInfo(String organizationId) throws ApiException {
+ okhttp3.Call call = findProductsToSubscribeValidateBeforeCall(organizationId, null, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -300,7 +300,7 @@ public ApiResponse> findProductToSubscribeWithHttpInfo(
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call findProductToSubscribeAsync(String organizationId, final ApiCallback> callback) throws ApiException {
+ public okhttp3.Call findProductsToSubscribeAsync(String organizationId, final ApiCallback> callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -322,7 +322,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = findProductToSubscribeValidateBeforeCall(organizationId, progressListener, progressRequestListener);
+ okhttp3.Call call = findProductsToSubscribeValidateBeforeCall(organizationId, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken>(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
@@ -358,7 +358,7 @@ public okhttp3.Call saveSymEgressKeyCall(String vCSenderOrganizationId, String v
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
diff --git a/src/main/java/Api/ManageWebhooksApi.java b/src/main/java/Api/ManageWebhooksApi.java
index 225ecba21..ed781c4e7 100644
--- a/src/main/java/Api/ManageWebhooksApi.java
+++ b/src/main/java/Api/ManageWebhooksApi.java
@@ -31,9 +31,9 @@
import Model.InlineResponse2004;
import Model.InlineResponse2014;
import Model.InlineResponse4042;
-import Model.ReplayWebhooks;
+import Model.ReplayWebhooksRequest;
import Model.SaveAsymEgressKey;
-import Model.UpdateWebhook;
+import Model.UpdateWebhookRequest;
import java.lang.reflect.Type;
import java.util.ArrayList;
@@ -92,7 +92,7 @@ public okhttp3.Call deleteWebhookSubscriptionCall(String webhookId, final Progre
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -199,16 +199,14 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
return call;
}
/**
- * Build call for getAllWebhooks
- * @param organizationId The Organization Identifier. (required)
- * @param productId The Product Identifier. (required)
- * @param eventType The Event Type. (required)
+ * Build call for getWebhookSubscriptionById
+ * @param webhookId The webhook Identifier (required)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call getAllWebhooksCall(String organizationId, String productId, String eventType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call getWebhookSubscriptionByIdCall(String webhookId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = null;
if ("GET".equalsIgnoreCase("POST")) {
@@ -216,22 +214,17 @@ public okhttp3.Call getAllWebhooksCall(String organizationId, String productId,
}
// create path and map variables
- String localVarPath = "/notification-subscriptions/v1/webhooks";
+ String localVarPath = "/notification-subscriptions/v1/webhooks/{webhookId}"
+ .replaceAll("\\{" + "webhookId" + "\\}", apiClient.escapeString(webhookId.toString()));
List localVarQueryParams = new ArrayList();
- if (organizationId != null)
- localVarQueryParams.addAll(apiClient.parameterToPairs("", "organizationId", organizationId));
- if (productId != null)
- localVarQueryParams.addAll(apiClient.parameterToPairs("", "productId", productId));
- if (eventType != null)
- localVarQueryParams.addAll(apiClient.parameterToPairs("", "eventType", eventType));
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -259,28 +252,16 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getAllWebhooksValidateBeforeCall(String organizationId, String productId, String eventType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call getWebhookSubscriptionByIdValidateBeforeCall(String webhookId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
- // verify the required parameter 'organizationId' is set
- if (organizationId == null) {
- logger.error("Missing the required parameter 'organizationId' when calling getAllWebhooks(Async)");
- throw new ApiException("Missing the required parameter 'organizationId' when calling getAllWebhooks(Async)");
- }
-
- // verify the required parameter 'productId' is set
- if (productId == null) {
- logger.error("Missing the required parameter 'productId' when calling getAllWebhooks(Async)");
- throw new ApiException("Missing the required parameter 'productId' when calling getAllWebhooks(Async)");
- }
-
- // verify the required parameter 'eventType' is set
- if (eventType == null) {
- logger.error("Missing the required parameter 'eventType' when calling getAllWebhooks(Async)");
- throw new ApiException("Missing the required parameter 'eventType' when calling getAllWebhooks(Async)");
+ // verify the required parameter 'webhookId' is set
+ if (webhookId == null) {
+ logger.error("Missing the required parameter 'webhookId' when calling getWebhookSubscriptionById(Async)");
+ throw new ApiException("Missing the required parameter 'webhookId' when calling getWebhookSubscriptionById(Async)");
}
- okhttp3.Call call = getAllWebhooksCall(organizationId, productId, eventType, progressListener, progressRequestListener);
+ okhttp3.Call call = getWebhookSubscriptionByIdCall(webhookId, progressListener, progressRequestListener);
return call;
@@ -290,49 +271,43 @@ private okhttp3.Call getAllWebhooksValidateBeforeCall(String organizationId, Str
}
/**
- * Get Details On All Created Webhooks
- * Retrieve a list of all previously created webhooks.
+ * Get Details On a Single Webhook
+ * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
* DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
- * @param organizationId The Organization Identifier. (required)
- * @param productId The Product Identifier. (required)
- * @param eventType The Event Type. (required)
- * @return List<InlineResponse2004>
+ * @param webhookId The webhook Identifier (required)
+ * @return InlineResponse2004
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public List getAllWebhooks(String organizationId, String productId, String eventType) throws ApiException {
- logger.info("CALL TO METHOD 'getAllWebhooks' STARTED");
+ public InlineResponse2004 getWebhookSubscriptionById(String webhookId) throws ApiException {
+ logger.info("CALL TO METHOD 'getWebhookSubscriptionById' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse> resp = getAllWebhooksWithHttpInfo(organizationId, productId, eventType);
- logger.info("CALL TO METHOD 'getAllWebhooks' ENDED");
+ ApiResponse resp = getWebhookSubscriptionByIdWithHttpInfo(webhookId);
+ logger.info("CALL TO METHOD 'getWebhookSubscriptionById' ENDED");
return resp.getData();
}
/**
- * Get Details On All Created Webhooks
- * Retrieve a list of all previously created webhooks.
- * @param organizationId The Organization Identifier. (required)
- * @param productId The Product Identifier. (required)
- * @param eventType The Event Type. (required)
- * @return ApiResponse<List<InlineResponse2004>>
+ * Get Details On a Single Webhook
+ * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
+ * @param webhookId The webhook Identifier (required)
+ * @return ApiResponse<InlineResponse2004>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse> getAllWebhooksWithHttpInfo(String organizationId, String productId, String eventType) throws ApiException {
- okhttp3.Call call = getAllWebhooksValidateBeforeCall(organizationId, productId, eventType, null, null);
- Type localVarReturnType = new TypeToken>(){}.getType();
+ public ApiResponse getWebhookSubscriptionByIdWithHttpInfo(String webhookId) throws ApiException {
+ okhttp3.Call call = getWebhookSubscriptionByIdValidateBeforeCall(webhookId, null, null);
+ Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
/**
- * Get Details On All Created Webhooks (asynchronously)
- * Retrieve a list of all previously created webhooks.
- * @param organizationId The Organization Identifier. (required)
- * @param productId The Product Identifier. (required)
- * @param eventType The Event Type. (required)
+ * Get Details On a Single Webhook (asynchronously)
+ * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
+ * @param webhookId The webhook Identifier (required)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call getAllWebhooksAsync(String organizationId, String productId, String eventType, final ApiCallback> callback) throws ApiException {
+ public okhttp3.Call getWebhookSubscriptionByIdAsync(String webhookId, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -354,20 +329,22 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = getAllWebhooksValidateBeforeCall(organizationId, productId, eventType, progressListener, progressRequestListener);
- Type localVarReturnType = new TypeToken>(){}.getType();
+ okhttp3.Call call = getWebhookSubscriptionByIdValidateBeforeCall(webhookId, progressListener, progressRequestListener);
+ Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
}
/**
- * Build call for getWebhookDetails
- * @param webhookId The webhook Identifier (required)
+ * Build call for getWebhookSubscriptionsByOrg
+ * @param organizationId The Organization Identifier. (required)
+ * @param productId The Product Identifier. (required)
+ * @param eventType The Event Type. (required)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call getWebhookDetailsCall(String webhookId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call getWebhookSubscriptionsByOrgCall(String organizationId, String productId, String eventType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = null;
if ("GET".equalsIgnoreCase("POST")) {
@@ -375,17 +352,22 @@ public okhttp3.Call getWebhookDetailsCall(String webhookId, final ProgressRespon
}
// create path and map variables
- String localVarPath = "/notification-subscriptions/v1/webhooks/{webhookId}"
- .replaceAll("\\{" + "webhookId" + "\\}", apiClient.escapeString(webhookId.toString()));
+ String localVarPath = "/notification-subscriptions/v1/webhooks";
List localVarQueryParams = new ArrayList();
+ if (organizationId != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "organizationId", organizationId));
+ if (productId != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "productId", productId));
+ if (eventType != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "eventType", eventType));
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -413,16 +395,28 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getWebhookDetailsValidateBeforeCall(String webhookId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call getWebhookSubscriptionsByOrgValidateBeforeCall(String organizationId, String productId, String eventType, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
- // verify the required parameter 'webhookId' is set
- if (webhookId == null) {
- logger.error("Missing the required parameter 'webhookId' when calling getWebhookDetails(Async)");
- throw new ApiException("Missing the required parameter 'webhookId' when calling getWebhookDetails(Async)");
+ // verify the required parameter 'organizationId' is set
+ if (organizationId == null) {
+ logger.error("Missing the required parameter 'organizationId' when calling getWebhookSubscriptionsByOrg(Async)");
+ throw new ApiException("Missing the required parameter 'organizationId' when calling getWebhookSubscriptionsByOrg(Async)");
}
+ // verify the required parameter 'productId' is set
+ if (productId == null) {
+ logger.error("Missing the required parameter 'productId' when calling getWebhookSubscriptionsByOrg(Async)");
+ throw new ApiException("Missing the required parameter 'productId' when calling getWebhookSubscriptionsByOrg(Async)");
+ }
- okhttp3.Call call = getWebhookDetailsCall(webhookId, progressListener, progressRequestListener);
+ // verify the required parameter 'eventType' is set
+ if (eventType == null) {
+ logger.error("Missing the required parameter 'eventType' when calling getWebhookSubscriptionsByOrg(Async)");
+ throw new ApiException("Missing the required parameter 'eventType' when calling getWebhookSubscriptionsByOrg(Async)");
+ }
+
+
+ okhttp3.Call call = getWebhookSubscriptionsByOrgCall(organizationId, productId, eventType, progressListener, progressRequestListener);
return call;
@@ -432,43 +426,49 @@ private okhttp3.Call getWebhookDetailsValidateBeforeCall(String webhookId, final
}
/**
- * Get Details On a Single Webhook
- * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
+ * Get Details On All Created Webhooks
+ * Retrieve a list of all previously created webhooks.
* DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
- * @param webhookId The webhook Identifier (required)
- * @return InlineResponse2004
+ * @param organizationId The Organization Identifier. (required)
+ * @param productId The Product Identifier. (required)
+ * @param eventType The Event Type. (required)
+ * @return List<InlineResponse2004>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public InlineResponse2004 getWebhookDetails(String webhookId) throws ApiException {
- logger.info("CALL TO METHOD 'getWebhookDetails' STARTED");
+ public List getWebhookSubscriptionsByOrg(String organizationId, String productId, String eventType) throws ApiException {
+ logger.info("CALL TO METHOD 'getWebhookSubscriptionsByOrg' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = getWebhookDetailsWithHttpInfo(webhookId);
- logger.info("CALL TO METHOD 'getWebhookDetails' ENDED");
+ ApiResponse> resp = getWebhookSubscriptionsByOrgWithHttpInfo(organizationId, productId, eventType);
+ logger.info("CALL TO METHOD 'getWebhookSubscriptionsByOrg' ENDED");
return resp.getData();
}
/**
- * Get Details On a Single Webhook
- * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
- * @param webhookId The webhook Identifier (required)
- * @return ApiResponse<InlineResponse2004>
+ * Get Details On All Created Webhooks
+ * Retrieve a list of all previously created webhooks.
+ * @param organizationId The Organization Identifier. (required)
+ * @param productId The Product Identifier. (required)
+ * @param eventType The Event Type. (required)
+ * @return ApiResponse<List<InlineResponse2004>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse getWebhookDetailsWithHttpInfo(String webhookId) throws ApiException {
- okhttp3.Call call = getWebhookDetailsValidateBeforeCall(webhookId, null, null);
- Type localVarReturnType = new TypeToken(){}.getType();
+ public ApiResponse> getWebhookSubscriptionsByOrgWithHttpInfo(String organizationId, String productId, String eventType) throws ApiException {
+ okhttp3.Call call = getWebhookSubscriptionsByOrgValidateBeforeCall(organizationId, productId, eventType, null, null);
+ Type localVarReturnType = new TypeToken>(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
/**
- * Get Details On a Single Webhook (asynchronously)
- * Retrieve the details of a specific webhook by supplying the webhook ID in the path.
- * @param webhookId The webhook Identifier (required)
+ * Get Details On All Created Webhooks (asynchronously)
+ * Retrieve a list of all previously created webhooks.
+ * @param organizationId The Organization Identifier. (required)
+ * @param productId The Product Identifier. (required)
+ * @param eventType The Event Type. (required)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call getWebhookDetailsAsync(String webhookId, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call getWebhookSubscriptionsByOrgAsync(String organizationId, String productId, String eventType, final ApiCallback> callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -490,23 +490,23 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = getWebhookDetailsValidateBeforeCall(webhookId, progressListener, progressRequestListener);
- Type localVarReturnType = new TypeToken(){}.getType();
+ okhttp3.Call call = getWebhookSubscriptionsByOrgValidateBeforeCall(organizationId, productId, eventType, progressListener, progressRequestListener);
+ Type localVarReturnType = new TypeToken>(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
}
/**
- * Build call for replayPreviousWebhook
+ * Build call for replayPreviousWebhooks
* @param webhookId The webhook uuid identifier. (required)
- * @param replayWebhooks The request query (optional)
+ * @param replayWebhooksRequest The request query (optional)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call replayPreviousWebhookCall(String webhookId, ReplayWebhooks replayWebhooks, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call replayPreviousWebhooksCall(String webhookId, ReplayWebhooksRequest replayWebhooksRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
- Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(replayWebhooks, ReplayWebhooks.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
+ Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(replayWebhooksRequest, ReplayWebhooksRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
// create path and map variables
String localVarPath = "/nrtf/v1/webhooks/{webhookId}/replays"
@@ -519,7 +519,7 @@ public okhttp3.Call replayPreviousWebhookCall(String webhookId, ReplayWebhooks r
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -547,16 +547,16 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call replayPreviousWebhookValidateBeforeCall(String webhookId, ReplayWebhooks replayWebhooks, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call replayPreviousWebhooksValidateBeforeCall(String webhookId, ReplayWebhooksRequest replayWebhooksRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'webhookId' is set
if (webhookId == null) {
- logger.error("Missing the required parameter 'webhookId' when calling replayPreviousWebhook(Async)");
- throw new ApiException("Missing the required parameter 'webhookId' when calling replayPreviousWebhook(Async)");
+ logger.error("Missing the required parameter 'webhookId' when calling replayPreviousWebhooks(Async)");
+ throw new ApiException("Missing the required parameter 'webhookId' when calling replayPreviousWebhooks(Async)");
}
- okhttp3.Call call = replayPreviousWebhookCall(webhookId, replayWebhooks, progressListener, progressRequestListener);
+ okhttp3.Call call = replayPreviousWebhooksCall(webhookId, replayWebhooksRequest, progressListener, progressRequestListener);
return call;
@@ -570,13 +570,13 @@ private okhttp3.Call replayPreviousWebhookValidateBeforeCall(String webhookId, R
* Initiate a webhook replay request to replay transactions that happened in the past. Cannot execute more than 1 replay request at a time. While one request is processing, you will not be allowed to execute another replay. The difference between Start and End time cannot exceed a 24 hour window, and 1 month is the farthest date back that is eligible for replay.
* DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
* @param webhookId The webhook uuid identifier. (required)
- * @param replayWebhooks The request query (optional)
+ * @param replayWebhooksRequest The request query (optional)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public void replayPreviousWebhook(String webhookId, ReplayWebhooks replayWebhooks) throws ApiException {
- logger.info("CALL TO METHOD 'replayPreviousWebhook' STARTED");
+ public void replayPreviousWebhooks(String webhookId, ReplayWebhooksRequest replayWebhooksRequest) throws ApiException {
+ logger.info("CALL TO METHOD 'replayPreviousWebhooks' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- replayPreviousWebhookWithHttpInfo(webhookId, replayWebhooks);
+ replayPreviousWebhooksWithHttpInfo(webhookId, replayWebhooksRequest);
}
@@ -584,12 +584,12 @@ public void replayPreviousWebhook(String webhookId, ReplayWebhooks replayWebhook
* Replay Previous Webhooks
* Initiate a webhook replay request to replay transactions that happened in the past. Cannot execute more than 1 replay request at a time. While one request is processing, you will not be allowed to execute another replay. The difference between Start and End time cannot exceed a 24 hour window, and 1 month is the farthest date back that is eligible for replay.
* @param webhookId The webhook uuid identifier. (required)
- * @param replayWebhooks The request query (optional)
+ * @param replayWebhooksRequest The request query (optional)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse replayPreviousWebhookWithHttpInfo(String webhookId, ReplayWebhooks replayWebhooks) throws ApiException {
- okhttp3.Call call = replayPreviousWebhookValidateBeforeCall(webhookId, replayWebhooks, null, null);
+ public ApiResponse replayPreviousWebhooksWithHttpInfo(String webhookId, ReplayWebhooksRequest replayWebhooksRequest) throws ApiException {
+ okhttp3.Call call = replayPreviousWebhooksValidateBeforeCall(webhookId, replayWebhooksRequest, null, null);
return apiClient.execute(call);
}
@@ -597,12 +597,12 @@ public ApiResponse replayPreviousWebhookWithHttpInfo(String webhookId, Rep
* Replay Previous Webhooks (asynchronously)
* Initiate a webhook replay request to replay transactions that happened in the past. Cannot execute more than 1 replay request at a time. While one request is processing, you will not be allowed to execute another replay. The difference between Start and End time cannot exceed a 24 hour window, and 1 month is the farthest date back that is eligible for replay.
* @param webhookId The webhook uuid identifier. (required)
- * @param replayWebhooks The request query (optional)
+ * @param replayWebhooksRequest The request query (optional)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call replayPreviousWebhookAsync(String webhookId, ReplayWebhooks replayWebhooks, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call replayPreviousWebhooksAsync(String webhookId, ReplayWebhooksRequest replayWebhooksRequest, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -624,7 +624,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = replayPreviousWebhookValidateBeforeCall(webhookId, replayWebhooks, progressListener, progressRequestListener);
+ okhttp3.Call call = replayPreviousWebhooksValidateBeforeCall(webhookId, replayWebhooksRequest, progressListener, progressRequestListener);
apiClient.executeAsync(call, callback);
return call;
}
@@ -659,7 +659,7 @@ public okhttp3.Call saveAsymEgressKeyCall(String vCSenderOrganizationId, String
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -793,15 +793,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
/**
* Build call for updateWebhookSubscription
* @param webhookId The Webhook Identifier. (required)
- * @param updateWebhook The webhook payload or changes to apply. (optional)
+ * @param updateWebhookRequest The webhook payload or changes to apply. (optional)
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call updateWebhookSubscriptionCall(String webhookId, UpdateWebhook updateWebhook, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call updateWebhookSubscriptionCall(String webhookId, UpdateWebhookRequest updateWebhookRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
- Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(updateWebhook, UpdateWebhook.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
+ Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(updateWebhookRequest, UpdateWebhookRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment());
// create path and map variables
String localVarPath = "/notification-subscriptions/v1/webhooks/{webhookId}"
@@ -814,7 +814,7 @@ public okhttp3.Call updateWebhookSubscriptionCall(String webhookId, UpdateWebhoo
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
- "application/hal+json;charset=utf-8"
+ "application/json;charset=utf-8"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept);
@@ -842,7 +842,7 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call updateWebhookSubscriptionValidateBeforeCall(String webhookId, UpdateWebhook updateWebhook, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call updateWebhookSubscriptionValidateBeforeCall(String webhookId, UpdateWebhookRequest updateWebhookRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'webhookId' is set
if (webhookId == null) {
@@ -851,7 +851,7 @@ private okhttp3.Call updateWebhookSubscriptionValidateBeforeCall(String webhookI
}
- okhttp3.Call call = updateWebhookSubscriptionCall(webhookId, updateWebhook, progressListener, progressRequestListener);
+ okhttp3.Call call = updateWebhookSubscriptionCall(webhookId, updateWebhookRequest, progressListener, progressRequestListener);
return call;
@@ -865,13 +865,13 @@ private okhttp3.Call updateWebhookSubscriptionValidateBeforeCall(String webhookI
* Update the webhook subscription using PATCH.
* DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.
* @param webhookId The Webhook Identifier. (required)
- * @param updateWebhook The webhook payload or changes to apply. (optional)
+ * @param updateWebhookRequest The webhook payload or changes to apply. (optional)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public void updateWebhookSubscription(String webhookId, UpdateWebhook updateWebhook) throws ApiException {
+ public void updateWebhookSubscription(String webhookId, UpdateWebhookRequest updateWebhookRequest) throws ApiException {
logger.info("CALL TO METHOD 'updateWebhookSubscription' STARTED");
this.apiClient.setComputationStartTime(System.nanoTime());
- updateWebhookSubscriptionWithHttpInfo(webhookId, updateWebhook);
+ updateWebhookSubscriptionWithHttpInfo(webhookId, updateWebhookRequest);
}
@@ -879,12 +879,12 @@ public void updateWebhookSubscription(String webhookId, UpdateWebhook updateWebh
* Update a Webhook Subscription
* Update the webhook subscription using PATCH.
* @param webhookId The Webhook Identifier. (required)
- * @param updateWebhook The webhook payload or changes to apply. (optional)
+ * @param updateWebhookRequest The webhook payload or changes to apply. (optional)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse updateWebhookSubscriptionWithHttpInfo(String webhookId, UpdateWebhook updateWebhook) throws ApiException {
- okhttp3.Call call = updateWebhookSubscriptionValidateBeforeCall(webhookId, updateWebhook, null, null);
+ public ApiResponse updateWebhookSubscriptionWithHttpInfo(String webhookId, UpdateWebhookRequest updateWebhookRequest) throws ApiException {
+ okhttp3.Call call = updateWebhookSubscriptionValidateBeforeCall(webhookId, updateWebhookRequest, null, null);
return apiClient.execute(call);
}
@@ -892,12 +892,12 @@ public ApiResponse updateWebhookSubscriptionWithHttpInfo(String webhookId,
* Update a Webhook Subscription (asynchronously)
* Update the webhook subscription using PATCH.
* @param webhookId The Webhook Identifier. (required)
- * @param updateWebhook The webhook payload or changes to apply. (optional)
+ * @param updateWebhookRequest The webhook payload or changes to apply. (optional)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call updateWebhookSubscriptionAsync(String webhookId, UpdateWebhook updateWebhook, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call updateWebhookSubscriptionAsync(String webhookId, UpdateWebhookRequest updateWebhookRequest, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -919,7 +919,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = updateWebhookSubscriptionValidateBeforeCall(webhookId, updateWebhook, progressListener, progressRequestListener);
+ okhttp3.Call call = updateWebhookSubscriptionValidateBeforeCall(webhookId, updateWebhookRequest, progressListener, progressRequestListener);
apiClient.executeAsync(call, callback);
return call;
}
diff --git a/src/main/java/Api/ReportSubscriptionsApi.java b/src/main/java/Api/ReportSubscriptionsApi.java
index 7922751ee..68a9d6de1 100644
--- a/src/main/java/Api/ReportSubscriptionsApi.java
+++ b/src/main/java/Api/ReportSubscriptionsApi.java
@@ -676,7 +676,7 @@ private okhttp3.Call getSubscriptionValidateBeforeCall(String reportName, String
/**
* Get Subscription for Report Name
- * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
+ * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
* @param reportName Name of the Report to Retrieve (required)
* @param organizationId Valid Organization Id (optional)
* @return ReportingV3ReportSubscriptionsGet200ResponseSubscriptions
@@ -692,7 +692,7 @@ public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions getSubscription
/**
* Get Subscription for Report Name
- * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
+ * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
* @param reportName Name of the Report to Retrieve (required)
* @param organizationId Valid Organization Id (optional)
* @return ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions>
@@ -706,7 +706,7 @@ public ApiResponse ge
/**
* Get Subscription for Report Name (asynchronously)
- * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
+ * View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
* @param reportName Name of the Report to Retrieve (required)
* @param organizationId Valid Organization Id (optional)
* @param callback The callback to be executed when the API call finishes
diff --git a/src/main/java/Api/ReportsApi.java b/src/main/java/Api/ReportsApi.java
index 0c4ef56e5..96c780fc9 100644
--- a/src/main/java/Api/ReportsApi.java
+++ b/src/main/java/Api/ReportsApi.java
@@ -275,7 +275,7 @@ private okhttp3.Call getReportByReportIdValidateBeforeCall(String reportId, Stri
/**
* Get Report Based on Report Id
- * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
+ * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
* @param reportId Valid Report Id (required)
* @param organizationId Valid Organization Id (optional)
* @return ReportingV3ReportsIdGet200Response
@@ -291,7 +291,7 @@ public ReportingV3ReportsIdGet200Response getReportByReportId(String reportId, S
/**
* Get Report Based on Report Id
- * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
+ * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
* @param reportId Valid Report Id (required)
* @param organizationId Valid Organization Id (optional)
* @return ApiResponse<ReportingV3ReportsIdGet200Response>
@@ -305,7 +305,7 @@ public ApiResponse getReportByReportIdWithHt
/**
* Get Report Based on Report Id (asynchronously)
- * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
+ * Download a report using the reportId value. If you don't already know this value, you can obtain it using the Retrieve available reports call.
* @param reportId Valid Report Id (required)
* @param organizationId Valid Organization Id (optional)
* @param callback The callback to be executed when the API call finishes
diff --git a/src/main/java/Invokers/ApiClient.java b/src/main/java/Invokers/ApiClient.java
index c43041104..7611d1a68 100644
--- a/src/main/java/Invokers/ApiClient.java
+++ b/src/main/java/Invokers/ApiClient.java
@@ -727,9 +727,7 @@ public ApiClient setUserAgent(String userAgent) {
* @return ApiClient
*/
public ApiClient addDefaultHeader(String key, String value) {
- if (!defaultHeaderMap.containsKey(key)) {
- defaultHeaderMap.put(key, value);
- }
+ defaultHeaderMap.put(key, value);
return this;
}
@@ -1322,7 +1320,9 @@ public Call buildCall(String path, String method, List queryParams, Object
if(merchantConfig.getDefaultHeaders() != null && !merchantConfig.getDefaultHeaders().isEmpty()) {
for (Entry header : merchantConfig.getDefaultHeaders().entrySet()) {
- addDefaultHeader(header.getKey(), header.getValue());
+ if(!header.getKey().equalsIgnoreCase("Authorization") && !header.getKey().equalsIgnoreCase("Signature")){
+ addDefaultHeader(header.getKey(), header.getValue());
+ }
}
}
diff --git a/src/main/java/Model/Boardingv1registrationsProductInformationSelectedProducts.java b/src/main/java/Model/Boardingv1registrationsProductInformationSelectedProducts.java
index a41ade5fa..c432970aa 100644
--- a/src/main/java/Model/Boardingv1registrationsProductInformationSelectedProducts.java
+++ b/src/main/java/Model/Boardingv1registrationsProductInformationSelectedProducts.java
@@ -15,7 +15,7 @@
import java.util.Objects;
import Model.CommerceSolutionsProducts;
-import Model.PaymentProducts;
+import Model.PaymentsProducts;
import Model.RiskProducts;
import Model.ValueAddedServicesProducts;
import com.google.gson.TypeAdapter;
@@ -33,7 +33,7 @@
public class Boardingv1registrationsProductInformationSelectedProducts {
@SerializedName("payments")
- private PaymentProducts payments = null;
+ private PaymentsProducts payments = null;
@SerializedName("risk")
private RiskProducts risk = null;
@@ -44,7 +44,7 @@ public class Boardingv1registrationsProductInformationSelectedProducts {
@SerializedName("valueAddedServices")
private ValueAddedServicesProducts valueAddedServices = null;
- public Boardingv1registrationsProductInformationSelectedProducts payments(PaymentProducts payments) {
+ public Boardingv1registrationsProductInformationSelectedProducts payments(PaymentsProducts payments) {
this.payments = payments;
return this;
}
@@ -54,11 +54,11 @@ public Boardingv1registrationsProductInformationSelectedProducts payments(Paymen
* @return payments
**/
@ApiModelProperty(value = "")
- public PaymentProducts getPayments() {
+ public PaymentsProducts getPayments() {
return payments;
}
- public void setPayments(PaymentProducts payments) {
+ public void setPayments(PaymentsProducts payments) {
this.payments = payments;
}
diff --git a/src/main/java/Model/CommerceSolutionsProductsAccountUpdater.java b/src/main/java/Model/CommerceSolutionsProductsAccountUpdater.java
index a3d8bfd55..6fa78fb14 100644
--- a/src/main/java/Model/CommerceSolutionsProductsAccountUpdater.java
+++ b/src/main/java/Model/CommerceSolutionsProductsAccountUpdater.java
@@ -15,7 +15,7 @@
import java.util.Objects;
import Model.CommerceSolutionsProductsAccountUpdaterConfigurationInformation;
-import Model.PaymentProductsPayerAuthenticationSubscriptionInformation;
+import Model.PaymentsProductsPayerAuthenticationSubscriptionInformation;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -31,12 +31,12 @@
public class CommerceSolutionsProductsAccountUpdater {
@SerializedName("subscriptionInformation")
- private PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
+ private PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
@SerializedName("configurationInformation")
private CommerceSolutionsProductsAccountUpdaterConfigurationInformation configurationInformation = null;
- public CommerceSolutionsProductsAccountUpdater subscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public CommerceSolutionsProductsAccountUpdater subscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
return this;
}
@@ -46,11 +46,11 @@ public CommerceSolutionsProductsAccountUpdater subscriptionInformation(PaymentPr
* @return subscriptionInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
+ public PaymentsProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
return subscriptionInformation;
}
- public void setSubscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public void setSubscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
}
diff --git a/src/main/java/Model/CommerceSolutionsProductsBinLookup.java b/src/main/java/Model/CommerceSolutionsProductsBinLookup.java
index a8dc38e2f..28aed71fc 100644
--- a/src/main/java/Model/CommerceSolutionsProductsBinLookup.java
+++ b/src/main/java/Model/CommerceSolutionsProductsBinLookup.java
@@ -15,7 +15,7 @@
import java.util.Objects;
import Model.CommerceSolutionsProductsBinLookupConfigurationInformation;
-import Model.PaymentProductsPayerAuthenticationSubscriptionInformation;
+import Model.PaymentsProductsPayerAuthenticationSubscriptionInformation;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -31,12 +31,12 @@
public class CommerceSolutionsProductsBinLookup {
@SerializedName("subscriptionInformation")
- private PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
+ private PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
@SerializedName("configurationInformation")
private CommerceSolutionsProductsBinLookupConfigurationInformation configurationInformation = null;
- public CommerceSolutionsProductsBinLookup subscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public CommerceSolutionsProductsBinLookup subscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
return this;
}
@@ -46,11 +46,11 @@ public CommerceSolutionsProductsBinLookup subscriptionInformation(PaymentProduct
* @return subscriptionInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
+ public PaymentsProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
return subscriptionInformation;
}
- public void setSubscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public void setSubscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
}
diff --git a/src/main/java/Model/CommerceSolutionsProductsTokenManagement.java b/src/main/java/Model/CommerceSolutionsProductsTokenManagement.java
index c793236f4..523e76f17 100644
--- a/src/main/java/Model/CommerceSolutionsProductsTokenManagement.java
+++ b/src/main/java/Model/CommerceSolutionsProductsTokenManagement.java
@@ -15,7 +15,7 @@
import java.util.Objects;
import Model.CommerceSolutionsProductsTokenManagementConfigurationInformation;
-import Model.PaymentProductsPayerAuthenticationSubscriptionInformation;
+import Model.PaymentsProductsPayerAuthenticationSubscriptionInformation;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -31,12 +31,12 @@
public class CommerceSolutionsProductsTokenManagement {
@SerializedName("subscriptionInformation")
- private PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
+ private PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
@SerializedName("configurationInformation")
private CommerceSolutionsProductsTokenManagementConfigurationInformation configurationInformation = null;
- public CommerceSolutionsProductsTokenManagement subscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public CommerceSolutionsProductsTokenManagement subscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
return this;
}
@@ -46,11 +46,11 @@ public CommerceSolutionsProductsTokenManagement subscriptionInformation(PaymentP
* @return subscriptionInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
+ public PaymentsProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
return subscriptionInformation;
}
- public void setSubscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public void setSubscriptionInformation(PaymentsProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
}
diff --git a/src/main/java/Model/CreateSearchRequest.java b/src/main/java/Model/CreateSearchRequest.java
index 7a75cf633..3e17cabf8 100644
--- a/src/main/java/Model/CreateSearchRequest.java
+++ b/src/main/java/Model/CreateSearchRequest.java
@@ -91,10 +91,10 @@ public CreateSearchRequest timezone(String timezone) {
}
/**
- * Merchant’s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`
+ * Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago`
* @return timezone
**/
- @ApiModelProperty(value = "Merchant’s time zone in ISO standard, using the TZ database format. For example: `America/Chicago` ")
+ @ApiModelProperty(value = "Merchant's time zone in ISO standard, using the TZ database format. For example: `America/Chicago` ")
public String getTimezone() {
return timezone;
}
diff --git a/src/main/java/Model/CreateWebhook.java b/src/main/java/Model/CreateWebhookRequest.java
similarity index 82%
rename from src/main/java/Model/CreateWebhook.java
rename to src/main/java/Model/CreateWebhookRequest.java
index 15c61b761..3b76dd789 100644
--- a/src/main/java/Model/CreateWebhook.java
+++ b/src/main/java/Model/CreateWebhookRequest.java
@@ -28,10 +28,10 @@
import java.util.List;
/**
- * CreateWebhook
+ * CreateWebhookRequest
*/
-public class CreateWebhook {
+public class CreateWebhookRequest {
@SerializedName("name")
private String name = null;
@@ -62,7 +62,7 @@ public class CreateWebhook {
@SerializedName("securityPolicy")
private Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy = null;
- public CreateWebhook name(String name) {
+ public CreateWebhookRequest name(String name) {
this.name = name;
return this;
}
@@ -80,7 +80,7 @@ public void setName(String name) {
this.name = name;
}
- public CreateWebhook description(String description) {
+ public CreateWebhookRequest description(String description) {
this.description = description;
return this;
}
@@ -98,7 +98,7 @@ public void setDescription(String description) {
this.description = description;
}
- public CreateWebhook organizationId(String organizationId) {
+ public CreateWebhookRequest organizationId(String organizationId) {
this.organizationId = organizationId;
return this;
}
@@ -116,7 +116,7 @@ public void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
- public CreateWebhook productId(String productId) {
+ public CreateWebhookRequest productId(String productId) {
this.productId = productId;
return this;
}
@@ -134,12 +134,12 @@ public void setProductId(String productId) {
this.productId = productId;
}
- public CreateWebhook eventTypes(List eventTypes) {
+ public CreateWebhookRequest eventTypes(List eventTypes) {
this.eventTypes = eventTypes;
return this;
}
- public CreateWebhook addEventTypesItem(String eventTypesItem) {
+ public CreateWebhookRequest addEventTypesItem(String eventTypesItem) {
if (this.eventTypes == null) {
this.eventTypes = new ArrayList();
}
@@ -160,7 +160,7 @@ public void setEventTypes(List eventTypes) {
this.eventTypes = eventTypes;
}
- public CreateWebhook webhookUrl(String webhookUrl) {
+ public CreateWebhookRequest webhookUrl(String webhookUrl) {
this.webhookUrl = webhookUrl;
return this;
}
@@ -178,7 +178,7 @@ public void setWebhookUrl(String webhookUrl) {
this.webhookUrl = webhookUrl;
}
- public CreateWebhook healthCheckUrl(String healthCheckUrl) {
+ public CreateWebhookRequest healthCheckUrl(String healthCheckUrl) {
this.healthCheckUrl = healthCheckUrl;
return this;
}
@@ -196,7 +196,7 @@ public void setHealthCheckUrl(String healthCheckUrl) {
this.healthCheckUrl = healthCheckUrl;
}
- public CreateWebhook notificationScope(String notificationScope) {
+ public CreateWebhookRequest notificationScope(String notificationScope) {
this.notificationScope = notificationScope;
return this;
}
@@ -214,7 +214,7 @@ public void setNotificationScope(String notificationScope) {
this.notificationScope = notificationScope;
}
- public CreateWebhook retryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy) {
+ public CreateWebhookRequest retryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy) {
this.retryPolicy = retryPolicy;
return this;
}
@@ -232,7 +232,7 @@ public void setRetryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryP
this.retryPolicy = retryPolicy;
}
- public CreateWebhook securityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy) {
+ public CreateWebhookRequest securityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy) {
this.securityPolicy = securityPolicy;
return this;
}
@@ -259,17 +259,17 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- CreateWebhook createWebhook = (CreateWebhook) o;
- return Objects.equals(this.name, createWebhook.name) &&
- Objects.equals(this.description, createWebhook.description) &&
- Objects.equals(this.organizationId, createWebhook.organizationId) &&
- Objects.equals(this.productId, createWebhook.productId) &&
- Objects.equals(this.eventTypes, createWebhook.eventTypes) &&
- Objects.equals(this.webhookUrl, createWebhook.webhookUrl) &&
- Objects.equals(this.healthCheckUrl, createWebhook.healthCheckUrl) &&
- Objects.equals(this.notificationScope, createWebhook.notificationScope) &&
- Objects.equals(this.retryPolicy, createWebhook.retryPolicy) &&
- Objects.equals(this.securityPolicy, createWebhook.securityPolicy);
+ CreateWebhookRequest createWebhookRequest = (CreateWebhookRequest) o;
+ return Objects.equals(this.name, createWebhookRequest.name) &&
+ Objects.equals(this.description, createWebhookRequest.description) &&
+ Objects.equals(this.organizationId, createWebhookRequest.organizationId) &&
+ Objects.equals(this.productId, createWebhookRequest.productId) &&
+ Objects.equals(this.eventTypes, createWebhookRequest.eventTypes) &&
+ Objects.equals(this.webhookUrl, createWebhookRequest.webhookUrl) &&
+ Objects.equals(this.healthCheckUrl, createWebhookRequest.healthCheckUrl) &&
+ Objects.equals(this.notificationScope, createWebhookRequest.notificationScope) &&
+ Objects.equals(this.retryPolicy, createWebhookRequest.retryPolicy) &&
+ Objects.equals(this.securityPolicy, createWebhookRequest.securityPolicy);
}
@Override
@@ -281,7 +281,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class CreateWebhook {\n");
+ sb.append("class CreateWebhookRequest {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
diff --git a/src/main/java/Model/GetAllSubscriptionsResponseOrderInformationBillTo.java b/src/main/java/Model/GetAllSubscriptionsResponseOrderInformationBillTo.java
index d7c4dd8f0..7155e4a49 100644
--- a/src/main/java/Model/GetAllSubscriptionsResponseOrderInformationBillTo.java
+++ b/src/main/java/Model/GetAllSubscriptionsResponseOrderInformationBillTo.java
@@ -40,10 +40,10 @@ public GetAllSubscriptionsResponseOrderInformationBillTo firstName(String firstN
}
/**
- * Customer’s first name.
+ * Customer's first name.
* @return firstName
**/
- @ApiModelProperty(value = "Customer’s first name. ")
+ @ApiModelProperty(value = "Customer's first name. ")
public String getFirstName() {
return firstName;
}
@@ -58,10 +58,10 @@ public GetAllSubscriptionsResponseOrderInformationBillTo lastName(String lastNam
}
/**
- * Customer’s last name.
+ * Customer's last name.
* @return lastName
**/
- @ApiModelProperty(value = "Customer’s last name. ")
+ @ApiModelProperty(value = "Customer's last name. ")
public String getLastName() {
return lastName;
}
diff --git a/src/main/java/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.java b/src/main/java/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.java
index 63e811563..182247704 100644
--- a/src/main/java/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.java
+++ b/src/main/java/Model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.java
@@ -58,10 +58,10 @@ public InvoicingV2InvoicesAllGet200ResponseCustomerInformation merchantCustomerI
}
/**
- * 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)
+ * 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)
* @return merchantCustomerId
**/
- @ApiModelProperty(value = "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) ")
+ @ApiModelProperty(value = "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) ")
public String getMerchantCustomerId() {
return merchantCustomerId;
}
diff --git a/src/main/java/Model/Invoicingv2invoicesCustomerInformation.java b/src/main/java/Model/Invoicingv2invoicesCustomerInformation.java
index 60e1ba74e..b53b11f00 100644
--- a/src/main/java/Model/Invoicingv2invoicesCustomerInformation.java
+++ b/src/main/java/Model/Invoicingv2invoicesCustomerInformation.java
@@ -84,10 +84,10 @@ public Invoicingv2invoicesCustomerInformation merchantCustomerId(String merchant
}
/**
- * 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)
+ * 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)
* @return merchantCustomerId
**/
- @ApiModelProperty(value = "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) ")
+ @ApiModelProperty(value = "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) ")
public String getMerchantCustomerId() {
return merchantCustomerId;
}
diff --git a/src/main/java/Model/Invoicingv2invoicesCustomerInformationCompany.java b/src/main/java/Model/Invoicingv2invoicesCustomerInformationCompany.java
index 65e3515f9..90d0b6b51 100644
--- a/src/main/java/Model/Invoicingv2invoicesCustomerInformationCompany.java
+++ b/src/main/java/Model/Invoicingv2invoicesCustomerInformationCompany.java
@@ -37,10 +37,10 @@ public Invoicingv2invoicesCustomerInformationCompany name(String name) {
}
/**
- * 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)
* @return name
**/
- @ApiModelProperty(value = "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) ")
+ @ApiModelProperty(value = "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) ")
public String getName() {
return name;
}
diff --git a/src/main/java/Model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation.java b/src/main/java/Model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation.java
index acd5f870a..9fef3756b 100644
--- a/src/main/java/Model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation.java
+++ b/src/main/java/Model/KmsV2KeysAsymDeletesPost200ResponseKeyInformation.java
@@ -72,10 +72,10 @@ public KmsV2KeysAsymDeletesPost200ResponseKeyInformation referenceNumber(String
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/KmsV2KeysAsymGet200ResponseKeyInformation.java b/src/main/java/Model/KmsV2KeysAsymGet200ResponseKeyInformation.java
index 536d0ada0..b6de37ab5 100644
--- a/src/main/java/Model/KmsV2KeysAsymGet200ResponseKeyInformation.java
+++ b/src/main/java/Model/KmsV2KeysAsymGet200ResponseKeyInformation.java
@@ -78,10 +78,10 @@ public KmsV2KeysAsymGet200ResponseKeyInformation referenceNumber(String referenc
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/KmsV2KeysAsymPost201ResponseKeyInformation.java b/src/main/java/Model/KmsV2KeysAsymPost201ResponseKeyInformation.java
index 4724705c5..4e90456a3 100644
--- a/src/main/java/Model/KmsV2KeysAsymPost201ResponseKeyInformation.java
+++ b/src/main/java/Model/KmsV2KeysAsymPost201ResponseKeyInformation.java
@@ -81,10 +81,10 @@ public KmsV2KeysAsymPost201ResponseKeyInformation referenceNumber(String referen
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/KmsV2KeysSymPost201ResponseKeyInformation.java b/src/main/java/Model/KmsV2KeysSymPost201ResponseKeyInformation.java
index c56321b36..ba79debc1 100644
--- a/src/main/java/Model/KmsV2KeysSymPost201ResponseKeyInformation.java
+++ b/src/main/java/Model/KmsV2KeysSymPost201ResponseKeyInformation.java
@@ -99,10 +99,10 @@ public KmsV2KeysSymPost201ResponseKeyInformation referenceNumber(String referenc
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/Kmsv2keysasymKeyInformation.java b/src/main/java/Model/Kmsv2keysasymKeyInformation.java
index 443f4085e..2c0d97590 100644
--- a/src/main/java/Model/Kmsv2keysasymKeyInformation.java
+++ b/src/main/java/Model/Kmsv2keysasymKeyInformation.java
@@ -62,10 +62,10 @@ public Kmsv2keysasymKeyInformation referenceNumber(String referenceNumber) {
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/Kmsv2keyssymKeyInformation.java b/src/main/java/Model/Kmsv2keyssymKeyInformation.java
index bfa7078c3..66ea8f947 100644
--- a/src/main/java/Model/Kmsv2keyssymKeyInformation.java
+++ b/src/main/java/Model/Kmsv2keyssymKeyInformation.java
@@ -59,10 +59,10 @@ public Kmsv2keyssymKeyInformation referenceNumber(String referenceNumber) {
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/Kmsv2keyssymdeletesKeyInformation.java b/src/main/java/Model/Kmsv2keyssymdeletesKeyInformation.java
index e5d86135b..e24eed78a 100644
--- a/src/main/java/Model/Kmsv2keyssymdeletesKeyInformation.java
+++ b/src/main/java/Model/Kmsv2keyssymdeletesKeyInformation.java
@@ -62,10 +62,10 @@ public Kmsv2keyssymdeletesKeyInformation referenceNumber(String referenceNumber)
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/Kmsv2keyssymverifiKeyInformation.java b/src/main/java/Model/Kmsv2keyssymverifiKeyInformation.java
index 22ada8229..3723136a7 100644
--- a/src/main/java/Model/Kmsv2keyssymverifiKeyInformation.java
+++ b/src/main/java/Model/Kmsv2keyssymverifiKeyInformation.java
@@ -109,10 +109,10 @@ public Kmsv2keyssymverifiKeyInformation referenceNumber(String referenceNumber)
}
/**
- * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.
+ * Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response.
* @return referenceNumber
**/
- @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
+ @ApiModelProperty(value = "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client's convenience. If client specifies value for this field in the request, it is expected to be available in the response. ")
public String getReferenceNumber() {
return referenceNumber;
}
diff --git a/src/main/java/Model/PaymentProductsCardPresentConnect.java b/src/main/java/Model/PaymentProductsCardPresentConnect.java
deleted file mode 100644
index ebfab5a56..000000000
--- a/src/main/java/Model/PaymentProductsCardPresentConnect.java
+++ /dev/null
@@ -1,118 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsCardPresentConnectConfigurationInformation;
-import Model.PaymentProductsCardPresentConnectSubscriptionInformation;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsCardPresentConnect
- */
-
-public class PaymentProductsCardPresentConnect {
- @SerializedName("subscriptionInformation")
- private PaymentProductsCardPresentConnectSubscriptionInformation subscriptionInformation = null;
-
- @SerializedName("configurationInformation")
- private PaymentProductsCardPresentConnectConfigurationInformation configurationInformation = null;
-
- public PaymentProductsCardPresentConnect subscriptionInformation(PaymentProductsCardPresentConnectSubscriptionInformation subscriptionInformation) {
- this.subscriptionInformation = subscriptionInformation;
- return this;
- }
-
- /**
- * Get subscriptionInformation
- * @return subscriptionInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsCardPresentConnectSubscriptionInformation getSubscriptionInformation() {
- return subscriptionInformation;
- }
-
- public void setSubscriptionInformation(PaymentProductsCardPresentConnectSubscriptionInformation subscriptionInformation) {
- this.subscriptionInformation = subscriptionInformation;
- }
-
- public PaymentProductsCardPresentConnect configurationInformation(PaymentProductsCardPresentConnectConfigurationInformation configurationInformation) {
- this.configurationInformation = configurationInformation;
- return this;
- }
-
- /**
- * Get configurationInformation
- * @return configurationInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsCardPresentConnectConfigurationInformation getConfigurationInformation() {
- return configurationInformation;
- }
-
- public void setConfigurationInformation(PaymentProductsCardPresentConnectConfigurationInformation configurationInformation) {
- this.configurationInformation = configurationInformation;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsCardPresentConnect paymentProductsCardPresentConnect = (PaymentProductsCardPresentConnect) o;
- return Objects.equals(this.subscriptionInformation, paymentProductsCardPresentConnect.subscriptionInformation) &&
- Objects.equals(this.configurationInformation, paymentProductsCardPresentConnect.configurationInformation);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(subscriptionInformation, configurationInformation);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardPresentConnect {\n");
-
- sb.append(" subscriptionInformation: ").append(toIndentedString(subscriptionInformation)).append("\n");
- sb.append(" configurationInformation: ").append(toIndentedString(configurationInformation)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService.java b/src/main/java/Model/PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService.java
deleted file mode 100644
index 0f1b3f107..000000000
--- a/src/main/java/Model/PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService.java
+++ /dev/null
@@ -1,129 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceInternalOnly;
-import Model.PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceProcessors;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-/**
- * PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService
- */
-
-public class PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService {
- @SerializedName("internalOnly")
- private PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceInternalOnly internalOnly = null;
-
- @SerializedName("processors")
- private Map processors = null;
-
- public PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService internalOnly(PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceInternalOnly internalOnly) {
- this.internalOnly = internalOnly;
- return this;
- }
-
- /**
- * Get internalOnly
- * @return internalOnly
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceInternalOnly getInternalOnly() {
- return internalOnly;
- }
-
- public void setInternalOnly(PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceInternalOnly internalOnly) {
- this.internalOnly = internalOnly;
- }
-
- public PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService processors(Map processors) {
- this.processors = processors;
- return this;
- }
-
- public PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService putProcessorsItem(String key, PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationServiceProcessors processorsItem) {
- if (this.processors == null) {
- this.processors = new HashMap();
- }
- this.processors.put(key, processorsItem);
- return this;
- }
-
- /**
- * *NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods. Example * \"bofaach\" * \"wellsfargoach\"
- * @return processors
- **/
- @ApiModelProperty(value = "*NEW* Payment Processing connection used to support eCheck, aka ACH, payment methods. Example * \"bofaach\" * \"wellsfargoach\" ")
- public Map getProcessors() {
- return processors;
- }
-
- public void setProcessors(Map processors) {
- this.processors = processors;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService paymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService = (PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService) o;
- return Objects.equals(this.internalOnly, paymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService.internalOnly) &&
- Objects.equals(this.processors, paymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService.processors);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(internalOnly, processors);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsECheckConfigurationInformationConfigurationsFeaturesAccountValidationService {\n");
-
- sb.append(" internalOnly: ").append(toIndentedString(internalOnly)).append("\n");
- sb.append(" processors: ").append(toIndentedString(processors)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.java b/src/main/java/Model/PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.java
deleted file mode 100644
index f6c344a57..000000000
--- a/src/main/java/Model/PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.java
+++ /dev/null
@@ -1,257 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesCB;
-import Model.PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesJCBJSecure;
-import Model.PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes
- */
-
-public class PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes {
- @SerializedName("verifiedByVisa")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa verifiedByVisa = null;
-
- @SerializedName("masterCardSecureCode")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa masterCardSecureCode = null;
-
- @SerializedName("amexSafeKey")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa amexSafeKey = null;
-
- @SerializedName("jCBJSecure")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesJCBJSecure jCBJSecure = null;
-
- @SerializedName("dinersClubInternationalProtectBuy")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa dinersClubInternationalProtectBuy = null;
-
- @SerializedName("ELO")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa ELO = null;
-
- @SerializedName("UPI")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa UPI = null;
-
- @SerializedName("CB")
- private PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesCB CB = null;
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes verifiedByVisa(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa verifiedByVisa) {
- this.verifiedByVisa = verifiedByVisa;
- return this;
- }
-
- /**
- * Get verifiedByVisa
- * @return verifiedByVisa
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getVerifiedByVisa() {
- return verifiedByVisa;
- }
-
- public void setVerifiedByVisa(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa verifiedByVisa) {
- this.verifiedByVisa = verifiedByVisa;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes masterCardSecureCode(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa masterCardSecureCode) {
- this.masterCardSecureCode = masterCardSecureCode;
- return this;
- }
-
- /**
- * Get masterCardSecureCode
- * @return masterCardSecureCode
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getMasterCardSecureCode() {
- return masterCardSecureCode;
- }
-
- public void setMasterCardSecureCode(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa masterCardSecureCode) {
- this.masterCardSecureCode = masterCardSecureCode;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes amexSafeKey(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa amexSafeKey) {
- this.amexSafeKey = amexSafeKey;
- return this;
- }
-
- /**
- * Get amexSafeKey
- * @return amexSafeKey
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getAmexSafeKey() {
- return amexSafeKey;
- }
-
- public void setAmexSafeKey(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa amexSafeKey) {
- this.amexSafeKey = amexSafeKey;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes jCBJSecure(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesJCBJSecure jCBJSecure) {
- this.jCBJSecure = jCBJSecure;
- return this;
- }
-
- /**
- * Get jCBJSecure
- * @return jCBJSecure
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesJCBJSecure getJCBJSecure() {
- return jCBJSecure;
- }
-
- public void setJCBJSecure(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesJCBJSecure jCBJSecure) {
- this.jCBJSecure = jCBJSecure;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes dinersClubInternationalProtectBuy(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa dinersClubInternationalProtectBuy) {
- this.dinersClubInternationalProtectBuy = dinersClubInternationalProtectBuy;
- return this;
- }
-
- /**
- * Get dinersClubInternationalProtectBuy
- * @return dinersClubInternationalProtectBuy
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getDinersClubInternationalProtectBuy() {
- return dinersClubInternationalProtectBuy;
- }
-
- public void setDinersClubInternationalProtectBuy(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa dinersClubInternationalProtectBuy) {
- this.dinersClubInternationalProtectBuy = dinersClubInternationalProtectBuy;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes ELO(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa ELO) {
- this.ELO = ELO;
- return this;
- }
-
- /**
- * Get ELO
- * @return ELO
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getELO() {
- return ELO;
- }
-
- public void setELO(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa ELO) {
- this.ELO = ELO;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes UPI(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa UPI) {
- this.UPI = UPI;
- return this;
- }
-
- /**
- * Get UPI
- * @return UPI
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa getUPI() {
- return UPI;
- }
-
- public void setUPI(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesVerifiedByVisa UPI) {
- this.UPI = UPI;
- }
-
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes CB(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesCB CB) {
- this.CB = CB;
- return this;
- }
-
- /**
- * Get CB
- * @return CB
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesCB getCB() {
- return CB;
- }
-
- public void setCB(PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypesCB CB) {
- this.CB = CB;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes = (PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes) o;
- return Objects.equals(this.verifiedByVisa, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.verifiedByVisa) &&
- Objects.equals(this.masterCardSecureCode, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.masterCardSecureCode) &&
- Objects.equals(this.amexSafeKey, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.amexSafeKey) &&
- Objects.equals(this.jCBJSecure, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.jCBJSecure) &&
- Objects.equals(this.dinersClubInternationalProtectBuy, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.dinersClubInternationalProtectBuy) &&
- Objects.equals(this.ELO, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.ELO) &&
- Objects.equals(this.UPI, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.UPI) &&
- Objects.equals(this.CB, paymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes.CB);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(verifiedByVisa, masterCardSecureCode, amexSafeKey, jCBJSecure, dinersClubInternationalProtectBuy, ELO, UPI, CB);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsPayerAuthenticationConfigurationInformationConfigurationsCardTypes {\n");
-
- sb.append(" verifiedByVisa: ").append(toIndentedString(verifiedByVisa)).append("\n");
- sb.append(" masterCardSecureCode: ").append(toIndentedString(masterCardSecureCode)).append("\n");
- sb.append(" amexSafeKey: ").append(toIndentedString(amexSafeKey)).append("\n");
- sb.append(" jCBJSecure: ").append(toIndentedString(jCBJSecure)).append("\n");
- sb.append(" dinersClubInternationalProtectBuy: ").append(toIndentedString(dinersClubInternationalProtectBuy)).append("\n");
- sb.append(" ELO: ").append(toIndentedString(ELO)).append("\n");
- sb.append(" UPI: ").append(toIndentedString(UPI)).append("\n");
- sb.append(" CB: ").append(toIndentedString(CB)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsPayoutsConfigurationInformationConfigurations.java b/src/main/java/Model/PaymentProductsPayoutsConfigurationInformationConfigurations.java
deleted file mode 100644
index dd2ae258a..000000000
--- a/src/main/java/Model/PaymentProductsPayoutsConfigurationInformationConfigurations.java
+++ /dev/null
@@ -1,137 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsPayoutsConfigurationInformationConfigurationsPullfunds;
-import Model.PaymentProductsPayoutsConfigurationInformationConfigurationsPushfunds;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-/**
- * PaymentProductsPayoutsConfigurationInformationConfigurations
- */
-
-public class PaymentProductsPayoutsConfigurationInformationConfigurations {
- @SerializedName("pullfunds")
- private Map pullfunds = null;
-
- @SerializedName("pushfunds")
- private Map pushfunds = null;
-
- public PaymentProductsPayoutsConfigurationInformationConfigurations pullfunds(Map pullfunds) {
- this.pullfunds = pullfunds;
- return this;
- }
-
- public PaymentProductsPayoutsConfigurationInformationConfigurations putPullfundsItem(String key, PaymentProductsPayoutsConfigurationInformationConfigurationsPullfunds pullfundsItem) {
- if (this.pullfunds == null) {
- this.pullfunds = new HashMap();
- }
- this.pullfunds.put(key, pullfundsItem);
- return this;
- }
-
- /**
- * Get pullfunds
- * @return pullfunds
- **/
- @ApiModelProperty(value = "")
- public Map getPullfunds() {
- return pullfunds;
- }
-
- public void setPullfunds(Map pullfunds) {
- this.pullfunds = pullfunds;
- }
-
- public PaymentProductsPayoutsConfigurationInformationConfigurations pushfunds(Map pushfunds) {
- this.pushfunds = pushfunds;
- return this;
- }
-
- public PaymentProductsPayoutsConfigurationInformationConfigurations putPushfundsItem(String key, PaymentProductsPayoutsConfigurationInformationConfigurationsPushfunds pushfundsItem) {
- if (this.pushfunds == null) {
- this.pushfunds = new HashMap();
- }
- this.pushfunds.put(key, pushfundsItem);
- return this;
- }
-
- /**
- * Get pushfunds
- * @return pushfunds
- **/
- @ApiModelProperty(value = "")
- public Map getPushfunds() {
- return pushfunds;
- }
-
- public void setPushfunds(Map pushfunds) {
- this.pushfunds = pushfunds;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsPayoutsConfigurationInformationConfigurations paymentProductsPayoutsConfigurationInformationConfigurations = (PaymentProductsPayoutsConfigurationInformationConfigurations) o;
- return Objects.equals(this.pullfunds, paymentProductsPayoutsConfigurationInformationConfigurations.pullfunds) &&
- Objects.equals(this.pushfunds, paymentProductsPayoutsConfigurationInformationConfigurations.pushfunds);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(pullfunds, pushfunds);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsPayoutsConfigurationInformationConfigurations {\n");
-
- sb.append(" pullfunds: ").append(toIndentedString(pullfunds)).append("\n");
- sb.append(" pushfunds: ").append(toIndentedString(pushfunds)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurations.java b/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurations.java
deleted file mode 100644
index 58fb0c320..000000000
--- a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurations.java
+++ /dev/null
@@ -1,237 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsCheckout;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsContactInformation;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentMethods;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypes;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsService;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsSecureAcceptanceConfigurationInformationConfigurations
- */
-
-public class PaymentProductsSecureAcceptanceConfigurationInformationConfigurations {
- @SerializedName("parentProfileId")
- private String parentProfileId = null;
-
- @SerializedName("contactInformation")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsContactInformation contactInformation = null;
-
- @SerializedName("notifications")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications notifications = null;
-
- @SerializedName("service")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsService service = null;
-
- @SerializedName("paymentMethods")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentMethods paymentMethods = null;
-
- @SerializedName("checkout")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsCheckout checkout = null;
-
- @SerializedName("paymentTypes")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypes paymentTypes = null;
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations parentProfileId(String parentProfileId) {
- this.parentProfileId = parentProfileId;
- return this;
- }
-
- /**
- * You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here.
- * @return parentProfileId
- **/
- @ApiModelProperty(value = "You can group Secure Acceptance profiles under parent profiles. By changing the parent profile, you can update all profiles underneath that parent. Specify the Parent Profile ID here.")
- public String getParentProfileId() {
- return parentProfileId;
- }
-
- public void setParentProfileId(String parentProfileId) {
- this.parentProfileId = parentProfileId;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations contactInformation(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsContactInformation contactInformation) {
- this.contactInformation = contactInformation;
- return this;
- }
-
- /**
- * Get contactInformation
- * @return contactInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsContactInformation getContactInformation() {
- return contactInformation;
- }
-
- public void setContactInformation(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsContactInformation contactInformation) {
- this.contactInformation = contactInformation;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations notifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications notifications) {
- this.notifications = notifications;
- return this;
- }
-
- /**
- * Get notifications
- * @return notifications
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications getNotifications() {
- return notifications;
- }
-
- public void setNotifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications notifications) {
- this.notifications = notifications;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations service(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsService service) {
- this.service = service;
- return this;
- }
-
- /**
- * Get service
- * @return service
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsService getService() {
- return service;
- }
-
- public void setService(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsService service) {
- this.service = service;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations paymentMethods(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentMethods paymentMethods) {
- this.paymentMethods = paymentMethods;
- return this;
- }
-
- /**
- * Get paymentMethods
- * @return paymentMethods
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentMethods getPaymentMethods() {
- return paymentMethods;
- }
-
- public void setPaymentMethods(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentMethods paymentMethods) {
- this.paymentMethods = paymentMethods;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations checkout(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsCheckout checkout) {
- this.checkout = checkout;
- return this;
- }
-
- /**
- * Get checkout
- * @return checkout
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsCheckout getCheckout() {
- return checkout;
- }
-
- public void setCheckout(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsCheckout checkout) {
- this.checkout = checkout;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurations paymentTypes(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypes paymentTypes) {
- this.paymentTypes = paymentTypes;
- return this;
- }
-
- /**
- * Get paymentTypes
- * @return paymentTypes
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypes getPaymentTypes() {
- return paymentTypes;
- }
-
- public void setPaymentTypes(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypes paymentTypes) {
- this.paymentTypes = paymentTypes;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsSecureAcceptanceConfigurationInformationConfigurations paymentProductsSecureAcceptanceConfigurationInformationConfigurations = (PaymentProductsSecureAcceptanceConfigurationInformationConfigurations) o;
- return Objects.equals(this.parentProfileId, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.parentProfileId) &&
- Objects.equals(this.contactInformation, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.contactInformation) &&
- Objects.equals(this.notifications, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.notifications) &&
- Objects.equals(this.service, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.service) &&
- Objects.equals(this.paymentMethods, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.paymentMethods) &&
- Objects.equals(this.checkout, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.checkout) &&
- Objects.equals(this.paymentTypes, paymentProductsSecureAcceptanceConfigurationInformationConfigurations.paymentTypes);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(parentProfileId, contactInformation, notifications, service, paymentMethods, checkout, paymentTypes);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsSecureAcceptanceConfigurationInformationConfigurations {\n");
-
- sb.append(" parentProfileId: ").append(toIndentedString(parentProfileId)).append("\n");
- sb.append(" contactInformation: ").append(toIndentedString(contactInformation)).append("\n");
- sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n");
- sb.append(" service: ").append(toIndentedString(service)).append("\n");
- sb.append(" paymentMethods: ").append(toIndentedString(paymentMethods)).append("\n");
- sb.append(" checkout: ").append(toIndentedString(checkout)).append("\n");
- sb.append(" paymentTypes: ").append(toIndentedString(paymentTypes)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications.java b/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications.java
deleted file mode 100644
index 402bc9563..000000000
--- a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications.java
+++ /dev/null
@@ -1,118 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsCustomerNotifications;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsMerchantNotifications;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications
- */
-
-public class PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications {
- @SerializedName("merchantNotifications")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsMerchantNotifications merchantNotifications = null;
-
- @SerializedName("customerNotifications")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsCustomerNotifications customerNotifications = null;
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications merchantNotifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsMerchantNotifications merchantNotifications) {
- this.merchantNotifications = merchantNotifications;
- return this;
- }
-
- /**
- * Get merchantNotifications
- * @return merchantNotifications
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsMerchantNotifications getMerchantNotifications() {
- return merchantNotifications;
- }
-
- public void setMerchantNotifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsMerchantNotifications merchantNotifications) {
- this.merchantNotifications = merchantNotifications;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications customerNotifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsCustomerNotifications customerNotifications) {
- this.customerNotifications = customerNotifications;
- return this;
- }
-
- /**
- * Get customerNotifications
- * @return customerNotifications
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsCustomerNotifications getCustomerNotifications() {
- return customerNotifications;
- }
-
- public void setCustomerNotifications(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotificationsCustomerNotifications customerNotifications) {
- this.customerNotifications = customerNotifications;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications paymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications = (PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications) o;
- return Objects.equals(this.merchantNotifications, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications.merchantNotifications) &&
- Objects.equals(this.customerNotifications, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications.customerNotifications);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(merchantNotifications, customerNotifications);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsNotifications {\n");
-
- sb.append(" merchantNotifications: ").append(toIndentedString(merchantNotifications)).append("\n");
- sb.append(" customerNotifications: ").append(toIndentedString(customerNotifications)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.java b/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.java
deleted file mode 100644
index 2980d24e5..000000000
--- a/src/main/java/Model/PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.java
+++ /dev/null
@@ -1,163 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes
- */
-
-public class PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes {
- @SerializedName("discover")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover discover = null;
-
- @SerializedName("amex")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover amex = null;
-
- @SerializedName("masterCard")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover masterCard = null;
-
- @SerializedName("visa")
- private PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover visa = null;
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes discover(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover discover) {
- this.discover = discover;
- return this;
- }
-
- /**
- * Get discover
- * @return discover
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover getDiscover() {
- return discover;
- }
-
- public void setDiscover(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover discover) {
- this.discover = discover;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes amex(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover amex) {
- this.amex = amex;
- return this;
- }
-
- /**
- * Get amex
- * @return amex
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover getAmex() {
- return amex;
- }
-
- public void setAmex(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover amex) {
- this.amex = amex;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes masterCard(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover masterCard) {
- this.masterCard = masterCard;
- return this;
- }
-
- /**
- * Get masterCard
- * @return masterCard
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover getMasterCard() {
- return masterCard;
- }
-
- public void setMasterCard(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover masterCard) {
- this.masterCard = masterCard;
- }
-
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes visa(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover visa) {
- this.visa = visa;
- return this;
- }
-
- /**
- * Get visa
- * @return visa
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover getVisa() {
- return visa;
- }
-
- public void setVisa(PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypesDiscover visa) {
- this.visa = visa;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes paymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes = (PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes) o;
- return Objects.equals(this.discover, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.discover) &&
- Objects.equals(this.amex, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.amex) &&
- Objects.equals(this.masterCard, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.masterCard) &&
- Objects.equals(this.visa, paymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes.visa);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(discover, amex, masterCard, visa);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsSecureAcceptanceConfigurationInformationConfigurationsPaymentTypesCardTypes {\n");
-
- sb.append(" discover: ").append(toIndentedString(discover)).append("\n");
- sb.append(" amex: ").append(toIndentedString(amex)).append("\n");
- sb.append(" masterCard: ").append(toIndentedString(masterCard)).append("\n");
- sb.append(" visa: ").append(toIndentedString(visa)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.java b/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.java
deleted file mode 100644
index b7221ba19..000000000
--- a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.java
+++ /dev/null
@@ -1,142 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationBasicInformation;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationPaymentInformation;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation
- */
-
-public class PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation {
- @SerializedName("basicInformation")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationBasicInformation basicInformation = null;
-
- @SerializedName("paymentInformation")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationPaymentInformation paymentInformation = null;
-
- @SerializedName("merchantDefinedDataFields")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields merchantDefinedDataFields = null;
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation basicInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationBasicInformation basicInformation) {
- this.basicInformation = basicInformation;
- return this;
- }
-
- /**
- * Get basicInformation
- * @return basicInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationBasicInformation getBasicInformation() {
- return basicInformation;
- }
-
- public void setBasicInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationBasicInformation basicInformation) {
- this.basicInformation = basicInformation;
- }
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation paymentInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationPaymentInformation paymentInformation) {
- this.paymentInformation = paymentInformation;
- return this;
- }
-
- /**
- * Get paymentInformation
- * @return paymentInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationPaymentInformation getPaymentInformation() {
- return paymentInformation;
- }
-
- public void setPaymentInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationPaymentInformation paymentInformation) {
- this.paymentInformation = paymentInformation;
- }
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation merchantDefinedDataFields(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields merchantDefinedDataFields) {
- this.merchantDefinedDataFields = merchantDefinedDataFields;
- return this;
- }
-
- /**
- * Get merchantDefinedDataFields
- * @return merchantDefinedDataFields
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields getMerchantDefinedDataFields() {
- return merchantDefinedDataFields;
- }
-
- public void setMerchantDefinedDataFields(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformationMerchantDefinedDataFields merchantDefinedDataFields) {
- this.merchantDefinedDataFields = merchantDefinedDataFields;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation = (PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation) o;
- return Objects.equals(this.basicInformation, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.basicInformation) &&
- Objects.equals(this.paymentInformation, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.paymentInformation) &&
- Objects.equals(this.merchantDefinedDataFields, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation.merchantDefinedDataFields);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(basicInformation, paymentInformation, merchantDefinedDataFields);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentGlobalPaymentInformation {\n");
-
- sb.append(" basicInformation: ").append(toIndentedString(basicInformation)).append("\n");
- sb.append(" paymentInformation: ").append(toIndentedString(paymentInformation)).append("\n");
- sb.append(" merchantDefinedDataFields: ").append(toIndentedString(merchantDefinedDataFields)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.java b/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.java
deleted file mode 100644
index cead44a8a..000000000
--- a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.java
+++ /dev/null
@@ -1,142 +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
- * Do not edit the class manually.
- */
-
-
-package Model;
-
-import java.util.Objects;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationEmailReceipt;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationHeader;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationOrderInformation;
-import com.google.gson.TypeAdapter;
-import com.google.gson.annotations.JsonAdapter;
-import com.google.gson.annotations.SerializedName;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-import java.io.IOException;
-
-/**
- * PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation
- */
-
-public class PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation {
- @SerializedName("header")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationHeader header = null;
-
- @SerializedName("orderInformation")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationOrderInformation orderInformation = null;
-
- @SerializedName("emailReceipt")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationEmailReceipt emailReceipt = null;
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation header(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationHeader header) {
- this.header = header;
- return this;
- }
-
- /**
- * Get header
- * @return header
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationHeader getHeader() {
- return header;
- }
-
- public void setHeader(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationHeader header) {
- this.header = header;
- }
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation orderInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationOrderInformation orderInformation) {
- this.orderInformation = orderInformation;
- return this;
- }
-
- /**
- * Get orderInformation
- * @return orderInformation
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationOrderInformation getOrderInformation() {
- return orderInformation;
- }
-
- public void setOrderInformation(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationOrderInformation orderInformation) {
- this.orderInformation = orderInformation;
- }
-
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation emailReceipt(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationEmailReceipt emailReceipt) {
- this.emailReceipt = emailReceipt;
- return this;
- }
-
- /**
- * Get emailReceipt
- * @return emailReceipt
- **/
- @ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationEmailReceipt getEmailReceipt() {
- return emailReceipt;
- }
-
- public void setEmailReceipt(PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformationEmailReceipt emailReceipt) {
- this.emailReceipt = emailReceipt;
- }
-
-
- @Override
- public boolean equals(java.lang.Object o) {
- if (this == o) {
- return true;
- }
- if (o == null || getClass() != o.getClass()) {
- return false;
- }
- PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation = (PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation) o;
- return Objects.equals(this.header, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.header) &&
- Objects.equals(this.orderInformation, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.orderInformation) &&
- Objects.equals(this.emailReceipt, paymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation.emailReceipt);
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(header, orderInformation, emailReceipt);
- }
-
-
- @Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsVirtualTerminalConfigurationInformationConfigurationsCardNotPresentReceiptInformation {\n");
-
- sb.append(" header: ").append(toIndentedString(header)).append("\n");
- sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n");
- sb.append(" emailReceipt: ").append(toIndentedString(emailReceipt)).append("\n");
- sb.append("}");
- return sb.toString();
- }
-
- /**
- * Convert the given object to string with each line indented by 4 spaces
- * (except the first line).
- */
- private String toIndentedString(java.lang.Object o) {
- if (o == null) {
- return "null";
- }
- return o.toString().replace("\n", "\n ");
- }
-
-}
-
diff --git a/src/main/java/Model/PaymentProducts.java b/src/main/java/Model/PaymentsProducts.java
similarity index 53%
rename from src/main/java/Model/PaymentProducts.java
rename to src/main/java/Model/PaymentsProducts.java
index b228761ce..16289cca8 100644
--- a/src/main/java/Model/PaymentProducts.java
+++ b/src/main/java/Model/PaymentsProducts.java
@@ -14,18 +14,18 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardPresentConnect;
-import Model.PaymentProductsCardProcessing;
-import Model.PaymentProductsCurrencyConversion;
-import Model.PaymentProductsCybsReadyTerminal;
-import Model.PaymentProductsDifferentialFee;
-import Model.PaymentProductsDigitalPayments;
-import Model.PaymentProductsECheck;
-import Model.PaymentProductsPayerAuthentication;
-import Model.PaymentProductsPayouts;
-import Model.PaymentProductsSecureAcceptance;
-import Model.PaymentProductsTax;
-import Model.PaymentProductsVirtualTerminal;
+import Model.PaymentsProductsCardPresentConnect;
+import Model.PaymentsProductsCardProcessing;
+import Model.PaymentsProductsCurrencyConversion;
+import Model.PaymentsProductsCybsReadyTerminal;
+import Model.PaymentsProductsDifferentialFee;
+import Model.PaymentsProductsDigitalPayments;
+import Model.PaymentsProductsECheck;
+import Model.PaymentsProductsPayerAuthentication;
+import Model.PaymentsProductsPayouts;
+import Model.PaymentsProductsSecureAcceptance;
+import Model.PaymentsProductsTax;
+import Model.PaymentsProductsVirtualTerminal;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -36,62 +36,62 @@
import java.io.IOException;
/**
- * PaymentProducts
+ * PaymentsProducts
*/
-public class PaymentProducts {
+public class PaymentsProducts {
@SerializedName("cardProcessing")
- private PaymentProductsCardProcessing cardProcessing = null;
+ private PaymentsProductsCardProcessing cardProcessing = null;
@SerializedName("cardPresentConnect")
- private PaymentProductsCardPresentConnect cardPresentConnect = null;
+ private PaymentsProductsCardPresentConnect cardPresentConnect = null;
@SerializedName("cybsReadyTerminal")
- private PaymentProductsCybsReadyTerminal cybsReadyTerminal = null;
+ private PaymentsProductsCybsReadyTerminal cybsReadyTerminal = null;
@SerializedName("eCheck")
- private PaymentProductsECheck eCheck = null;
+ private PaymentsProductsECheck eCheck = null;
@SerializedName("payerAuthentication")
- private PaymentProductsPayerAuthentication payerAuthentication = null;
+ private PaymentsProductsPayerAuthentication payerAuthentication = null;
@SerializedName("digitalPayments")
- private PaymentProductsDigitalPayments digitalPayments = null;
+ private PaymentsProductsDigitalPayments digitalPayments = null;
@SerializedName("secureAcceptance")
- private PaymentProductsSecureAcceptance secureAcceptance = null;
+ private PaymentsProductsSecureAcceptance secureAcceptance = null;
@SerializedName("virtualTerminal")
- private PaymentProductsVirtualTerminal virtualTerminal = null;
+ private PaymentsProductsVirtualTerminal virtualTerminal = null;
@SerializedName("currencyConversion")
- private PaymentProductsCurrencyConversion currencyConversion = null;
+ private PaymentsProductsCurrencyConversion currencyConversion = null;
@SerializedName("tax")
- private PaymentProductsTax tax = null;
+ private PaymentsProductsTax tax = null;
@SerializedName("customerInvoicing")
- private PaymentProductsTax customerInvoicing = null;
+ private PaymentsProductsTax customerInvoicing = null;
@SerializedName("recurringBilling")
- private PaymentProductsTax recurringBilling = null;
+ private PaymentsProductsTax recurringBilling = null;
@SerializedName("paymentOrchestration")
- private PaymentProductsTax paymentOrchestration = null;
+ private PaymentsProductsTax paymentOrchestration = null;
@SerializedName("payouts")
- private PaymentProductsPayouts payouts = null;
+ private PaymentsProductsPayouts payouts = null;
@SerializedName("differentialFee")
- private PaymentProductsDifferentialFee differentialFee = null;
+ private PaymentsProductsDifferentialFee differentialFee = null;
@SerializedName("payByLink")
- private PaymentProductsTax payByLink = null;
+ private PaymentsProductsTax payByLink = null;
@SerializedName("unifiedCheckout")
- private PaymentProductsTax unifiedCheckout = null;
+ private PaymentsProductsTax unifiedCheckout = null;
- public PaymentProducts cardProcessing(PaymentProductsCardProcessing cardProcessing) {
+ public PaymentsProducts cardProcessing(PaymentsProductsCardProcessing cardProcessing) {
this.cardProcessing = cardProcessing;
return this;
}
@@ -101,15 +101,15 @@ public PaymentProducts cardProcessing(PaymentProductsCardProcessing cardProcessi
* @return cardProcessing
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessing getCardProcessing() {
+ public PaymentsProductsCardProcessing getCardProcessing() {
return cardProcessing;
}
- public void setCardProcessing(PaymentProductsCardProcessing cardProcessing) {
+ public void setCardProcessing(PaymentsProductsCardProcessing cardProcessing) {
this.cardProcessing = cardProcessing;
}
- public PaymentProducts cardPresentConnect(PaymentProductsCardPresentConnect cardPresentConnect) {
+ public PaymentsProducts cardPresentConnect(PaymentsProductsCardPresentConnect cardPresentConnect) {
this.cardPresentConnect = cardPresentConnect;
return this;
}
@@ -119,15 +119,15 @@ public PaymentProducts cardPresentConnect(PaymentProductsCardPresentConnect card
* @return cardPresentConnect
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardPresentConnect getCardPresentConnect() {
+ public PaymentsProductsCardPresentConnect getCardPresentConnect() {
return cardPresentConnect;
}
- public void setCardPresentConnect(PaymentProductsCardPresentConnect cardPresentConnect) {
+ public void setCardPresentConnect(PaymentsProductsCardPresentConnect cardPresentConnect) {
this.cardPresentConnect = cardPresentConnect;
}
- public PaymentProducts cybsReadyTerminal(PaymentProductsCybsReadyTerminal cybsReadyTerminal) {
+ public PaymentsProducts cybsReadyTerminal(PaymentsProductsCybsReadyTerminal cybsReadyTerminal) {
this.cybsReadyTerminal = cybsReadyTerminal;
return this;
}
@@ -137,15 +137,15 @@ public PaymentProducts cybsReadyTerminal(PaymentProductsCybsReadyTerminal cybsRe
* @return cybsReadyTerminal
**/
@ApiModelProperty(value = "")
- public PaymentProductsCybsReadyTerminal getCybsReadyTerminal() {
+ public PaymentsProductsCybsReadyTerminal getCybsReadyTerminal() {
return cybsReadyTerminal;
}
- public void setCybsReadyTerminal(PaymentProductsCybsReadyTerminal cybsReadyTerminal) {
+ public void setCybsReadyTerminal(PaymentsProductsCybsReadyTerminal cybsReadyTerminal) {
this.cybsReadyTerminal = cybsReadyTerminal;
}
- public PaymentProducts eCheck(PaymentProductsECheck eCheck) {
+ public PaymentsProducts eCheck(PaymentsProductsECheck eCheck) {
this.eCheck = eCheck;
return this;
}
@@ -155,15 +155,15 @@ public PaymentProducts eCheck(PaymentProductsECheck eCheck) {
* @return eCheck
**/
@ApiModelProperty(value = "")
- public PaymentProductsECheck getECheck() {
+ public PaymentsProductsECheck getECheck() {
return eCheck;
}
- public void setECheck(PaymentProductsECheck eCheck) {
+ public void setECheck(PaymentsProductsECheck eCheck) {
this.eCheck = eCheck;
}
- public PaymentProducts payerAuthentication(PaymentProductsPayerAuthentication payerAuthentication) {
+ public PaymentsProducts payerAuthentication(PaymentsProductsPayerAuthentication payerAuthentication) {
this.payerAuthentication = payerAuthentication;
return this;
}
@@ -173,15 +173,15 @@ public PaymentProducts payerAuthentication(PaymentProductsPayerAuthentication pa
* @return payerAuthentication
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthentication getPayerAuthentication() {
+ public PaymentsProductsPayerAuthentication getPayerAuthentication() {
return payerAuthentication;
}
- public void setPayerAuthentication(PaymentProductsPayerAuthentication payerAuthentication) {
+ public void setPayerAuthentication(PaymentsProductsPayerAuthentication payerAuthentication) {
this.payerAuthentication = payerAuthentication;
}
- public PaymentProducts digitalPayments(PaymentProductsDigitalPayments digitalPayments) {
+ public PaymentsProducts digitalPayments(PaymentsProductsDigitalPayments digitalPayments) {
this.digitalPayments = digitalPayments;
return this;
}
@@ -191,15 +191,15 @@ public PaymentProducts digitalPayments(PaymentProductsDigitalPayments digitalPay
* @return digitalPayments
**/
@ApiModelProperty(value = "")
- public PaymentProductsDigitalPayments getDigitalPayments() {
+ public PaymentsProductsDigitalPayments getDigitalPayments() {
return digitalPayments;
}
- public void setDigitalPayments(PaymentProductsDigitalPayments digitalPayments) {
+ public void setDigitalPayments(PaymentsProductsDigitalPayments digitalPayments) {
this.digitalPayments = digitalPayments;
}
- public PaymentProducts secureAcceptance(PaymentProductsSecureAcceptance secureAcceptance) {
+ public PaymentsProducts secureAcceptance(PaymentsProductsSecureAcceptance secureAcceptance) {
this.secureAcceptance = secureAcceptance;
return this;
}
@@ -209,15 +209,15 @@ public PaymentProducts secureAcceptance(PaymentProductsSecureAcceptance secureAc
* @return secureAcceptance
**/
@ApiModelProperty(value = "")
- public PaymentProductsSecureAcceptance getSecureAcceptance() {
+ public PaymentsProductsSecureAcceptance getSecureAcceptance() {
return secureAcceptance;
}
- public void setSecureAcceptance(PaymentProductsSecureAcceptance secureAcceptance) {
+ public void setSecureAcceptance(PaymentsProductsSecureAcceptance secureAcceptance) {
this.secureAcceptance = secureAcceptance;
}
- public PaymentProducts virtualTerminal(PaymentProductsVirtualTerminal virtualTerminal) {
+ public PaymentsProducts virtualTerminal(PaymentsProductsVirtualTerminal virtualTerminal) {
this.virtualTerminal = virtualTerminal;
return this;
}
@@ -227,15 +227,15 @@ public PaymentProducts virtualTerminal(PaymentProductsVirtualTerminal virtualTer
* @return virtualTerminal
**/
@ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminal getVirtualTerminal() {
+ public PaymentsProductsVirtualTerminal getVirtualTerminal() {
return virtualTerminal;
}
- public void setVirtualTerminal(PaymentProductsVirtualTerminal virtualTerminal) {
+ public void setVirtualTerminal(PaymentsProductsVirtualTerminal virtualTerminal) {
this.virtualTerminal = virtualTerminal;
}
- public PaymentProducts currencyConversion(PaymentProductsCurrencyConversion currencyConversion) {
+ public PaymentsProducts currencyConversion(PaymentsProductsCurrencyConversion currencyConversion) {
this.currencyConversion = currencyConversion;
return this;
}
@@ -245,15 +245,15 @@ public PaymentProducts currencyConversion(PaymentProductsCurrencyConversion curr
* @return currencyConversion
**/
@ApiModelProperty(value = "")
- public PaymentProductsCurrencyConversion getCurrencyConversion() {
+ public PaymentsProductsCurrencyConversion getCurrencyConversion() {
return currencyConversion;
}
- public void setCurrencyConversion(PaymentProductsCurrencyConversion currencyConversion) {
+ public void setCurrencyConversion(PaymentsProductsCurrencyConversion currencyConversion) {
this.currencyConversion = currencyConversion;
}
- public PaymentProducts tax(PaymentProductsTax tax) {
+ public PaymentsProducts tax(PaymentsProductsTax tax) {
this.tax = tax;
return this;
}
@@ -263,15 +263,15 @@ public PaymentProducts tax(PaymentProductsTax tax) {
* @return tax
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getTax() {
+ public PaymentsProductsTax getTax() {
return tax;
}
- public void setTax(PaymentProductsTax tax) {
+ public void setTax(PaymentsProductsTax tax) {
this.tax = tax;
}
- public PaymentProducts customerInvoicing(PaymentProductsTax customerInvoicing) {
+ public PaymentsProducts customerInvoicing(PaymentsProductsTax customerInvoicing) {
this.customerInvoicing = customerInvoicing;
return this;
}
@@ -281,15 +281,15 @@ public PaymentProducts customerInvoicing(PaymentProductsTax customerInvoicing) {
* @return customerInvoicing
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getCustomerInvoicing() {
+ public PaymentsProductsTax getCustomerInvoicing() {
return customerInvoicing;
}
- public void setCustomerInvoicing(PaymentProductsTax customerInvoicing) {
+ public void setCustomerInvoicing(PaymentsProductsTax customerInvoicing) {
this.customerInvoicing = customerInvoicing;
}
- public PaymentProducts recurringBilling(PaymentProductsTax recurringBilling) {
+ public PaymentsProducts recurringBilling(PaymentsProductsTax recurringBilling) {
this.recurringBilling = recurringBilling;
return this;
}
@@ -299,15 +299,15 @@ public PaymentProducts recurringBilling(PaymentProductsTax recurringBilling) {
* @return recurringBilling
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getRecurringBilling() {
+ public PaymentsProductsTax getRecurringBilling() {
return recurringBilling;
}
- public void setRecurringBilling(PaymentProductsTax recurringBilling) {
+ public void setRecurringBilling(PaymentsProductsTax recurringBilling) {
this.recurringBilling = recurringBilling;
}
- public PaymentProducts paymentOrchestration(PaymentProductsTax paymentOrchestration) {
+ public PaymentsProducts paymentOrchestration(PaymentsProductsTax paymentOrchestration) {
this.paymentOrchestration = paymentOrchestration;
return this;
}
@@ -317,15 +317,15 @@ public PaymentProducts paymentOrchestration(PaymentProductsTax paymentOrchestrat
* @return paymentOrchestration
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getPaymentOrchestration() {
+ public PaymentsProductsTax getPaymentOrchestration() {
return paymentOrchestration;
}
- public void setPaymentOrchestration(PaymentProductsTax paymentOrchestration) {
+ public void setPaymentOrchestration(PaymentsProductsTax paymentOrchestration) {
this.paymentOrchestration = paymentOrchestration;
}
- public PaymentProducts payouts(PaymentProductsPayouts payouts) {
+ public PaymentsProducts payouts(PaymentsProductsPayouts payouts) {
this.payouts = payouts;
return this;
}
@@ -335,15 +335,15 @@ public PaymentProducts payouts(PaymentProductsPayouts payouts) {
* @return payouts
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayouts getPayouts() {
+ public PaymentsProductsPayouts getPayouts() {
return payouts;
}
- public void setPayouts(PaymentProductsPayouts payouts) {
+ public void setPayouts(PaymentsProductsPayouts payouts) {
this.payouts = payouts;
}
- public PaymentProducts differentialFee(PaymentProductsDifferentialFee differentialFee) {
+ public PaymentsProducts differentialFee(PaymentsProductsDifferentialFee differentialFee) {
this.differentialFee = differentialFee;
return this;
}
@@ -353,15 +353,15 @@ public PaymentProducts differentialFee(PaymentProductsDifferentialFee differenti
* @return differentialFee
**/
@ApiModelProperty(value = "")
- public PaymentProductsDifferentialFee getDifferentialFee() {
+ public PaymentsProductsDifferentialFee getDifferentialFee() {
return differentialFee;
}
- public void setDifferentialFee(PaymentProductsDifferentialFee differentialFee) {
+ public void setDifferentialFee(PaymentsProductsDifferentialFee differentialFee) {
this.differentialFee = differentialFee;
}
- public PaymentProducts payByLink(PaymentProductsTax payByLink) {
+ public PaymentsProducts payByLink(PaymentsProductsTax payByLink) {
this.payByLink = payByLink;
return this;
}
@@ -371,15 +371,15 @@ public PaymentProducts payByLink(PaymentProductsTax payByLink) {
* @return payByLink
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getPayByLink() {
+ public PaymentsProductsTax getPayByLink() {
return payByLink;
}
- public void setPayByLink(PaymentProductsTax payByLink) {
+ public void setPayByLink(PaymentsProductsTax payByLink) {
this.payByLink = payByLink;
}
- public PaymentProducts unifiedCheckout(PaymentProductsTax unifiedCheckout) {
+ public PaymentsProducts unifiedCheckout(PaymentsProductsTax unifiedCheckout) {
this.unifiedCheckout = unifiedCheckout;
return this;
}
@@ -389,11 +389,11 @@ public PaymentProducts unifiedCheckout(PaymentProductsTax unifiedCheckout) {
* @return unifiedCheckout
**/
@ApiModelProperty(value = "")
- public PaymentProductsTax getUnifiedCheckout() {
+ public PaymentsProductsTax getUnifiedCheckout() {
return unifiedCheckout;
}
- public void setUnifiedCheckout(PaymentProductsTax unifiedCheckout) {
+ public void setUnifiedCheckout(PaymentsProductsTax unifiedCheckout) {
this.unifiedCheckout = unifiedCheckout;
}
@@ -406,24 +406,24 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProducts paymentProducts = (PaymentProducts) o;
- return Objects.equals(this.cardProcessing, paymentProducts.cardProcessing) &&
- Objects.equals(this.cardPresentConnect, paymentProducts.cardPresentConnect) &&
- Objects.equals(this.cybsReadyTerminal, paymentProducts.cybsReadyTerminal) &&
- Objects.equals(this.eCheck, paymentProducts.eCheck) &&
- Objects.equals(this.payerAuthentication, paymentProducts.payerAuthentication) &&
- Objects.equals(this.digitalPayments, paymentProducts.digitalPayments) &&
- Objects.equals(this.secureAcceptance, paymentProducts.secureAcceptance) &&
- Objects.equals(this.virtualTerminal, paymentProducts.virtualTerminal) &&
- Objects.equals(this.currencyConversion, paymentProducts.currencyConversion) &&
- Objects.equals(this.tax, paymentProducts.tax) &&
- Objects.equals(this.customerInvoicing, paymentProducts.customerInvoicing) &&
- Objects.equals(this.recurringBilling, paymentProducts.recurringBilling) &&
- Objects.equals(this.paymentOrchestration, paymentProducts.paymentOrchestration) &&
- Objects.equals(this.payouts, paymentProducts.payouts) &&
- Objects.equals(this.differentialFee, paymentProducts.differentialFee) &&
- Objects.equals(this.payByLink, paymentProducts.payByLink) &&
- Objects.equals(this.unifiedCheckout, paymentProducts.unifiedCheckout);
+ PaymentsProducts paymentsProducts = (PaymentsProducts) o;
+ return Objects.equals(this.cardProcessing, paymentsProducts.cardProcessing) &&
+ Objects.equals(this.cardPresentConnect, paymentsProducts.cardPresentConnect) &&
+ Objects.equals(this.cybsReadyTerminal, paymentsProducts.cybsReadyTerminal) &&
+ Objects.equals(this.eCheck, paymentsProducts.eCheck) &&
+ Objects.equals(this.payerAuthentication, paymentsProducts.payerAuthentication) &&
+ Objects.equals(this.digitalPayments, paymentsProducts.digitalPayments) &&
+ Objects.equals(this.secureAcceptance, paymentsProducts.secureAcceptance) &&
+ Objects.equals(this.virtualTerminal, paymentsProducts.virtualTerminal) &&
+ Objects.equals(this.currencyConversion, paymentsProducts.currencyConversion) &&
+ Objects.equals(this.tax, paymentsProducts.tax) &&
+ Objects.equals(this.customerInvoicing, paymentsProducts.customerInvoicing) &&
+ Objects.equals(this.recurringBilling, paymentsProducts.recurringBilling) &&
+ Objects.equals(this.paymentOrchestration, paymentsProducts.paymentOrchestration) &&
+ Objects.equals(this.payouts, paymentsProducts.payouts) &&
+ Objects.equals(this.differentialFee, paymentsProducts.differentialFee) &&
+ Objects.equals(this.payByLink, paymentsProducts.payByLink) &&
+ Objects.equals(this.unifiedCheckout, paymentsProducts.unifiedCheckout);
}
@Override
@@ -435,7 +435,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProducts {\n");
+ sb.append("class PaymentsProducts {\n");
sb.append(" cardProcessing: ").append(toIndentedString(cardProcessing)).append("\n");
sb.append(" cardPresentConnect: ").append(toIndentedString(cardPresentConnect)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsPayerAuthentication.java b/src/main/java/Model/PaymentsProductsCardPresentConnect.java
similarity index 65%
rename from src/main/java/Model/PaymentProductsPayerAuthentication.java
rename to src/main/java/Model/PaymentsProductsCardPresentConnect.java
index 169830fb0..e0e7a94fc 100644
--- a/src/main/java/Model/PaymentProductsPayerAuthentication.java
+++ b/src/main/java/Model/PaymentsProductsCardPresentConnect.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsPayerAuthenticationConfigurationInformation;
-import Model.PaymentProductsPayerAuthenticationSubscriptionInformation;
+import Model.PaymentsProductsCardPresentConnectConfigurationInformation;
+import Model.PaymentsProductsCardPresentConnectSubscriptionInformation;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.io.IOException;
/**
- * PaymentProductsPayerAuthentication
+ * PaymentsProductsCardPresentConnect
*/
-public class PaymentProductsPayerAuthentication {
+public class PaymentsProductsCardPresentConnect {
@SerializedName("subscriptionInformation")
- private PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
+ private PaymentsProductsCardPresentConnectSubscriptionInformation subscriptionInformation = null;
@SerializedName("configurationInformation")
- private PaymentProductsPayerAuthenticationConfigurationInformation configurationInformation = null;
+ private PaymentsProductsCardPresentConnectConfigurationInformation configurationInformation = null;
- public PaymentProductsPayerAuthentication subscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public PaymentsProductsCardPresentConnect subscriptionInformation(PaymentsProductsCardPresentConnectSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
return this;
}
@@ -46,15 +46,15 @@ public PaymentProductsPayerAuthentication subscriptionInformation(PaymentProduct
* @return subscriptionInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
+ public PaymentsProductsCardPresentConnectSubscriptionInformation getSubscriptionInformation() {
return subscriptionInformation;
}
- public void setSubscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public void setSubscriptionInformation(PaymentsProductsCardPresentConnectSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
}
- public PaymentProductsPayerAuthentication configurationInformation(PaymentProductsPayerAuthenticationConfigurationInformation configurationInformation) {
+ public PaymentsProductsCardPresentConnect configurationInformation(PaymentsProductsCardPresentConnectConfigurationInformation configurationInformation) {
this.configurationInformation = configurationInformation;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsPayerAuthentication configurationInformation(PaymentProduc
* @return configurationInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationConfigurationInformation getConfigurationInformation() {
+ public PaymentsProductsCardPresentConnectConfigurationInformation getConfigurationInformation() {
return configurationInformation;
}
- public void setConfigurationInformation(PaymentProductsPayerAuthenticationConfigurationInformation configurationInformation) {
+ public void setConfigurationInformation(PaymentsProductsCardPresentConnectConfigurationInformation configurationInformation) {
this.configurationInformation = configurationInformation;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsPayerAuthentication paymentProductsPayerAuthentication = (PaymentProductsPayerAuthentication) o;
- return Objects.equals(this.subscriptionInformation, paymentProductsPayerAuthentication.subscriptionInformation) &&
- Objects.equals(this.configurationInformation, paymentProductsPayerAuthentication.configurationInformation);
+ PaymentsProductsCardPresentConnect paymentsProductsCardPresentConnect = (PaymentsProductsCardPresentConnect) o;
+ return Objects.equals(this.subscriptionInformation, paymentsProductsCardPresentConnect.subscriptionInformation) &&
+ Objects.equals(this.configurationInformation, paymentsProductsCardPresentConnect.configurationInformation);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsPayerAuthentication {\n");
+ sb.append("class PaymentsProductsCardPresentConnect {\n");
sb.append(" subscriptionInformation: ").append(toIndentedString(subscriptionInformation)).append("\n");
sb.append(" configurationInformation: ").append(toIndentedString(configurationInformation)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformation.java b/src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformation.java
similarity index 63%
rename from src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformation.java
rename to src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformation.java
index e6ba4bc69..50ddd7300 100644
--- a/src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformation.java
+++ b/src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformation.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardPresentConnectConfigurationInformationConfigurations;
+import Model.PaymentsProductsCardPresentConnectConfigurationInformationConfigurations;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.util.UUID;
/**
- * PaymentProductsCardPresentConnectConfigurationInformation
+ * PaymentsProductsCardPresentConnectConfigurationInformation
*/
-public class PaymentProductsCardPresentConnectConfigurationInformation {
+public class PaymentsProductsCardPresentConnectConfigurationInformation {
@SerializedName("templateId")
private UUID templateId = null;
@SerializedName("configurations")
- private PaymentProductsCardPresentConnectConfigurationInformationConfigurations configurations = null;
+ private PaymentsProductsCardPresentConnectConfigurationInformationConfigurations configurations = null;
- public PaymentProductsCardPresentConnectConfigurationInformation templateId(UUID templateId) {
+ public PaymentsProductsCardPresentConnectConfigurationInformation templateId(UUID templateId) {
this.templateId = templateId;
return this;
}
@@ -54,7 +54,7 @@ public void setTemplateId(UUID templateId) {
this.templateId = templateId;
}
- public PaymentProductsCardPresentConnectConfigurationInformation configurations(PaymentProductsCardPresentConnectConfigurationInformationConfigurations configurations) {
+ public PaymentsProductsCardPresentConnectConfigurationInformation configurations(PaymentsProductsCardPresentConnectConfigurationInformationConfigurations configurations) {
this.configurations = configurations;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsCardPresentConnectConfigurationInformation configurations(
* @return configurations
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardPresentConnectConfigurationInformationConfigurations getConfigurations() {
+ public PaymentsProductsCardPresentConnectConfigurationInformationConfigurations getConfigurations() {
return configurations;
}
- public void setConfigurations(PaymentProductsCardPresentConnectConfigurationInformationConfigurations configurations) {
+ public void setConfigurations(PaymentsProductsCardPresentConnectConfigurationInformationConfigurations configurations) {
this.configurations = configurations;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardPresentConnectConfigurationInformation paymentProductsCardPresentConnectConfigurationInformation = (PaymentProductsCardPresentConnectConfigurationInformation) o;
- return Objects.equals(this.templateId, paymentProductsCardPresentConnectConfigurationInformation.templateId) &&
- Objects.equals(this.configurations, paymentProductsCardPresentConnectConfigurationInformation.configurations);
+ PaymentsProductsCardPresentConnectConfigurationInformation paymentsProductsCardPresentConnectConfigurationInformation = (PaymentsProductsCardPresentConnectConfigurationInformation) o;
+ return Objects.equals(this.templateId, paymentsProductsCardPresentConnectConfigurationInformation.templateId) &&
+ Objects.equals(this.configurations, paymentsProductsCardPresentConnectConfigurationInformation.configurations);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardPresentConnectConfigurationInformation {\n");
+ sb.append("class PaymentsProductsCardPresentConnectConfigurationInformation {\n");
sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n");
sb.append(" configurations: ").append(toIndentedString(configurations)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformationConfigurations.java b/src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations.java
similarity index 76%
rename from src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformationConfigurations.java
rename to src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations.java
index 228eae338..6753f2140 100644
--- a/src/main/java/Model/PaymentProductsCardPresentConnectConfigurationInformationConfigurations.java
+++ b/src/main/java/Model/PaymentsProductsCardPresentConnectConfigurationInformationConfigurations.java
@@ -24,14 +24,14 @@
import java.io.IOException;
/**
- * PaymentProductsCardPresentConnectConfigurationInformationConfigurations
+ * PaymentsProductsCardPresentConnectConfigurationInformationConfigurations
*/
-public class PaymentProductsCardPresentConnectConfigurationInformationConfigurations {
+public class PaymentsProductsCardPresentConnectConfigurationInformationConfigurations {
@SerializedName("partnerSolutionIdentifier")
private String partnerSolutionIdentifier = null;
- public PaymentProductsCardPresentConnectConfigurationInformationConfigurations partnerSolutionIdentifier(String partnerSolutionIdentifier) {
+ public PaymentsProductsCardPresentConnectConfigurationInformationConfigurations partnerSolutionIdentifier(String partnerSolutionIdentifier) {
this.partnerSolutionIdentifier = partnerSolutionIdentifier;
return this;
}
@@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardPresentConnectConfigurationInformationConfigurations paymentProductsCardPresentConnectConfigurationInformationConfigurations = (PaymentProductsCardPresentConnectConfigurationInformationConfigurations) o;
- return Objects.equals(this.partnerSolutionIdentifier, paymentProductsCardPresentConnectConfigurationInformationConfigurations.partnerSolutionIdentifier);
+ PaymentsProductsCardPresentConnectConfigurationInformationConfigurations paymentsProductsCardPresentConnectConfigurationInformationConfigurations = (PaymentsProductsCardPresentConnectConfigurationInformationConfigurations) o;
+ return Objects.equals(this.partnerSolutionIdentifier, paymentsProductsCardPresentConnectConfigurationInformationConfigurations.partnerSolutionIdentifier);
}
@Override
@@ -71,7 +71,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardPresentConnectConfigurationInformationConfigurations {\n");
+ sb.append("class PaymentsProductsCardPresentConnectConfigurationInformationConfigurations {\n");
sb.append(" partnerSolutionIdentifier: ").append(toIndentedString(partnerSolutionIdentifier)).append("\n");
sb.append("}");
diff --git a/src/main/java/Model/PaymentProductsCardPresentConnectSubscriptionInformation.java b/src/main/java/Model/PaymentsProductsCardPresentConnectSubscriptionInformation.java
similarity index 81%
rename from src/main/java/Model/PaymentProductsCardPresentConnectSubscriptionInformation.java
rename to src/main/java/Model/PaymentsProductsCardPresentConnectSubscriptionInformation.java
index 335696f1d..9eb429097 100644
--- a/src/main/java/Model/PaymentProductsCardPresentConnectSubscriptionInformation.java
+++ b/src/main/java/Model/PaymentsProductsCardPresentConnectSubscriptionInformation.java
@@ -24,10 +24,10 @@
import java.io.IOException;
/**
- * PaymentProductsCardPresentConnectSubscriptionInformation
+ * PaymentsProductsCardPresentConnectSubscriptionInformation
*/
-public class PaymentProductsCardPresentConnectSubscriptionInformation {
+public class PaymentsProductsCardPresentConnectSubscriptionInformation {
@SerializedName("enabled")
private Boolean enabled = null;
@@ -79,7 +79,7 @@ public SelfServiceabilityEnum read(final JsonReader jsonReader) throws IOExcepti
@SerializedName("selfServiceability")
private SelfServiceabilityEnum selfServiceability = SelfServiceabilityEnum.SERVICEABLE;
- public PaymentProductsCardPresentConnectSubscriptionInformation enabled(Boolean enabled) {
+ public PaymentsProductsCardPresentConnectSubscriptionInformation enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -97,7 +97,7 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardPresentConnectSubscriptionInformation selfServiceability(SelfServiceabilityEnum selfServiceability) {
+ public PaymentsProductsCardPresentConnectSubscriptionInformation selfServiceability(SelfServiceabilityEnum selfServiceability) {
this.selfServiceability = selfServiceability;
return this;
}
@@ -124,9 +124,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardPresentConnectSubscriptionInformation paymentProductsCardPresentConnectSubscriptionInformation = (PaymentProductsCardPresentConnectSubscriptionInformation) o;
- return Objects.equals(this.enabled, paymentProductsCardPresentConnectSubscriptionInformation.enabled) &&
- Objects.equals(this.selfServiceability, paymentProductsCardPresentConnectSubscriptionInformation.selfServiceability);
+ PaymentsProductsCardPresentConnectSubscriptionInformation paymentsProductsCardPresentConnectSubscriptionInformation = (PaymentsProductsCardPresentConnectSubscriptionInformation) o;
+ return Objects.equals(this.enabled, paymentsProductsCardPresentConnectSubscriptionInformation.enabled) &&
+ Objects.equals(this.selfServiceability, paymentsProductsCardPresentConnectSubscriptionInformation.selfServiceability);
}
@Override
@@ -138,7 +138,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardPresentConnectSubscriptionInformation {\n");
+ sb.append("class PaymentsProductsCardPresentConnectSubscriptionInformation {\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" selfServiceability: ").append(toIndentedString(selfServiceability)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsVirtualTerminal.java b/src/main/java/Model/PaymentsProductsCardProcessing.java
similarity index 63%
rename from src/main/java/Model/PaymentProductsVirtualTerminal.java
rename to src/main/java/Model/PaymentsProductsCardProcessing.java
index e6d0c792e..245ded30c 100644
--- a/src/main/java/Model/PaymentProductsVirtualTerminal.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessing.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsPayerAuthenticationSubscriptionInformation;
-import Model.PaymentProductsVirtualTerminalConfigurationInformation;
+import Model.PaymentsProductsCardProcessingConfigurationInformation;
+import Model.PaymentsProductsCardProcessingSubscriptionInformation;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.io.IOException;
/**
- * PaymentProductsVirtualTerminal
+ * PaymentsProductsCardProcessing
*/
-public class PaymentProductsVirtualTerminal {
+public class PaymentsProductsCardProcessing {
@SerializedName("subscriptionInformation")
- private PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation = null;
+ private PaymentsProductsCardProcessingSubscriptionInformation subscriptionInformation = null;
@SerializedName("configurationInformation")
- private PaymentProductsVirtualTerminalConfigurationInformation configurationInformation = null;
+ private PaymentsProductsCardProcessingConfigurationInformation configurationInformation = null;
- public PaymentProductsVirtualTerminal subscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public PaymentsProductsCardProcessing subscriptionInformation(PaymentsProductsCardProcessingSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
return this;
}
@@ -46,15 +46,15 @@ public PaymentProductsVirtualTerminal subscriptionInformation(PaymentProductsPay
* @return subscriptionInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsPayerAuthenticationSubscriptionInformation getSubscriptionInformation() {
+ public PaymentsProductsCardProcessingSubscriptionInformation getSubscriptionInformation() {
return subscriptionInformation;
}
- public void setSubscriptionInformation(PaymentProductsPayerAuthenticationSubscriptionInformation subscriptionInformation) {
+ public void setSubscriptionInformation(PaymentsProductsCardProcessingSubscriptionInformation subscriptionInformation) {
this.subscriptionInformation = subscriptionInformation;
}
- public PaymentProductsVirtualTerminal configurationInformation(PaymentProductsVirtualTerminalConfigurationInformation configurationInformation) {
+ public PaymentsProductsCardProcessing configurationInformation(PaymentsProductsCardProcessingConfigurationInformation configurationInformation) {
this.configurationInformation = configurationInformation;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsVirtualTerminal configurationInformation(PaymentProductsVi
* @return configurationInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformation getConfigurationInformation() {
+ public PaymentsProductsCardProcessingConfigurationInformation getConfigurationInformation() {
return configurationInformation;
}
- public void setConfigurationInformation(PaymentProductsVirtualTerminalConfigurationInformation configurationInformation) {
+ public void setConfigurationInformation(PaymentsProductsCardProcessingConfigurationInformation configurationInformation) {
this.configurationInformation = configurationInformation;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsVirtualTerminal paymentProductsVirtualTerminal = (PaymentProductsVirtualTerminal) o;
- return Objects.equals(this.subscriptionInformation, paymentProductsVirtualTerminal.subscriptionInformation) &&
- Objects.equals(this.configurationInformation, paymentProductsVirtualTerminal.configurationInformation);
+ PaymentsProductsCardProcessing paymentsProductsCardProcessing = (PaymentsProductsCardProcessing) o;
+ return Objects.equals(this.subscriptionInformation, paymentsProductsCardProcessing.subscriptionInformation) &&
+ Objects.equals(this.configurationInformation, paymentsProductsCardProcessing.configurationInformation);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsVirtualTerminal {\n");
+ sb.append("class PaymentsProductsCardProcessing {\n");
sb.append(" subscriptionInformation: ").append(toIndentedString(subscriptionInformation)).append("\n");
sb.append(" configurationInformation: ").append(toIndentedString(configurationInformation)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformation.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformation.java
similarity index 71%
rename from src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformation.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformation.java
index d9376be14..32056f10a 100644
--- a/src/main/java/Model/PaymentProductsVirtualTerminalConfigurationInformation.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformation.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsVirtualTerminalConfigurationInformationConfigurations;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurations;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.util.UUID;
/**
- * PaymentProductsVirtualTerminalConfigurationInformation
+ * PaymentsProductsCardProcessingConfigurationInformation
*/
-public class PaymentProductsVirtualTerminalConfigurationInformation {
+public class PaymentsProductsCardProcessingConfigurationInformation {
@SerializedName("templateId")
private UUID templateId = null;
@SerializedName("configurations")
- private PaymentProductsVirtualTerminalConfigurationInformationConfigurations configurations = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurations configurations = null;
- public PaymentProductsVirtualTerminalConfigurationInformation templateId(UUID templateId) {
+ public PaymentsProductsCardProcessingConfigurationInformation templateId(UUID templateId) {
this.templateId = templateId;
return this;
}
@@ -54,7 +54,7 @@ public void setTemplateId(UUID templateId) {
this.templateId = templateId;
}
- public PaymentProductsVirtualTerminalConfigurationInformation configurations(PaymentProductsVirtualTerminalConfigurationInformationConfigurations configurations) {
+ public PaymentsProductsCardProcessingConfigurationInformation configurations(PaymentsProductsCardProcessingConfigurationInformationConfigurations configurations) {
this.configurations = configurations;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsVirtualTerminalConfigurationInformation configurations(Pay
* @return configurations
**/
@ApiModelProperty(value = "")
- public PaymentProductsVirtualTerminalConfigurationInformationConfigurations getConfigurations() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurations getConfigurations() {
return configurations;
}
- public void setConfigurations(PaymentProductsVirtualTerminalConfigurationInformationConfigurations configurations) {
+ public void setConfigurations(PaymentsProductsCardProcessingConfigurationInformationConfigurations configurations) {
this.configurations = configurations;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsVirtualTerminalConfigurationInformation paymentProductsVirtualTerminalConfigurationInformation = (PaymentProductsVirtualTerminalConfigurationInformation) o;
- return Objects.equals(this.templateId, paymentProductsVirtualTerminalConfigurationInformation.templateId) &&
- Objects.equals(this.configurations, paymentProductsVirtualTerminalConfigurationInformation.configurations);
+ PaymentsProductsCardProcessingConfigurationInformation paymentsProductsCardProcessingConfigurationInformation = (PaymentsProductsCardProcessingConfigurationInformation) o;
+ return Objects.equals(this.templateId, paymentsProductsCardProcessingConfigurationInformation.templateId) &&
+ Objects.equals(this.configurations, paymentsProductsCardProcessingConfigurationInformation.configurations);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsVirtualTerminalConfigurationInformation {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformation {\n");
sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n");
sb.append(" configurations: ").append(toIndentedString(configurations)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurations.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurations.java
similarity index 52%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurations.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurations.java
index 211508689..7a8961918 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurations.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurations.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.io.IOException;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurations
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurations
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurations {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurations {
@SerializedName("common")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon common = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon common = null;
@SerializedName("features")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures features = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures features = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurations common(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon common) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurations common(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon common) {
this.common = common;
return this;
}
@@ -46,15 +46,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurations commo
* @return common
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon getCommon() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon getCommon() {
return common;
}
- public void setCommon(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon common) {
+ public void setCommon(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon common) {
this.common = common;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurations features(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures features) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurations features(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures features) {
this.features = features;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurations featu
* @return features
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures getFeatures() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures getFeatures() {
return features;
}
- public void setFeatures(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures features) {
+ public void setFeatures(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures features) {
this.features = features;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurations paymentProductsCardProcessingConfigurationInformationConfigurations = (PaymentProductsCardProcessingConfigurationInformationConfigurations) o;
- return Objects.equals(this.common, paymentProductsCardProcessingConfigurationInformationConfigurations.common) &&
- Objects.equals(this.features, paymentProductsCardProcessingConfigurationInformationConfigurations.features);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurations paymentsProductsCardProcessingConfigurationInformationConfigurations = (PaymentsProductsCardProcessingConfigurationInformationConfigurations) o;
+ return Objects.equals(this.common, paymentsProductsCardProcessingConfigurationInformationConfigurations.common) &&
+ Objects.equals(this.features, paymentsProductsCardProcessingConfigurationInformationConfigurations.features);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurations {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurations {\n");
sb.append(" common: ").append(toIndentedString(common)).append("\n");
sb.append(" features: ").append(toIndentedString(features)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.java
similarity index 79%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.java
index 53022430f..197b31459 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -29,12 +29,12 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon {
@SerializedName("processors")
- private Map processors = null;
+ private Map processors = null;
@SerializedName("amexVendorCode")
private String amexVendorCode = null;
@@ -143,16 +143,16 @@ public DefaultAuthTypeCodeEnum read(final JsonReader jsonReader) throws IOExcept
private Boolean preferCobadgedSecondaryBrand = null;
@SerializedName("merchantDescriptorInformation")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon processors(Map processors) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon processors(Map processors) {
this.processors = processors;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon putProcessorsItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors processorsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon putProcessorsItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors processorsItem) {
if (this.processors == null) {
- this.processors = new HashMap();
+ this.processors = new HashMap();
}
this.processors.put(key, processorsItem);
return this;
@@ -163,15 +163,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return processors
**/
@ApiModelProperty(value = "e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> ")
- public Map getProcessors() {
+ public Map getProcessors() {
return processors;
}
- public void setProcessors(Map processors) {
+ public void setProcessors(Map processors) {
this.processors = processors;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon amexVendorCode(String amexVendorCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon amexVendorCode(String amexVendorCode) {
this.amexVendorCode = amexVendorCode;
return this;
}
@@ -189,7 +189,7 @@ public void setAmexVendorCode(String amexVendorCode) {
this.amexVendorCode = amexVendorCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon defaultAuthTypeCode(DefaultAuthTypeCodeEnum defaultAuthTypeCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon defaultAuthTypeCode(DefaultAuthTypeCodeEnum defaultAuthTypeCode) {
this.defaultAuthTypeCode = defaultAuthTypeCode;
return this;
}
@@ -207,7 +207,7 @@ public void setDefaultAuthTypeCode(DefaultAuthTypeCodeEnum defaultAuthTypeCode)
this.defaultAuthTypeCode = defaultAuthTypeCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon masterCardAssignedId(String masterCardAssignedId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon masterCardAssignedId(String masterCardAssignedId) {
this.masterCardAssignedId = masterCardAssignedId;
return this;
}
@@ -225,7 +225,7 @@ public void setMasterCardAssignedId(String masterCardAssignedId) {
this.masterCardAssignedId = masterCardAssignedId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon enablePartialAuth(Boolean enablePartialAuth) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon enablePartialAuth(Boolean enablePartialAuth) {
this.enablePartialAuth = enablePartialAuth;
return this;
}
@@ -243,7 +243,7 @@ public void setEnablePartialAuth(Boolean enablePartialAuth) {
this.enablePartialAuth = enablePartialAuth;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon merchantCategoryCode(String merchantCategoryCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon merchantCategoryCode(String merchantCategoryCode) {
this.merchantCategoryCode = merchantCategoryCode;
return this;
}
@@ -261,7 +261,7 @@ public void setMerchantCategoryCode(String merchantCategoryCode) {
this.merchantCategoryCode = merchantCategoryCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon sicCode(String sicCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon sicCode(String sicCode) {
this.sicCode = sicCode;
return this;
}
@@ -279,7 +279,7 @@ public void setSicCode(String sicCode) {
this.sicCode = sicCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon foodAndConsumerServiceId(String foodAndConsumerServiceId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon foodAndConsumerServiceId(String foodAndConsumerServiceId) {
this.foodAndConsumerServiceId = foodAndConsumerServiceId;
return this;
}
@@ -297,7 +297,7 @@ public void setFoodAndConsumerServiceId(String foodAndConsumerServiceId) {
this.foodAndConsumerServiceId = foodAndConsumerServiceId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon enableSplitShipment(Boolean enableSplitShipment) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon enableSplitShipment(Boolean enableSplitShipment) {
this.enableSplitShipment = enableSplitShipment;
return this;
}
@@ -315,7 +315,7 @@ public void setEnableSplitShipment(Boolean enableSplitShipment) {
this.enableSplitShipment = enableSplitShipment;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon enableInterchangeOptimization(Boolean enableInterchangeOptimization) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon enableInterchangeOptimization(Boolean enableInterchangeOptimization) {
this.enableInterchangeOptimization = enableInterchangeOptimization;
return this;
}
@@ -333,16 +333,16 @@ public void setEnableInterchangeOptimization(Boolean enableInterchangeOptimizati
this.enableInterchangeOptimization = enableInterchangeOptimization;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon visaDelegatedAuthenticationId(String visaDelegatedAuthenticationId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon visaDelegatedAuthenticationId(String visaDelegatedAuthenticationId) {
this.visaDelegatedAuthenticationId = visaDelegatedAuthenticationId;
return this;
}
/**
- * Identifier provided to merchants who opt for Visa’s delegated authorization program. Applicable for VPC processors.
+ * Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors.
* @return visaDelegatedAuthenticationId
**/
- @ApiModelProperty(value = "Identifier provided to merchants who opt for Visa’s delegated authorization program. Applicable for VPC processors.")
+ @ApiModelProperty(value = "Identifier provided to merchants who opt for Visa's delegated authorization program. Applicable for VPC processors.")
public String getVisaDelegatedAuthenticationId() {
return visaDelegatedAuthenticationId;
}
@@ -351,7 +351,7 @@ public void setVisaDelegatedAuthenticationId(String visaDelegatedAuthenticationI
this.visaDelegatedAuthenticationId = visaDelegatedAuthenticationId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon creditCardRefundLimitPercent(String creditCardRefundLimitPercent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon creditCardRefundLimitPercent(String creditCardRefundLimitPercent) {
this.creditCardRefundLimitPercent = creditCardRefundLimitPercent;
return this;
}
@@ -369,7 +369,7 @@ public void setCreditCardRefundLimitPercent(String creditCardRefundLimitPercent)
this.creditCardRefundLimitPercent = creditCardRefundLimitPercent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon businessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon businessCenterCreditCardRefundLimitPercent(String businessCenterCreditCardRefundLimitPercent) {
this.businessCenterCreditCardRefundLimitPercent = businessCenterCreditCardRefundLimitPercent;
return this;
}
@@ -387,7 +387,7 @@ public void setBusinessCenterCreditCardRefundLimitPercent(String businessCenterC
this.businessCenterCreditCardRefundLimitPercent = businessCenterCreditCardRefundLimitPercent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon allowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon allowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreaterThanAuthorizations) {
this.allowCapturesGreaterThanAuthorizations = allowCapturesGreaterThanAuthorizations;
return this;
}
@@ -405,7 +405,7 @@ public void setAllowCapturesGreaterThanAuthorizations(Boolean allowCapturesGreat
this.allowCapturesGreaterThanAuthorizations = allowCapturesGreaterThanAuthorizations;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon enableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon enableDuplicateMerchantReferenceNumberBlocking(Boolean enableDuplicateMerchantReferenceNumberBlocking) {
this.enableDuplicateMerchantReferenceNumberBlocking = enableDuplicateMerchantReferenceNumberBlocking;
return this;
}
@@ -423,7 +423,7 @@ public void setEnableDuplicateMerchantReferenceNumberBlocking(Boolean enableDupl
this.enableDuplicateMerchantReferenceNumberBlocking = enableDuplicateMerchantReferenceNumberBlocking;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon domesticMerchantId(Boolean domesticMerchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon domesticMerchantId(Boolean domesticMerchantId) {
this.domesticMerchantId = domesticMerchantId;
return this;
}
@@ -441,7 +441,7 @@ public void setDomesticMerchantId(Boolean domesticMerchantId) {
this.domesticMerchantId = domesticMerchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon processLevel3Data(String processLevel3Data) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon processLevel3Data(String processLevel3Data) {
this.processLevel3Data = processLevel3Data;
return this;
}
@@ -459,7 +459,7 @@ public void setProcessLevel3Data(String processLevel3Data) {
this.processLevel3Data = processLevel3Data;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon subMerchantId(String subMerchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon subMerchantId(String subMerchantId) {
this.subMerchantId = subMerchantId;
return this;
}
@@ -477,7 +477,7 @@ public void setSubMerchantId(String subMerchantId) {
this.subMerchantId = subMerchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon subMerchantBusinessName(String subMerchantBusinessName) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon subMerchantBusinessName(String subMerchantBusinessName) {
this.subMerchantBusinessName = subMerchantBusinessName;
return this;
}
@@ -495,7 +495,7 @@ public void setSubMerchantBusinessName(String subMerchantBusinessName) {
this.subMerchantBusinessName = subMerchantBusinessName;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon preferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon preferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand) {
this.preferCobadgedSecondaryBrand = preferCobadgedSecondaryBrand;
return this;
}
@@ -513,7 +513,7 @@ public void setPreferCobadgedSecondaryBrand(Boolean preferCobadgedSecondaryBrand
this.preferCobadgedSecondaryBrand = preferCobadgedSecondaryBrand;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon merchantDescriptorInformation(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon merchantDescriptorInformation(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation) {
this.merchantDescriptorInformation = merchantDescriptorInformation;
return this;
}
@@ -523,11 +523,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return merchantDescriptorInformation
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation getMerchantDescriptorInformation() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation getMerchantDescriptorInformation() {
return merchantDescriptorInformation;
}
- public void setMerchantDescriptorInformation(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation) {
+ public void setMerchantDescriptorInformation(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation merchantDescriptorInformation) {
this.merchantDescriptorInformation = merchantDescriptorInformation;
}
@@ -540,28 +540,28 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon paymentProductsCardProcessingConfigurationInformationConfigurationsCommon = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon) o;
- return Objects.equals(this.processors, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.processors) &&
- Objects.equals(this.amexVendorCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.amexVendorCode) &&
- Objects.equals(this.defaultAuthTypeCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.defaultAuthTypeCode) &&
- Objects.equals(this.masterCardAssignedId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.masterCardAssignedId) &&
- Objects.equals(this.enablePartialAuth, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.enablePartialAuth) &&
- Objects.equals(this.merchantCategoryCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.merchantCategoryCode) &&
- Objects.equals(this.sicCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.sicCode) &&
- Objects.equals(this.foodAndConsumerServiceId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.foodAndConsumerServiceId) &&
- Objects.equals(this.enableSplitShipment, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.enableSplitShipment) &&
- Objects.equals(this.enableInterchangeOptimization, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.enableInterchangeOptimization) &&
- Objects.equals(this.visaDelegatedAuthenticationId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.visaDelegatedAuthenticationId) &&
- Objects.equals(this.creditCardRefundLimitPercent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.creditCardRefundLimitPercent) &&
- Objects.equals(this.businessCenterCreditCardRefundLimitPercent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.businessCenterCreditCardRefundLimitPercent) &&
- Objects.equals(this.allowCapturesGreaterThanAuthorizations, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.allowCapturesGreaterThanAuthorizations) &&
- Objects.equals(this.enableDuplicateMerchantReferenceNumberBlocking, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.enableDuplicateMerchantReferenceNumberBlocking) &&
- Objects.equals(this.domesticMerchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.domesticMerchantId) &&
- Objects.equals(this.processLevel3Data, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.processLevel3Data) &&
- Objects.equals(this.subMerchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.subMerchantId) &&
- Objects.equals(this.subMerchantBusinessName, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.subMerchantBusinessName) &&
- Objects.equals(this.preferCobadgedSecondaryBrand, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.preferCobadgedSecondaryBrand) &&
- Objects.equals(this.merchantDescriptorInformation, paymentProductsCardProcessingConfigurationInformationConfigurationsCommon.merchantDescriptorInformation);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon) o;
+ return Objects.equals(this.processors, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.processors) &&
+ Objects.equals(this.amexVendorCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.amexVendorCode) &&
+ Objects.equals(this.defaultAuthTypeCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.defaultAuthTypeCode) &&
+ Objects.equals(this.masterCardAssignedId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.masterCardAssignedId) &&
+ Objects.equals(this.enablePartialAuth, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.enablePartialAuth) &&
+ Objects.equals(this.merchantCategoryCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.merchantCategoryCode) &&
+ Objects.equals(this.sicCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.sicCode) &&
+ Objects.equals(this.foodAndConsumerServiceId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.foodAndConsumerServiceId) &&
+ Objects.equals(this.enableSplitShipment, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.enableSplitShipment) &&
+ Objects.equals(this.enableInterchangeOptimization, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.enableInterchangeOptimization) &&
+ Objects.equals(this.visaDelegatedAuthenticationId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.visaDelegatedAuthenticationId) &&
+ Objects.equals(this.creditCardRefundLimitPercent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.creditCardRefundLimitPercent) &&
+ Objects.equals(this.businessCenterCreditCardRefundLimitPercent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.businessCenterCreditCardRefundLimitPercent) &&
+ Objects.equals(this.allowCapturesGreaterThanAuthorizations, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.allowCapturesGreaterThanAuthorizations) &&
+ Objects.equals(this.enableDuplicateMerchantReferenceNumberBlocking, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.enableDuplicateMerchantReferenceNumberBlocking) &&
+ Objects.equals(this.domesticMerchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.domesticMerchantId) &&
+ Objects.equals(this.processLevel3Data, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.processLevel3Data) &&
+ Objects.equals(this.subMerchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.subMerchantId) &&
+ Objects.equals(this.subMerchantBusinessName, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.subMerchantBusinessName) &&
+ Objects.equals(this.preferCobadgedSecondaryBrand, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.preferCobadgedSecondaryBrand) &&
+ Objects.equals(this.merchantDescriptorInformation, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommon.merchantDescriptorInformation);
}
@Override
@@ -573,7 +573,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon {\n");
sb.append(" processors: ").append(toIndentedString(processors)).append("\n");
sb.append(" amexVendorCode: ").append(toIndentedString(amexVendorCode)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java
similarity index 77%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java
index 7f123e7cd..c8bf640f2 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.java
@@ -28,7 +28,7 @@
*/
@ApiModel(description = "Identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant.")
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer {
@SerializedName("institutionId")
private String institutionId = null;
@@ -44,7 +44,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("fileDestinationBin")
private String fileDestinationBin = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer institutionId(String institutionId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer institutionId(String institutionId) {
this.institutionId = institutionId;
return this;
}
@@ -62,7 +62,7 @@ public void setInstitutionId(String institutionId) {
this.institutionId = institutionId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer interbankCardAssociationId(String interbankCardAssociationId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer interbankCardAssociationId(String interbankCardAssociationId) {
this.interbankCardAssociationId = interbankCardAssociationId;
return this;
}
@@ -80,7 +80,7 @@ public void setInterbankCardAssociationId(String interbankCardAssociationId) {
this.interbankCardAssociationId = interbankCardAssociationId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer discoverInstitutionId(String discoverInstitutionId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer discoverInstitutionId(String discoverInstitutionId) {
this.discoverInstitutionId = discoverInstitutionId;
return this;
}
@@ -98,7 +98,7 @@ public void setDiscoverInstitutionId(String discoverInstitutionId) {
this.discoverInstitutionId = discoverInstitutionId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer countryCode(String countryCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer countryCode(String countryCode) {
this.countryCode = countryCode;
return this;
}
@@ -116,7 +116,7 @@ public void setCountryCode(String countryCode) {
this.countryCode = countryCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer fileDestinationBin(String fileDestinationBin) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer fileDestinationBin(String fileDestinationBin) {
this.fileDestinationBin = fileDestinationBin;
return this;
}
@@ -143,12 +143,12 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer) o;
- return Objects.equals(this.institutionId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.institutionId) &&
- Objects.equals(this.interbankCardAssociationId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.interbankCardAssociationId) &&
- Objects.equals(this.discoverInstitutionId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.discoverInstitutionId) &&
- Objects.equals(this.countryCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.countryCode) &&
- Objects.equals(this.fileDestinationBin, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.fileDestinationBin);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer) o;
+ return Objects.equals(this.institutionId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.institutionId) &&
+ Objects.equals(this.interbankCardAssociationId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.interbankCardAssociationId) &&
+ Objects.equals(this.discoverInstitutionId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.discoverInstitutionId) &&
+ Objects.equals(this.countryCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.countryCode) &&
+ Objects.equals(this.fileDestinationBin, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.fileDestinationBin);
}
@Override
@@ -160,7 +160,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer {\n");
sb.append(" institutionId: ").append(toIndentedString(institutionId)).append("\n");
sb.append(" interbankCardAssociationId: ").append(toIndentedString(interbankCardAssociationId)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java
similarity index 74%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java
index 36284cf91..275d063b5 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.java
@@ -26,10 +26,10 @@
import java.util.List;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies {
@SerializedName("enabled")
private Boolean enabled = null;
@@ -51,7 +51,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("serviceEnablementNumber")
private String serviceEnablementNumber = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabled(Boolean enabled) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -69,7 +69,7 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabledCardPresent(Boolean enabledCardPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
return this;
}
@@ -87,7 +87,7 @@ public void setEnabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabledCardNotPresent(Boolean enabledCardNotPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies enabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
return this;
}
@@ -105,7 +105,7 @@ public void setEnabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies merchantId(String merchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies merchantId(String merchantId) {
this.merchantId = merchantId;
return this;
}
@@ -123,7 +123,7 @@ public void setMerchantId(String merchantId) {
this.merchantId = merchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies terminalId(String terminalId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies terminalId(String terminalId) {
this.terminalId = terminalId;
return this;
}
@@ -141,12 +141,12 @@ public void setTerminalId(String terminalId) {
this.terminalId = terminalId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies terminalIds(List terminalIds) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies terminalIds(List terminalIds) {
this.terminalIds = terminalIds;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies addTerminalIdsItem(String terminalIdsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies addTerminalIdsItem(String terminalIdsItem) {
if (this.terminalIds == null) {
this.terminalIds = new ArrayList();
}
@@ -167,7 +167,7 @@ public void setTerminalIds(List terminalIds) {
this.terminalIds = terminalIds;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies serviceEnablementNumber(String serviceEnablementNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies serviceEnablementNumber(String serviceEnablementNumber) {
this.serviceEnablementNumber = serviceEnablementNumber;
return this;
}
@@ -194,14 +194,14 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies) o;
- return Objects.equals(this.enabled, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabled) &&
- Objects.equals(this.enabledCardPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabledCardPresent) &&
- Objects.equals(this.enabledCardNotPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabledCardNotPresent) &&
- Objects.equals(this.merchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.merchantId) &&
- Objects.equals(this.terminalId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.terminalId) &&
- Objects.equals(this.terminalIds, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.terminalIds) &&
- Objects.equals(this.serviceEnablementNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.serviceEnablementNumber);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies) o;
+ return Objects.equals(this.enabled, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabled) &&
+ Objects.equals(this.enabledCardPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabledCardPresent) &&
+ Objects.equals(this.enabledCardNotPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.enabledCardNotPresent) &&
+ Objects.equals(this.merchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.merchantId) &&
+ Objects.equals(this.terminalId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.terminalId) &&
+ Objects.equals(this.terminalIds, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.terminalIds) &&
+ Objects.equals(this.serviceEnablementNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies.serviceEnablementNumber);
}
@Override
@@ -213,7 +213,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies {\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" enabledCardPresent: ").append(toIndentedString(enabledCardPresent)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java
similarity index 72%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java
index ee9446ff4..8a29f7004 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.java
@@ -26,10 +26,10 @@
import java.util.List;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 {
@SerializedName("enabled")
private Boolean enabled = null;
@@ -42,7 +42,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("terminalIds")
private List terminalIds = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabled(Boolean enabled) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -60,7 +60,7 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabledCardPresent(Boolean enabledCardPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
return this;
}
@@ -78,7 +78,7 @@ public void setEnabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabledCardNotPresent(Boolean enabledCardNotPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 enabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
return this;
}
@@ -96,12 +96,12 @@ public void setEnabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 terminalIds(List terminalIds) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 terminalIds(List terminalIds) {
this.terminalIds = terminalIds;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 addTerminalIdsItem(String terminalIdsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 addTerminalIdsItem(String terminalIdsItem) {
if (this.terminalIds == null) {
this.terminalIds = new ArrayList();
}
@@ -131,11 +131,11 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1) o;
- return Objects.equals(this.enabled, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabled) &&
- Objects.equals(this.enabledCardPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabledCardPresent) &&
- Objects.equals(this.enabledCardNotPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabledCardNotPresent) &&
- Objects.equals(this.terminalIds, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.terminalIds);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1) o;
+ return Objects.equals(this.enabled, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabled) &&
+ Objects.equals(this.enabledCardPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabledCardPresent) &&
+ Objects.equals(this.enabledCardNotPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.enabledCardNotPresent) &&
+ Objects.equals(this.terminalIds, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.terminalIds);
}
@Override
@@ -147,7 +147,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 {\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" enabledCardPresent: ").append(toIndentedString(enabledCardPresent)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java
similarity index 82%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java
index 5c281968c..f46b78ab1 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.java
@@ -24,11 +24,11 @@
import java.io.IOException;
/**
- * A merchant descriptor is the line of copy that identifies transactions on a cardholder’s account activity and statement. If this information is not populated, the data will be retrieved from OMS.
+ * A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.
*/
-@ApiModel(description = "A merchant descriptor is the line of copy that identifies transactions on a cardholder’s account activity and statement. If this information is not populated, the data will be retrieved from OMS.")
+@ApiModel(description = "A merchant descriptor is the line of copy that identifies transactions on a cardholder's account activity and statement. If this information is not populated, the data will be retrieved from OMS.")
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation {
@SerializedName("name")
private String name = null;
@@ -53,7 +53,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("url")
private String url = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation name(String name) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation name(String name) {
this.name = name;
return this;
}
@@ -71,7 +71,7 @@ public void setName(String name) {
this.name = name;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation city(String city) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation city(String city) {
this.city = city;
return this;
}
@@ -89,7 +89,7 @@ public void setCity(String city) {
this.city = city;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation country(String country) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation country(String country) {
this.country = country;
return this;
}
@@ -107,7 +107,7 @@ public void setCountry(String country) {
this.country = country;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation phone(String phone) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation phone(String phone) {
this.phone = phone;
return this;
}
@@ -125,7 +125,7 @@ public void setPhone(String phone) {
this.phone = phone;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation state(String state) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation state(String state) {
this.state = state;
return this;
}
@@ -143,7 +143,7 @@ public void setState(String state) {
this.state = state;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation street(String street) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation street(String street) {
this.street = street;
return this;
}
@@ -161,7 +161,7 @@ public void setStreet(String street) {
this.street = street;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation zip(String zip) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation zip(String zip) {
this.zip = zip;
return this;
}
@@ -179,7 +179,7 @@ public void setZip(String zip) {
this.zip = zip;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation url(String url) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation url(String url) {
this.url = url;
return this;
}
@@ -206,15 +206,15 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation) o;
- return Objects.equals(this.name, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.name) &&
- Objects.equals(this.city, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.city) &&
- Objects.equals(this.country, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.country) &&
- Objects.equals(this.phone, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.phone) &&
- Objects.equals(this.state, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.state) &&
- Objects.equals(this.street, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.street) &&
- Objects.equals(this.zip, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.zip) &&
- Objects.equals(this.url, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.url);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation) o;
+ return Objects.equals(this.name, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.name) &&
+ Objects.equals(this.city, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.city) &&
+ Objects.equals(this.country, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.country) &&
+ Objects.equals(this.phone, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.phone) &&
+ Objects.equals(this.state, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.state) &&
+ Objects.equals(this.street, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.street) &&
+ Objects.equals(this.zip, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.zip) &&
+ Objects.equals(this.url, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.url);
}
@Override
@@ -226,7 +226,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" city: ").append(toIndentedString(city)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java
similarity index 56%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java
index 0aa81940b..25b0b83ad 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -28,17 +28,17 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes {
@SerializedName("enabled")
private Boolean enabled = null;
@SerializedName("currencies")
- private Map currencies = null;
+ private Map currencies = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes enabled(Boolean enabled) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -56,14 +56,14 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes currencies(Map currencies) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes currencies(Map currencies) {
this.currencies = currencies;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes putCurrenciesItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies currenciesItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes putCurrenciesItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies currenciesItem) {
if (this.currencies == null) {
- this.currencies = new HashMap();
+ this.currencies = new HashMap();
}
this.currencies.put(key, currenciesItem);
return this;
@@ -74,11 +74,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return currencies
**/
@ApiModelProperty(value = "Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)")
- public Map getCurrencies() {
+ public Map getCurrencies() {
return currencies;
}
- public void setCurrencies(Map currencies) {
+ public void setCurrencies(Map currencies) {
this.currencies = currencies;
}
@@ -91,9 +91,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes paymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes) o;
- return Objects.equals(this.enabled, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.enabled) &&
- Objects.equals(this.currencies, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.currencies);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes) o;
+ return Objects.equals(this.enabled, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.enabled) &&
+ Objects.equals(this.currencies, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.currencies);
}
@Override
@@ -105,7 +105,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes {\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" currencies: ").append(toIndentedString(currencies)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java
similarity index 70%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java
index 32a92b01c..93b8ead87 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.java
@@ -14,9 +14,9 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -30,10 +30,10 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors {
@SerializedName("batchGroup")
private String batchGroup = null;
@@ -47,7 +47,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
private String abaNumber = null;
@SerializedName("acquirer")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer = null;
@SerializedName("merchantId")
private String merchantId = null;
@@ -56,10 +56,10 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
private String terminalId = null;
@SerializedName("paymentTypes")
- private Map paymentTypes = null;
+ private Map paymentTypes = null;
@SerializedName("currencies")
- private Map currencies = null;
+ private Map currencies = null;
@SerializedName("sicCode")
private String sicCode = null;
@@ -231,7 +231,7 @@ public IndustryCodeEnum read(final JsonReader jsonReader) throws IOException {
@SerializedName("merchantTier")
private String merchantTier = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors batchGroup(String batchGroup) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors batchGroup(String batchGroup) {
this.batchGroup = batchGroup;
return this;
}
@@ -249,7 +249,7 @@ public void setBatchGroup(String batchGroup) {
this.batchGroup = batchGroup;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors businessApplicationId(String businessApplicationId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors businessApplicationId(String businessApplicationId) {
this.businessApplicationId = businessApplicationId;
return this;
}
@@ -267,7 +267,7 @@ public void setBusinessApplicationId(String businessApplicationId) {
this.businessApplicationId = businessApplicationId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantVerificationValue(String merchantVerificationValue) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantVerificationValue(String merchantVerificationValue) {
this.merchantVerificationValue = merchantVerificationValue;
return this;
}
@@ -285,7 +285,7 @@ public void setMerchantVerificationValue(String merchantVerificationValue) {
this.merchantVerificationValue = merchantVerificationValue;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors abaNumber(String abaNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors abaNumber(String abaNumber) {
this.abaNumber = abaNumber;
return this;
}
@@ -303,7 +303,7 @@ public void setAbaNumber(String abaNumber) {
this.abaNumber = abaNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors acquirer(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors acquirer(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer) {
this.acquirer = acquirer;
return this;
}
@@ -313,15 +313,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return acquirer
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer getAcquirer() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer getAcquirer() {
return acquirer;
}
- public void setAcquirer(PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer) {
+ public void setAcquirer(PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer acquirer) {
this.acquirer = acquirer;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantId(String merchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantId(String merchantId) {
this.merchantId = merchantId;
return this;
}
@@ -339,7 +339,7 @@ public void setMerchantId(String merchantId) {
this.merchantId = merchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors terminalId(String terminalId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors terminalId(String terminalId) {
this.terminalId = terminalId;
return this;
}
@@ -357,14 +357,14 @@ public void setTerminalId(String terminalId) {
this.terminalId = terminalId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors paymentTypes(Map paymentTypes) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors paymentTypes(Map paymentTypes) {
this.paymentTypes = paymentTypes;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors putPaymentTypesItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes paymentTypesItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors putPaymentTypesItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes paymentTypesItem) {
if (this.paymentTypes == null) {
- this.paymentTypes = new HashMap();
+ this.paymentTypes = new HashMap();
}
this.paymentTypes.put(key, paymentTypesItem);
return this;
@@ -375,22 +375,22 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return paymentTypes
**/
@ApiModelProperty(value = "Valid values are: * VISA * MASTERCARD * AMERICAN_EXPRESS * CUP * EFTPOS * DINERS_CLUB * DISCOVER * JCB ")
- public Map getPaymentTypes() {
+ public Map getPaymentTypes() {
return paymentTypes;
}
- public void setPaymentTypes(Map paymentTypes) {
+ public void setPaymentTypes(Map paymentTypes) {
this.paymentTypes = paymentTypes;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors currencies(Map currencies) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors currencies(Map currencies) {
this.currencies = currencies;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors putCurrenciesItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 currenciesItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors putCurrenciesItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1 currenciesItem) {
if (this.currencies == null) {
- this.currencies = new HashMap();
+ this.currencies = new HashMap();
}
this.currencies.put(key, currenciesItem);
return this;
@@ -401,15 +401,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommon
* @return currencies
**/
@ApiModelProperty(value = "Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)")
- public Map getCurrencies() {
+ public Map getCurrencies() {
return currencies;
}
- public void setCurrencies(Map currencies) {
+ public void setCurrencies(Map currencies) {
this.currencies = currencies;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors sicCode(String sicCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors sicCode(String sicCode) {
this.sicCode = sicCode;
return this;
}
@@ -427,7 +427,7 @@ public void setSicCode(String sicCode) {
this.sicCode = sicCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors allowMultipleBills(Boolean allowMultipleBills) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors allowMultipleBills(Boolean allowMultipleBills) {
this.allowMultipleBills = allowMultipleBills;
return this;
}
@@ -445,7 +445,7 @@ public void setAllowMultipleBills(Boolean allowMultipleBills) {
this.allowMultipleBills = allowMultipleBills;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors allowMerchantDescriptorOverride(Boolean allowMerchantDescriptorOverride) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors allowMerchantDescriptorOverride(Boolean allowMerchantDescriptorOverride) {
this.allowMerchantDescriptorOverride = allowMerchantDescriptorOverride;
return this;
}
@@ -463,7 +463,7 @@ public void setAllowMerchantDescriptorOverride(Boolean allowMerchantDescriptorOv
this.allowMerchantDescriptorOverride = allowMerchantDescriptorOverride;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enhancedData(String enhancedData) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enhancedData(String enhancedData) {
this.enhancedData = enhancedData;
return this;
}
@@ -481,7 +481,7 @@ public void setEnhancedData(String enhancedData) {
this.enhancedData = enhancedData;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors fireSafetyIndicator(Boolean fireSafetyIndicator) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors fireSafetyIndicator(Boolean fireSafetyIndicator) {
this.fireSafetyIndicator = fireSafetyIndicator;
return this;
}
@@ -499,7 +499,7 @@ public void setFireSafetyIndicator(Boolean fireSafetyIndicator) {
this.fireSafetyIndicator = fireSafetyIndicator;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors quasiCash(Boolean quasiCash) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors quasiCash(Boolean quasiCash) {
this.quasiCash = quasiCash;
return this;
}
@@ -517,7 +517,7 @@ public void setQuasiCash(Boolean quasiCash) {
this.quasiCash = quasiCash;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors acquirerMerchantId(String acquirerMerchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors acquirerMerchantId(String acquirerMerchantId) {
this.acquirerMerchantId = acquirerMerchantId;
return this;
}
@@ -535,16 +535,16 @@ public void setAcquirerMerchantId(String acquirerMerchantId) {
this.acquirerMerchantId = acquirerMerchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors avsFormat(String avsFormat) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors avsFormat(String avsFormat) {
this.avsFormat = avsFormat;
return this;
}
/**
- * Enables Enhanced AVS/Automated Address Verification Plus (AAV+). Valid values: \"basic\" - Standard address verification system. When a processor supports AVS for a transaction’s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent. \"basic + name\" - Enhanced address verification system. Consists of the standard AVS functionality plus verification of some additional fields. The additional fields that are verified for Enhanced AVS are: - customer_firstname - customer_lastname \"basic + name + shipto\" - Automated address verification plus. Consists of the Enhanced AVS functionality plus verification of some additional fields. AAV+ intended for merchants who deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. For information about Enhanced AVS - The additional fields that are verified for AAV+ are: - ship_to_firstname - ship_to_lastname - ship_to_address1 - ship_to_country - ship_to_zip - ship_to_phone - customer_phone(American Express Direct only) Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>basic</td></tr> </table>
+ * Enables Enhanced AVS/Automated Address Verification Plus (AAV+). Valid values: \"basic\" - Standard address verification system. When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent. \"basic + name\" - Enhanced address verification system. Consists of the standard AVS functionality plus verification of some additional fields. The additional fields that are verified for Enhanced AVS are: - customer_firstname - customer_lastname \"basic + name + shipto\" - Automated address verification plus. Consists of the Enhanced AVS functionality plus verification of some additional fields. AAV+ intended for merchants who deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. For information about Enhanced AVS - The additional fields that are verified for AAV+ are: - ship_to_firstname - ship_to_lastname - ship_to_address1 - ship_to_country - ship_to_zip - ship_to_phone - customer_phone(American Express Direct only) Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>basic</td></tr> </table>
* @return avsFormat
**/
- @ApiModelProperty(value = "Enables Enhanced AVS/Automated Address Verification Plus (AAV+). Valid values: \"basic\" - Standard address verification system. When a processor supports AVS for a transaction’s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent. \"basic + name\" - Enhanced address verification system. Consists of the standard AVS functionality plus verification of some additional fields. The additional fields that are verified for Enhanced AVS are: - customer_firstname - customer_lastname \"basic + name + shipto\" - Automated address verification plus. Consists of the Enhanced AVS functionality plus verification of some additional fields. AAV+ intended for merchants who deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. For information about Enhanced AVS - The additional fields that are verified for AAV+ are: - ship_to_firstname - ship_to_lastname - ship_to_address1 - ship_to_country - ship_to_zip - ship_to_phone - customer_phone(American Express Direct only) Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | basic |
")
+ @ApiModelProperty(value = "Enables Enhanced AVS/Automated Address Verification Plus (AAV+). Valid values: \"basic\" - Standard address verification system. When a processor supports AVS for a transaction's card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent. \"basic + name\" - Enhanced address verification system. Consists of the standard AVS functionality plus verification of some additional fields. The additional fields that are verified for Enhanced AVS are: - customer_firstname - customer_lastname \"basic + name + shipto\" - Automated address verification plus. Consists of the Enhanced AVS functionality plus verification of some additional fields. AAV+ intended for merchants who deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. For information about Enhanced AVS - The additional fields that are verified for AAV+ are: - ship_to_firstname - ship_to_lastname - ship_to_address1 - ship_to_country - ship_to_zip - ship_to_phone - customer_phone(American Express Direct only) Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cnp, cp, hybrid | Yes | basic |
")
public String getAvsFormat() {
return avsFormat;
}
@@ -553,7 +553,7 @@ public void setAvsFormat(String avsFormat) {
this.avsFormat = avsFormat;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLongTransRefNo(Boolean enableLongTransRefNo) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLongTransRefNo(Boolean enableLongTransRefNo) {
this.enableLongTransRefNo = enableLongTransRefNo;
return this;
}
@@ -571,7 +571,7 @@ public void setEnableLongTransRefNo(Boolean enableLongTransRefNo) {
this.enableLongTransRefNo = enableLongTransRefNo;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLevel2(Boolean enableLevel2) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLevel2(Boolean enableLevel2) {
this.enableLevel2 = enableLevel2;
return this;
}
@@ -589,16 +589,16 @@ public void setEnableLevel2(Boolean enableLevel2) {
this.enableLevel2 = enableLevel2;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultipleTransactionAdviceAddendum(Boolean enableMultipleTransactionAdviceAddendum) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultipleTransactionAdviceAddendum(Boolean enableMultipleTransactionAdviceAddendum) {
this.enableMultipleTransactionAdviceAddendum = enableMultipleTransactionAdviceAddendum;
return this;
}
/**
- * This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table>
+ * This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, cnp, hybrid</td><td>No</td><td>No</td></tr> </table>
* @return enableMultipleTransactionAdviceAddendum
**/
- @ApiModelProperty(value = "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
")
+ @ApiModelProperty(value = "This flag related to multiple transaction advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Default Value |
|---|
| American Express Direct | cp, cnp, hybrid | No | No |
")
public Boolean getEnableMultipleTransactionAdviceAddendum() {
return enableMultipleTransactionAdviceAddendum;
}
@@ -607,16 +607,16 @@ public void setEnableMultipleTransactionAdviceAddendum(Boolean enableMultipleTra
this.enableMultipleTransactionAdviceAddendum = enableMultipleTransactionAdviceAddendum;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors amexTransactionAdviceAddendum1(String amexTransactionAdviceAddendum1) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors amexTransactionAdviceAddendum1(String amexTransactionAdviceAddendum1) {
this.amexTransactionAdviceAddendum1 = amexTransactionAdviceAddendum1;
return this;
}
/**
- * Advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>40</td><td>^[0-9a-zA-Z\-\\s.]+$</td></tr> </table>
+ * Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>40</td><td>^[0-9a-zA-Z\-\\s.]+$</td></tr> </table>
* @return amexTransactionAdviceAddendum1
**/
- @ApiModelProperty(value = "Advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
")
+ @ApiModelProperty(value = "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors. Validation details (for selected processors)... | Processor | Acceptance Type | Required | Min. Length | Max. Length | Regex |
|---|
| American Express Direct | cnp, cp, hybrid | No | 1 | 40 | ^[0-9a-zA-Z\-\\s.]+$ |
")
public String getAmexTransactionAdviceAddendum1() {
return amexTransactionAdviceAddendum1;
}
@@ -625,7 +625,7 @@ public void setAmexTransactionAdviceAddendum1(String amexTransactionAdviceAddend
this.amexTransactionAdviceAddendum1 = amexTransactionAdviceAddendum1;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultiLineItems(Boolean enableMultiLineItems) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultiLineItems(Boolean enableMultiLineItems) {
this.enableMultiLineItems = enableMultiLineItems;
return this;
}
@@ -643,7 +643,7 @@ public void setEnableMultiLineItems(Boolean enableMultiLineItems) {
this.enableMultiLineItems = enableMultiLineItems;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableTransactionReferenceNumber(Boolean enableTransactionReferenceNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableTransactionReferenceNumber(Boolean enableTransactionReferenceNumber) {
this.enableTransactionReferenceNumber = enableTransactionReferenceNumber;
return this;
}
@@ -661,7 +661,7 @@ public void setEnableTransactionReferenceNumber(Boolean enableTransactionReferen
this.enableTransactionReferenceNumber = enableTransactionReferenceNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableAutoAuthReversalAfterVoid(Boolean enableAutoAuthReversalAfterVoid) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableAutoAuthReversalAfterVoid(Boolean enableAutoAuthReversalAfterVoid) {
this.enableAutoAuthReversalAfterVoid = enableAutoAuthReversalAfterVoid;
return this;
}
@@ -679,7 +679,7 @@ public void setEnableAutoAuthReversalAfterVoid(Boolean enableAutoAuthReversalAft
this.enableAutoAuthReversalAfterVoid = enableAutoAuthReversalAfterVoid;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableExpresspayPanTranslation(Boolean enableExpresspayPanTranslation) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableExpresspayPanTranslation(Boolean enableExpresspayPanTranslation) {
this.enableExpresspayPanTranslation = enableExpresspayPanTranslation;
return this;
}
@@ -697,7 +697,7 @@ public void setEnableExpresspayPanTranslation(Boolean enableExpresspayPanTransla
this.enableExpresspayPanTranslation = enableExpresspayPanTranslation;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableCreditAuth(Boolean enableCreditAuth) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableCreditAuth(Boolean enableCreditAuth) {
this.enableCreditAuth = enableCreditAuth;
return this;
}
@@ -715,7 +715,7 @@ public void setEnableCreditAuth(Boolean enableCreditAuth) {
this.enableCreditAuth = enableCreditAuth;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors industryCode(IndustryCodeEnum industryCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors industryCode(IndustryCodeEnum industryCode) {
this.industryCode = industryCode;
return this;
}
@@ -733,7 +733,7 @@ public void setIndustryCode(IndustryCodeEnum industryCode) {
this.industryCode = industryCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors sendAmexLevel2Data(Boolean sendAmexLevel2Data) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors sendAmexLevel2Data(Boolean sendAmexLevel2Data) {
this.sendAmexLevel2Data = sendAmexLevel2Data;
return this;
}
@@ -751,16 +751,16 @@ public void setSendAmexLevel2Data(Boolean sendAmexLevel2Data) {
this.sendAmexLevel2Data = sendAmexLevel2Data;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors softDescriptorType(String softDescriptorType) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors softDescriptorType(String softDescriptorType) {
this.softDescriptorType = softDescriptorType;
return this;
}
/**
- * A soft descriptor is a text, rendered on a cardholder’s statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: `1` - trans_ref_no `2` - merchant_descriptor `3` - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor.
+ * A soft descriptor is a text, rendered on a cardholder's statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: `1` - trans_ref_no `2` - merchant_descriptor `3` - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor.
* @return softDescriptorType
**/
- @ApiModelProperty(value = "A soft descriptor is a text, rendered on a cardholder’s statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: `1` - trans_ref_no `2` - merchant_descriptor `3` - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor. ")
+ @ApiModelProperty(value = "A soft descriptor is a text, rendered on a cardholder's statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: `1` - trans_ref_no `2` - merchant_descriptor `3` - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor. ")
public String getSoftDescriptorType() {
return softDescriptorType;
}
@@ -769,7 +769,7 @@ public void setSoftDescriptorType(String softDescriptorType) {
this.softDescriptorType = softDescriptorType;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors vitalNumber(String vitalNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors vitalNumber(String vitalNumber) {
this.vitalNumber = vitalNumber;
return this;
}
@@ -787,7 +787,7 @@ public void setVitalNumber(String vitalNumber) {
this.vitalNumber = vitalNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors bankNumber(String bankNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors bankNumber(String bankNumber) {
this.bankNumber = bankNumber;
return this;
}
@@ -805,7 +805,7 @@ public void setBankNumber(String bankNumber) {
this.bankNumber = bankNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors chainNumber(String chainNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors chainNumber(String chainNumber) {
this.chainNumber = chainNumber;
return this;
}
@@ -823,7 +823,7 @@ public void setChainNumber(String chainNumber) {
this.chainNumber = chainNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantBinNumber(String merchantBinNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantBinNumber(String merchantBinNumber) {
this.merchantBinNumber = merchantBinNumber;
return this;
}
@@ -841,16 +841,16 @@ public void setMerchantBinNumber(String merchantBinNumber) {
this.merchantBinNumber = merchantBinNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantLocationNumber(String merchantLocationNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantLocationNumber(String merchantLocationNumber) {
this.merchantLocationNumber = merchantLocationNumber;
return this;
}
/**
- * 5 digit merchant location number. Unless otherwise specified by merchant’s bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.
+ * 5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.
* @return merchantLocationNumber
**/
- @ApiModelProperty(value = "5 digit merchant location number. Unless otherwise specified by merchant’s bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.")
+ @ApiModelProperty(value = "5 digit merchant location number. Unless otherwise specified by merchant's bank or processor, this field should default to 00001. Applicable for TSYS (tsys) processor.")
public String getMerchantLocationNumber() {
return merchantLocationNumber;
}
@@ -859,7 +859,7 @@ public void setMerchantLocationNumber(String merchantLocationNumber) {
this.merchantLocationNumber = merchantLocationNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors storeID(String storeID) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors storeID(String storeID) {
this.storeID = storeID;
return this;
}
@@ -877,7 +877,7 @@ public void setStoreID(String storeID) {
this.storeID = storeID;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors travelAgencyCode(String travelAgencyCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors travelAgencyCode(String travelAgencyCode) {
this.travelAgencyCode = travelAgencyCode;
return this;
}
@@ -895,7 +895,7 @@ public void setTravelAgencyCode(String travelAgencyCode) {
this.travelAgencyCode = travelAgencyCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors travelAgencyName(String travelAgencyName) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors travelAgencyName(String travelAgencyName) {
this.travelAgencyName = travelAgencyName;
return this;
}
@@ -913,7 +913,7 @@ public void setTravelAgencyName(String travelAgencyName) {
this.travelAgencyName = travelAgencyName;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors settlementCurrency(String settlementCurrency) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors settlementCurrency(String settlementCurrency) {
this.settlementCurrency = settlementCurrency;
return this;
}
@@ -931,7 +931,7 @@ public void setSettlementCurrency(String settlementCurrency) {
this.settlementCurrency = settlementCurrency;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLeastCostRouting(Boolean enableLeastCostRouting) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableLeastCostRouting(Boolean enableLeastCostRouting) {
this.enableLeastCostRouting = enableLeastCostRouting;
return this;
}
@@ -949,7 +949,7 @@ public void setEnableLeastCostRouting(Boolean enableLeastCostRouting) {
this.enableLeastCostRouting = enableLeastCostRouting;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableCVVResponseIndicator(Boolean enableCVVResponseIndicator) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableCVVResponseIndicator(Boolean enableCVVResponseIndicator) {
this.enableCVVResponseIndicator = enableCVVResponseIndicator;
return this;
}
@@ -967,7 +967,7 @@ public void setEnableCVVResponseIndicator(Boolean enableCVVResponseIndicator) {
this.enableCVVResponseIndicator = enableCVVResponseIndicator;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultiCurrencyProcessing(String enableMultiCurrencyProcessing) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableMultiCurrencyProcessing(String enableMultiCurrencyProcessing) {
this.enableMultiCurrencyProcessing = enableMultiCurrencyProcessing;
return this;
}
@@ -985,16 +985,16 @@ public void setEnableMultiCurrencyProcessing(String enableMultiCurrencyProcessin
this.enableMultiCurrencyProcessing = enableMultiCurrencyProcessing;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enablePosNetworkSwitching(Boolean enablePosNetworkSwitching) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enablePosNetworkSwitching(Boolean enablePosNetworkSwitching) {
this.enablePosNetworkSwitching = enablePosNetworkSwitching;
return this;
}
/**
- * ‘POS Network Switching’ or ‘Alternate Routing’ means merchant can process PIN Debit transactions without a PIN. Set the value to ‘Yes’ if it is supported. Applicable for FDI Global (fdiglobal) processor.
+ * 'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor.
* @return enablePosNetworkSwitching
**/
- @ApiModelProperty(value = "‘POS Network Switching’ or ‘Alternate Routing’ means merchant can process PIN Debit transactions without a PIN. Set the value to ‘Yes’ if it is supported. Applicable for FDI Global (fdiglobal) processor.")
+ @ApiModelProperty(value = "'POS Network Switching' or 'Alternate Routing' means merchant can process PIN Debit transactions without a PIN. Set the value to 'Yes' if it is supported. Applicable for FDI Global (fdiglobal) processor.")
public Boolean getEnablePosNetworkSwitching() {
return enablePosNetworkSwitching;
}
@@ -1003,7 +1003,7 @@ public void setEnablePosNetworkSwitching(Boolean enablePosNetworkSwitching) {
this.enablePosNetworkSwitching = enablePosNetworkSwitching;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableDynamicCurrencyConversion(Boolean enableDynamicCurrencyConversion) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors enableDynamicCurrencyConversion(Boolean enableDynamicCurrencyConversion) {
this.enableDynamicCurrencyConversion = enableDynamicCurrencyConversion;
return this;
}
@@ -1021,7 +1021,7 @@ public void setEnableDynamicCurrencyConversion(Boolean enableDynamicCurrencyConv
this.enableDynamicCurrencyConversion = enableDynamicCurrencyConversion;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantTier(String merchantTier) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors merchantTier(String merchantTier) {
this.merchantTier = merchantTier;
return this;
}
@@ -1048,51 +1048,51 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors = (PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors) o;
- return Objects.equals(this.batchGroup, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.batchGroup) &&
- Objects.equals(this.businessApplicationId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.businessApplicationId) &&
- Objects.equals(this.merchantVerificationValue, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantVerificationValue) &&
- Objects.equals(this.abaNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.abaNumber) &&
- Objects.equals(this.acquirer, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.acquirer) &&
- Objects.equals(this.merchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantId) &&
- Objects.equals(this.terminalId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.terminalId) &&
- Objects.equals(this.paymentTypes, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.paymentTypes) &&
- Objects.equals(this.currencies, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.currencies) &&
- Objects.equals(this.sicCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.sicCode) &&
- Objects.equals(this.allowMultipleBills, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.allowMultipleBills) &&
- Objects.equals(this.allowMerchantDescriptorOverride, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.allowMerchantDescriptorOverride) &&
- Objects.equals(this.enhancedData, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enhancedData) &&
- Objects.equals(this.fireSafetyIndicator, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.fireSafetyIndicator) &&
- Objects.equals(this.quasiCash, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.quasiCash) &&
- Objects.equals(this.acquirerMerchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.acquirerMerchantId) &&
- Objects.equals(this.avsFormat, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.avsFormat) &&
- Objects.equals(this.enableLongTransRefNo, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLongTransRefNo) &&
- Objects.equals(this.enableLevel2, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLevel2) &&
- Objects.equals(this.enableMultipleTransactionAdviceAddendum, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultipleTransactionAdviceAddendum) &&
- Objects.equals(this.amexTransactionAdviceAddendum1, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.amexTransactionAdviceAddendum1) &&
- Objects.equals(this.enableMultiLineItems, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultiLineItems) &&
- Objects.equals(this.enableTransactionReferenceNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableTransactionReferenceNumber) &&
- Objects.equals(this.enableAutoAuthReversalAfterVoid, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableAutoAuthReversalAfterVoid) &&
- Objects.equals(this.enableExpresspayPanTranslation, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableExpresspayPanTranslation) &&
- Objects.equals(this.enableCreditAuth, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableCreditAuth) &&
- Objects.equals(this.industryCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.industryCode) &&
- Objects.equals(this.sendAmexLevel2Data, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.sendAmexLevel2Data) &&
- Objects.equals(this.softDescriptorType, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.softDescriptorType) &&
- Objects.equals(this.vitalNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.vitalNumber) &&
- Objects.equals(this.bankNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.bankNumber) &&
- Objects.equals(this.chainNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.chainNumber) &&
- Objects.equals(this.merchantBinNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantBinNumber) &&
- Objects.equals(this.merchantLocationNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantLocationNumber) &&
- Objects.equals(this.storeID, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.storeID) &&
- Objects.equals(this.travelAgencyCode, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.travelAgencyCode) &&
- Objects.equals(this.travelAgencyName, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.travelAgencyName) &&
- Objects.equals(this.settlementCurrency, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.settlementCurrency) &&
- Objects.equals(this.enableLeastCostRouting, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLeastCostRouting) &&
- Objects.equals(this.enableCVVResponseIndicator, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableCVVResponseIndicator) &&
- Objects.equals(this.enableMultiCurrencyProcessing, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultiCurrencyProcessing) &&
- Objects.equals(this.enablePosNetworkSwitching, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enablePosNetworkSwitching) &&
- Objects.equals(this.enableDynamicCurrencyConversion, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableDynamicCurrencyConversion) &&
- Objects.equals(this.merchantTier, paymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantTier);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors) o;
+ return Objects.equals(this.batchGroup, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.batchGroup) &&
+ Objects.equals(this.businessApplicationId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.businessApplicationId) &&
+ Objects.equals(this.merchantVerificationValue, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantVerificationValue) &&
+ Objects.equals(this.abaNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.abaNumber) &&
+ Objects.equals(this.acquirer, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.acquirer) &&
+ Objects.equals(this.merchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantId) &&
+ Objects.equals(this.terminalId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.terminalId) &&
+ Objects.equals(this.paymentTypes, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.paymentTypes) &&
+ Objects.equals(this.currencies, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.currencies) &&
+ Objects.equals(this.sicCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.sicCode) &&
+ Objects.equals(this.allowMultipleBills, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.allowMultipleBills) &&
+ Objects.equals(this.allowMerchantDescriptorOverride, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.allowMerchantDescriptorOverride) &&
+ Objects.equals(this.enhancedData, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enhancedData) &&
+ Objects.equals(this.fireSafetyIndicator, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.fireSafetyIndicator) &&
+ Objects.equals(this.quasiCash, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.quasiCash) &&
+ Objects.equals(this.acquirerMerchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.acquirerMerchantId) &&
+ Objects.equals(this.avsFormat, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.avsFormat) &&
+ Objects.equals(this.enableLongTransRefNo, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLongTransRefNo) &&
+ Objects.equals(this.enableLevel2, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLevel2) &&
+ Objects.equals(this.enableMultipleTransactionAdviceAddendum, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultipleTransactionAdviceAddendum) &&
+ Objects.equals(this.amexTransactionAdviceAddendum1, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.amexTransactionAdviceAddendum1) &&
+ Objects.equals(this.enableMultiLineItems, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultiLineItems) &&
+ Objects.equals(this.enableTransactionReferenceNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableTransactionReferenceNumber) &&
+ Objects.equals(this.enableAutoAuthReversalAfterVoid, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableAutoAuthReversalAfterVoid) &&
+ Objects.equals(this.enableExpresspayPanTranslation, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableExpresspayPanTranslation) &&
+ Objects.equals(this.enableCreditAuth, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableCreditAuth) &&
+ Objects.equals(this.industryCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.industryCode) &&
+ Objects.equals(this.sendAmexLevel2Data, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.sendAmexLevel2Data) &&
+ Objects.equals(this.softDescriptorType, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.softDescriptorType) &&
+ Objects.equals(this.vitalNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.vitalNumber) &&
+ Objects.equals(this.bankNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.bankNumber) &&
+ Objects.equals(this.chainNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.chainNumber) &&
+ Objects.equals(this.merchantBinNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantBinNumber) &&
+ Objects.equals(this.merchantLocationNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantLocationNumber) &&
+ Objects.equals(this.storeID, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.storeID) &&
+ Objects.equals(this.travelAgencyCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.travelAgencyCode) &&
+ Objects.equals(this.travelAgencyName, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.travelAgencyName) &&
+ Objects.equals(this.settlementCurrency, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.settlementCurrency) &&
+ Objects.equals(this.enableLeastCostRouting, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableLeastCostRouting) &&
+ Objects.equals(this.enableCVVResponseIndicator, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableCVVResponseIndicator) &&
+ Objects.equals(this.enableMultiCurrencyProcessing, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableMultiCurrencyProcessing) &&
+ Objects.equals(this.enablePosNetworkSwitching, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enablePosNetworkSwitching) &&
+ Objects.equals(this.enableDynamicCurrencyConversion, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.enableDynamicCurrencyConversion) &&
+ Objects.equals(this.merchantTier, paymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.merchantTier);
}
@Override
@@ -1104,7 +1104,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors {\n");
sb.append(" batchGroup: ").append(toIndentedString(batchGroup)).append("\n");
sb.append(" businessApplicationId: ").append(toIndentedString(businessApplicationId)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures.java
similarity index 50%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures.java
index 664fbdfde..6dfddcb76 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -26,17 +26,17 @@
import java.io.IOException;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures {
@SerializedName("cardNotPresent")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent = null;
@SerializedName("cardPresent")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures cardNotPresent(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures cardNotPresent(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent) {
this.cardNotPresent = cardNotPresent;
return this;
}
@@ -46,15 +46,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return cardNotPresent
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent getCardNotPresent() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent getCardNotPresent() {
return cardNotPresent;
}
- public void setCardNotPresent(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent) {
+ public void setCardNotPresent(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent cardNotPresent) {
this.cardNotPresent = cardNotPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures cardPresent(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures cardPresent(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent) {
this.cardPresent = cardPresent;
return this;
}
@@ -64,11 +64,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return cardPresent
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent getCardPresent() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent getCardPresent() {
return cardPresent;
}
- public void setCardPresent(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent) {
+ public void setCardPresent(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent cardPresent) {
this.cardPresent = cardPresent;
}
@@ -81,9 +81,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures paymentProductsCardProcessingConfigurationInformationConfigurationsFeatures = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures) o;
- return Objects.equals(this.cardNotPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsFeatures.cardNotPresent) &&
- Objects.equals(this.cardPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsFeatures.cardPresent);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures paymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures) o;
+ return Objects.equals(this.cardNotPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures.cardNotPresent) &&
+ Objects.equals(this.cardPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures.cardPresent);
}
@Override
@@ -95,7 +95,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatures {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeatures {\n");
sb.append(" cardNotPresent: ").append(toIndentedString(cardNotPresent)).append("\n");
sb.append(" cardPresent: ").append(toIndentedString(cardPresent)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java
similarity index 61%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java
index 27cc5f811..fddc9470c 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.java
@@ -14,8 +14,8 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -29,12 +29,12 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent {
@SerializedName("processors")
- private Map processors = null;
+ private Map processors = null;
@SerializedName("ignoreAddressVerificationSystem")
private Boolean ignoreAddressVerificationSystem = null;
@@ -46,16 +46,16 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
private String amexTransactionAdviceAddendum1 = null;
@SerializedName("installment")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent processors(Map processors) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent processors(Map processors) {
this.processors = processors;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent putProcessorsItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors processorsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent putProcessorsItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors processorsItem) {
if (this.processors == null) {
- this.processors = new HashMap();
+ this.processors = new HashMap();
}
this.processors.put(key, processorsItem);
return this;
@@ -66,15 +66,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return processors
**/
@ApiModelProperty(value = "e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> ")
- public Map getProcessors() {
+ public Map getProcessors() {
return processors;
}
- public void setProcessors(Map processors) {
+ public void setProcessors(Map processors) {
this.processors = processors;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent ignoreAddressVerificationSystem(Boolean ignoreAddressVerificationSystem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent ignoreAddressVerificationSystem(Boolean ignoreAddressVerificationSystem) {
this.ignoreAddressVerificationSystem = ignoreAddressVerificationSystem;
return this;
}
@@ -92,7 +92,7 @@ public void setIgnoreAddressVerificationSystem(Boolean ignoreAddressVerification
this.ignoreAddressVerificationSystem = ignoreAddressVerificationSystem;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent visaStraightThroughProcessingOnly(Boolean visaStraightThroughProcessingOnly) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent visaStraightThroughProcessingOnly(Boolean visaStraightThroughProcessingOnly) {
this.visaStraightThroughProcessingOnly = visaStraightThroughProcessingOnly;
return this;
}
@@ -110,16 +110,16 @@ public void setVisaStraightThroughProcessingOnly(Boolean visaStraightThroughProc
this.visaStraightThroughProcessingOnly = visaStraightThroughProcessingOnly;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent amexTransactionAdviceAddendum1(String amexTransactionAdviceAddendum1) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent amexTransactionAdviceAddendum1(String amexTransactionAdviceAddendum1) {
this.amexTransactionAdviceAddendum1 = amexTransactionAdviceAddendum1;
return this;
}
/**
- * Advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
+ * Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.
* @return amexTransactionAdviceAddendum1
**/
- @ApiModelProperty(value = "Advice addendum field. It is used to display descriptive information about a transaction on customer’s American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.")
+ @ApiModelProperty(value = "Advice addendum field. It is used to display descriptive information about a transaction on customer's American Express card statement. Applicable for TSYS (tsys), FDI Global (fdiglobal) and American Express Direct (amexdirect) processors.")
public String getAmexTransactionAdviceAddendum1() {
return amexTransactionAdviceAddendum1;
}
@@ -128,7 +128,7 @@ public void setAmexTransactionAdviceAddendum1(String amexTransactionAdviceAddend
this.amexTransactionAdviceAddendum1 = amexTransactionAdviceAddendum1;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent installment(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent installment(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment) {
this.installment = installment;
return this;
}
@@ -138,11 +138,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return installment
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment getInstallment() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment getInstallment() {
return installment;
}
- public void setInstallment(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment) {
+ public void setInstallment(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installment) {
this.installment = installment;
}
@@ -155,12 +155,12 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent) o;
- return Objects.equals(this.processors, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.processors) &&
- Objects.equals(this.ignoreAddressVerificationSystem, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.ignoreAddressVerificationSystem) &&
- Objects.equals(this.visaStraightThroughProcessingOnly, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.visaStraightThroughProcessingOnly) &&
- Objects.equals(this.amexTransactionAdviceAddendum1, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.amexTransactionAdviceAddendum1) &&
- Objects.equals(this.installment, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.installment);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent) o;
+ return Objects.equals(this.processors, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.processors) &&
+ Objects.equals(this.ignoreAddressVerificationSystem, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.ignoreAddressVerificationSystem) &&
+ Objects.equals(this.visaStraightThroughProcessingOnly, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.visaStraightThroughProcessingOnly) &&
+ Objects.equals(this.amexTransactionAdviceAddendum1, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.amexTransactionAdviceAddendum1) &&
+ Objects.equals(this.installment, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent.installment);
}
@Override
@@ -172,7 +172,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresent {\n");
sb.append(" processors: ").append(toIndentedString(processors)).append("\n");
sb.append(" ignoreAddressVerificationSystem: ").append(toIndentedString(ignoreAddressVerificationSystem)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java
similarity index 77%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java
index c6fff8186..d714d3688 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.java
@@ -24,17 +24,17 @@
import java.io.IOException;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment {
@SerializedName("enableInstallment")
private Boolean enableInstallment = null;
@SerializedName("installmentPlan")
private String installmentPlan = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment enableInstallment(Boolean enableInstallment) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment enableInstallment(Boolean enableInstallment) {
this.enableInstallment = enableInstallment;
return this;
}
@@ -52,7 +52,7 @@ public void setEnableInstallment(Boolean enableInstallment) {
this.enableInstallment = enableInstallment;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installmentPlan(String installmentPlan) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment installmentPlan(String installmentPlan) {
this.installmentPlan = installmentPlan;
return this;
}
@@ -79,9 +79,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment) o;
- return Objects.equals(this.enableInstallment, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.enableInstallment) &&
- Objects.equals(this.installmentPlan, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.installmentPlan);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment) o;
+ return Objects.equals(this.enableInstallment, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.enableInstallment) &&
+ Objects.equals(this.installmentPlan, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment.installmentPlan);
}
@Override
@@ -93,7 +93,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentInstallment {\n");
sb.append(" enableInstallment: ").append(toIndentedString(enableInstallment)).append("\n");
sb.append(" installmentPlan: ").append(toIndentedString(installmentPlan)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java
similarity index 70%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java
index dd03e02fa..b435d7147 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -28,10 +28,10 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts {
@SerializedName("reimbursementCode")
private String reimbursementCode = null;
@@ -51,7 +51,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
private String networkOrder = null;
@SerializedName("currencies")
- private Map currencies = null;
+ private Map currencies = null;
@SerializedName("merchantId")
private String merchantId = null;
@@ -59,7 +59,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("terminalId")
private String terminalId = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts reimbursementCode(String reimbursementCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts reimbursementCode(String reimbursementCode) {
this.reimbursementCode = reimbursementCode;
return this;
}
@@ -77,7 +77,7 @@ public void setReimbursementCode(String reimbursementCode) {
this.reimbursementCode = reimbursementCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts acquiringInstitutionId(String acquiringInstitutionId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts acquiringInstitutionId(String acquiringInstitutionId) {
this.acquiringInstitutionId = acquiringInstitutionId;
return this;
}
@@ -95,7 +95,7 @@ public void setAcquiringInstitutionId(String acquiringInstitutionId) {
this.acquiringInstitutionId = acquiringInstitutionId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts businessApplicationId(String businessApplicationId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts businessApplicationId(String businessApplicationId) {
this.businessApplicationId = businessApplicationId;
return this;
}
@@ -113,7 +113,7 @@ public void setBusinessApplicationId(String businessApplicationId) {
this.businessApplicationId = businessApplicationId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts financialInstitutionId(String financialInstitutionId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts financialInstitutionId(String financialInstitutionId) {
this.financialInstitutionId = financialInstitutionId;
return this;
}
@@ -131,7 +131,7 @@ public void setFinancialInstitutionId(String financialInstitutionId) {
this.financialInstitutionId = financialInstitutionId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts merchantAbaNumber(String merchantAbaNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts merchantAbaNumber(String merchantAbaNumber) {
this.merchantAbaNumber = merchantAbaNumber;
return this;
}
@@ -149,7 +149,7 @@ public void setMerchantAbaNumber(String merchantAbaNumber) {
this.merchantAbaNumber = merchantAbaNumber;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts networkOrder(String networkOrder) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts networkOrder(String networkOrder) {
this.networkOrder = networkOrder;
return this;
}
@@ -167,14 +167,14 @@ public void setNetworkOrder(String networkOrder) {
this.networkOrder = networkOrder;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts currencies(Map currencies) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts currencies(Map currencies) {
this.currencies = currencies;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts putCurrenciesItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies currenciesItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts putCurrenciesItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies currenciesItem) {
if (this.currencies == null) {
- this.currencies = new HashMap();
+ this.currencies = new HashMap();
}
this.currencies.put(key, currenciesItem);
return this;
@@ -185,15 +185,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return currencies
**/
@ApiModelProperty(example = "{\"USD\":{\"enabled\":true,\"enabledCardPresent\":false,\"enabledCardNotPresent\":true,\"merchantId\":\"merchantId\",\"terminalIds\":[\"12345678\",\"12345678\"],\"serviceEnablementNumber\":\"serviceEnablementNumber\"}}", value = "Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)")
- public Map getCurrencies() {
+ public Map getCurrencies() {
return currencies;
}
- public void setCurrencies(Map currencies) {
+ public void setCurrencies(Map currencies) {
this.currencies = currencies;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts merchantId(String merchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts merchantId(String merchantId) {
this.merchantId = merchantId;
return this;
}
@@ -211,7 +211,7 @@ public void setMerchantId(String merchantId) {
this.merchantId = merchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts terminalId(String terminalId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts terminalId(String terminalId) {
this.terminalId = terminalId;
return this;
}
@@ -238,16 +238,16 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts) o;
- return Objects.equals(this.reimbursementCode, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.reimbursementCode) &&
- Objects.equals(this.acquiringInstitutionId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.acquiringInstitutionId) &&
- Objects.equals(this.businessApplicationId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.businessApplicationId) &&
- Objects.equals(this.financialInstitutionId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.financialInstitutionId) &&
- Objects.equals(this.merchantAbaNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.merchantAbaNumber) &&
- Objects.equals(this.networkOrder, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.networkOrder) &&
- Objects.equals(this.currencies, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.currencies) &&
- Objects.equals(this.merchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.merchantId) &&
- Objects.equals(this.terminalId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.terminalId);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts) o;
+ return Objects.equals(this.reimbursementCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.reimbursementCode) &&
+ Objects.equals(this.acquiringInstitutionId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.acquiringInstitutionId) &&
+ Objects.equals(this.businessApplicationId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.businessApplicationId) &&
+ Objects.equals(this.financialInstitutionId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.financialInstitutionId) &&
+ Objects.equals(this.merchantAbaNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.merchantAbaNumber) &&
+ Objects.equals(this.networkOrder, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.networkOrder) &&
+ Objects.equals(this.currencies, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.currencies) &&
+ Objects.equals(this.merchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.merchantId) &&
+ Objects.equals(this.terminalId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts.terminalId);
}
@Override
@@ -259,7 +259,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts {\n");
sb.append(" reimbursementCode: ").append(toIndentedString(reimbursementCode)).append("\n");
sb.append(" acquiringInstitutionId: ").append(toIndentedString(acquiringInstitutionId)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java
similarity index 70%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java
index 10a81de06..17e203c39 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.java
@@ -26,10 +26,10 @@
import java.util.List;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies {
@SerializedName("enabled")
private Boolean enabled = null;
@@ -51,7 +51,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("serviceEnablementNumber")
private String serviceEnablementNumber = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabled(Boolean enabled) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -69,7 +69,7 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabledCardPresent(Boolean enabledCardPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
return this;
}
@@ -87,7 +87,7 @@ public void setEnabledCardPresent(Boolean enabledCardPresent) {
this.enabledCardPresent = enabledCardPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabledCardNotPresent(Boolean enabledCardNotPresent) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies enabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
return this;
}
@@ -105,7 +105,7 @@ public void setEnabledCardNotPresent(Boolean enabledCardNotPresent) {
this.enabledCardNotPresent = enabledCardNotPresent;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies merchantId(String merchantId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies merchantId(String merchantId) {
this.merchantId = merchantId;
return this;
}
@@ -123,7 +123,7 @@ public void setMerchantId(String merchantId) {
this.merchantId = merchantId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies terminalId(String terminalId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies terminalId(String terminalId) {
this.terminalId = terminalId;
return this;
}
@@ -141,12 +141,12 @@ public void setTerminalId(String terminalId) {
this.terminalId = terminalId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies terminalIds(List terminalIds) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies terminalIds(List terminalIds) {
this.terminalIds = terminalIds;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies addTerminalIdsItem(String terminalIdsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies addTerminalIdsItem(String terminalIdsItem) {
if (this.terminalIds == null) {
this.terminalIds = new ArrayList();
}
@@ -167,7 +167,7 @@ public void setTerminalIds(List terminalIds) {
this.terminalIds = terminalIds;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies serviceEnablementNumber(String serviceEnablementNumber) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies serviceEnablementNumber(String serviceEnablementNumber) {
this.serviceEnablementNumber = serviceEnablementNumber;
return this;
}
@@ -194,14 +194,14 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies) o;
- return Objects.equals(this.enabled, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabled) &&
- Objects.equals(this.enabledCardPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabledCardPresent) &&
- Objects.equals(this.enabledCardNotPresent, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabledCardNotPresent) &&
- Objects.equals(this.merchantId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.merchantId) &&
- Objects.equals(this.terminalId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.terminalId) &&
- Objects.equals(this.terminalIds, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.terminalIds) &&
- Objects.equals(this.serviceEnablementNumber, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.serviceEnablementNumber);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies) o;
+ return Objects.equals(this.enabled, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabled) &&
+ Objects.equals(this.enabledCardPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabledCardPresent) &&
+ Objects.equals(this.enabledCardNotPresent, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.enabledCardNotPresent) &&
+ Objects.equals(this.merchantId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.merchantId) &&
+ Objects.equals(this.terminalId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.terminalId) &&
+ Objects.equals(this.terminalIds, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.terminalIds) &&
+ Objects.equals(this.serviceEnablementNumber, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies.serviceEnablementNumber);
}
@Override
@@ -213,7 +213,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayoutsCurrencies {\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" enabledCardPresent: ").append(toIndentedString(enabledCardPresent)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java
similarity index 78%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java
index 4883d89e3..7c65b107f 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -25,10 +25,10 @@
import java.io.IOException;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors {
@SerializedName("relaxAddressVerificationSystem")
private Boolean relaxAddressVerificationSystem = null;
@@ -45,9 +45,9 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
private String prestigiousPropertyIndicator = null;
@SerializedName("payouts")
- private PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts = null;
+ private PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystem(Boolean relaxAddressVerificationSystem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystem(Boolean relaxAddressVerificationSystem) {
this.relaxAddressVerificationSystem = relaxAddressVerificationSystem;
return this;
}
@@ -65,7 +65,7 @@ public void setRelaxAddressVerificationSystem(Boolean relaxAddressVerificationSy
this.relaxAddressVerificationSystem = relaxAddressVerificationSystem;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystemAllowZipWithoutCountry(Boolean relaxAddressVerificationSystemAllowZipWithoutCountry) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystemAllowZipWithoutCountry(Boolean relaxAddressVerificationSystemAllowZipWithoutCountry) {
this.relaxAddressVerificationSystemAllowZipWithoutCountry = relaxAddressVerificationSystemAllowZipWithoutCountry;
return this;
}
@@ -83,7 +83,7 @@ public void setRelaxAddressVerificationSystemAllowZipWithoutCountry(Boolean rela
this.relaxAddressVerificationSystemAllowZipWithoutCountry = relaxAddressVerificationSystemAllowZipWithoutCountry;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystemAllowExpiredCard(Boolean relaxAddressVerificationSystemAllowExpiredCard) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors relaxAddressVerificationSystemAllowExpiredCard(Boolean relaxAddressVerificationSystemAllowExpiredCard) {
this.relaxAddressVerificationSystemAllowExpiredCard = relaxAddressVerificationSystemAllowExpiredCard;
return this;
}
@@ -101,7 +101,7 @@ public void setRelaxAddressVerificationSystemAllowExpiredCard(Boolean relaxAddre
this.relaxAddressVerificationSystemAllowExpiredCard = relaxAddressVerificationSystemAllowExpiredCard;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors enableEmsTransactionRiskScore(Boolean enableEmsTransactionRiskScore) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors enableEmsTransactionRiskScore(Boolean enableEmsTransactionRiskScore) {
this.enableEmsTransactionRiskScore = enableEmsTransactionRiskScore;
return this;
}
@@ -119,7 +119,7 @@ public void setEnableEmsTransactionRiskScore(Boolean enableEmsTransactionRiskSco
this.enableEmsTransactionRiskScore = enableEmsTransactionRiskScore;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors prestigiousPropertyIndicator(String prestigiousPropertyIndicator) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors prestigiousPropertyIndicator(String prestigiousPropertyIndicator) {
this.prestigiousPropertyIndicator = prestigiousPropertyIndicator;
return this;
}
@@ -137,7 +137,7 @@ public void setPrestigiousPropertyIndicator(String prestigiousPropertyIndicator)
this.prestigiousPropertyIndicator = prestigiousPropertyIndicator;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors payouts(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors payouts(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts) {
this.payouts = payouts;
return this;
}
@@ -147,11 +147,11 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return payouts
**/
@ApiModelProperty(value = "")
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts getPayouts() {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts getPayouts() {
return payouts;
}
- public void setPayouts(PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts) {
+ public void setPayouts(PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentPayouts payouts) {
this.payouts = payouts;
}
@@ -164,13 +164,13 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors) o;
- return Objects.equals(this.relaxAddressVerificationSystem, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystem) &&
- Objects.equals(this.relaxAddressVerificationSystemAllowZipWithoutCountry, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystemAllowZipWithoutCountry) &&
- Objects.equals(this.relaxAddressVerificationSystemAllowExpiredCard, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystemAllowExpiredCard) &&
- Objects.equals(this.enableEmsTransactionRiskScore, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.enableEmsTransactionRiskScore) &&
- Objects.equals(this.prestigiousPropertyIndicator, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.prestigiousPropertyIndicator) &&
- Objects.equals(this.payouts, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.payouts);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors) o;
+ return Objects.equals(this.relaxAddressVerificationSystem, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystem) &&
+ Objects.equals(this.relaxAddressVerificationSystemAllowZipWithoutCountry, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystemAllowZipWithoutCountry) &&
+ Objects.equals(this.relaxAddressVerificationSystemAllowExpiredCard, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.relaxAddressVerificationSystemAllowExpiredCard) &&
+ Objects.equals(this.enableEmsTransactionRiskScore, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.enableEmsTransactionRiskScore) &&
+ Objects.equals(this.prestigiousPropertyIndicator, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.prestigiousPropertyIndicator) &&
+ Objects.equals(this.payouts, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors.payouts);
}
@Override
@@ -182,7 +182,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardNotPresentProcessors {\n");
sb.append(" relaxAddressVerificationSystem: ").append(toIndentedString(relaxAddressVerificationSystem)).append("\n");
sb.append(" relaxAddressVerificationSystemAllowZipWithoutCountry: ").append(toIndentedString(relaxAddressVerificationSystemAllowZipWithoutCountry)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java
similarity index 62%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java
index d00d52f8c..dabdf9316 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors;
+import Model.PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -28,24 +28,24 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent {
@SerializedName("processors")
- private Map processors = null;
+ private Map processors = null;
@SerializedName("enableTerminalIdLookup")
private Boolean enableTerminalIdLookup = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent processors(Map processors) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent processors(Map processors) {
this.processors = processors;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent putProcessorsItem(String key, PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors processorsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent putProcessorsItem(String key, PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors processorsItem) {
if (this.processors == null) {
- this.processors = new HashMap();
+ this.processors = new HashMap();
}
this.processors.put(key, processorsItem);
return this;
@@ -56,15 +56,15 @@ public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeatur
* @return processors
**/
@ApiModelProperty(value = "e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> ")
- public Map getProcessors() {
+ public Map getProcessors() {
return processors;
}
- public void setProcessors(Map processors) {
+ public void setProcessors(Map processors) {
this.processors = processors;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent enableTerminalIdLookup(Boolean enableTerminalIdLookup) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent enableTerminalIdLookup(Boolean enableTerminalIdLookup) {
this.enableTerminalIdLookup = enableTerminalIdLookup;
return this;
}
@@ -91,9 +91,9 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent) o;
- return Objects.equals(this.processors, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.processors) &&
- Objects.equals(this.enableTerminalIdLookup, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.enableTerminalIdLookup);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent) o;
+ return Objects.equals(this.processors, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.processors) &&
+ Objects.equals(this.enableTerminalIdLookup, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent.enableTerminalIdLookup);
}
@Override
@@ -105,7 +105,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresent {\n");
sb.append(" processors: ").append(toIndentedString(processors)).append("\n");
sb.append(" enableTerminalIdLookup: ").append(toIndentedString(enableTerminalIdLookup)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java
similarity index 75%
rename from src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java
rename to src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java
index 62f95e42a..37077dcc3 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.java
@@ -26,10 +26,10 @@
import java.util.List;
/**
- * PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors
+ * PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors
*/
-public class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors {
+public class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors {
@SerializedName("defaultPointOfSaleTerminalId")
private String defaultPointOfSaleTerminalId = null;
@@ -51,7 +51,7 @@ public class PaymentProductsCardProcessingConfigurationInformationConfigurations
@SerializedName("enablePinTranslation")
private Boolean enablePinTranslation = null;
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors defaultPointOfSaleTerminalId(String defaultPointOfSaleTerminalId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors defaultPointOfSaleTerminalId(String defaultPointOfSaleTerminalId) {
this.defaultPointOfSaleTerminalId = defaultPointOfSaleTerminalId;
return this;
}
@@ -69,12 +69,12 @@ public void setDefaultPointOfSaleTerminalId(String defaultPointOfSaleTerminalId)
this.defaultPointOfSaleTerminalId = defaultPointOfSaleTerminalId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pointOfSaleTerminalIds(List pointOfSaleTerminalIds) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pointOfSaleTerminalIds(List pointOfSaleTerminalIds) {
this.pointOfSaleTerminalIds = pointOfSaleTerminalIds;
return this;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors addPointOfSaleTerminalIdsItem(String pointOfSaleTerminalIdsItem) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors addPointOfSaleTerminalIdsItem(String pointOfSaleTerminalIdsItem) {
if (this.pointOfSaleTerminalIds == null) {
this.pointOfSaleTerminalIds = new ArrayList();
}
@@ -95,7 +95,7 @@ public void setPointOfSaleTerminalIds(List pointOfSaleTerminalIds) {
this.pointOfSaleTerminalIds = pointOfSaleTerminalIds;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors disablePointOfSaleTerminalIdValidation(Boolean disablePointOfSaleTerminalIdValidation) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors disablePointOfSaleTerminalIdValidation(Boolean disablePointOfSaleTerminalIdValidation) {
this.disablePointOfSaleTerminalIdValidation = disablePointOfSaleTerminalIdValidation;
return this;
}
@@ -113,7 +113,7 @@ public void setDisablePointOfSaleTerminalIdValidation(Boolean disablePointOfSale
this.disablePointOfSaleTerminalIdValidation = disablePointOfSaleTerminalIdValidation;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pinDebitNetworkOrder(String pinDebitNetworkOrder) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pinDebitNetworkOrder(String pinDebitNetworkOrder) {
this.pinDebitNetworkOrder = pinDebitNetworkOrder;
return this;
}
@@ -131,7 +131,7 @@ public void setPinDebitNetworkOrder(String pinDebitNetworkOrder) {
this.pinDebitNetworkOrder = pinDebitNetworkOrder;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pinDebitReimbursementCode(String pinDebitReimbursementCode) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors pinDebitReimbursementCode(String pinDebitReimbursementCode) {
this.pinDebitReimbursementCode = pinDebitReimbursementCode;
return this;
}
@@ -149,7 +149,7 @@ public void setPinDebitReimbursementCode(String pinDebitReimbursementCode) {
this.pinDebitReimbursementCode = pinDebitReimbursementCode;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors financialInstitutionId(String financialInstitutionId) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors financialInstitutionId(String financialInstitutionId) {
this.financialInstitutionId = financialInstitutionId;
return this;
}
@@ -167,7 +167,7 @@ public void setFinancialInstitutionId(String financialInstitutionId) {
this.financialInstitutionId = financialInstitutionId;
}
- public PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors enablePinTranslation(Boolean enablePinTranslation) {
+ public PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors enablePinTranslation(Boolean enablePinTranslation) {
this.enablePinTranslation = enablePinTranslation;
return this;
}
@@ -194,14 +194,14 @@ public boolean equals(java.lang.Object o) {
if (o == null || getClass() != o.getClass()) {
return false;
}
- PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors = (PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors) o;
- return Objects.equals(this.defaultPointOfSaleTerminalId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.defaultPointOfSaleTerminalId) &&
- Objects.equals(this.pointOfSaleTerminalIds, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pointOfSaleTerminalIds) &&
- Objects.equals(this.disablePointOfSaleTerminalIdValidation, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.disablePointOfSaleTerminalIdValidation) &&
- Objects.equals(this.pinDebitNetworkOrder, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pinDebitNetworkOrder) &&
- Objects.equals(this.pinDebitReimbursementCode, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pinDebitReimbursementCode) &&
- Objects.equals(this.financialInstitutionId, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.financialInstitutionId) &&
- Objects.equals(this.enablePinTranslation, paymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.enablePinTranslation);
+ PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors = (PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors) o;
+ return Objects.equals(this.defaultPointOfSaleTerminalId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.defaultPointOfSaleTerminalId) &&
+ Objects.equals(this.pointOfSaleTerminalIds, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pointOfSaleTerminalIds) &&
+ Objects.equals(this.disablePointOfSaleTerminalIdValidation, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.disablePointOfSaleTerminalIdValidation) &&
+ Objects.equals(this.pinDebitNetworkOrder, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pinDebitNetworkOrder) &&
+ Objects.equals(this.pinDebitReimbursementCode, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.pinDebitReimbursementCode) &&
+ Objects.equals(this.financialInstitutionId, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.financialInstitutionId) &&
+ Objects.equals(this.enablePinTranslation, paymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors.enablePinTranslation);
}
@Override
@@ -213,7 +213,7 @@ public int hashCode() {
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("class PaymentProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors {\n");
+ sb.append("class PaymentsProductsCardProcessingConfigurationInformationConfigurationsFeaturesCardPresentProcessors {\n");
sb.append(" defaultPointOfSaleTerminalId: ").append(toIndentedString(defaultPointOfSaleTerminalId)).append("\n");
sb.append(" pointOfSaleTerminalIds: ").append(toIndentedString(pointOfSaleTerminalIds)).append("\n");
diff --git a/src/main/java/Model/PaymentProductsCardProcessingSubscriptionInformation.java b/src/main/java/Model/PaymentsProductsCardProcessingSubscriptionInformation.java
similarity index 73%
rename from src/main/java/Model/PaymentProductsCardProcessingSubscriptionInformation.java
rename to src/main/java/Model/PaymentsProductsCardProcessingSubscriptionInformation.java
index 6e590811f..7deffcf8b 100644
--- a/src/main/java/Model/PaymentProductsCardProcessingSubscriptionInformation.java
+++ b/src/main/java/Model/PaymentsProductsCardProcessingSubscriptionInformation.java
@@ -14,7 +14,7 @@
package Model;
import java.util.Objects;
-import Model.PaymentProductsCardProcessingSubscriptionInformationFeatures;
+import Model.PaymentsProductsCardProcessingSubscriptionInformationFeatures;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
@@ -28,10 +28,10 @@
import java.util.Map;
/**
- * PaymentProductsCardProcessingSubscriptionInformation
+ * PaymentsProductsCardProcessingSubscriptionInformation
*/
-public class PaymentProductsCardProcessingSubscriptionInformation {
+public class PaymentsProductsCardProcessingSubscriptionInformation {
@SerializedName("enabled")
private Boolean enabled = null;
@@ -88,9 +88,9 @@ public SelfServiceabilityEnum read(final JsonReader jsonReader) throws IOExcepti
private SelfServiceabilityEnum selfServiceability = SelfServiceabilityEnum.NOT_SELF_SERVICEABLE;
@SerializedName("features")
- private Map features = null;
+ private Map features = null;
- public PaymentProductsCardProcessingSubscriptionInformation enabled(Boolean enabled) {
+ public PaymentsProductsCardProcessingSubscriptionInformation enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
@@ -108,7 +108,7 @@ public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
- public PaymentProductsCardProcessingSubscriptionInformation selfServiceability(SelfServiceabilityEnum selfServiceability) {
+ public PaymentsProductsCardProcessingSubscriptionInformation selfServiceability(SelfServiceabilityEnum selfServiceability) {
this.selfServiceability = selfServiceability;
return this;
}
@@ -126,14 +126,14 @@ public void setSelfServiceability(SelfServiceabilityEnum selfServiceability) {
this.selfServiceability = selfServiceability;
}
- public PaymentProductsCardProcessingSubscriptionInformation features(Map features) {
+ public PaymentsProductsCardProcessingSubscriptionInformation features(Map features) {
this.features = features;
return this;
}
- public PaymentProductsCardProcessingSubscriptionInformation putFeaturesItem(String key, PaymentProductsCardProcessingSubscriptionInformationFeatures featuresItem) {
+ public PaymentsProductsCardProcessingSubscriptionInformation putFeaturesItem(String key, PaymentsProductsCardProcessingSubscriptionInformationFeatures featuresItem) {
if (this.features == null) {
- this.features = new HashMap();
+ this.features = new HashMap();
}
this.features.put(key, featuresItem);
return this;
@@ -144,11 +144,11 @@ public PaymentProductsCardProcessingSubscriptionInformation putFeaturesItem(Stri
* @return features
**/
@ApiModelProperty(value = "This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled.