swagger: '2.0' info: description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html version: 0.0.1 title: CyberSource Merged Spec bankAccountValidation payments API host: apitest.cybersource.com basePath: / schemes: - https consumes: - application/json;charset=utf-8 produces: - application/hal+json;charset=utf-8 tags: - name: payments description: 'A payment authorizes the amount for the transaction. There are a number of supported payment instruments, such as Credit Card, Debit Card, e-Wallet, and Alternative Payments. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. ' paths: /pts/v2/payments: post: summary: Process a Payment description: 'A payment authorizes the amount for the transaction. There are a number of supported payment features, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation. ' tags: - payments operationId: createPayment produces: - application/hal+json;charset=utf-8 consumes: - application/json;charset=utf-8 x-devcenter-metaData: categoryTag: Payments testingTriggers: https://developer.cybersource.com/hello-world/testing-guide.html responseCodes: https://developer.cybersource.com/api/reference/response-codes.html developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: createPaymentRequest in: body required: true schema: type: object properties: clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' pausedRequestId: type: string maxLength: 26 description: 'Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. ' transactionId: type: string maxLength: 30 description: 'Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. ' comments: type: string description: Brief description of the order or any comment you wish to add to the order. partner: type: object properties: originalTransactionId: type: string maxLength: 32 description: 'Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal''s software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal''s software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. ' developerId: type: string maxLength: 8 description: 'Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. ' solutionId: type: string maxLength: 8 description: 'Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. ' thirdPartyCertificationNumber: type: string maxLength: 12 description: 'Value that identifies the application vendor and application version for a third party gateway. CyberSource provides you with this value during testing and validation. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void** Optional field. #### PIN debit Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request. ' applicationName: type: string description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. ' applicationVersion: type: string description: 'Version of the CyberSource application or integration used for a transaction. ' applicationUser: type: string description: 'The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. ' processingInformation: type: object properties: actionList: type: array description: "Array of actions (one or more) to be included in the payment to invoke bundled services along with payment.\n\nPossible values are one or more of follows:\n\n - `DECISION_SKIP`: Use this when you want to skip Decision Manager service(s).\n\n - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your payment request.\n\n - `CONSUMER_AUTHENTICATION`: Use this when you want to check if a card is enrolled in Payer Authentication along with your payment request.\n\n - `VALIDATE_CONSUMER_AUTHENTICATION`: Use this after you acquire a Payer Authentication result that needs to be included for your payment request.\n \n - `AP_INITIATE`: Use this when Alternative Payment Initiate service is requested.\n\n - `WATCHLIST_SCREENING` : Use this when you want to call Watchlist Screening service.\n\n - `AP_SALE` : Use this when Alternative Payment Sale service is requested.\n\n\n - `AP_AUTH` : Use this when Alternative Payment Authorize service is requested.\n\n - `AP_REAUTH` : Use this when Alternative Payment Reauthorize service is requested.\n" items: type: string enableEscrowOption: type: boolean 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 description: 'CyberSource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Valid values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress ' items: type: string binSource: type: string description: 'Bin Source File Identifier. Possible values: - itmx - rupay ' capture: type: boolean description: 'Indicates whether to also include a capture in the submitted authorization request or not. Possible values: - `true`: Include a capture with an authorization request. - `false`: (default) Do not include a capture with an authorization request. #### Used by **Authorization and Capture** Optional field. ' default: false processorId: type: string maxLength: 3 description: 'Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. ' businessApplicationId: type: string description: "Required for AFT and OCT transactions.\n\nGiven below is a list of all the BAI values available. However, the processors may support only few specific BAI values.\n\n- AA : Account-to-account \n- BB : Supplier Payments\n- BI : Bank-Initiated P2P Money Transfer\n- BP : Non-Card Bill Pay/Bill Pay\n- CD : Cash Deposit\n- CP : Credit card Bill Payment\n- FD : Funds disbursement \n- FT : Funds transfer\n- GD : Government Disbursement\n- GP : Gambling payout (non-online gambling)\n- LO : Loyalty credits and rebates\n- MD : Merchant Settlement\n- OG : Online Gambling Payout\n- PD : Payroll and pension disbursement\n- PP : Person-to-Person or Peer-to-Peer\n- TU : Top up, prepaid load\n- WT : Digital wallet \n" 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.\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 instead of the default value \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.\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 \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 maxLength: 12 description: "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" reconciliationId: type: string maxLength: 60 description: 'Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). ' linkId: type: string maxLength: 26 description: 'Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments ' purchaseLevel: type: string maxLength: 1 description: Set this field to 3 to indicate that the request includes Level III data. transactionTimeout: type: integer maximum: 99999 description: The time-out limit in seconds for the transaction. The time-out limit starts when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is 99999 (about 27 hours). When the transaction times out, the payment system changes the status to abandoned. intentsId: type: string maxLength: 26 description: Set to the value of the requestID field returned in the order service response. reportGroup: type: string maxLength: 25 description: 'Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. ' visaCheckoutId: type: string maxLength: 48 description: 'Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. ' industryDataType: type: string maxLength: 20 description: 'Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. ' authorizationOptions: type: object properties: authType: type: string maxLength: 15 description: "Authorization type. Possible values:\n\n - `AUTOCAPTURE`: automatic capture.\n - `STANDARDCAPTURE`: standard capture.\n - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n#### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing\nSet this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.\n\n#### Forced Capture\nSet this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system.\n\n#### Verbal Authorization\nSet this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization.\n\n#### for PayPal ptsV2CreateOrderPost400Response\nSet this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want to invoke delayed capture or sale respectively.\n" panReturnIndicator: type: string maxLength: 1 description: '#### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is  1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request ' verbalAuthCode: type: string maxLength: 7 description: 'Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. ' verbalAuthTransactionId: type: string maxLength: 15 description: 'Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). ' authIndicator: type: string maxLength: 1 description: "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nTo set the default for this field, contact CyberSource Customer Support.\n\n#### Barclays and Elavon\nThe default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support.\n\n#### CyberSource through VisaNet\nWhen the value for this field is 0, it corresponds to the following data in the TC 33 capture file:\n - Record: CP01 TCR0\n - Position: 164\n - Field: Additional Authorization Indicators\nWhen the value for this field is 1, it does not correspond to any data in the TC 33 capture file.\n" partialAuthIndicator: type: boolean description: 'Flag that indicates whether the transaction is enabled for partial authorization. When the request includes this field, this value overrides the information in your account. Possible values: - `true`: Enable the transaction for partial authorization. - `false`: Do not enable the transaction for partial authorization. #### PIN debit Required field for partial authorizations that use PIN debit purchase; otherwise, not used. #### Used by **Authorization** Optional field. #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators ' extendAuthIndicator: type: string maxLength: 5 description: "Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period.\n\nPossible values:\n- true: Transaction is an Authorization Extension transaction. \n- false: Transaction is not an Authorization Extension transaction.\n" balanceInquiry: type: boolean description: 'Flag that indicates whether to return balance information. Possible values: - `true`: Return balance information. - `false`: Do not return balance information. #### Used by **Authorization** Required for a balance inquiry; otherwise, not used. #### PIN debit Required for a balance inquiry request of a PIN debit purchase; otherwise, not used. ' ignoreAvsResult: type: boolean description: 'Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives an AVS decline, as indicated by a reply flag value of DAVSNO. Possible values: - `true`: Ignore the results of AVS checking and run the capture service. - `false` (default): If the authorization receives an AVS decline, do not run the capture service. When the value of this field is `true`, the list in the `processingInformation.authorizationOptions.declineAvsFlags` field is ignored. #### Used by **Authorization** Optional field. String (3) ' default: false 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'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 ignoreCvResult: type: boolean description: 'Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives a CVN decline, as indicated by an `processorInformation.cardVerification.resultCode` value of `D` or `N`. Possible values: - `true`: Ignore the results of CVN checking and run the capture service. - `false` (default): If the authorization receives a CVN decline, do not run the capture service. #### Used by **Authorization** Optional field. ' default: false initiator: type: object properties: type: type: string description: 'This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** ' credentialStoredOnFile: type: boolean description: 'Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The 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. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. ' storedCredentialUsed: type: boolean description: 'Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **true** means the merchant-initiated transaction came from a card that was already stored on file. - **false** means the merchant-initiated transaction came from a card that was not stored on file. ' merchantInitiatedTransaction: type: object properties: reason: type: string maxLength: 1 description: 'Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code ' previousTransactionId: type: string maxLength: 15 description: 'Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. ' originalAuthorizedAmount: type: string maxLength: 61 description: 'Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. ' agreementId: type: string maxLength: 140 description: 'An API to carry the agreement ID generated for recurring and unscheduled Card on file transaction. the merchant generates this per card holder or per payment agreement and shares the generated unique ID in the subsequent transactions. This can contain foreign/arabic character set also. Cybersource forwards this value to the Saudi Payment processor. ' billPayment: type: boolean description: 'Indicates payment for bill or payment towards existing contractual loan. Possible values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. Optional request field. ' billPaymentType: type: string description: 'Reason for the payment. Possible values: - 001: Public utilities / Utility payment - 002: Government services - 003: Cellular / Mobile phone top-up - 004: Coupon payment - 005: Installment based repayment - 006: Billing payment - 007: Tax payment - 008: Tax payment refunds The value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil): - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier The value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment) based Repayment): - Record: CP01 TCR6 - Position: 154-156 - Field: Bill Payment Transaction Type Identifier This field is supported for 1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet. 2. Installment based repayment transactions on Cybersource through VisaNet. ' redemptionInquiry: type: boolean description: "Flag that indicates the payment request is a redemption inquiry.\n\nPossible values:\n - `true`\n - `false`\n" transportationMode: type: string description: 'Type of transportation mode : Possible Values: - 00 = Unknown - 01 = Urban bus - 02 = Interurban bus - 03=Lighttrainmasstransit(Underground Metro LTR) - 04 = Train - 05 = Commuter train - 06 = Water-borne vehicle - 07 = Toll - 08 = Parking - 09 = Taxi - 10 = High-speed train - 11 = Rural bus - 12 = Express commuter train - 13 = Para transit - 14 = Self drive vehicle - 15 = Coach - 16 = Locomotive - 17 = Powered motor coach - 18 = Trailer - 19 = Regional train - 20 = Inter-city - 21 = Funicular train - 22 = Cable car ' aggregatedAuthIndicator: type: string description: 'Indicates if transaction is an aggregated auth Possible values: - **true** - **false** ' debtRecoveryIndicator: type: string description: 'Indicates if transaction is a debt recovery request Possible values: - **true** - **false** ' deferredAuthIndicator: type: boolean description: "Flag that indicates whether the authorization request was delayed because connectivity was interrupted.\n\nPossible values:\n - `true` (Deferred authorization)\n - `false` (default: Not a deferred authorization)\n" cashAdvanceIndicator: type: boolean description: "This API field enables the merchant to indicate that a given transaction is Cash Advance.\n\nCash advance or Cash disbursement functionality allows a merchant to dispense cash at a point of sale.\nIt provides the ability of a POS system to act like an ATM. These terminals are typically seen in bank\nbranches where customers can use their card and withdraw cash or at merchant locations where ATMs are sparse.\n\nPossible values:\n - `true` (Cash advance is supported)\n - `false` (default: cash advance is not supported)\n" splitPaymentTransaction: type: boolean description: "#### Visa Platform Connect\nIndicates split payment transaction. A split payment allows the use of two payment methods for a single transaction.\n\nPossible values:\n - `true` (split payment transaction is supported)\n - `false` (default: split payment transaction is not supported)\n" cardVerificationIndicator: type: boolean description: "This API field will indicate whether a card verification check is being performed during the transaction\n\nPossible values:\n - `true`\n - `false` (default value)\n" transactionMode: type: string maxLength: 1 description: 'Transaction mode identifier. Identifies the specific channel from which the transaction originates. Possible values: - M – Mobile Order - T – Telephone Order ' aftIndicator: type: boolean description: "Indicates whether the transaction is an Account Funding Transaction (AFT). \nThis field is mandatory for Account Funding Transactions (AFT). \n\nPossible values:\n - `true` (This is an AFT transaction)\n - `false` (default value) (This is not an AFT transaction)\n" serviceType: type: string maxLength: 10 description: "Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time \nfunding or a live-load. This type of transaction can also be connected to a purchase. \nIn back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: \n- account one is used to make the purchase\n- account two is used to automatically fund or reimburse account one\n\nPossible values:\n- 0B = back to back funding transaction\n- 00 = normal transaction\n- 01 = originator hold\n- 02 = Visa deferred OCT hold, default interval\n- 03 = Visa deferred OCT hold, user-defined interval\n- 09 = Cancel pending deferred OCT request\n- 0I = Visa Direct custom program 1\n- 0Q = uery the status of the deferred OCT\n- A0 = Alias Directory 2\n" balanceUpdate: type: boolean description: "Merchant to inform Cybersource whether a transaction is Money load with Balance Update.\n\nPossible values:\n - `true` (This is a Money load with balance update transaction)\n - `false` (default value) (This is not a Money load with balance update transaction)\n" moneyLoad: type: boolean description: "Merchant to inform Cybersource whether a transaction is Money load with Money load only.\n\nPossible values:\n - `true` (This is a money load transaction)\n - `false` (default value) (This is not a money load transaction)\n" captureOptions: type: object properties: captureSequenceNumber: type: integer minimum: 1 maximum: 99 description: "Capture number when requesting multiple partial captures for one authorization.\nUsed along with `totalCaptureCount` to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber_ = 2`, and\n - `totalCaptureCount = 5`\n" totalCaptureCount: type: integer minimum: 1 maximum: 99 description: "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - `captureSequenceNumber = 2`, and\n - `totalCaptureCount = 5`\n" dateToCapture: type: string maxLength: 4 description: 'Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet. Format: `MMDD` #### Used by **Authorization** Optional field. ' isFinal: type: string maxLength: 5 description: "Indicates whether to release the authorization hold on the remaining funds. \nPossible Values:\n- `true`\n- `false`\n" notes: type: string maxLength: 255 description: 'An informational note about this settlement. Appears in both the payer''s transaction history and the emails that the payer receives. ' reconciliationId: type: string maxLength: 60 description: Used for authbill request when capture field equals true reconciliationIdAlternate: type: string maxLength: 12 description: Used by Nike merchant to send 12 digit order number recurringOptions: type: object properties: loanPayment: type: boolean description: 'Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment ' default: false firstRecurringPayment: type: boolean description: "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - `true` Indicates this is the first payment in a series of recurring payments\n - `false` (default) Indicates this is not the first payment in a series of recurring payments.\n" default: false bankTransferOptions: type: object properties: declineAvsFlags: type: string maxLength: 15 description: 'Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The 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. AVS is considered either domestic or international, depending on the location of the bank that issued the customer''s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member''s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |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.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |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.| |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.| |M|See the entry for D & M.| |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.| |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.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member''s name does not match, but street address matches. Returned only for the American Express card type.| |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.| |V|Match: card member''s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |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.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| ' secCode: type: string maxLength: 3 description: 'Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry ' terminalCity: type: string maxLength: 4 description: 'City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. ' terminalState: type: string maxLength: 2 description: 'State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. ' effectiveDate: type: string maxLength: 8 description: 'Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service. ' partialPaymentId: type: string maxLength: 25 description: 'Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. ' customerMemo: type: string maxLength: 80 description: 'Payment related information. This information is included on the customer''s statement. ' paymentCategoryCode: type: string maxLength: 1 description: 'Flag that indicates whether to process the payment. Use with deferred payments. Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used. ' settlementMethod: type: string maxLength: 1 description: 'Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) ' fraudScreeningLevel: type: string maxLength: 1 description: 'Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification ' customerPresent: type: string maxLength: 1 description: 'Indicates whether a customer is physically present and whether the customer is enrolling in CyberSource Recurring Billing. Possible values: - `1`: Customer is present and not enrolling. - `2`: Customer is not present and not enrolling. - `3`: Customer is present and enrolling. - `4`: Customer is not present and enrolling. ' purchaseOptions: type: object properties: isElectronicBenefitsTransfer: type: boolean description: 'Flag that indicates whether this transaction is an EBT transaction. Possible values: - `true` - `false` #### PIN debit Required field for EBT and EBT voucher transactions that use PIN debit credit or PIN debit purchase; otherwise, not used. ' type: type: string maxLength: 20 description: 'Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. - `BUY` - `RENT` - `BOOK` - `SUBSCRIBE` - `DOWNLOAD` - `ORDER` - `CONTINUE` #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. ' eligibilityIndicator: type: string maxLength: 20 description: "This field contains installment data defined by MasterCard.\nPossible values:\n - Y = eligible\n - N = not eligile\n" benefitAmount: type: string maxLength: 20 description: Workplace benefit amount. benefitType: type: string maxLength: 100 description: 'Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education ' electronicBenefitsTransfer: type: object properties: category: type: string maxLength: 4 description: 'Flag that specifies the category for the EBT transaction. Possible values: - `CASH`: Cash benefits, which can be used to purchase any item at a participating retailer, as well as to obtain cash-back or make a cash withdrawal from a participating ATM. - `FOOD`: Food stamp benefits, which can be used only to purchase food items authorized by the USDA SNAP program. #### PIN debit Required field for EBT transactions that use PIN debit credit or PIN debit purchase; otherwise, not used. ' voucherSerialNumber: type: string maxLength: 15 description: 'The serial number printed on the EBT voucher. #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. ' loanOptions: type: object properties: type: type: string maxLength: 20 description: 'Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type ' assetType: type: string maxLength: 1 description: "Indicates whether a loan is for a recoverable item or a non-recoverable item.\nPossible values:\n- `N`: non-recoverable item\n- `R`: recoverable item\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n Record: CP07 TCR2, Position: 26, Field: Asset Indicator\n" walletType: type: string maxLength: 5 description: 'This field carries the wallet type in authorization requests and credit requests. Possible value are: - `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. - `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. - `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. - `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. - `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. - `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions. - `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. For 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. Masterpass (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. Visa Checkout: This field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations. For 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 Solutions 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. For incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102. Payment card companies can introduce new values without notice. Your order management system should be able to process new values without problems. CyberSource through VisaNet When 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. When 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. ' nationalNetDomesticData: type: string maxLength: 123 description: 'Supplementary domestic transaction information provided by the acquirer for National Net Settlement Service (NNSS) transactions. NNSS is a settlement service that Visa provides. For transactions on CyberSource through VisaNet in countries that subscribe to NNSS: VisaNet clears transactions; VisaNet transfers funds to the acquirer after deducting processing fees and interchange fees. VisaNet settles transactions in the local pricing currency through a local financial institution. This field is supported only on CyberSource through VisaNet for domestic data in Colombia ' merchantVerificationValue: type: string maxLength: 25 description: 'The override value of the Merchant Verification Value (MVV) received by various card brands. MVV refers to the value assigned by the card brand/network to identify participation in select merchant programs. Sample value for Visa: `101010` ' japanPaymentOptions: type: object properties: paymentMethod: type: string maxLength: 2 description: 'This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) ' bonuses: type: array description: "An array of objects, each of which contains a bonus month and bonus amount. \nLength of bonuses array is equal to the number of bonuses. Max length = 6. \nIn case of bonus month and amount not specified, null objects to be returned in the array.\nExample: bonuses : [ {\"month\": \"1\",\"amount\": \"200\"}, {\"month\": \"3\",\"amount\": \"2500\"}, null]\n" items: type: object properties: month: type: string maxLength: 2 description: 'This value is a 2-digit code indicating the first bonus month. Valid value from 1 to 12. ' amount: type: string maxLength: 8 description: 'This value contains the bonus amount of the first month. Maximum value without decimal 99999999. ' preapprovalType: type: string maxLength: 1 description: 'This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization ' installments: type: string maximum: 99 description: 'Number of Installments. ' terminalId: type: string maxLength: 13 description: 'Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the `pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. ' firstBillingMonth: type: string maxLength: 2 description: 'Billing month in MM format. ' businessName: type: string maxLength: 25 description: 'Business name in Japanese characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. ' businessNameKatakana: type: string maxLength: 25 description: 'Business name in Katakana characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. ' jis2TrackData: type: string maxLength: 69 description: 'Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. ' businessNameAlphaNumeric: type: string maxLength: 25 description: 'Business name in alphanumeric characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet. ' mobileRemotePaymentType: type: string maxLength: 1 description: 'Type of payment initiated from a cardholder''s mobile device. Possible values: - `1` : Consumer-initiated remote purchase, face-to-face - `2` : Consumer-initiated remote purchase, e-commerce - `3` : Consumer-initiated remote purchase, mail order / telephone order - `4` : Consumer-initiated bill pay - `5` : Consumer-initiated top up - `6` : Consumer-initiated cash out - `7` : ATM triggered or agent-initiated cash out - `8` : Merchant-initiated remote purchase, face-to-face - `9` : Merchant-initiated remote purchase, e-commerce This field is supported only for Mastercard transactions on CyberSource through VisaNet. Optional field. **Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 94 - Field: Mastercard Mobile Remote Payment Program Indicator The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. ' extendedCreditTotalCount: type: string maxLength: 1 description: 'A private national-use field submitted by acquirers and issuers in South Africa for South Africa-domestic (intra-country) authorizations and financial requests. Values for this field are 00 through 99. ' 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. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code. 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. #### PIN debit Priority 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: | Network | Code | | --- | --- | | Accel | E | | AFFN | U | | Alaska Option | 3 | | CU24 | C | | Interlink | G | | Maestro | 8 | | NETS | P | | NYCE | F | | Pulse | H | | Shazam | 7 | | Star | M | | Visa | V | For example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of `MH`. When you do not include this value in your PIN debit request, the list of network codes from your account is used. **Note** This field is supported only for businesses located in the U.S. Optional field for PIN debit credit or PIN debit purchase. ' payByPointsIndicator: type: boolean description: 'Flag that indicates if the transaction is pay by points transaction true: Transaction uses loyalty points false: Transaction does not use loyalty points Default: false ' timeout: type: integer description: 'Minutes until a pending MyBank transaction will be timed out. Value must be between 5 and 30. Default is 5. ' isReturnAuthRecordEnabled: type: boolean description: 'Flag that indicates the functionality we are having for merchants for which auth is done through Cybersource but settlement is done by themselves. true: functionality is supported. Processor should send raw processor auth response to Merchant. false: functionality is not supported. Default: false ' networkPartnerId: type: string maxLength: 11 description: 'Merchant payment gateway ID that is assigned by Mastercard and is provided by the acquirer when a registered merchant payment gateway service provider is involved in the transaction. This field is supported for Visa Platform Connect, Chase Paymentech Salem. ' paymentType: type: string maxLength: 3 description: 'Identifier for the payment type. ' enablerId: type: string maxLength: 15 description: 'Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. ' processingInstruction: type: string maxLength: 36 description: 'The instruction to process an order. - default value: ''NO_INSTRUCTION'' - ''ORDER_SAVED_EXPLICITLY'' ' transactionTypeIndicator: type: string maxLength: 3 description: 'This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values: - 201- Mastercard Rebate - 202- rePower Load Value - 203- Gaming Re-pay - 204- General Person-to-Person - 205- General Transfer to Own Account - 206- Agent Cash Out - 207- Payment of Own Credit Card Bill - 208- Business Disbursement - 209- Government/Non-Profit Disbursement - 210- Rapid Merchant Settlement - 211- Cash in at ATM (Usage limited to specific countries) - 212- Cash in at Point of Sale (Usage limited to specific countries) - 213- General Business to Business Transfer - 214- Mastercard Merchant Presented QR - 215- Mastercard Merchant Presented QR Refund Payment - 216- Utility Payments (for Brazil domestic use only) - 217- Government Services (for Brazil domestic use only) - 218- Mobile phone top-ups (for Brazil domestic use only) - 219- Coupon booklet payments (for Brazil domestic use only) - 220- General Person-to-Person Transfer - 221- Person-to-Person Transfer to Card Account - 222- General Transfer to Own Account - 223- Agent Cash Out - 224- Payment of Own Credit Card Bill - 225- Business Disbursement - 226- Transfer to Own Staged Digital Wallet Account - 227- Transfer to Own Debit or Prepaid Account - 228- General Business-to-Business Transfer - 229- Installment-based repayment - 230- Mastercard ATM Cash Pick-Up Transaction - 231- Cryptocurrency - 232- High-risk Securities ' purposeOfPayment: type: string maxLength: 25 description: 'This field is applicable for AFT and OCT transactions. For list of supported values, please refer to Developer Guide. ' languageCode: type: string maxLength: 10 description: 'Contains the ISO 639-2 defined language Code ' originalPaymentId: type: string maxLength: 26 description: "This value is used for linking Authorization extension transaction to the original Authorization transaction \nand for linking MIT (Merchant initiated transaction) with the respective CIT (Customer initiated transaction).\n" amexIndirectModelType: type: string maxLength: 2 description: "Effective with the April 2025 release, American Express is introducing the following new Indirect Acceptor models :\n- Digital Wallet Operator\n - Staged back to back transaction\n - Peer to peer (P2P) transaction\n - Stored value transaction\n- Marketplace\n\nEach model must have a separate American Express Merchant Account number and will be assigned a unique Indirect Model Type value.\n\nValid/Sample Values :\n- `1`: Bill payment provider\n- `2`: Installment payment transaction\n- `3`: Marketplace\n- `4`: Peer to peer transaction\n- `5`: Staged back to back transaction\n- `6`: Stored value transaction\n" walletTransactionIntent: type: number maxLength: 2 description: 'Identifies the type of operation being performed by the staged digital wallet operator. The value distinguishes between a Cash-in transaction (coded as "02"), where funds are loaded into the digital wallet from a registered payment card, and a Purchase transaction (coded as "01"), where the wallet is used to make a payment to a merchant or transfer funds between wallets. This distinction is essential for transaction processing, reporting, and ensuring compliance with the specific rules and requirements associated with each card brand and transaction type. ' destinationType: type: number maxLength: 2 description: "Identifies the destination/purpose of the cash-in: \n• 04: M2M (Same ownership, same portfolio/arrangement)\n• 05: P2P (For another holder, same wallet/arrangement)\n• 06: Transfer to another arrangement (same ownership)\n• 07: Transfer to another arrangement (other ownership)\n• 08: Transfer to stored value digital wallet.\n" programIndicators: type: object description: 'Contains program-specific indicators for transaction processing. ' properties: quickPayment: type: boolean maxLength: 5 description: 'Indicator for when a Quick Payment transaction. A Quick Payment Service (QPS) Transaction is a magnetic stripe-based or contact chip-based face-to-face Mastercard POS transaction that occurs at a Peruvian merchant in an eligible merchant category and for an amount equal or less to the CVM limit. This field is supported for Mastercard transactions in Peru. Possible values: - `true`: This is a Quick Payment Service transaction - `false`: This is not a Quick Payment Service transaction Default: null ' qrInitiated: type: boolean maxLength: 5 description: 'Indicator that the transaction was made via QR Payment. This field is supported for Mastercard QR e-commerce payment programs in Peru. Possible values: - `true`: Transaction was initiated via QR code - `false`: Transaction was not initiated via QR code Default: null ' inquiryType: type: string maxLength: 2 description: "Type of inquiry for Zero dollar transactions. Mastercard is introducing Mastercard One Credential, a single, digitally connected credential that offers cardholders the ability to access multiple payment methods. \n\nThis field is used for Product Status Inquiry (PSI), Account Status Inquiry with Product Status Inquiry (ASI with PSI), and Account Status Inquiry with Product Status Inquiry and Probability Indicator.\n\nThis field is supported for Zero dollar transactions only.\n\nPossible values:\n- `01`: Product status inquiry\n- `02`: Account status inquiry with product status inquiry\n- `03`: Account status Inquiry with Product Status Inquiry and Probability Indicator\n\n#### Used by\n**Authorization (Zero dollar transactions)**\nOptional field.\n" issuerInformation: type: object properties: discretionaryData: type: string maxLength: 255 description: 'Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. ' paymentInformation: type: object properties: card: type: object properties: number: type: string maxLength: 20 description: 'The customer''s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' expirationMonth: type: string maxLength: 2 description: 'Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' expirationYear: type: string maxLength: 4 description: 'Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' useAs: type: string maxLength: 20 description: "Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect.\nThe cardholder provides this information during the payment process. This field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n\n**China UnionPayCard Transactions on China UnionPay:**\nPossible values:\n - C: Domestic credit card\n - D: Domestic debit card\n - F: International credit card\n - I: International debit card\n\nWhen the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request.\nWhen the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request.\n\n**Cielo and Comercio Latino Credit Card Transactions:**\nOn these processors, this field is supported only for authorizations. Possible values:\n - CR: Credit card\n - DB: Debit card \n\n**Visa Platform Connect Credit Card Transactions:**\nThis field is supported for all card types on Visa Platform Connect.\nFor combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - CR: Credit card\n - DB: Debit Card\n\nFor combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - C: Credit card\n - D: Debit card\n\nA value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.\n" sourceAccountType: type: string maxLength: 20 description: "Flag that specifies the type of account associated with the card. \nThe cardholder provides this information during the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for CyberSource through VisaNet (CtV).\n\n**Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - `CH`: Checking account\n - `CR`: Credit card account\n - `SA`: Saving account\n - `LI`: Line of credit or credit portion of combo card\n - `PP`: Prepaid card account or prepaid portion of combo card\n - `UA`: Universal account\n\nIf useAs is set to credit/debit and there is a value in SourceAccountType, the value in the SourceAccountType field will take precedence.\nIf useAs is set to CR/DB and there is a value in SourceAccountType, the value in the useAs field will take precedence.\n" sourceAccountTypeDetails: type: string maxLength: 4 description: 'Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - `AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet. ' securityCode: type: string maxLength: 4 description: 'Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional. ' securityCodeIndicator: type: string maxLength: 1 description: "Indicates whether a CVN code was sent. Possible values:\n\n - `0` (default): CVN service not requested. This default value is used when you do not include\n `securityCode` field in the request.\n - `1` (default): CVN service requested and supported. This default value is used when you include\n `securityCode` field in the request.\n - `2`: CVN on credit card is illegible.\n - `9`: CVN was not imprinted on credit card.\n\n#### FDMS Nashville\nRequired for American Express cards; otherwise, optional.\n\n#### TSYS Acquiring Solutions\nOptional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used.\n\n#### All other processors\nOptional.\n" accountEncoderId: type: string maxLength: 3 description: 'Identifier for the issuing bank that provided the customer''s encoded account number. Contact your processor for the bank''s ID. ' issueNumber: type: string maxLength: 5 description: 'Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. ' startMonth: type: string maxLength: 2 description: 'Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. ' startYear: type: string maxLength: 4 description: 'Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. ' productName: type: string maxLength: 15 description: 'Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data ' productSubtype: type: string maxLength: 2 description: "This field would contain the indicator for transaction type\n\nPossible values:\n- AC: Agriculture Maintenance Account\n- AE: Agriculture Debit Account/Electron \n- AG: Agriculture \n- AI: Agriculture Investment Loan\n- CG: Brazil Cargo\n- CS: Construction \n- DS: Distribution \n- HC: Healthcare\n- LP: Visa Large Purchase Advantage\n- MA: Visa Mobile Agent\n- MB: Interoperable Mobile Branchless Banking\n- MG: Visa Mobile General\n- VA: Visa Vale - Supermarket\n- VF: Visa Vale - Fuel\n- VR: Visa Vale - Restaurant\n" typeSelectionIndicator: type: string maxLength: 1 description: 'Flag that identifies how the card type was selected. Possible values: - 0: Card type was selected based on default acquirer settings. - 1: Customer selected the card type. ' tokenizedCard: type: object properties: number: type: string maxLength: 20 description: 'Customer''s payment network token value. ' expirationMonth: type: string maxLength: 2 description: 'One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. ' expirationYear: type: string maxLength: 4 description: 'One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' cryptogram: type: string maxLength: 255 description: This field contains token information. requestorId: type: string maxLength: 11 description: 'Value that identifies your business and indicates that the cardholder''s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider''s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. ' 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 provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer''s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. ' assuranceLevel: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. **Note** Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field. ' storageMethod: type: string maxLength: 3 description: "Type of technology used in the device to store token data. Possible values:\n\n- `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment\n credentials, a SE is tested against a set of requirements defined by the payment networks.\n\n **Note** This field is supported only for _FDC Compass_.\n\n- 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n**Note** This field is supported only for _FDC Compass_.\n" securityCode: type: string maxLength: 4 description: 'Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. ' securityCodeIndicator: type: string maxLength: 1 description: "Indicates whether a CVN code was sent. Possible values:\n\n - `0` (default): CVN service not requested. This default value is used when you do not include\n `securityCode` field in the request.\n - `1` (default): CVN service requested and supported. This default value is used when you include\n `securityCode` field in the request.\n - `2`: CVN on credit card is illegible.\n - `9`: CVN was not imprinted on credit card.\n\n#### FDMS Nashville\nRequired for American Express cards; otherwise, optional.\n\n#### TSYS Acquiring Solutions\nOptional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used.\n\n#### All other processors\nOptional.\n" assuranceMethod: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** ' tokenizedPaymentMethod: type: object properties: id: type: string maxLength: 255 description: 'The PayPal-generated ID for the token. ' directDebit: type: object properties: mandate: type: object properties: clearingDate: type: string maxLength: 8 description: 'This is the date on which the SEPA DD should be executed. Debit date: the day on which the payer''s account is debited. ' fluidData: type: object properties: keySerialNumber: type: string description: 'The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) ' descriptor: type: string maxLength: 128 description: 'The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is `Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504` ' value: type: string maxLength: 4000 description: 'Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device. ' encoding: type: string maxLength: 6 description: 'Encoding method used to encrypt the payment data. Valid values: `Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding ' customer: type: object properties: customerId: type: string description: 'Unique identifier for the customer''s card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer''s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn''t need to pass in data such as the card number or expiration date in the request itself. ' id: type: string description: 'Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. ' minLength: 1 maxLength: 32 paymentInstrument: type: object properties: id: type: string description: 'Unique identifier for the Payment Instrument token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. ' minLength: 1 maxLength: 32 instrumentIdentifier: type: object properties: id: type: string description: 'Unique identifier for the Instrument Identifier token used in the transaction. When you include this value in your request, many of the fields that can be supplied for an authorization or credit become optional. ' minLength: 12 maxLength: 32 shippingAddress: type: object properties: id: type: string description: 'Unique identifier for the Customers Shipping Address token used in the transaction. When you include this value in your request, many of the shipping fields that can be supplied for an authorization or credit become optional. ' minLength: 1 maxLength: 32 legacyToken: type: object properties: id: type: string description: 'Unique identifier for the legacy Secure Storage token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. ' minLength: 1 maxLength: 32 bank: type: object properties: account: type: object properties: type: type: string maxLength: 1 description: "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" number: type: string maxLength: 30 description: 'Account number. When processing encoded account numbers, use this field for the encoded account number. ' encoderId: type: string maxLength: 3 description: 'Identifier for the bank that provided the customer''s encoded account number. To obtain the bank identifier, contact your processor. ' checkNumber: type: string maxLength: 8 description: 'Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. ' checkImageReferenceNumber: type: string maxLength: 32 description: 'Image reference number associated with the check. You cannot include any special characters. ' iban: type: string maxLength: 50 description: 'International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. ' routingNumber: type: string maxLength: 9 description: 'Bank routing number. This is also called the _transit number_. ' iban: type: string maxLength: 50 description: 'International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. ' swiftCode: type: string description: 'Bank''s SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. ' code: type: string maxLength: 50 description: 'Bank code of the consumer''s account ' accountAlias: type: object properties: id: type: string description: Alias value (phone, email, account number, business number, or organization ID) maxLength: 255 type: type: string description: "Indicates the kind of alias (phone, email, account number, business number, or account ID) \nPossible values:\n- phone\n- email\n- accountNumber\n- businessNumber\n- accountID" options: type: object properties: id: type: string description: 'Payment option ID name. This is the bank''s swift code.Include the option ID name returned in the Options service response. ' minLength: 1 maxLength: 60 paymentType: type: object properties: name: type: string description: 'A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) ' subTypeName: type: string description: 'In case the APM supports multiple modes of initiation (e.g. Alipay via QR Code or Barcode) ' method: type: object properties: name: type: string description: 'A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, bofaPayByBank, payToPayByBank, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data #### Via KCP - `KCP` : Local Card, Bank Transfer and Carrier Billing. - `PAYCO` - `KAKAOPAY` - `NAVERPAY` ' 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''s site, and the payment channel is known. Possible Values: #### Via PPRO - `alfaVa` - `kredivo` - `consumerBarCode` - `merchantQrCode` - `dokuWallet` ' initiationChannel: type: string maxLength: 2 description: 'Mastercard-defined code that indicates how the account information was obtained. - `00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by **Authorization** Optional field. ' sepa: type: object properties: directDebit: type: object properties: reference: type: string maxLength: 255 description: 'Mandate reference as returned on the first transaction in the sequence ' signatureDate: type: string maxLength: 255 description: 'Date of the initial transaction, format is YYYY-MM-DD. Date can be taken from the finaltimestamp of the SUCCEEDED notification for the first transaction in the sequence. ' url: type: string maxLength: 255 description: 'Valid URL pointing to the SEPA mandate, needs to be accessible by our risk and compliance department. ' type: type: string maxLength: 255 description: 'Sequence type of the direct debit, defaults to "oneOff". Valid values: oneOff The direct debit is executed once. first First direct debit in a series of recurring ones. ' eWallet: type: object properties: accountId: type: string maxLength: 26 description: The ID of the customer, passed in the return_url field by PayPal after customer approval. fundingSource: type: string maxLength: 30 description: 'Payment method for the unit purchase. Possible values: - `UNRESTRICTED (default)—this value is only available if configured by PayPal for the merchant.` - `INSTANT` ' paymentAccountReference: type: object properties: id: type: string maxLength: 29 description: 'A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN. It identifies the card account, not just a card. PAR is a non-payment identifier that can be associated to PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. ' thirdPartyToken: type: object properties: id: type: string maxLength: 16 description: 'When a third party is being used for tokenization, this field contains the token ID. See tokenInformation.thirdPartyToken.source to identify the provider. ' merchantLimitedAcceptanceIndicator: type: string maxLength: 1 description: 'Mastercard One Credential merchant limited acceptance indicator. Mastercard One Credential connects multiple Mastercard payment methods and allows cardhollers to access various options and set payment preferences. This field indicates which Mastercard One Credential funding PAN acceptance brands should NOT be assigned for this transaction. This field flows in ISO field 34, DSID 02 tag DB, mapped to Mastercard Data Element (DE) 48, Sub element 02, Subfield 01. Possible values: - `C`: Do not assign a Mastercard One Credential funding PAN containing the Mastercard Credit Acceptance Brand for this transaction - `D`: Do not assign a Mastercard One Credential funding PAN containing the Debit Mastercard Acceptance Brand for this transaction - `M`: Do not assign a Mastercard One Credential funding PAN containing the Maestro Acceptance Brand for this transaction This field is supported for all flavors of Authorization request only. Will not be received in response. #### Used by **Authorization Request** Optional field. ' orderInformation: type: object properties: extensionDays: type: string maxLength: 19 description: 'Request field for merchant to increase the AUTH expiry days for Klarna Advantage Plus. Applicable for Re-Authorization (AP_REAUTH) service. ' amountDetails: type: object properties: refundBalance: type: string maxLength: 15 description: The remaining amount which can be refunded. giftWrapAmount: type: string maxLength: 19 description: 'Amount being charged as gift wrap fee. ' invoiceAmount: type: string maxLength: 12 description: 'Invoice amount. The invoice amount issued by the Merchant to the Cardholder, which includes VAT (excluding items such as TIPS or CASHBACK). For transactions that do not have applicable Benefit Laws, the field may be entered as zeros. This field is only applicable for Uruguay market. Example: 100.00 Uruguay The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 7-18 - Field: Invoice Amount ' totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" subTotalAmount: type: string maxLength: 15 description: 'Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request. ' currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' discountAmount: type: string maxLength: 15 description: 'Total discount amount applied to the order. ' dutyAmount: type: string maxLength: 15 description: 'Total charges for any import or export duties included in the order. ' gratuityAmount: type: string maxLength: 13 description: 'Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present. ' taxAmount: type: string maxLength: 12 description: 'Total tax amount for all the items in the order. ' nationalTaxIncluded: type: string maxLength: 1 description: "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n" taxAppliedAfterDiscount: type: string maxLength: 1 description: "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n" taxAppliedLevel: type: string maxLength: 1 description: "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n" taxTypeCode: type: string maxLength: 3 description: "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n" freightAmount: type: string maxLength: 13 description: 'Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. ' foreignAmount: type: string maxLength: 15 description: 'Set this field to the converted amount that was returned by the DCC provider. ' foreignCurrency: type: string maxLength: 5 description: 'Set this field to the converted amount that was returned by the DCC provider. ' exchangeRate: type: string maxLength: 13 description: 'Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. ' exchangeRateTimeStamp: type: string maxLength: 16 description: 'Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. ' surcharge: type: object properties: amount: type: string maxLength: 15 description: 'The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. **NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8. #### PIN debit Surcharge amount that you are charging the customer for this transaction. If you include a surcharge amount in the request, you must also include the surcharge amount in the value for `orderInformation.amountDetails.totalAmount`. Optional field for transactions that use PIN debit credit or PIN debit purchase. ' description: type: string description: Merchant-defined field for describing the surcharge amount. 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''s account. This field is returned for OCT transactions. ' settlementCurrency: type: string maxLength: 3 description: 'This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder''s account. This field is returned for OCT transactions. ' amexAdditionalAmounts: type: array items: type: object properties: code: type: string maxLength: 3 description: 'Additional amount type. This field is supported only for **American Express Direct**. ' amount: type: string maxLength: 12 description: 'Additional amount. This field is supported only for **American Express Direct**. ' taxDetails: type: array items: type: object properties: type: type: string description: 'Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` ' amount: type: string maxLength: 13 description: 'Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | ' rate: type: string maxLength: 6 description: 'Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) ' code: type: string maxLength: 4 description: 'Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` ' taxId: type: string maxLength: 15 description: 'Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. ' applied: type: boolean description: 'Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. ' exemptionCode: type: string maxLength: 1 description: 'Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' serviceFeeAmount: type: string maxLength: 15 description: 'Service fee. Required for service fee transactions. ' originalAmount: type: string maxLength: 15 description: 'Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. ' originalCurrency: type: string maxLength: 15 description: 'Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) ' cashbackAmount: type: string maxLength: 13 description: 'Cashback amount in the acquirer''s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal. ' currencyConversion: type: object properties: indicator: type: string maxLength: 1 description: 'Flag indicating that DCC Lookup has been performed before this transaction. Set this field to 1 when cardholders opts to use DCC on the transaction. ' reconciliationId: type: string maxLength: 60 description: 'Unique identifier generated by the DCC provider. ' id: type: string maxLength: 26 description: 'Value of the Cybersource request ID returned in a DCC Lookup transaction. ' oct-surcharge: type: object properties: amount: type: string maxLength: 15 x-nullable: true description: "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. \nThe issuer can provide information about the surcharge amount to the customer. \n\nIf the amount is positive, then it is a debit for the customer. \n\nIf the amount is negative, then it is a credit for the customer.\n" order: type: object properties: totalAmount: type: string maxLength: 10 description: 'Grand total for the order. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places ' currency: type: string maxLength: 5 description: 'Currency used for the order ' subTotalAmount: type: string maxLength: 15 description: 'Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' handlingAmount: type: string maxLength: 15 description: 'Aggregate handling charges for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' shippingAmount: type: string maxLength: 15 description: 'Aggregate shipping charges for the transaction If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' shippingDiscountAmount: type: string maxLength: 15 description: 'Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' taxAmount: type: string maxLength: 10 description: 'Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. ' insuranceAmount: type: string maxLength: 15 description: 'Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal. ' giftWrapAmount: type: string maxLength: 15 description: "Amount being charged as gift wrap fee.\n \n" anticipatedAmount: type: string maxLength: 15 description: 'This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases. ' billTo: type: object properties: firstName: type: string maxLength: 60 description: 'Customer''s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' lastName: type: string maxLength: 60 description: 'Customer''s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' middleName: type: string maxLength: 60 description: 'Customer''s middle name. ' nameSuffix: type: string maxLength: 60 description: 'Customer''s name suffix. ' title: type: string maxLength: 60 description: 'Title. ' company: type: object properties: name: type: string maxLength: 60 description: '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. ' address1: type: string maxLength: 40 description: First line in the street address of the company purchasing the product. address2: type: string maxLength: 40 description: Additional address information for the company purchasing the product. locality: type: string maxLength: 30 description: City in the address of the company purchasing the product. administrativeArea: type: string maxLength: 50 description: 'State or province in the address of the company purchasing the product. Use the State, Province, and Territory Codes for the United States and Canada. ' postalCode: type: string maxLength: 10 description: 'Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits. When the company country is the U.S., the 9-digit postal code must follow this format: **[5 digits][dash][4 digits]** #### Example `12345-6789` When the company country is Canada, the 6-digit postal code must follow this format: **[alpha][numeric][alpha][space][numeric][alpha][numeric]** #### Example `A1B 2C3` ' country: type: string maxLength: 2 description: 'Country in the address of the company purchasing the product. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). ' address1: type: string maxLength: 60 description: 'Payment card billing street address as it appears on the credit card issuer''s records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' address2: type: string maxLength: 60 description: 'Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) ' address3: type: string maxLength: 60 description: 'Additional address information (third line of the billing address) ' address4: type: string maxLength: 60 description: 'Additional address information (fourth line of the billing address) ' locality: type: string maxLength: 50 description: 'Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' administrativeArea: type: string maxLength: 50 description: 'State or province of the billing 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' postalCode: type: string maxLength: 10 description: "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### SEPA\nRequired for Create Mandate and Import Mandate\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet\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 ASCII\ncharacters for transmission to the credit card networks.\n\n#### FDMS Nashville\nRequired if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada.\nOptional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada.\nNot used if swiped.\n\n#### RBS WorldPay Atlanta:\nFor best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional field.\n" county: type: string maxLength: 50 description: U.S. county if available. country: type: string maxLength: 3 description: 'Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' district: type: string maxLength: 50 description: 'Customer''s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. ' buildingNumber: type: string maxLength: 256 description: "Building number in the street address.\n\nFor example, if the street address is:\nRua da Quitanda 187\nthen the building number is 187.\n\nThis field is supported only for:\n - Cielo transactions.\n - Redecard customer validation with CyberSource Latin American Processing.\n" email: type: string maxLength: 255 description: 'Customer''s email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won''t work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' emailDomain: type: string maxLength: 100 description: 'Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address. ' phoneNumber: type: string maxLength: 15 description: 'Customer''s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. ' phoneType: type: string description: 'Customer''s phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work ' verificationStatus: type: string description: 'Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED ' alternatePhoneNumber: type: string maxLength: 15 description: '#### Visa Platform Connect contains customer''s alternate phone number. ' alternateEmail: type: string maxLength: 255 description: '#### Visa Platform Connect contains customer''s alternate email address. ' shipTo: type: object properties: title: type: string description: The title of the person receiving the product. maxLength: 60 firstName: type: string maxLength: 60 description: 'First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' middleName: type: string maxLength: 60 description: 'Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' lastName: type: string maxLength: 60 description: 'Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' address1: type: string maxLength: 60 description: 'First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' address2: type: string maxLength: 60 description: 'Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' locality: type: string maxLength: 50 description: 'City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' administrativeArea: type: string maxLength: 50 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: 32 description: 'Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' county: type: string maxLength: 50 description: U.S. county if available. 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) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' maxLength: 3 district: type: string maxLength: 50 description: Neighborhood, community, or region within a city or municipality. buildingNumber: type: string maxLength: 15 description: 'Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 ' phoneNumber: type: string maxLength: 15 description: Phone number associated with the shipping address. email: type: string maxLength: 255 description: 'Email of the recipient. ' company: type: string maxLength: 60 description: 'Name of the customer''s company. ' destinationTypes: type: string maxLength: 25 description: 'Shipping destination of item. Example: Commercial, Residential, Store ' destinationCode: type: integer maxLength: 2 description: 'Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other ' method: type: string maxLength: 10 description: 'Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.). ' lineItems: type: array items: type: object properties: productCode: type: string maxLength: 255 description: 'Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The 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]. ' productName: type: string maxLength: 255 description: 'For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' productSku: type: string maxLength: 255 description: 'Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. ' quantity: type: integer minimum: 1 maximum: 999999999 default: 1 description: 'Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' unitPrice: type: string maxLength: 15 description: 'Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) ' unitOfMeasure: type: string maxLength: 12 description: 'Unit of measure, or unit of measure code, for the item. ' totalAmount: type: string maxLength: 13 description: 'Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is "gift_card", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 ' taxAmount: type: string maxLength: 15 description: "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nOptional field.\n\n#### Airlines processing\nTax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s).\nFormat: English characters only.\nOptional request field for a line item.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nNote if you send this field in your tax request, the value in the field will override the tax engine\n" taxRate: type: string maxLength: 7 description: 'Tax rate applied to the item. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). ' taxAppliedAfterDiscount: type: string maxLength: 1 description: "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" taxStatusIndicator: type: string maxLength: 1 description: "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" taxTypeCode: type: string maxLength: 4 description: 'Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` ' amountIncludesTax: type: boolean description: "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n" typeOfSupply: type: string maxLength: 2 description: "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" commodityCode: type: string maxLength: 15 description: 'Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. ' discountAmount: type: string maxLength: 13 description: Discount applied to the item. discountApplied: type: boolean description: "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n" discountRate: type: string maxLength: 6 description: 'Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) ' invoiceNumber: type: string maxLength: 23 description: 'Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items. ' taxDetails: type: array items: type: object properties: type: type: string description: 'Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` ' amount: type: string maxLength: 13 description: 'Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | ' rate: type: string maxLength: 6 description: 'Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) ' code: type: string maxLength: 4 description: 'Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` ' taxId: type: string maxLength: 15 description: 'Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. ' applied: type: boolean description: 'Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. ' exemptionCode: type: string maxLength: 1 description: 'Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' fulfillmentType: type: string description: 'Information about the product code used for the line item. Possible values: - `E`: The product code is `electronic_software`. - `P`: The product code is not `electronic_software`. For details, see the `fulfillmentType` field description in [Business Center Reporting User Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User/html/) ' weight: type: string maxLength: 9 description: 'Weight of the item. ' weightIdentifier: type: string maxLength: 1 description: 'Type of weight. Possible values: - B: Billed weight - N: Actual net weight ' weightUnit: type: string maxLength: 2 description: 'Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). ' referenceDataCode: type: string maxLength: 150 description: 'Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer''s part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' referenceDataNumber: type: string maxLength: 30 description: 'Reference number. The meaning of this value is identified by the value of the corresponding `referenceDataCode` field. See Numbered Elements. The maximum length for this field depends on the value of the corresponding `referenceDataCode` field: - When the code is `PO`, the maximum length for the reference number is 22. - When the code is `VC`, the maximum length for the reference number is 20. - For all other codes, the maximum length for the reference number is 30. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' unitTaxAmount: type: string maxLength: 15 description: 'Per-item tax amount of the product. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. ' measurement: type: string maxLength: 10 description: 'This field would contain measurement of a line item. ' productDescription: type: string description: Brief description of item. giftCardCurrency: type: integer maxLength: 3 description: 'When `orderInformation.lineItems[].productCode` is "gift_card", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) ' shippingDestinationTypes: type: string maxLength: 50 description: 'Destination to where the item will be shipped. Example: Commercial, Residential, Store ' gift: type: boolean description: 'This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. ' passenger: type: object description: Contains travel-related passenger details used by DM service only. properties: type: type: string maxLength: 32 description: 'Passenger classification associated with the price of the ticket. You can use one of the following values: - `ADT`: Adult - `CNN`: Child - `INF`: Infant - `YTH`: Youth - `STU`: Student - `SCR`: Senior Citizen - `MIL`: Military ' status: type: string maxLength: 32 description: 'Your company''s passenger classification, such as with a frequent flyer program. In this case, you might use values such as `standard`, `gold`, or `platinum`. ' phone: type: string maxLength: 15 description: 'Passenger''s phone number. If the order is from outside the U.S., CyberSource recommends that you include the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). ' firstName: type: string maxLength: 60 description: Passenger's first name. lastName: type: string maxLength: 60 description: Passenger's last name. id: type: string maxLength: 40 description: 'ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number. ' email: type: string maxLength: 255 description: Passenger's email address, including the full domain name, such as jdoe@example.com. nationality: type: string maxLength: 2 description: Passenger's nationality country. Use the two character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). allowedExportCountries: type: array items: type: string description: 'Comma-separated list of ISO country codes for countries to which the product can be exported. If country codes are not specified, or if this field is not included, the U.S. government''s country code list is used. **Note** The default list of countries restricted by the U.S. always applies. Any country not specifically added to the export field is considered restricted. ' restrictedExportCountries: type: array items: type: string description: 'Comma-separated list of ISO country codes for countries to which the product cannot be exported. **Note** If the export field is also present, the content of the `restrictedExportCountries` field overrides the content of export. ' invoiceDetails: type: object properties: invoiceNumber: type: string description: Invoice Number. barcodeNumber: type: string description: Barcode Number. expirationDate: type: string description: Expiration Date. purchaseOrderNumber: type: string maxLength: 50 description: 'Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. ' purchaseOrderDate: type: string maxLength: 10 description: 'Date the order was processed. `Format: YYYY-MM-DD`. ' purchaseContactName: type: string maxLength: 36 description: 'The name of the individual or the company contacted for company authorized purchases. ' taxable: type: boolean description: "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" vatInvoiceReferenceNumber: type: string maxLength: 15 description: 'VAT invoice number associated with the transaction. ' commodityCode: type: string maxLength: 4 description: 'International description code of the overall order''s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. ' merchandiseCode: type: integer description: 'Identifier for the merchandise. This field is supported only on the processors listed in this field description. #### American Express Direct Possible value: - 1000: Gift card #### CyberSource through VisaNet This value must be right justified. In Japan, this value is called a _goods code_. #### JCN Gateway This value must be right justified. In Japan, this value is called a _goods code_. ' transactionAdviceAddendum: type: array items: type: object properties: data: type: string maxLength: 40 description: 'Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information about a transaction on the customer''s American Express card statement. When you send TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. To use these fields, contact CyberSource Customer Support to have your account enabled for this feature. ' referenceDataCode: type: string maxLength: 3 description: 'Code that identifies the value of the `referenceDataNumber` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' referenceDataNumber: type: string maxLength: 30 description: 'Reference number. The meaning of this value is identified by the value of the `referenceDataCode` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' salesSlipNumber: type: integer maximum: 99999 description: 'Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. ' invoiceDate: type: string maxLength: 8 description: 'Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' costCenter: type: string maxLength: 25 description: Cost centre of the merchant issuerMessage: type: string maxLength: 41 description: Text message from the issuer. If you give the customer a receipt, display this value on the receipt. productDescription: type: string description: Brief description of item. shippingDetails: type: object description: Contains shipping information not related to address. properties: giftWrap: type: boolean description: 'Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping. ' shippingMethod: type: string maxLength: 32 description: "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n\nKlarna Advantage Plus additional values:\n - `TO_DOOR`: Delivery to door\n - `TO_CURB`: Delivery to curb\n - `TO_MAILBOX`: Delivery to mailbox\n - `PICKUP_BOX`: Pickup from box\n - `PICKUP_POINT`: Pickup from point\n - `PICKUP_STORE`: Pickup from store\n - `PICKUP_WAREHOUSE`: Pickup from warehouse\n - `DIGITAL_EMAIL`: Digital delivery via email\n - `DIGITAL_DOWNLOAD`: Digital download\n - `DIGITAL_OTHER`: Other digital delivery\n - `PHYSICAL_OTHER`: Other physical delivery\n" shipFromPostalCode: type: string maxLength: 10 description: 'Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: `[5 digits][dash][4 digits]` Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: `[alpha][numeric][alpha][space] [numeric][alpha][numeric]` Example A1B 2C3 This field is frequently used for Level II and Level III transactions. ' shippingCarrier: type: string maxLength: 255 description: 'Name of the shipping carrier/company handling the delivery. ' digitalCurrency: type: object description: Digital currency information for the order. properties: type: type: string maxLength: 10 description: 'Currently, Visa uses a broad "cryptocurrency" indicator. The enhancement will introduce specific values to identify the type of digital currency or coin involved, such as Central Bank Digital Currency (CBDC), stable coins, blockchain-native tokens, and Non-Fungible Tokens (NFTs). Values: - 1: CBDC_TOKENDEPOSIT - 2: STABLE_COIN - 3: BLOCKCHAIN_NATIVE_TOKEN - 4: NFT' rampProviderCountry: type: string maxLength: 10 description: Ramp is a platform where we can buy Digital currency, for example Coinbase. This value identifies the country where the Ramp provider is registered. conversionAffiliate: type: string maxLength: 10 description: Affiliate is the platform for the digital currency transactions. The merchant provides the Affiliate country for transaction processing. The combination of affiliate country and ramp country helps to derive the foreign retail indicator. returnsAccepted: type: boolean description: 'This is only needed when you are requesting both payment and DM service at same time. Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order. ' isCryptocurrencyPurchase: type: string description: '#### Visa Platform Connect : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. Additional values to add : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. valid values are - Y/y, true - N/n, false ' cutoffDateTime: type: string description: 'Starting date and time for an event or a journey that is independent of which transportation mechanism, in UTC. The cutoffDateTime will supersede travelInformation.transit.airline.legs[].departureDate and travelInformation.transit.airline.legs[].departureTime if these fields are supplied in the request. Format: YYYY-MM-DDThh:mm:ssZ. Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ' preOrder: type: string description: 'Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability ' preOrderDate: type: string maxLength: 10 description: 'Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD ' reordered: type: boolean description: 'Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered ' totalOffersCount: type: string maxLength: 2 description: 'Total number of articles/items in the order as a numeric decimal count. Possible values: 00 - 99 ' buyerInformation: type: object properties: merchantCustomerId: type: string maxLength: 100 description: '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. ' dateOfBirth: type: string maxLength: 8 description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' vatRegistrationNumber: type: string maxLength: 20 description: 'Customer''s government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. ' companyTaxId: type: string maxLength: 9 description: 'Company''s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. ' personalIdentification: type: array items: type: object properties: type: type: string description: "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n -\t`BR_CPF` The individual tax ID type, typically is 11 characters long\n -\t`BR_CNPJ` The business tax ID type, typically is 14 characters long.\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" id: type: string maxLength: 26 description: "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" issuedBy: type: string description: 'The government agency that issued the driver''s license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer''s driver''s license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder''s passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. ' verificationResults: type: string description: 'Verification results received from Issuer or Card Network for verification transactions. Response Only Field. ' hashedPassword: type: string maxLength: 100 description: 'The merchant''s password that CyberSource hashes and stores as a hashed password. ' gender: type: string maxLength: 3 description: Customer's gender. Possible values are F (female), M (male),O (other). language: type: string maxLength: 5 description: "language setting of the user. \nSupports 2-character language codes (e.g., en, fr) and 5-character locale values (e.g., en-US, fr-CA).\n" noteToSeller: type: string maxLength: 255 description: Note to the recipient of the funds in this transaction mobilePhone: type: integer maxLength: 25 description: 'Cardholder''s mobile phone number. **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. ' walletId: type: string maxLength: 150 description: "The one-time identification code of the Alipay wallet user. \nIt is scanned from the barcode that is shown by the mobile application.\n" senderInformation: type: object properties: firstName: type: string maxLength: 30 description: "First name of the sender.\nThis field is applicable for AFT and OCT transactions. \n\nOnly alpha numeric values are supported.Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to the processor.\n" middleName: type: string maxLength: 30 description: "Middle name of the sender.\nThis field is applicable for AFT and OCT transactions. \n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.\n" lastName: type: string maxLength: 35 description: 'Last name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. ' address1: type: string maxLength: 35 description: "The street address of the sender.\nThis field is applicable for AFT transactions. \n \nOnly alpha numeric values are supported. \nSpecial characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.\n" locality: type: string maxLength: 25 description: "The city or locality of the sender.\nThis field is applicable for AFT transactions.\n\nOnly alpha numeric values are supported. \nSpecial characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.\n" administrativeArea: type: string maxLength: 2 description: 'The state or province of the sender. This field is applicable for AFT transactions when the sender country is US or CA. Else it is optional. Must be a two character value ' countryCode: type: string maxLength: 2 description: "The country associated with the address of the sender.\nThis field is applicable for AFT transactions. \n\nMust be a two character ISO country code. \nFor example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)\n" aliasName: type: string maxLength: 50 description: Sender's alias name. referenceNumber: type: string maxLength: 19 description: "This field is applicable for AFT transactions. \n\nContains a transaction reference number provided by the Merchant. Only alpha numeric values are supported.\n" account: type: object properties: number: type: string maxLength: 50 description: 'The account number of the entity funding the transaction. The value for this field can be a payment card account number or bank account number. ' type: type: string maxLength: 2 description: "Identifies the sender's account type.\nThis field is applicable for AFT transactions.\n\nValid values are:\n - `00` for Other\n - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)\n - `02` for International Bank Account Number (IBAN)\n - `03` for Card Account\n - `04` for Email\n - `05` for Phone Number\n - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code\n - `07` for Wallet ID\n - `08` for Social Network ID\n" fundsSource: type: string maxLength: 2 description: "Source of funds.\nPossible Values:\n - `01`: Credit.\n - `02`: Debit.\n - `03`: Prepaid.\n - `04`: Deposit Account.\n - `05`: Mobile Money Account.\n - `06`: Cash.\n - `07`: Other.\n - `V5`: Debits / deposit access other than those linked to the cardholders' scheme.\n - `V6`: Credit accounts other than those linked to the cardholder's scheme.\n" postalCode: type: string maxLength: 10 description: 'Postal code of sender. ' taxIdNumber: type: number maxLength: 14 x-nullable: true description: 'CPF or CNPJ of the cash-in recipient. "Cadastro de Pessoas Físicas", which translates to the "Natural Persons Register." It is the individual taxpayer registry identification number in Brazil, similar to a Social Security Number (SSN) in the United States or a National Insurance Number in the UK. ' recipientInformation: type: object properties: accountId: type: string maxLength: 50 description: 'Identifier for the recipient''s account. This field is applicable for AFT transactions. ' accountType: type: string maxLength: 2 description: "Identifies the recipient's account type.\nThis field is applicable for AFT transactions.\n\nValid values are:\n - `00` for Other\n - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)\n - `02` for International Bank Account Number (IBAN)\n - `03` for Card Account\n - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code\n" firstName: type: string maxLength: 35 description: "First name of the recipient.\nThis field is applicable for AFT transactions. \n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor.\n" middleName: type: string maxLength: 30 description: 'Middle name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. ' lastName: type: string maxLength: 35 description: 'Last name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. ' address1: type: string maxLength: 50 description: "The street address of the recipient\nThis field is applicable for AFT and OCT transactions.\n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. \n" administrativeArea: type: string maxLength: 2 description: 'The state or province of the recipient. This field is applicable for AFT transactions when the recipient country is US or CA. Else it is optional. Must be a two character value ' postalCode: type: string maxLength: 10 description: 'Partial postal code for the recipient''s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' country: type: string maxLength: 2 description: "The country associated with the address of the recipient.\nThis field is applicable for AFT and OCT transactions.\n\nMust be a two character ISO country code. \nFor example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)\n" dateOfBirth: type: string maxLength: 8 description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' beneficiaryId: type: string maxLength: 255 description: 'Only for e-wallets: ID, username, hash or anything uniquely identifying the ultimate beneficiary. ' beneficiaryName: type: string maxLength: 255 description: 'Only for e-wallets: The ultimate beneficiary''s full name. ' beneficiaryAddress: type: string maxLength: 255 description: 'Only for e-wallets: The ultimate beneficiary''s street address (street, zip code, city), excluding the country. Example: "Main street 1, 12345, Barcelona ' aliasName: type: string maxLength: 50 description: 'Account owner alias name. ' nationality: type: string maxLength: 10 description: Account Owner Nationality countryOfBirth: type: string maxLength: 10 description: Account Owner Country of Birth occupation: type: string maxLength: 50 description: Account Owner Occupation email: type: string maxLength: 150 description: Account Owner email address locality: type: string maxLength: 25 description: 'The city of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. ' taxIdNumber: type: number maxLength: 14 x-nullable: true description: 'CPF or CNPJ of the cash-in recipient. "Cadastro de Pessoas Físicas", which translates to the "Natural Persons Register." It is the individual taxpayer registry identification number in Brazil, similar to a Social Security Number (SSN) in the United States or a National Insurance Number in the UK. ' deviceInformation: type: object properties: id: type: string description: 'Value created by the client software that uniquely identifies the POS device. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only for authorizations and credits on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. String (32) ' hostName: type: string maxLength: 60 description: DNS resolved hostname from `ipAddress`. ipAddress: type: string maxLength: 45 description: 'IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. ' userAgent: type: string maxLength: 40 description: 'Customer''s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. ' fingerprintSessionId: type: string description: 'Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual''s web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. ' useRawFingerprintSessionId: type: boolean description: 'Boolean that indicates whether request contains the device fingerprint information. Values: - `true`: Use raw fingerprintSessionId when looking up device details. - `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection. ' deviceType: type: string maxLength: 60 description: The device type at the client side. appUrl: type: string description: 'This field will contain the deep link that would help the Customer App to wake up. ' metadata: type: string maxLength: 36 description: 'Verifies that the payment is originating from a valid, user-approved application and device. Sending this field helps reduce fraud and declined transactions. Note The length is set for a hexadecimal representation of the GUID/UUID. This field accepts a 36-character string (with hyphens) or a 32-character string (without hyphens). Example 123e4567-e89b-12d3-a456-426655440000 Example 123e4567e89b12d3a456426655440000 ' rawData: type: array items: type: object properties: data: type: string description: 'Field that contains the device fingerprint data from the specified provider. The value should be Base64 encoded. ' provider: type: string maxLength: 32 description: 'Possible values: - cardinal - inauth - threatmetrix ' httpAcceptBrowserValue: type: string maxLength: 255 description: 'Value of the Accept header sent by the customer''s web browser. **Note** If the customer''s browser provides a value, you must include it in your request. ' httpAcceptContent: type: string maxLength: 256 description: 'The exact content of the HTTP accept header. ' httpBrowserEmail: type: string description: 'Email address set in the customer''s browser, which may differ from customer email. ' httpBrowserLanguage: type: string maxLength: 8 description: 'Value represents the browser language as defined in IETF BCP47. Example:en-US, refer https://en.wikipedia.org/wiki/IETF_language_tag for more details. ' httpBrowserJavaEnabled: type: boolean description: 'A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False ' httpBrowserJavaScriptEnabled: type: boolean description: 'A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. **Note**: Merchants should be able to know the values from fingerprint details of cardholder''s browser. ' httpBrowserColorDepth: type: string maxLength: 2 description: 'Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer https://en.wikipedia.org/wiki/Color_depth for more details ' httpBrowserScreenHeight: type: string maxLength: 6 description: 'Total height of the Cardholder''s scree in pixels, example: 864. ' httpBrowserScreenWidth: type: string maxLength: 6 description: 'Total width of the cardholder''s screen in pixels. Example: 1536. ' httpBrowserTimeDifference: type: string maxLength: 5 description: 'Time difference between UTC time and the cardholder browser local time, in minutes, Example:300 ' userAgentBrowserValue: type: string maxLength: 255 description: 'Value of the User-Agent header sent by the customer''s web browser. Note If the customer''s browser provides a value, you must include it in your request. ' merchantInformation: type: object properties: merchantDescriptor: type: object properties: name: type: string description: 'Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. **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. **Important** This value must consist of English characters. Required for captures and credits. ' alternateName: type: string maxLength: 13 description: 'An alternate name for the merchant. ' contact: type: string maxLength: 25 description: 'Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) ' address1: type: string maxLength: 60 description: 'First line of merchant''s address. ' locality: type: string maxLength: 30 description: 'Merchant''s City. #### PIN debit City for your business location. This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. ' country: type: string maxLength: 3 description: 'Merchant''s country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** 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`. Optional field for PIN debit credit or PIN debit purchase. ' postalCode: type: string maxLength: 14 description: 'Merchant''s postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder''s statement. If 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` If 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` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. ' administrativeArea: type: string description: 'The state where the merchant is located. #### PIN debit State 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. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase. ' phone: type: string maxLength: 13 description: 'Merchant phone as contact information for CNP transactions ' url: type: string maxLength: 255 description: 'Address of company''s website provided by merchant ' countryOfOrigin: type: string maxLength: 2 description: '#### Visa Platform Connect This field will indicate merchant country of origin ' storeId: type: string maxLength: 50 description: 'The identifier of the store. ' storeName: type: string maxLength: 50 description: 'The name of the store. ' customerServicePhoneNumber: type: string maxLength: 27 description: '#### Visa Platform Connect Indicates customer service phone number of Merchant. ' domainName: type: string maxLength: 127 description: 'This field will contain either the merchant url or the reverse domain as per the requirement for DSRP Format 3. This might vary transaction to transaction and might not be static. Merchant needs to have access to send this value for all DSRP program. ' salesOrganizationId: type: string maxLength: 11 description: 'Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **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. ' categoryCode: type: integer maximum: 9999 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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code ' 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 card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company''s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct. ' taxId: type: string maxLength: 15 description: 'Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 ' vatRegistrationNumber: type: string maxLength: 21 description: 'Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. ' cardAcceptorReferenceNumber: type: string maxLength: 25 description: 'Reference number that facilitates card acceptor/corporation communication and record keeping. ' transactionLocalDateTime: type: string maxLength: 14 description: "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where:\n - `YYYY` = year\n - `MM` = month\n - `DD` = day\n - `hh` = hour\n - `mm` = minutes\n - `ss` = seconds\n\n#### Used by\n**Authorization**\nRequired for these processors:\n- American Express Direct - American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- SIX\n\nOptional for all other processors.\n" serviceFeeDescriptor: type: object properties: name: type: string maxLength: 22 description: 'Name of the service provider that is collecting the service fee. The service provider name must consist of 3, 7, or 12 characters followed by an asterisk (*). This value must also include the words "Service Fee." When you include more than one consecutive space, extra spaces are removed. Use one of the following formats for this value: - <3-character name>*Service Fee - <7-character name>*Service Fee - <12-character name>*Service Fee When payments are made in installments, this value must also include installment information such as "1 of 5" or "3 of 7." For installment payments, use one of the following formats for this value: - <3-character name>*Service Fee* of - <7-character name>*Service Fee* of - <12-character name>*Service Fee* of where is the payment number and is the total number of payments. When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account. This value might be displayed on the cardholder''s statement. ' contact: type: string maxLength: 11 description: 'Contact information for the service provider that is collecting the service fee. when you include more than one consecutive space, extra spaces are removed. When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account. This value might be displayed on the cardholder''s statement. ' state: type: string maxLength: 20 description: 'State or territory in which the service provider is located. When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account. This value might be displayed on the cardholder''s statement. ' cancelUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction successUrl: type: string maxLength: 2048 description: customer would be redirected to this url based on the decision of the transaction failureUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction returnUrl: type: string maxLength: 255 minLength: 7 description: 'URL for displaying payment results to the consumer (notifications) after the transaction is processed. Usually this URL belongs to merchant and its behavior is defined by merchant ' partnerIdCode: type: string maxLength: 10 description: '#### Visa Platform Connect This field may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners. ' serviceLocation: type: object properties: locality: type: string maxLength: 20 description: '#### Visa Platform Connect Merchant''s service location city name. When merchant provides services from a location other than the location identified as merchant location. ' countrySubdivisionCode: type: string maxLength: 9 description: '#### Visa Platform Connect Merchant''s service location country subdivision code. When merchant provides services from a location other than the location identified as merchant location. ' countryCode: type: string maxLength: 3 description: '#### Visa Platform Connect Merchant''s service location country code. When merchant provides services from a location other than the location identified as merchant location. ' postalCode: type: string maxLength: 10 description: '#### Visa Platform Connect Merchant''s service location postal code. When merchant provides services from a location other than the location identified as merchant location. ' noteToBuyer: type: string maxLength: 165 description: 'Free-form text field. ' merchantName: type: string maxLength: 25 description: 'Use this field only if you are requesting payment with Payer Authentication serice together. Your company''s name as you want it to appear to the customer in the issuing bank''s authentication form. This value overrides the value specified by your merchant bank. ' aggregatorInformation: type: object properties: aggregatorId: type: string maxLength: 20 description: 'Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\ This value must consist of uppercase characters. ' name: type: string maxLength: 37 description: 'Your payment aggregator business name. **American Express Direct**\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant 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. **FDC Compass**\ This value must consist of uppercase characters. ' subMerchant: type: object properties: cardAcceptorId: type: string maxLength: 15 description: Unique identifier assigned by the payment card company to the sub-merchant. id: type: string maxLength: 20 description: 'The ID you assigned to your sub-merchant. CyberSource through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 65-84 - Field: American Express Seller ID For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 117-131 - Field: Sub-Merchant ID FDC Compass: This value must consist of uppercase characters. American Express Direct: String (20) CyberSource through VisaNet with American Express: String (20) CyberSource through VisaNet with Visa,Mastercard and Discover: String (15) FDC Compass: String (20) FDC Nashville Global: String (14) ' name: type: string maxLength: 37 description: 'Sub-merchant''s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. ' address1: type: string maxLength: 38 description: 'First line of the sub-merchant''s street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ' locality: type: string maxLength: 21 description: 'Sub-merchant''s city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ' administrativeArea: type: string maxLength: 50 description: 'Sub-merchant''s state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ' region: type: string maxLength: 3 description: 'Sub-merchant''s region. **Example**\ `NE` indicates that the sub-merchant is in the northeast region. ' postalCode: type: string maxLength: 15 description: 'Partial postal code for the sub-merchant''s address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ' country: type: string maxLength: 3 description: 'Sub-merchant''s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. ' email: type: string maxLength: 40 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'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" merchantCategoryCode: type: number maxLength: 20 x-nullable: true streetAddress: type: string maxLength: 150 description: Acquirer street name. city: type: string maxLength: 100 description: Acquirer city. state: type: string maxLength: 10 description: Acquirer state. postalCode: type: string maxLength: 20 description: Acquirer postal code. country: type: string maxLength: 10 description: Acquirer country. serviceProvidername: type: string maxLength: 50 description: Contains transfer service provider name. consumerAuthenticationInformation: type: object properties: cavv: type: string maxLength: 40 description: Cardholder authentication verification value (CAVV). transactionFlowIndicator: type: string maxLength: 2 description: 'This field details out the type of transaction. Below are the possible values. 08:GC- Guest Checkout. ' cavvAlgorithm: type: string maxLength: 1 description: 'Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check. ' eciRaw: type: string maxLength: 2 description: 'Raw electronic commerce indicator (ECI). ' paresStatus: type: string maxLength: 1 description: 'Payer authentication response status. ' veresEnrolled: type: string maxLength: 1 description: 'Verification response enrollment status. ' xid: type: string maxLength: 40 description: 'Transaction identifier. ' ucafCollectionIndicator: type: string maxLength: 1 description: 'Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator ' ucafAuthenticationData: type: string maxLength: 32 description: 'Universal cardholder authentication field (UCAF) data. ' strongAuthentication: type: object properties: issuerInformation: type: object properties: exemptionDataRaw: type: string maxLength: 4 description: "Payer authentication exemption indicator for Carte Bancaire exemptions. \nThis is used with unbundled authentication and authorizations calls, for example: \"low fraud merchant program\".\nThe value for this field maps to the value returned in the payer authentication API response field -\n`consumerAuthenticationInformation.exemptionDataRaw`.\n" lowValueExemptionIndicator: type: string maxLength: 1 description: 'This field will contain the low value exemption indicator with one of the following values: Possible values: - `0` ( low value exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment) ' riskAnalysisExemptionIndicator: type: string maxLength: 1 description: 'This field will contain the transaction risk analysis exemption indicator with one of the following values: Possible values: - `0` (TRA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it to be low risk in accordance with the criteria defined by PSD2/RTS) ' trustedMerchantExemptionIndicator: type: string maxLength: 1 description: 'Possible values: - `0` (Trusted merchant exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as it originated at a merchant trusted by the cardholder) ' secureCorporatePaymentIndicator: type: string maxLength: 1 description: 'This field will contain the secure corporate payment exemption indicator with one of the following values: Possible values: - `0` (SCA exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as the merchant/acquirer has determined it as a secure corporate payment) ' delegatedAuthenticationExemptionIndicator: type: string maxLength: 1 description: 'This field will contain the delegated authentication exemption indicator with one of the following values: Possible values: - `0` (delegated Authentication exemption does not apply to the transaction) - `1` (Transaction exempt from SCA as authentication has been delegated to other provider (PSP,Acquirer)) ' outageExemptionIndicator: type: string maxLength: 1 description: 'This field will contain the outage exemption indicator with one of the following values: Possible values: - `0` (Outage Authentication exemption does not apply to the transaction) - `1` (Outage exempt from SCA as authentication could not be done due to outage) ' authenticationIndicator: type: string maxLength: 2 description: 'Indicates the type of Authentication request 01 - Payment transaction 02 - Recurring transaction 03 - Installment transaction 04 - Add card 05 - Maintain card 06 - Cardholder verification as part of EMV token ID and V ' directoryServerTransactionId: type: string maxLength: 36 description: "The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results.\nFor Cybersource Through Visanet Gateway:\nThe value for this field corresponds to the following data in the TC 33 capture file3: \nRecord: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID\n" paSpecificationVersion: type: string maxLength: 20 description: "This field contains 3DS version that was used for Secured Consumer Authentication (SCA). \nThe value for this field should be in the format major.minor.patch version.\n\nValid Values are:\n\n- `2.1.0` (EMV 3D Secure Version 2.1)\n- `2.2.0` (EMV 3D Secure Version 2.2)\n- `2.3.0` (EMV 3D Secure Version 2.3)\n- `2.4.0` (EMV 3D Secure Version 2.4)\n- `2.5.0` (EMV 3D Secure Version 2.5)\n- `2.6.0` (EMV 3D Secure Version 2.6)\n- `2.7.0` (EMV 3D Secure Version 2.7)\n- `2.8.0` (EMV 3D Secure Version 2.8)\n- `2.9.0` (EMV 3D Secure Version 2.9)\n\nFor Visa Platform Connect: \nThe value for this field corresponds to the following data in the TC 33 capture file3: \nRecord: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol\n\nIt will contain one of the following values:\n- `1` (3D Secure Version 1.x (3DS 1.0))\n- `2` (EMV 3-D Secure (3DS 2.x))\n" authenticationType: type: string maxLength: 2 description: 'Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled 20 - OTP hosted at merchant end. (Rupay S2S flow) **NOTE**: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time. ' responseAccessToken: type: string description: 'JWT returned by the 3D Secure provider when the authentication is complete. Required for Hybrid integration if you use the Cybersource-generated access token. Note: Max. length of this field is 2048 characters. ' acsTransactionId: type: string maxLength: 36 description: 'Unique transaction identifier assigned by the ACS to identify a single transaction. This field is supported for Cartes Bancaires Fast''R transactions on Credit Mutuel-CIC. ' acsWindowSize: type: string maxLength: 2 description: 'An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS (Active Control Server) will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window. 01 - 250x400 02 - 390x400 03 - 500x600 04 - 600x400 05 - Full page ' alternateAuthenticationData: type: string maxLength: 2048 description: 'Data that documents and supports a specific authentication process. ' alternateAuthenticationDate: type: string maxLength: 14 description: 'Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM ' alternateAuthenticationMethod: type: string description: 'Mechanism used by the cardholder to authenticate to the 3D Secure requestor. Possible values: - `01`: No authentication occurred - `02`: Login using merchant system credentials - `03`: Login using Federated ID - `04`: Login using issuer credentials - `05`: Login using third-party authenticator - `06`: Login using FIDO Authenticator ' authenticationDate: type: string maxLength: 14 description: 'The date/time of the authentication at the 3DS servers. RISK update authorization service in auth request payload with value returned in `consumerAuthenticationInformation.alternateAuthenticationData` if merchant calls via CYBS or field can be provided by merchant in authorization request if calling an external 3DS provider. This field is supported for Cartes Bancaires Fast''R transactions on Credit Mutuel-CIC. Format: YYYYMMDDHHMMSS ' authenticationTransactionId: type: string maxLength: 26 description: 'Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages.For Rupay,this is passed only in Re-Send OTP usecase. **Note**: Required for Standard integration, Rupay Seamless server to server integration for enroll service. Required for Hybrid integration for validate service. ' challengeCancelCode: type: string maxLength: 2 description: 'An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK ' challengeCode: type: string description: 'Possible values: - `01`: No preference - `02`: No challenge request - `03`: Challenge requested (3D Secure requestor preference) - `04`: Challenge requested (mandate) - `05`: No challenge requested (transactional risk analysis is already performed) - `06`: No challenge requested (Data share only) - `07`: No challenge requested (strong consumer authentication is already performed) - `08`: No challenge requested (utilize whitelist exemption if no challenge required) - `09`: Challenge requested (whitelist prompt requested if challenge required) **Note** This field will default to `01` on merchant configuration and can be overridden by the merchant. EMV 3D Secure version 2.1.0 supports values `01-04`. Version 2.2.0 supports values `01-09`. ' challengeStatus: type: string maxLength: 2 description: 'The `consumerAuthenticationInformation.challengeCode` indicates the authentication type/level, or challenge, that was presented to the cardholder at checkout by the merchant when calling the Carte Bancaire 3DS servers via CYBS RISK services. It conveys to the issuer the alternative authentication methods that the consumer used. ' customerCardAlias: type: string maxLength: 128 description: 'An alias that uniquely identifies the customer''s account and credit card on file. Note This field is required if Tokenization is enabled in the merchant profile settings. ' decoupledAuthenticationIndicator: type: string maxLength: 1 description: 'Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N ' decoupledAuthenticationMaxTime: type: string maxLength: 5 description: 'Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS (Active control server) to provide the results of a Decoupled Authentication transaction (in minutes). Possible Values: Numeric values between 1 and 10080 accepted. ' defaultCard: type: boolean description: 'Indicates that the card being used is the one designated as the primary payment card for purchase. Recommended for Discover ProtectBuy. ' deviceChannel: type: string maxLength: 10 description: 'Determines the channel that the transaction came through. Possible Values: SDK/Browser/3RI. 3RI - 3DS request initiated. ' installmentTotalCount: type: integer maxLength: 4 description: 'An integer value greater than 1 indicating the max number of permitted authorizations for installment payments. **Note** This is required if the merchant and cardholder have agreed to installment payments. ' merchantFraudRate: type: string maxLength: 2 description: 'Calculated by merchants as per PSD2** RTS** (EEA** card fraud divided by all EEA card volumes). Possible Values: 1 = Represents fraud rate <=1 2 = Represents fraud rate >1 and <=6 3 = Represents fraud rate >6 and <=13 4 = Represents fraud rate >13 and <=25 5 = Represents fraud rate >25 EEA** = European Economic Area RTS** = Regulatory Technical Standards PSD2** = Payment Services Directive ' marketingOptIn: type: boolean description: 'Indicates whether the customer has opted in for marketing offers. Recommended for Discover ProtectBuy. ' marketingSource: type: string maxLength: 40 description: 'Indicates origin of the marketing offer. Recommended for Discover ProtectBuy. ' mcc: type: string maxLength: 4 description: 'Merchant category code. **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. ' merchantScore: type: integer maxLength: 2 description: 'Risk Score provided by merchants. This is specific for CB transactions. ' messageCategory: type: string description: 'Category of the message for a specific use case. Possible values: - `01`: PA- payment authentication - `02`: NPA- non-payment authentication - `03-79`: Reserved for EMVCo future use (values invalid until defined by EMVCo) - `80-99`: Reserved for DS use ' networkScore: type: string maxLength: 2 description: "The global score calculated by the CB scoring platform and returned to merchants.\n\nPossible values: \n- '00' - '99'\n\nWhen you request the payer authentication and authorization services separately, get the value for this field from the pa_network_score reply field. \n\nThis field is supported only for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC.\n" npaCode: type: string maxLength: 2 description: 'Non-Payer Authentication Indicator. Possible values: - `01`: Add card - `02`: Maintain card information - `03`: Cardholder verification for EMV token - `04-80` Reserved for EMVCo - `80-90` Reserved DS ' overridePaymentMethod: type: string description: 'Specifies the Brazilian payment account type used for the transaction. This field overrides other payment types that might be specified in the request. Use one of the following values for this field: - `NA`: Not applicable. Do not override other payment types that are specified in the request. - `CR`: Credit card. - `DB`: Debit card. - `VSAVR`: Visa Vale Refeicao - `VSAVA`: Visa Vale Alimentacao **Important** Required only for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. ' overrideCountryCode: type: string maxLength: 2 description: 'Two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).. ' priorAuthenticationData: type: string maxLength: 2048 description: 'This field carry data that the ACS can use to verify the authentication process. ' priorAuthenticationMethod: type: string maxLength: 2 description: 'Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. 01 - Frictionless authentication occurred by ACS 02 - Cardholder challenge occurred by ACS 03 - AVS verified 04 - Other issuer methods 05-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 - Reserved for DS use ' priorAuthenticationReferenceId: type: string maxLength: 36 description: 'This data element contains a ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder ' priorAuthenticationTime: type: string maxLength: 12 description: 'Date and time in UTC of the prior cardholder authentication. Format – YYYYMMDDHHMM ' productCode: type: string maxLength: 3 description: 'Specifies the product code, which designates the type of transaction. Specify one of the following values for this field: - AIR: Airline purchase Important Required for American Express SafeKey (U.S.). - `ACC`: Accommodation Rental - `ACF`: Account funding - `CHA`: Check acceptance - `DIG`: Digital Goods - `DSP`: Cash Dispensing - `GAS`: Fuel - `GEN`: General Retail - `LUX`: Luxury Retail - `PAL`: Prepaid activation and load - `PHY`: Goods or services purchase - `QCT`: Quasi-cash transaction - `REN`: Car Rental - `RES`: Restaurant - `SVC`: Services - `TBD`: Other - `TRA`: Travel **Important** Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions. ' returnUrl: type: string maxLength: 2048 description: 'The URL of the merchant''s return page. CyberSource adds this return URL to the step-up JWT and returns it in the response of the Payer Authentication enrollment call. The merchant''s return URL page serves as a listening URL. Once the bank session completes, the merchant receives a POST to their URL. This response contains the completed bank session''s transactionId. The merchant''s return page should capture the transaction ID and send it in the Payer Authentication validation call. ' requestorId: type: string maxLength: 35 description: Cardinal's directory server assigned 3DS Requestor ID value requestorInitiatedAuthenticationIndicator: type: string maxLength: 2 description: 'Indicates the type of 3RI request. Possible Values: 01 - Recurring transaction 02 - Installment transaction 03 - Add card 04 - Maintain card 05 - Account verification 06 - Split/delayed shipment 07 - Top-up 08 - Mail Order 09 - Telephone Order 10 - Whitelist status check 11 - Other payment ' requestorName: type: string maxLength: 40 description: Cardinal's directory server assigned 3DS Requestor Name value referenceId: type: string maxLength: 50 description: 'Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration. ' sdkMaxTimeout: type: string maxLength: 2 description: 'This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Possible Values: Greater than or equal to 05 (05 is the minimum timeout to set) Cardinal Default is set to 15 NOTE: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed ' secureCorporatePaymentIndicator: type: string maxLength: 1 description: 'Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1 ' transactionMode: type: string description: 'Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `M`: MOTO (Mail Order Telephone Order) - `R`: Retail - `S`: eCommerce - `P`: Mobile Device - `T`: Tablet ' whiteListStatus: type: string maxLength: 1 description: 'Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder ' authenticationBrand: type: string maxLength: 16 description: "Indicates which directory server was used while authentication process, this data is useful in case of scenarios \nwhen domestic scheme directory server is not present and authentication fallbacks to global scheme directory server.\nPossible values:\n- VISA - Returned for Mada VISA Co-badged cards, when authentication falls back to VISA Directory Server\n- MASTERCARD - Returned for Mada MasterCard Co-badged cards, when authentication falls back to MasterCard Directory Server\n" effectiveAuthenticationType: type: string maxLength: 2 description: 'This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). ' signedParesStatusReason: type: string maxLength: 2 description: 'Provides additional information as to why the PAResStatus has a specific value. ' signedPares: type: string description: 'Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see "Storing Payer Authentication Data," page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request. ' acsReferenceNumber: type: string maxLength: 50 description: Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. dsReferenceNumber: type: string maxLength: 32 description: 'EMVCo-assigned unique identifier. This field is required in Cardholder Initiated 3DS fully authenticated mada transactions. When you request the payer authentication and authorization services separately, get the value for this field from the payerAuthEnrollReply_dsReferenceNumber or payerAuthValidateReply_dsReferenceNumber response field. ' scoreRequest: type: integer description: Risk Assessment from Mastercard. This is to be sent by merchant if they would like to request a score pointOfSaleInformation: type: object properties: terminalId: type: string maxLength: 8 description: "Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.\n\n#### CyberSource through VisaNet\nA list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for\nyour CyberSource account, the value you send for this field is validated against the list each time you include\nthe field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support.\n\nWhen you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account.\n\n#### FDC Nashville Global\nTo have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you.\n\n#### For Payouts\nThis field is applicable for CyberSource through VisaNet.\n\n#### GPX\nIdentifier for the terminal at your retail location. A list of all possible values is stored in your account.\nIf terminal ID validation is enabled for your account, the value you send for this field is validated against\nthe list each time you include the field in a request. To enable or disable terminal ID validation, contact\ncustomer support.\n\nWhen you do not include this field in a request, the default value that is defined in your account is used.\n\nOptional for authorizations.\n\n#### Used by\n**Authorization**\nOptional for the following processors. When you do not include this field in a request, the default value that is\ndefined in your account is used.\n - American Express Direct\n - Credit Mutuel-CIC\n - FDC Nashville Global\n - SIX\n- Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`.\n- FDMS Nashville: The default value that is defined in your account is used.\n- GPX\n- OmniPay Direct: Optional field.\n\nFor the following processors, this field is not used.\n- GPN\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n- Worldpay VAP\n\n#### Card Present reply\nTerminal identifier assigned by the acquirer. This value must be printed on the receipt.\n" terminalSerialNumber: type: string maxLength: 32 description: 'Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' cardholderVerificationMethodUsed: type: integer description: "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n - `4`: Biometric\n - `5`: OTP\n" laneNumber: type: string maxLength: 8 description: 'Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Otherwise, this field is not used by all other processors. Use the `terminalId` field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this `laneNumber` field to identify the terminal used for the transaction. This field is a pass-through, which means that the value is not checked or modified in any way before sending it to the processor. Optional field. #### Card present reply messaging Identifier for an alternate terminal at your retail location. You defined the value for this field in the request message. This value must be printed on the receipt. This field is supported only for MasterCard transactions on FDC Nashville Global. ' catLevel: type: integer minimum: 1 maximum: 11 description: "Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n - 10: Card Activated Fuel Dispenser\n - 11: Travel ticket vending machine\n#### Chase Paymentech Solutions\nOnly values 1, 2, and 3 are supported.\n\nRequired if `pointOfSaleInformation.terminalID` is included in the request; otherwise, optional.\n\n#### CyberSource through VisaNet\nValues 1 through 6 are supported on\nCyberSource through VisaNet, but some\nacquirers do not support all six values.\n\nOptional field.\n\n#### FDC Nashville Global\nOnly values 7, 8, and 9 are supported.\n\nOptional field for EMV transactions; otherwise, not used.\n\n#### GPN\nOnly values 6, 7, 8, and 9 are supported.\n\nRequired field.\n\n#### JCN Gateway\nOnly values 6, 7, 8, and 9 are supported.\n\nRequired field.\n\n#### TSYS Acquiring Solutions\nOnly value 6 is supported.\n\nRequired for transactions from mobile devices; otherwise, not used.\n\n#### All other processors\nNot used.\n\nNonnegative integer.\n" entryMode: type: string maxLength: 11 description: "Method of entering payment card information into the POS terminal. Possible values:\n\n - `contact`: Read from direct contact with chip card.\n - `contactless`: Read from a contactless interface using chip data.\n - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct.\n - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct.\n - `swiped`: Read from credit card magnetic stripe.\n\nThe `contact`, `contactless`, and `msd` values are supported only for EMV transactions.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### Card Present\nCard present information about EMV applies only to credit card processing and PIN debit processing. All other\ncard present information applies only to credit card processing.\n\n#### PIN debit\nRequired for a PIN debit purchase and a PIN debit credit request.\n" terminalCapability: type: integer minimum: 1 maximum: 5 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 maxLength: 1 description: 'Operating environment. Possible values for all card types except Mastercard: - `0`: No terminal used or unknown environment. - `1`: On merchant premises, attended. - `2`: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA). - `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - `4`: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA. - `5`: On premises of cardholder, unattended. - `9`: Unknown delivery mode. - `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. #### Possible values for Mastercard: - `2`: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. - `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. This field is supported only for American Express Direct and CyberSource through VisaNet. ' emv: type: object properties: 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 \"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\nFor Mastercard Transactions, Optionally Tag 9F60 (Authenticated Application Data) and \nTag 96 (Kernel Identifier - Terminal) can be included in the Field.\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 description: "Method that was used to verify the cardholder's identity.\n\nPossible values:\n - `0`: No verification\n - `1`: Signature\n\nThis field is supported only on **American Express Direct**.\n" cardSequenceNumber: type: string maxLength: 3 description: "Number assigned to a specific card when two or more cards are associated with the same primary account number.\n\nThis value enables issuers to distinguish among multiple cards that are linked to the same account.\n\nThis value can also act as a tracking tool when reissuing cards. \n\nWhen this value is available, it is provided by the chip reader. \n\nWhen the chip reader does not provide this value, do not include this field in your request.\n\nWhen sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Visa and Mastercard transactions. To enable this feature please call support.\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\n\nAll other card present information applies only to credit card processing. \n\nPIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global.\n\n#### Used by\nAuthorization: Optional\nPIN Debit processing: Optional\n\n#### GPX\n\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" fallback: type: boolean maxLength: 5 description: "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\n\nPossible values:\n- `true`: Fallback method was used.\n- `false` (default): Fallback method was not used.\n\nThis field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet,\nFDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.\n" fallbackCondition: type: integer description: "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - `1`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - `2`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN** and **JCN Gateway**.\n**NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field\nwhen the EMV terminal does not have any applications in common with the EMV card.\n" isRepeat: type: boolean description: '#### Visa Platform Connect Value "true" indicates this transaction is intentionally duplicated . The field contains value "true" which indicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending a duplicate auth request for a single tap txn because the issuer requested a PIN. ' amexCapnData: type: string maxLength: 15 description: 'Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. ' trackData: type: string 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 maxLength: 1 description: 'When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. Possible values: - `Y`: Transaction was stored and then forwarded. - `N` (default): Transaction was not stored and then forwarded. For authorizations and credits, this field is supported only on these processors: - American Express Direct - FDC Nashville Global - OmniPay Direct - SIX Optional field. ' cardholderVerificationMethod: type: array items: type: string example: - PIN - Signature - pinOnGlass description: 'Complete list of cardholder verification methods (CVMs) supported by the terminal. Optional field. Possible values: - `PIN`: For terminals with a PIN Pad - `Signature`: For terminals capable of receiving a signature - `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism **EXAMPLE**: ["PIN","Signature"]; ["pinOnGlass","Signature"] ' terminalCategory: type: string maxLength: 3 description: "Indicates the type of terminal. \n\nPossible values:\n- `AFD`: Automated Fuel Dispenser\n" terminalInputCapability: type: array items: type: string description: 'Complete list of card input methods supported by the terminal. Possible values: - `Keyed`: Terminal can accept card data that is entered manually. - `Swiped`: Terminal can accept card data from a magnetic stripe reader. - `Contact`: Terminal can accept card data in EMV contact mode ("dipping a card"). - `Contactless`: Terminal can accept card data in EMV contactless mode ("tapping a card"). - `BarCode`: Terminal can read bar codes. - `QRcode`: Terminal can read or scan QR codes. - `OCR`: Terminal can perform optical character recognition (OCT) on the card. **EXAMPLE**: ["Keyed","Swiped","Contact","Contactless"] #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' terminalCardCaptureCapability: type: string maxLength: 1 description: 'Indicates whether the terminal can capture the card. Possible values: - `1`: Terminal can capture card. - `0`: Terminal cannot capture card. For authorizations and credits, this field is supported only by these processors: - American Express Direct - Credit Mutuel-CIC - OmniPay Direct Optional field. ' terminalOutputCapability: type: string maxLength: 1 description: 'Indicates whether the terminal can print or display messages. Possible values: - 1: Neither - 2: Print only - 3: Display only - 4: Print and display - 5: Merchant terminal supports purchase only approvals This field is supported for authorizations and credits only on the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX - VisaNet Optional field. ' terminalPinCapability: type: integer description: 'Maximum PIN length that the terminal can capture. Possible values: - 0: No PIN capture capability - 1: PIN capture capability unknown - 2: PIN Pad down - 4: Four characters - 5: Five characters - 6: Six characters - 7: Seven characters - 8: Eight characters - 9: Nine characters - 10: Ten characters - 11: Eleven characters - 12: Twelve characters This field is supported for authorizations and credits only on the following processors: - American Express Direct - Credit Mutuel-CIC - OmniPay Direct - SIX - Visa Platform Connect Required field for authorization or credit of PIN transactions. ' pinEntrySolution: type: string description: 'This field will contain the type of Pin Pad the terminal has. Possible values: - PCI-SPoC: Where the pin is being put on screen - PCI-PTS: Where the pin is being put on actual hardware pin pad ' deviceId: type: string maxLength: 32 description: 'Value created by the client software that uniquely identifies the POS device. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. ' pinBlockEncodingFormat: type: integer maximum: 9 description: 'Format that is used to encode the PIN block. This value is provided by the client software that is installed on the POS terminal. Possible values: - `0`: ISO 9564 format 0 - `1`: ISO 9564 format 1 - `2`: ISO 9564 format 2 - `3`: ISO 9564 format 3 #### Used by **Authorization, PIN Debit** - Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. - Required for PIN debit credit or PIN debit purchase. For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also supported by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | --- | --- | --- | --- | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes | #### GPX For chip and online PIN transactions for authorization, GPX supports the following EMV Cards and Cardholder Verification Methods (CVMs): - Chip and Offline PIN - Chip and Signature For PIN Debit Purchase and Credit Service transactions, GPX supports the following EMV Cards and Cardholder Verification Methods (CVMs): - Chip and Online PIN ' encryptedPin: type: string maxLength: 16 description: 'Encrypted PIN. This value is provided by the client software that is installed on the POS terminal. #### Used by **Authorization, PIN Debit** Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. Required for PIN debit credit or PIN debit purchase. Required for online PIN transactions. For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also used by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | --- | --- | --- | --- | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes | ' encryptedKeySerialNumber: type: string maxLength: 20 description: 'Combination of the device''s unique identifier and a transaction counter that is used in the process of decrypting the encrypted PIN. The entity that injected the PIN encryption keys into the terminal decrypts the encrypted PIN and creates this value. For all terminals that are using derived unique key per transaction (DUKPT) encryption, this is generated as a single number within the terminal. #### Used by **Authorization, PIN Debit** - Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. - Required for PIN debit credit or PIN debit purchase. - Required for online PIN transactions For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also used by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | --- | --- | --- | --- | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes | ' encryptedKeyId: type: string maxLength: 100 description: "Identifies the Zone PIN Key (ZPK) used for Online PIN processing by providing the 10‑digit Key Set Identifier (KSI).\nThis value indicates that the PIN block is encrypted under a ZPK and enables the Payment Security Service (PSS) to perform \nthe correct ZPK→ZPK PIN translation during card‑present EMV PIN transactions.\n" partnerSdkVersion: type: string maxLength: 32 description: 'Version of the software installed on the POS terminal. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. For authorizations and credits, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' emvApplicationIdentifierAndDedicatedFileName: type: string maxLength: 32 description: 'This 32 byte length-maximum EBCDIC-K value is used to identify which chip application was performed between the terminal and the chip product. The included values are the Application Identifier (AID) and the Dedicated File (DF) name. It is available to early- or full-option VSDC issuers. Only single byte Katakana characters that can map to the EBCDIC-K table expected in the name. ' 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'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: - 0: Dongle - 1: Phone or tablet This optional field is supported only for Mastercard transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 141 - Field: Mastercard mPOS Transaction The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. ' terminalModel: type: string maxLength: 32 description: "This is the model name of the reader which is used to accept the payment.\nPossible values:\n - E3555\n - P400\n - A920\n" terminalMake: type: string maxLength: 32 description: "This is the manufacturer name of the reader which is used to accept the payment.\nPossible values:\n - PAX\n - Verifone\n - Ingenico\n" serviceCode: type: string maxLength: 3 description: "#### Visa Platform Connect\nMastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. \nYou can extract the service code from the track data and provide it in this API field. \n\nWhen not provided it will be extracted from:\n - Track2Data for MSR transactions\n - EMV tag 5F30 for EMV transactions\n\nTo enable this feature please call support.\n" merchantDefinedInformation: type: array description: 'The object containing the custom data that the merchant defines. ' items: type: object properties: key: type: string maxLength: 50 description: 'The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. ' value: type: string maxLength: 800 description: "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" merchantDefinedSecureInformation: type: object description: 'The object containing the secure data that the merchant defines. ' properties: secure1: type: string maxLength: 2048 description: 'The value you assign for your merchant-secure data field 1. ' secure2: type: string maxLength: 2048 description: 'The value you assign for your merchant-secure data field 2. ' secure3: type: string maxLength: 2048 description: 'The value you assign for your merchant-secure data field 3. ' secure4: type: string maxLength: 2048 description: 'The value you assign for your merchant-secure data field 4. ' installmentInformation: type: object properties: amount: type: string maxLength: 13 description: 'Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. ' frequency: type: string maxLength: 1 description: 'Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency ' planType: type: string maxLength: 1 description: '#### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) ' sequence: type: integer maximum: 999 description: 'Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ' totalAmount: type: string maxLength: 13 description: 'Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. ' totalCount: type: integer maximum: 999 description: 'Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ' firstInstallmentDate: type: string maxLength: 6 description: 'Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment ' invoiceData: type: string maxLength: 20 description: 'Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification ' paymentType: type: string maxLength: 1 description: 'Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow. ' eligibilityInquiry: type: string maxLength: 9 description: 'Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. ' gracePeriodDuration: type: string maximum: 99 description: 'Grace period requested by the customer before the first installment payment is due. When you include this field in a request, you must also include the grace period duration type field. The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard Grace Period Details. This field is supported only for Mastercard installment payments in Brazil and Greece. ' gracePeriodDurationType: type: string maxLength: 1 description: 'Unit for the requested grace period duration. Possible values: - `D`: Days - `W`: Weeks - `M`: Months The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace Period Details This field is supported only for Mastercard installment payments in Brazil and Greece on CyberSource through VisaNet. ' firstInstallmentAmount: type: string maxLength: 13 description: 'Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment ' validationIndicator: type: string maximum: 1 description: 'Standing Instruction/Installment validation indicator. - ''1'': Prevalidated - ''2'': Not Validated ' identifier: type: string maximum: 60 description: 'Standing Instruction/Installment identifier. ' annualInterestRate: type: string maxLength: 7 description: 'Annual interest rate. This field is returned only for two kinds of installment payments on Visa Platform Connect: - Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer''s request for Crediario installment payments. - Mastercard in all countries except Brazil, Croatia, Georgia, and Greece. Example: A value of 1.0 specifies 1%. Example: A value of 4.0 specifies 4%. #### Brazil The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate #### Other Countries The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 58-62 SCMP API Fields| 216 - Field: Mastercard Annual Percentage Rate ' interestIndicator: type: string maxLength: 1 description: 'Indicates if the installment plan has interest. Possible values: -Y - with interest -N - without interest -NULL - Do not send the field if no information available ' isGovernmentPlan: type: boolean maxLength: 1 description: 'Indicates if an installment plan is a government sponsored or part of a government program. Possible values: -true -false This field defaults to false when no value is provided. ' travelInformation: type: object properties: duration: type: string maxLength: 2 description: 'Duration of the auto rental or lodging rental. #### Auto rental This field is supported for Visa, MasterCard, and American Express. **Important** If this field is not included when the `processingInformation.industryDataType` is auto rental, the transaction is declined. ' agency: type: object properties: code: type: string maxLength: 8 description: 'International Air Transport Association (IATA) code of travel agency that made the vehicle rental reservation. ' name: type: string maxLength: 25 description: 'Name of travel agency that made the reservation. ' autoRental: type: object properties: noShowIndicator: type: boolean description: 'No Show Indicator provides an indicator noting that the individual did not show up after making a reservation for a vehicle. Possible values: - true - false ' customerName: type: string maxLength: 40 description: 'Name of the individual making the rental agreement. Valid data lengths by card: |Card Specific Validation|VISA|MasterCard|Discover|AMEX| |--- |--- |--- |--- | | Filed Length| 40| 40| 29| 26| | Field Type| AN| ANS| AN| AN| | M/O/C| O| M| M| M| ' vehicleClass: type: string maxLength: 4 description: 'Classification of the rented auto. **NOTE** For VISA, this is a 2-byte optional code. Valid values for American Express & MasterCard: |American Express |MasterCard |Description| |--- |--- |--- | | 0001| 0001| Mini| | 0002| 0002| Subcompact| | 0003| 0003| Economy| | 0004| 0004| Compact| | 0005| 0005| Midsize| | 0006| 0006| Intermediate| | 0007| 0007| Standard| | 0008| 0008| Fulll size| | 0009| 0009| Luxury| | 0010| 0010| Premium| | 0011| 0011| Minivan| | 0012| 0012| 12-passenger van| | 0013| 0013| Moving van| | 0014| 0014| 15-passenger van| | 0015| 0015| Cargo van| | 0016| 0016| 12-foot truck| | 0017| 0017| 20-foot truck| | 0018| 0018| 24-foot truck| | 0019| 0019| 26-foot truck| | 0020| 0020| Moped| | 0021| 0021| Stretch| | 0022| 0022| Regular| | 0023| 0023| Unique| | 0024| 0024| Exotic| | 0025| 0025| Small/medium truck| | 0026| 0026| Large truck| | 0027| 0027| Small SUV| | 0028| 0028| Medium SUV| | 0029| 0029| Large SUV| | 0030| 0030| Exotic SUV| | 9999| 9999| Miscellaneous| Additional Values allowed **only** for `American Express`: |American Express|MasterCard|Description| |--- |--- |--- | | 0031| NA| Four Wheel Drive| | 0032| NA| Special| | 0099| NA| Taxi| ' distanceTravelled: type: string maxLength: 5 description: 'Total number of miles driven by the customer. This field is supported only for MasterCard and American Express. ' distanceUnit: type: string maxLength: 1 description: 'Miles/Kilometers Indicator shows whether the "miles" fields are expressed in miles or kilometers. Allowed values: - `K` - Kilometers - `M` - Miles ' returnDateTime: type: string maxLength: 21 description: 'Date/time the auto was returned to the rental agency. Format: ``yyyy-MM-dd HH-mm-ss z`` This field is supported for Visa, MasterCard, and American Express. ' rentalDateTime: type: string maxLength: 21 description: 'Date/time the auto was picked up from the rental agency. Format: `yyyy-MM-dd HH-mm-ss z` This field is supported for Visa, MasterCard, and American Express. ' maxFreeDistance: type: string maxLength: 4 description: 'Maximum number of free miles or kilometers allowed to a customer for the duration of the auto rental agreement. This field is supported only for MasterCard and American Express. ' insuranceIndicator: type: boolean description: 'Used for MC and Discover Valid values: - `true` - Yes (insurance was purchased) - `false` - No (insurance was not purchased) ' programCode: type: string maxLength: 2 description: 'Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as "renter" or "show". This code is `2 digit` value agreed by Merchant and processor. ' returnAddress: type: object properties: city: type: string maxLength: 25 description: 'City where the auto was returned to the rental agency. ' state: type: string maxLength: 3 description: 'State in which the auto was returned to the rental agency. 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). For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for MasterCard and American Express. ' country: type: string maxLength: 3 description: 'Country where the auto was returned to the rental agency. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). ' locationId: type: string maxLength: 10 description: 'Code, address, phone number, etc. used to identify the location of the auto rental return. This field is supported only for MasterCard and American Express. ' address1: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s street address. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the return address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where the taxi passenger was dropped off or where the auto rental vehicle was returned. ' rentalAddress: type: object properties: city: type: string maxLength: 25 description: 'City in which the auto was rented. For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for American Express. For all other card types, this field is ignored. ' state: type: string maxLength: 3 description: 'State in which the auto was rented. 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). ' country: type: string maxLength: 3 description: 'Country where the auto was rented. Use the [ISO Standard Country Codes.](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This field is supported only for American Express. ' locationId: type: string maxLength: 10 description: 'The agency code, address, phone number, etc., used to identify the location where the vehicle was rented. ' address1: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' address2: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where a taxi passenger was picked up or where an auto rental vehicle was picked up. In most cases, this is the rental agency''s business name that appears on the storefront and/or customer receipts, commonly referred to as the DBA (Doing Business As) name. However, if the vehicle was picked up at another location (e.g., a hotel,auto dealership, repair shop, etc.), the name of that location should be used. This entry must be easily recognized by the Cardmember to avoid unnecessary inquiries. If the name is more than 38 characters, use proper and meaningful abbreviation, when possible. ' agreementNumber: type: string maxLength: 25 description: 'Auto rental agency''s agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions. This field is supported for Visa, MasterCard, and American Express. This Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become part of the descriptive bill on the Cardmember''s statement. ' odometerReading: type: string maxLength: 8 description: 'Odometer reading at time of vehicle rental. ' vehicleIdentificationNumber: type: string maxLength: 20 description: 'This field contains a unique identifier assigned by the company to the vehicle. ' companyId: type: string maxLength: 12 description: 'Corporate Identifier provides the unique identifier of the corporation or entity renting the vehicle: |Card Specific Validation|VISA|MasterCard|Discover|AMEX| |--- |--- |--- |--- | | Filed Length| NA| 12| NA| NA| | Field Type| NA| AN| NA| NA| | M/O/C| NA| O| NA| NA| ' numberOfAdditionalDrivers: type: string maxLength: 1 description: 'The number of additional drivers included on the rental agreement not including the individual who signed the rental agreement. ' driverAge: type: string maxLength: 3 description: 'Age of the driver renting the vehicle. ' specialProgramCode: type: string maxLength: 2 description: 'Program code used to identify special circumstances, such as "frequent renter" or "no show" status for the renter. Possible values: - `0`: not applicable (default) - `1`: frequent renter - `2`: no show For authorizations, this field is supported only for Visa. For captures, this field is supported for Visa, MasterCard, and American Express. Code for special programs applicable to the Card Transaction or the Cardholder. ' vehicleMake: type: string maxLength: 10 description: 'Make of the vehicle being rented (e.g., Chevrolet or Ford). ' vehicleModel: type: string maxLength: 10 description: 'Model of the vehicle being rented (e.g., Cavalier or Focus). ' timePeriod: type: string maxLength: 7 description: 'Indicates the time period for which the vehicle rental rate applies (e.g., daily, weekly or monthly). Daily, Weekly and Monthly are valid values. ' commodityCode: type: string maxLength: 15 description: 'Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. ' customerServicePhoneNumber: type: string maxLength: 17 description: 'Customer service telephone number that is used to resolve questions or disputes. Include the area code, exchange, and number. This field is supported only for MasterCard and American Express. ' taxDetails: type: object properties: amount: type: string maxLength: 13 description: 'Indicates the amount of tax based on the `type` field as described in the table below: ' rate: type: string maxLength: 6 description: 'Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) ' applied: type: boolean description: 'Flag that indicates whether the tax amount (`travelInformation.autoRental.taxDetails.amount`) is included in the request. Possible values: - `false`: tax amount is not included in the request. - `true`: tax amount is included in the request. ' exemptionCode: type: string maxLength: 1 description: 'Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ' taxType: type: string maxLength: 10 description: 'Different taxes the rental agency applies to the rental agreement such as tourist tax, airport tax, or rental tax. ' taxSummary: type: string maxLength: 12 description: 'Summary of all tax types ' insuranceAmount: type: string maxLength: 12 description: 'Insurance charges. Field is conditional and can include decimal point. ' oneWayDropOffAmount: type: string maxLength: 12 description: 'Extra charges incurred for a one-way rental agreement for the auto. This field is supported only for Visa. ' adjustedAmountIndicator: type: string maxLength: 1 description: 'For **MasterCard** and **Discover**: Adjusted amount indicator code that indicates any miscellaneous charges incurred after the auto was returned. Possible values: - `A` - Drop-off charges - `B` - Delivery charges - `C` - Parking expenses - `D` - Extra hours - `E` - Violations - `X` - More than one of the above charges For **American Express**: Audit indicator code that indicates any adjustment for mileage, fuel, auto damage, etc. made to a rental agreement and whether the cardholder was notified. Possible value for the authorization service: - `A` (default): adjustment amount greater than 0 (zero) Possible values for the capture service: - `X` - Multiple adjustments - `Y` - One adjustment only; Cardmember notified - `Z` - One adjustment only; Cardmember not notified. This value is used as the default if the request does not include this field and includes an adjustment amount greater than 0 (zero). This is an optional field. ' adjustedAmount: type: string maxLength: 12 description: 'Adjusted Amount indicates whether any miscellaneous charges were incurred after the vehicle was returned. For authorizations, this field is supported only for American Express. For captures, this field is supported only for MasterCard and American Express. **NOTE** For American Express, this field is required if the `travelInformation.autoRental.adjustedAmountIndicator` field is included in the request and has a value; otherwise, this field is optional. For all other card types, this field is ignored. ' fuelCharges: type: string maxLength: 12 description: 'Extra gasoline charges that extend beyond the basic rental agreement. This field is supported only for Visa. ' weeklyRentalRate: type: string maxLength: 12 description: 'Weekly Rental Amount provides the amount charged for a seven-day rental period. Field - Time Period needs to be populated with Weekly if this field is present ' dailyRentalRate: type: string maxLength: 12 description: 'Daily auto rental rate charged. This field is supported only for MasterCard and American Express. Field - Time Period needs to be populated with Daily if this field is present ' ratePerMile: type: string maxLength: 12 description: 'Rate charged for each mile. This field is supported only for MasterCard and American Express. ' mileageCharge: type: string maxLength: 12 description: 'Regular Mileage Charge provides the amount charged for regular miles traveled during vehicle rental. Two decimal places ' extraMileageCharge: type: string maxLength: 12 description: 'Extra mileage charges that extend beyond the basic rental agreement. This field is supported only for Visa. ' lateFeeAmount: type: string maxLength: 12 description: 'Extra charges related to a late return of the rented auto. This field is supported only for Visa. ' towingCharge: type: string maxLength: 4 description: '(Towing Charges) provides the amount charged to tow the rental vehicle. ' extraCharge: type: string maxLength: 12 description: '(Extra Charges) provides the extra charges associated with the vehicle rental. ' gpsCharge: type: string maxLength: 12 description: 'Amount charged for renting a Global Positioning Service (GPS). ' phoneCharge: type: string maxLength: 12 description: 'Additional charges incurred for phone usage included on the total bill. ' parkingViolationCharge: type: string maxLength: 12 description: 'Extra charges incurred due to a parking violation for the auto. This field is supported only for Visa. ' otherCharges: type: string maxLength: 12 description: 'Total amount charged for all other miscellaneous charges not previously defined. ' companyName: type: string maxLength: 50 description: 'Merchant to send their auto rental company name ' affiliateName: type: string maxLength: 50 description: 'When merchant wants to send the affiliate name. ' lodging: type: object properties: checkInDate: type: string maxLength: 6 description: 'Date on which the guest checked in. In the case of a no-show or a reservation, the scheduled arrival date. Format: `MMDDYY`. For best interchange rates, make sure it is a valid date. ' checkOutDate: type: string maxLength: 6 description: 'Date on which the guest checked out. Format: `MMDDYY`. For best interchange rates, make sure it is a valid date. ' room: type: array description: 'The object containing the number of nights and the daily rate that applies for that no of nights. ' items: type: object properties: dailyRate: type: string maxLength: 8 description: 'Daily cost of the room. ' numberOfNights: type: integer minimum: 1 maximum: 9999 description: 'Number of nights billed at the rate specified by `travelInformation.lodging.room[].dailyRate`. ' smokingPreference: type: string maxLength: 1 description: 'Smoking preference of the guest. Possible values: - `Y`: smoking room - `N`: non-smoking room ' numberOfRooms: type: integer minimum: 1 maximum: 99 description: 'Number of rooms booked by the cardholder. ' numberOfGuests: type: integer minimum: 1 maximum: 99 description: 'Number of guests staying in the room. ' roomBedType: type: string maxLength: 12 description: 'Type of room, such as queen, king, or two doubles. ' roomTaxType: type: string maxLength: 10 description: 'Type of tax, such as tourist or hotel. ' roomRateType: type: string maxLength: 12 description: 'Type of rate, such as corporate or senior citizen. ' guestName: type: string maxLength: 40 description: 'Name of the guest under which the room is reserved. ' customerServicePhoneNumber: type: string maxLength: 17 description: 'Your toll-free customer service phone number. ' corporateClientCode: type: string maxLength: 17 description: 'Code assigned to a business. You can use this code to identify corporate rates and discounts for guests. ' additionalDiscountAmount: type: string maxLength: 12 description: 'Amount of an additional coupon or discount. ' roomLocation: type: string maxLength: 10 description: 'Location of room, such as lake view or ocean view. ' specialProgramCode: type: string maxLength: 1 description: 'Code that identifies special circumstances. Possible values: - `1`: lodging (default) - `2`: no show reservation - `3`: advanced deposit ' totalTaxAmount: type: string maxLength: 12 description: 'Total tax amount. ' prepaidCost: type: string maxLength: 12 description: 'Prepaid amount, such as a deposit. ' foodAndBeverageCost: type: string maxLength: 12 description: 'Cost for all food and beverages. ' roomTaxAmount: type: string maxLength: 12 description: 'Total tax for the room. ' adjustmentAmount: type: string maxLength: 12 description: 'Adjusted amount charged in addition to the reservation amount after the stay is complete. ' phoneCost: type: string maxLength: 12 description: 'Cost of telephone services. ' restaurantCost: type: string maxLength: 12 description: 'Cost of restaurant purchases ' roomServiceCost: type: string maxLength: 12 description: 'Cost of room service. ' miniBarCost: type: string maxLength: 12 description: 'Cost of mini-bar purchases. ' laundryCost: type: string maxLength: 12 description: 'Cost of laundry services. ' miscellaneousCost: type: string maxLength: 12 description: 'Miscellaneous costs. ' giftShopCost: type: string maxLength: 12 description: 'Cost of gift shop purchases. ' movieCost: type: string maxLength: 12 description: 'Cost of movies. ' healthClubCost: type: string maxLength: 12 description: 'Cost of health club services. ' valetParkingCost: type: string maxLength: 12 description: 'Cost of valet parking services. ' cashDisbursementCost: type: string maxLength: 12 description: 'Cost of the cash that was disbursed plus any associated service fees ' nonRoomCost: type: string maxLength: 12 description: 'Cost of non-room purchases, such as meals and gifts. ' businessCenterCost: type: string maxLength: 12 description: 'Cost of business center services. ' loungeBarCost: type: string maxLength: 12 description: 'Cost of lounge and bar purchases. ' transportationCost: type: string maxLength: 12 description: 'Cost of transportation services. ' gratuityAmount: type: string maxLength: 12 description: 'Gratuity. ' conferenceRoomCost: type: string maxLength: 12 description: 'Cost of conference room services. ' audioVisualCost: type: string maxLength: 12 description: 'Cost of audio visual services. ' banquestCost: type: string maxLength: 12 description: 'Cost of banquet services. ' nonRoomTaxAmount: type: string maxLength: 12 description: 'Tax on non-room purchases. ' earlyCheckOutCost: type: string maxLength: 12 description: 'Service fee for early departure. ' internetAccessCost: type: string maxLength: 12 description: 'Cost of Internet access. ' name: type: string maxLength: 255 description: 'Name of the hotel for which the reservation is for. Mandatory in case the merchant''s business type is Hotel. ' hotelName: type: string description: 'The name of the hotel for which the reservation was made. ' checkInDateTime: type: string description: 'The date of the check-in in GMT+8 offset. ' checkOutDateTime: type: string description: 'The date of the check-out in GMT+8 offset. ' transit: type: object properties: airline: type: object properties: isDomestic: type: string maxLength: 255 description: 'Specifies if the flight is: Domestic (01) International (02) If Y then 01 else 02 ' bookingReferenceNumber: type: string maxLength: 15 description: 'Reference number for the airline booking. Required if ticket numbers are not issued. ' carrierName: type: string maxLength: 15 description: 'Airline that generated the ticket. Format: English characters only. Optional request field. ' ticketIssuer: type: object properties: code: type: string maxLength: 4 description: 'IATA2 airline code. Format: English characters only. Required for Mastercard; optional for all other card types. ' name: type: string maxLength: 20 description: 'Name of the ticket issuer. If you do not include this field, CyberSource uses the value for your merchant name that is in the CyberSource merchant configuration database. ' address: type: string maxLength: 16 description: 'Address of the company issuing the ticket. ' locality: type: string maxLength: 18 description: 'City in which the transaction occurred. If the name of the city exceeds 18 characters, use meaningful abbreviations. Format: English characters only. Optional request field. ' administrativeArea: type: string maxLength: 18 description: 'State in which transaction occured. ' postalCode: type: string maxLength: 15 description: 'Zip code of the city in which transaction occured. ' country: type: string maxLength: 18 description: 'Country in which transaction occured. ' ticketNumber: type: string maxLength: 15 description: 'Ticket number. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. ' checkDigit: type: string maxLength: 1 description: 'Check digit for the ticket number. CyberSource recommends that you validate the check digit. With Discover and Diners Club, a valid ticket number has these characteristics: - The value is numeric. - The first three digits are a valid IATA2 license plate carrier code. - The last digit is a check digit or zero (0). - All remaining digits are nonzero. ' restrictedTicketIndicator: type: integer maxLength: 1 description: 'Flag that indicates whether or not the ticket is restricted (nonrefundable). Possible values: - 0: No restriction (refundable) - 1: Restricted (nonrefundable) Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. ' transactionType: type: integer maxLength: 2 description: 'Type of charge. Possible values: - 01: Charge is for an airline ticket - 02: Charge is for an item that is not an airline ticket ' extendedPaymentCode: type: string maxLength: 3 description: 'The field is not currently supported. ' passengerName: type: string maxLength: 42 description: 'Name of the passenger to whom the ticket was issued. This will always be a single passenger''s name. If there are more than one passengers, provide only the primary passenger''s name. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Format: English characters only. Optional request field. ' customerCode: type: string maxLength: 40 description: 'Reference number or code that identifies the cardholder. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. ' documentType: type: string maxLength: 1 description: 'Airline document type code that specifies the purpose of the transaction. Format: English characters only. Optional request field. | Code | Description | | --- | --- | | 01 | Passenger ticket | | 02 | Additional collection | | 03 | Excess baggage | | 04 | Miscellaneous charge order (MCO) or prepaid ticket authorization | | 05 | Special service ticket | | 06 | Supported refund | | 07 | Unsupported refund | | 08 | Lost ticket application | | 09 | Tour order voucher | | 10 | Ticket by mail | | 11 | Undercharge adjustment | | 12 | Group ticket | | 13 | Exchange adjustment | | 14 | SPD or air freight | | 15 | In-flight adjustment | | 16 | Agency passenger ticket | | 17 | Agency tour order or voucher | | 18 | Agency miscellaneous charge order (MCO) | | 19 | Agency exchange order | | 20 | Agency group ticket | | 21 | Debit adjustment for duplicate refund or use | | 22 | In-flight merchandise order | | 23 | Catalogue merchandise order | | 24 | In-flight phone charges | | 25 | Frequent flyer fee or purchase | | 26 | Kennel charge | | 27 | Animal transportation charge | | 28 | Firearms case | | 29 | Upgrade charge | | 30 | Credit for unused transportation | | 31 | Credit for class of service adjustment | | 32 | Credit for denied boarding | | 33 | Credit for miscellaneous refund | | 34 | Credit for lost ticket refund | | 35 | Credit for exchange refund | | 36 | Credit for overcharge adjustment | | 37 | Credit for multiple Unused tickets | | 38 | Exchange order | | 39 | Self-service ticket | | 41 | In-flight duty-free purchase | | 42 | Senior citizen discount booklets | | 43 | Club membership fee | | 44 | Coupon book | | 45 | In-flight charges | | 46 | Tour deposit | | 47 | Frequent flyer overnight delivery charge | | 48 | Frequent flyer fulfillment | | 49 | Small package delivery | | 50 | Vendor sale | | 51 | Miscellaneous taxes or fees | | 52 | Travel agency fee | | 60 | Vendor refund or credit | | 64 | Duty free sale | | 65 | Preferred seat upgrade | | 66 | Cabin upgrade | | 67 | Lounge or club access or day pass | | 68 | Agent assisted reservation or ticketing fee | | 69 | Ticket change or cancel fee | | 70 | Trip insurance | | 71 | Unaccompanied minor | | 72 | Standby fee | | 73 | Curbside baggage | | 74 | In-flight medical equipment | | 75 | Ticket or pass print fee | | 76 | Checked sporting or special equipment | | 77 | Dry ice fee | | 78 | Mail or postage fee | | 79 | Club membership fee or temporary trial | | 80 | Frequent flyer activation or reinstatement | | 81 | Gift certificate | | 82 | Onboard or in-flight prepaid voucher | | 83 | Optional services fee | | 84 | Advance purchase for excess baggage | | 85 | Advance purchase for preferred seat upgrade | | 86 | Advance purchase for cabin upgrade | | 87 | Advance purchase for optional services | | 88 | WiFi | | 89 | Packages | | 90 | In-flight entertainment or internet access | | 91 | Overweight bag fee | | 92 | Sleep sets | | 93 | Special purchase fee | ' documentNumber: type: string maxLength: 14 description: 'The field is not currently supported. ' documentNumberOfParts: type: integer maxLength: 4 description: 'The field is not currently supported. ' invoiceNumber: type: string maxLength: 25 description: 'Invoice number for the airline transaction. ' invoiceDate: type: integer maxLength: 8 description: 'Invoice date. The format is YYYYMMDD. If this value is included in the request, it is used in the creation of the invoice number. See "Invoice Number," ' additionalCharges: type: string maxLength: 20 description: 'Description of the charge if the charge does not involve an airline ticket. For example: Excess baggage. ' totalFeeAmount: type: string maxLength: 12 description: 'Total fee for the ticket. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. Optional request field. ' clearingSequence: type: string maxLength: 2 description: 'Number that identifies the clearing message when multiple clearing messages are allowed per authorized transaction. Each clearing message linked to one authorization request must include a unique clearing sequence number between 1 and the total number of clearing records. Format: English characters only. Optional request field. ' clearingCount: type: string maxLength: 2 description: 'Total number of clearing messages associated with the authorization request. Format: English characters only. Optional request field. ' totalClearingAmount: type: string maxLength: 20 description: 'Total clearing amount for all transactions in the clearing count set. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. If this field is not set and if the total amount from the original authorization is not NULL, the total clearing amount is set to the total amount from the original authorization. ' numberOfPassengers: type: integer maxLength: 3 description: 'Number of passengers for whom the ticket was issued. Format: English characters only. Optional request field. ' reservationSystemCode: type: string maxLength: 20 description: 'Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field. ' processIdentifier: type: string maxLength: 3 description: 'Airline process identifier. This value is the airline''s three-digit IATA1 code which is used to process extended payment airline tickets. ' ticketIssueDate: type: string maxLength: 8 description: 'Date on which the transaction occurred. Format: `YYYYMMDD` Format: English characters only. Optional request field. ' electronicTicketIndicator: type: boolean description: 'Flag that indicates whether an electronic ticket was issued. Possible values: - `true` - `false` Optional request field. ' originalTicketNumber: type: string maxLength: 14 description: 'Original ticket number when the transaction is for a replacement ticket. ' purchaseType: type: string maxLength: 3 description: 'Type of purchase. Possible values: - `EXC`: Exchange ticket - `MSC`: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket) - `REF`: Refund - `TKT`: Ticket Format: English characters only. Optional request field. ' creditReasonIndicator: type: string maxLength: 1 description: 'Reason for the credit. Possible values: - `A`: Cancellation of the ancillary passenger transport purchase. - `B`: Cancellation of the airline ticket and the passenger transport ancillary purchase. - `C`: Cancellation of the airline ticket. - `O`: Other. - `P`: Partial refund of the airline ticket. Format: English characters only. Optional request field. ' ticketChangeIndicator: type: string maxLength: 1 description: 'Type of update. Possible values: - `C`: Change to the existing ticket. - `N`: New ticket. Format: English characters only Optional request field. ' planNumber: type: string maxLength: 1 description: 'Plan number based on the fare. This value is provided by the airline. Format: English characters only. Optional request field. ' arrivalDate: type: string maxLength: 8 description: 'Date of arrival for the last leg of the trip. Format: `MMDDYYYY` English characters only. Optional request field. ' restrictedTicketDesciption: type: string maxLength: 20 description: 'Text that describes the ticket limitations, such as _nonrefundable_. Format: English characters only. Optional request field. ' exchangeTicketAmount: type: string maxLength: 12 description: 'Amount of the exchanged ticket. Format: English characters only. ' exchangeTicketFeeAmount: type: string maxLength: 12 description: 'Fee for exchanging the ticket. Format: English characters only. Optional request field. ' reservationType: type: string maxLength: 32 description: 'The field is not currently supported. ' boardingFeeAmount: type: string maxLength: 12 description: 'Boarding fee. ' legs: type: array items: type: object properties: carrierCode: type: string maxLength: 4 description: 'IATA code for the carrier for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' flightNumber: type: string maxLength: 6 description: 'Flight number for this leg of the trip. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs. ' originatingAirportCode: type: string maxLength: 5 description: 'IATA code for the originating airport for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' class: type: string maxLength: 3 description: 'IATA code for the class of service for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' stopoverIndicator: type: integer maxLength: 1 description: 'Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: - `O` (capital letter "O") (default): Stopover allowed - `X` (capital letter "X"): Stopover not allowed Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' departureDate: type: integer maxLength: 8 description: 'Departure date for the first leg of the trip. Format: `YYYYMMDD`. Format: English characters only. Optional request field for travel legs. ' destinationAirportCode: type: string maxLength: 3 description: 'IATA code for the destination airport for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' fareBasis: type: string maxLength: 15 description: 'Code for the fare basis for this leg of the trip. The fare basis is assigned by the carriers and indicates a particular ticket type, such as business class or discounted/nonrefundable. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Format: English characters only. Optional request field for travel legs.auto_rental_regular_mileage_cost ' departTaxAmount: type: string maxLength: 12 description: 'Amount of departure tax for this leg of the trip. ' conjunctionTicket: type: string maxLength: 25 description: 'Ticket that contains additional coupons for this leg of the trip on an itinerary that has more than four segments. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' exchangeTicketNumber: type: string maxLength: 25 description: 'New ticket number that is issued when the ticket is exchanged for this leg of the trip. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs. ' couponNumber: type: string maxLength: 1 description: 'Coupon number. Each leg on the ticket requires a separate coupon, and each coupon is identified by the coupon number. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' departureTime: type: integer maxLength: 4 description: 'Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59`. Format: English characters only. Optional request field for travel legs. ' departureTimeMeridian: type: string maxLength: 1 description: 'AM or PM for the departure time. Possible values: - A: 12:00 midnight to 11:59 a.m. - P: 12:00 noon to 11:59 p.m Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' arrivalTime: type: integer maxLength: 4 description: 'Time of arrival for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59` Format: English characters only. Optional request field for travel legs. ' arrivalTimeMeridian: type: string maxLength: 1 description: 'AM or PM for the arrival time for this leg of the trip. Possible values: - `A`: 12:00 midnight to 11:59 a.m. - `P`: 12:00 noon to 11:59 p.m. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs. ' endorsementsRestrictions: type: string maxLength: 20 description: 'Notes or notations about endorsements and restrictions for this leg of the trip. Endorsements can be notations added by the travel agency, including mandatory government-required notations such as value added tax. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs. ' totalFareAmount: type: string maxLength: 15 description: 'Total fare for this leg of the trip. Format: English characters only. Optional request field for travel legs. ' feeAmount: type: string maxLength: 12 description: 'Fee for this leg of the trip, such as an airport fee or country fee. Format: English characters only. Optional request field for travel legs. ' taxAmount: type: string maxLength: 12 description: 'Tax for this leg of the trip. Format: English characters only. Optional request field for travel legs. ' ancillaryInformation: type: object properties: ticketNumber: type: string maxLength: 15 description: 'Ticket number, which consists of the carrier code, form, and serial number, without the check digit. **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) program. Format: English characters only. Optional field for ancillary services. ' passengerName: type: string maxLength: 20 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, this value is a description of the ancillary purchase. **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) program. Format: English characters only. Optional field for ancillary service. ' connectedTicketNumber: type: string maxLength: 15 description: 'Number for the airline ticket to which the ancillary purchase is connected. If this purchase has a connection or relationship to another purchase such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase. For a stand-alone purchase, the value for this field must be the same as the value for the `travelInformation.transit.airline.ancillaryInformation.ticketNumber` field. **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) program. Format: English characters only. Optional request field for ancillary services. ' creditReasonIndicator: type: string maxLength: 15 description: 'Reason for the credit. Possible values: - `A`: Cancellation of the ancillary passenger transport purchase. - `B`: Cancellation of the airline ticket and the passenger transport ancillary purchase. - `C`: Cancellation of the airline ticket. - `O`: Other. - `P`: Partial refund of the airline ticket. Format: English characters only. Optional field for ancillary services. ' service: type: array items: type: object properties: categoryCode: type: string maxLength: 4 description: 'Category code for the ancillary service that is provided. Obtain the codes from the International Air Transport Association (IATA). **Note** `#` is either 0, 1, 2, or 3. **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)program. Format: English characters only. Optional request field for ancillary services. ' subCategoryCode: type: string maxLength: 4 description: 'Subcategory code for the ancillary service category. Obtain the codes from the International Air Transport Association (IATA). **Note** `#` is either 0, 1, 2, or 3. Format English characters only. Optional request field for ancillary services. ' feeAmount: type: string maxLength: 15 description: "This field contains the fee amount. This value cannot be negative. \nYou can include a decimal point (.), but no other special characters.\nFormat: String, 15 characters maximum.\nOptional field for ancillary services.\n" feeCode: type: string maxLength: 4 description: 'This field contains the ancillary fee code. Format: Alphanumeric, 4 characters maximum. Optional field for ancillary services. ' feeDescription: type: string maxLength: 100 description: 'This field contains the fee description for the airline ancillary service provided. Format: Alphanumeric, 100 characters maximum. Optional field for ancillary services. ' flightType: type: string maxLength: 2 description: 'Specifies the type of flight. One way (0) Return (1) Transit (2) Transit & Return (3) Multi-City (4) ' insuranceAmount: type: string maxLength: 255 description: 'The total cost of the flight insurance. Example: 10000.00 ' frequentFlyerNumber: type: string maxLength: 255 description: 'The consumer''s frequent flyer number. Leave 0 if there is no frequent flyer number ' thirdPartyStatus: type: string maxLength: 255 description: 'Specifies if the travel agent joins the flight (0) or not (1) ' passengerType: type: string maxLength: 50 description: 'List of passenger types in a booking code: A (Adult) C (Child) Comma separated values for total number of passenger ' totalInsuranceAmount: type: string maxLength: 50 description: 'Total insurance amount. We have per leg and not total ' vehicleData: type: object properties: connectorType: type: string maxLength: 3 description: 'This field will contain connector type values for electric vehicle transactions. Possible Values: 001 (AC - J1772 Type 1) 002 (AC - Mennekes - Type 2) 003 (AC - GB/T) 100 (DC - CCS1) 101 (DC - CHAdeMO) 102 (DC - CCS2) 103 (DC - GB/T) 200 (NACS – Tesla) ' chargingReasonCode: type: string maxLength: 3 description: 'This field will contain charging reason code values for electric vehicle transactions. Possible Values: 010 (Other Error) 011 (Connector Lock Failure) 012 (EV Communication Error) 013 (Ground Failure) 014 (High Temperature) 015 (Internal Error) 016 (Over Current Failure) 017 (Over Voltage) 018 (Power Meter Failure) 019 (Power Switch Failure) 020 (Reader Failure) 021 (Reset Failure) 022 (Under Voltage) 023 (Weak Signal) 100 (No Error) 200 (Payment Related Error) ' healthCareInformation: type: object properties: amountDetails: type: array description: array for Healthcare fields items: type: object properties: amountType: type: string maxLength: 35 description: 'Total amount that has been spent on healthcare in a transaction. Valid Values for **Visa**: - `healthcare` - Total Amount Healthcare - `healthcare-transit` - Amount Transit - `vision` - Amount Vision/Optical - `prescription` - Amount Prescription/RX - `clinic` - Amount Clinic/Other Qualified Medical - `dental` - Amount Dental `Note:` - Prescription, Clinic and dental amounts must be preceded with the total healthcare amount and cannot occur individually. Vision and Transit must be sent individually and cannot be combined with total healthcare amount or any other amounts. Total Healthcare amount can be sent individually. Valid Values for **MasterCard**: - `prescription` - Amount Prescription/RX - `eligible-total` - Total Amount Healthcare `Note:` - Prescription must be preceded with the total healthcare amount and cannot occur individually. Total Healthcare amount can be sent individually. ' amount: type: string maxLength: 13 description: 'Total Amount that has been spent on the corresponding amountType. This is 13 byte field including sign. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. ' promotionInformation: type: object properties: additionalCode: type: string maxLength: 12 description: 'Additional rental agency marketed coupons for consumers to discount the rate of the vehicle rental agreement. ' code: type: string maxLength: 12 description: 'Code for a promotion or discount. ' tokenInformation: type: object properties: jti: type: string maxLength: 64 description: 'TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). ' transientTokenJwt: type: string description: 'Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. ' paymentInstrument: type: object properties: default: type: boolean description: 'Flag that specifies if the Payment Instrument should be made the Customers default. Possible values: - true - false : (default) ' default: false shippingAddress: type: object properties: default: type: boolean description: 'Flag that specifies if the Shipping Address should be made the Customers default. Possible values: - true - false : (default) ' default: false networkTokenOption: type: string description: 'Indicates whether a payment network token associated with a TMS token should be used for authorization. This field can contain one of following values: - `ignore`: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token. - `prefer`: (Default) Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number. ' tokenProvisioningInformation: type: object properties: consumerConsentObtained: type: boolean description: 'Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India. Possible Values: - `true`: Consumer has consented to tokenization of their credentials. - `false`: Consumer has not consented to tokenization of their credentials. ' multiFactorAuthenticated: type: boolean description: 'Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India. Possible Values: - `true`: Consumer has been authenticated by the issuer. - `false`: Consumer has not been authenticated by the issuer. ' clientCorrelationId: type: string maxLength: 36 description: 'Client-generated unique identifier for correlating token operations across API calls. This value helps track and associate token-related transactions. ' tokenAuthenticationInformation: type: object description: 'Contains authentication information associated with the token, including details about authenticated identities. ' properties: authenticatedIdentities: type: array description: 'An array of authenticated identity objects containing verification data from identity providers. ' items: type: object properties: data: type: string maxLength: 22000 description: 'Data related to the authenticated identity. Contains verification payload from the identity provider. ' provider: type: string description: "Provider of the authenticated identity. Identifies the authentication service or identity provider.\n \nPossible values:\n- CLIENT_DEVICE_CERT_JWS\n- VISA_PAYMENT_PASSKEY" id: type: string maxLength: 50 description: 'Unique identifier for the authenticated identity. A distinctive and non-transparent identifier for correlation purposes. ' relyingPartyId: type: string maxLength: 2000 description: 'Identifier of the relying party that requested the authentication. ' userAuthenticationMethod: type: string description: "The method used to authenticate the user.\n \nPossible values:\n- USERNAME_PASSWORD\n- PASSCODE_PASSWORD\n- PASSCODE\n- PASSWORD\n- PATTERN\n- BIOMETRIC_FINGERPRINT\n- BIOMETRIC_FACIAL\n- BIOMETRIC_IRIS\n- BIOMETRIC_VOICE\n- BIOMETRIC_BEHAVIORAL\n- DEVICE_UNLOCKED_METHOD_UNKNOWN\n- OTP_SMS\n- OTP_EMAIL\n- OTP_SMS_KNOWLEDGE\n- KNOWLEDGE_BASED_AUTHENTICATION\n- USER_UNVERIFIED\n- BIOMETRIC" invoiceDetails: type: object description: invoice Details properties: barcodeNumber: type: string maxLength: 100 description: Barcode ID scanned from the Payment Application. processorInformation: type: object description: Processor Information properties: preApprovalToken: type: string maxLength: 60 description: Token received in original session service. authorizationOptions: type: object properties: panReturnIndicator: type: string maxLength: 1 description: '#### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is  1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request ' reversal: type: object properties: preApprovalToken: type: string maxLength: 60 description: This is a token generated by PSP, which is received in response to the Sessions service. This token should be sent in the following transactions. network: type: object properties: economicallyRelatedTxnId: type: string maxLength: 50 description: Indicates the economically related transaction id network: type: object properties: economicallyRelatedTxnId: type: string maxLength: 50 description: Indicates the economically related transaction id authApprovalToken: type: string maxLength: 8192 description: 'Interoperability Token received by merchant for Authorization API. Field for merchant to send Klarna Advantage Plus authorization approval token for Auth API call. ' supplementaryTransactionData: type: string maxLength: 10240 description: 'Supplementary transaction data for Klarna Advantage Plus. Fields to capture Interoperability Data from Merchant and transfer to Klarna for Authorization/Sale/Re-Auth/Capture APIs. ' responseSourceCode: type: string maxLength: 1 description: 'Field contains the response source code that identifies the source. ' cedpVerifiedIndicator: type: string maxLength: 1 description: 'Merchant Commercial Enhanced Data Program (CEDP) verified indicator for capture/bill requests. This field is used when the client is doing authorization with a different gateway and capture/settlement with CyberSource. This field flows in ISO field 34, DSID 02 tag DA, in AN, EBCDIC format. Possible values: - `Y`: Merchant CEDP verified #### Used by **Capture Request** Request field for force capture/bill support when auth is done with a different gateway. ' agreementInformation: type: object properties: agreementId: type: string description: 'Identifier for the mandate being signed for. This mandate id is required for all the subsequent transactions. ' id: type: string maxLength: 128 description: 'The processor specific billing agreement ID. References an approved recurring payment for goods or services. This value is sent by merchant via Cybersource to processor. The value sent in this field is procured by the merchant from the processor. ' riskInformation: type: object description: This object is only needed when you are requesting both payment and DM services at same time. properties: profile: type: object description: Identifies a risk profile. properties: name: type: string maxLength: 30 description: 'Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. **Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field only if you want to specify the name of a different profile. The passed-in profile will then become the active profile. ' eventType: type: string maxLength: 255 description: 'Specifies one of the following types of events: - login - account_creation - account_update For regular payment transactions, do not send this field. ' buyerHistory: type: object properties: customerAccount: type: object properties: lastChangeDate: type: string maxLength: 10 description: 'Date the cardholder''s account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Recommended for Discover ProtectBuy. ' creationHistory: type: string description: 'The values from the enum can be: - GUEST - NEW_ACCOUNT - EXISTING_ACCOUNT ' modificationHistory: type: string description: 'This field is applicable only in case of EXISTING_ACCOUNT in creationHistory. Possible values: - ACCOUNT_UPDATED_NOW - ACCOUNT_UPDATED_PAST ' passwordHistory: type: string description: 'This only applies for EXISTING_ACCOUNT in creationHistory. The values from the enum can be: - PASSWORD_CHANGED_NOW - PASSWORD_CHANGED_PAST - PASSWORD_NEVER_CHANGED ' createDate: type: string maxLength: 10 description: 'Date the cardholder opened the account. Recommended for Discover ProtectBuy. This only applies for EXISTING_ACCOUNT in creationHistory. ' passwordChangeDate: type: string maxLength: 10 description: 'Date the cardholder last changed or reset password on account. Recommended for Discover ProtectBuy. This only applies for PASSWORD_CHANGED_PAST in passwordHistory. ' accountHistory: type: object properties: firstUseOfShippingAddress: type: boolean description: 'Applicable when this is not a guest account. ' shippingAddressUsageDate: type: string maxLength: 10 description: 'Date when the shipping address for this transaction was first used. Recommended for Discover ProtectBuy. If `firstUseOfShippingAddress` is false and not a guest account, then this date is entered. ' accountPurchases: type: integer maxLength: 4 description: 'Number of purchases with this cardholder account during the previous six months. Recommended for Discover ProtectBuy. ' addCardAttempts: type: integer maxLength: 3 description: 'Number of add card attempts in the last 24 hours. Recommended for Discover ProtectBuy. ' priorSuspiciousActivity: type: boolean description: 'Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account. Recommended for Discover ProtectBuy. ' paymentAccountHistory: type: string description: 'This only applies for NEW_ACCOUNT and EXISTING_ACCOUNT in creationHistory. Possible values are: - PAYMENT_ACCOUNT_EXISTS - PAYMENT_ACCOUNT_ADDED_NOW ' paymentAccountDate: type: integer maxLength: 8 description: 'Date applicable only for PAYMENT_ACCOUNT_EXISTS in paymentAccountHistory ' transactionCountDay: type: integer maxLength: 3 description: 'Number of transaction (successful or abandoned) for this cardholder account within the last 24 hours. Recommended for Discover ProtectBuy. ' transactionCountYear: type: integer maxLength: 3 description: 'Number of transaction (successful or abandoned) for this cardholder account within the last year. Recommended for Discover ProtectBuy. ' auxiliaryData: type: array items: type: object description: Contains auxiliary key-value pairs. properties: key: type: string maxLength: 255 description: 'Fields that you can use to send additional data to Risk services. **Warning** Auxiliary fields are not intended to and MUST NOT be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the auxiliary data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver''s license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the auxiliary data fields, whether or not intentionally, CyberSource WILL immediately suspend the merchant''s account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. ' value: type: string maxLength: 255 description: String value for the key acquirerInformation: type: object properties: acquirerBin: type: string maxLength: 11 description: 'Acquirer bank ID number that corresponds to a certificate that Cybersource already has.This ID has this format. 4XXXXX for Visa and 5XXXXX for Mastercard. ' country: type: string maxLength: 2 description: 'Issuers need to be aware of the Acquirer''s Country Code when the Acquirer country differs from the Merchant country and the Acquirer is in the EEA (European Economic Area). ' password: type: string maxLength: 8 description: 'Registered password for the Visa directory server. ' merchantId: type: string maxLength: 15 description: 'Username for the visa directory server that is created when your acquirer sets up your account. This ID might be the same as your merchant ID. the username can be 15 or 23 characters. ' acquirerMerchantId: type: string maxLength: 15 description: 'Acquirer assigned merchant id. Check if your processor supports this field. ' recurringPaymentInformation: type: object description: This object contains recurring payment information. required: - frequency - endDate properties: endDate: type: string maxLength: 10 description: 'The date after which no further recurring authorizations should be performed. Format: `YYYY-MM-DD` **Note** This field is required for recurring transactions. ' frequency: type: integer maxLength: 4 description: 'Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 Example values accepted (31 days): - 31 - 031 - 0031 **Note** This field is required for recurring transactions. ' numberOfPayments: type: integer maxLength: 3 description: 'Total number of payments for the duration of the recurring subscription. ' originalPurchaseDate: type: string maxLength: 17 description: 'Date of original purchase. Required for recurring transactions. Format: `YYYY-MM-DDTHH:MM:SSZ` **Note**: If this field is empty, the current date is used. ' sequenceNumber: type: integer maxLength: 3 description: "This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC. \nThis field records recurring sequence, e.g. 1st for initial, 2 for subsequent, 3 etc\n" type: type: string maxLength: 1 description: 'This contains the type of recurring payment. Valid Values : 1 - Registration/First transaction 2 - Subsequent transaction 3 - Modification 4 - Cancellation ' occurrence: type: string maxLength: 2 description: 'This value indicates how often a recurring payment occurs. Valid Values : • 01 (Daily) • 02 (Twice weekly) • 03 (Weekly) • 04 (Ten days) • 05 (Fortnightly) • 06 (Monthly) • 07 (Every two months) • 08 (Trimester) • 09 (Quarterly) • 10 (Twice yearly) • 11 (Annually) • 12 (Unscheduled) ' validationIndicator: type: string maxLength: 1 description: 'This tag will contain a value that indicates whether or not the recurring payment transaction has been validated. Valid values : 0- Not validated 1- Validated ' amountType: type: string maxLength: 1 description: 'Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount ' maximumAmount: type: string maxLength: 12 description: 'This API field will contain the maximum amount agreed to by the cardholder. The currency of this amount will be specified in Field 49—Currency Code,Transaction. ' referenceNumber: type: string maxLength: 35 description: 'This will contain a unique reference number for the recurring payment transaction. ' unscheduledPaymentInformation: type: object properties: type: type: string maxLength: 1 description: 'Indicates the type of unscheduled payment. This field is required for unscheduled payments CIT/MIT Possible values: 1: First unscheduled transaction. 2: Subsequent unscheduled transaction. ' hostedPaymentInformation: type: object properties: hostName: type: string maxLength: 255 description: 'The title of the hosted payment page, displayed in the browser''s tab. If not set, defaults to the title set in the merchant configuration. ' ipAddress: type: string maxLength: 255 description: 'URL of the merchant''s logo to be displayed in Klarna''s hosted payment page. If not set, defaults to the logo set in the merchant configuration. ' userAgent: type: object description: 'The images to be used as background on Klarna''s payment page (the image best matching the resolution will be used). This is a pass-through field. Check Klarna''s documentation for more information about the correct format. This value can also be set in the merchant configuration. ' properties: url: type: string maxLength: 255 description: Url for the image width: type: integer description: Width of the image watchlistScreeningInformation: type: object properties: addressOperator: type: string description: 'Parts of the customer''s information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customer''s name or company and the customer''s address must appear in the database. - OR: The customer''s name must appear in the database. - IGNORE: You want the service to detect a match only of the customer''s name or company but not of the address. ' weights: type: object properties: address: type: string maxLength: 6 description: 'Degree of correlation between a customer''s address and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The address must be identical to the entry in the DPL. - high: (default) The address cannot differ significantly from the entry in the DPL. - medium: The address can differ slightly more from the entry in the DPL. - low: The address can differ significantly from the entry in the DPL. ' company: type: string maxLength: 6 description: 'Degree of correlation between a company address and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The company name must be identical to the entry in the DPL. - high: (default) The company name cannot differ significantly from the entry in the DPL. - medium: The company name can differ slightly more from the entry in the DPL. - low: The company name can differ significantly from the entry in the DPL. ' name: type: string maxLength: 6 description: 'Degree of correlation between a customer''s name and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The name must be identical to the entry in the DPL. - high: (default) The name cannot differ significantly from the entry in the DPL. - medium: The name can differ slightly more from the entry in the DPL. - low: The name can differ significantly the entry in the DPL. ' sanctionLists: type: array items: type: string maxLength: 255 description: 'Use this field to specify which list(s) you want checked with the request. The reply will include the list name as well as the response data. To check against multiple lists, enter multiple list codes separated by a caret (^). For more information, see "Restricted and Denied Parties List," page 68. ' proceedOnMatch: type: boolean description: 'Indicates whether the transaction should proceed if there is a match. Possible values: - `true`: Transaction proceeds even when match is found in the Denied Parties List. The match is noted in the response. - `false`: Normal watchlist screening behavior occurs. (Transaction stops if a match to DPL occurs. Transaction proceeds if no match.) ' example: clientReferenceInformation: code: TC50171_3 orderInformation: billTo: country: US lastName: VDP address1: 201 S. Division St. postalCode: 48104-2201 locality: Ann Arbor administrativeArea: MI firstName: RTS phoneNumber: '999999999' district: MI buildingNumber: '123' email: test@cybs.com amountDetails: totalAmount: '102.21' currency: USD paymentInformation: card: expirationYear: '2031' number: '5555555555554444' securityCode: '123' expirationMonth: '12' type: '002' responses: '201': description: Successful response. schema: title: ptsV2PaymentsPost201Response type: object properties: _links: type: object properties: self: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' reversal: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' capture: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' customer: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' paymentInstrument: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' shippingAddress: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' instrumentIdentifier: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' message: type: string description: 'More information about the transaction response. ' submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - AUTHORIZED\n - PARTIAL_AUTHORIZED\n - AUTHORIZED_PENDING_REVIEW\n - AUTHORIZED_RISK_DECLINED\n - PENDING_AUTHENTICATION\n - PENDING_REVIEW\n - DECLINED\n - INVALID_REQUEST\n" reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' errorInformation: type: object properties: reason: type: string description: "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - BLOCKED_BY_CARDHOLDER\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n - ACH_VERIFICATION_FAILED\n - DECISION_PROFILE_REVIEW\n - CONSUMER_AUTHENTICATION_REQUIRED\n - CONSUMER_AUTHENTICATION_FAILED\n - ALLOWABLE_PIN_RETRIES_EXCEEDED\n - PROCESSOR_ERROR\n - CUSTOMER_WATCHLIST_MATCH\n - ADDRESS_COUNTRY_WATCHLIST_MATCH\n - EMAIL_COUNTRY_WATCHLIST_MATCH\n - IP_COUNTRY_WATCHLIST_MATCH\n - INVALID_MERCHANT_CONFIGURATION\n - DAGGREJECTED\n - DAGGDENIED\n - DSYSREJECTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' submitLocalDateTime: type: string maxLength: 14 description: 'Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds #### PIN Debit Optional field for PIN Debit purchase and credit requests. ' ownerMerchantId: type: string description: 'Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. ' processingInformation: type: object properties: bankTransferOptions: type: object properties: settlementMethod: type: string maxLength: 1 description: 'Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) ' fraudScreeningLevel: type: string maxLength: 1 description: 'Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification ' paymentSolution: type: string maxLength: 12 description: "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" enhancedDataEnabled: type: boolean description: 'The possible values for the reply field are: - `true` : the airline data was included in the request to the processor. - `false` : the airline data was not included in the request to the processor. Returned by authorization, capture, or credit services. ' digitalServiceIndicator: type: string maxLength: 104 description: "Mastercard Digital Enablement Service (MDES) digital service indicators received in the authorization response message for MDES transactions. \n\nThis data is provided in the 0110 response in the Field 34—Acceptance Environment Data (TLV Format), Dataset ID 04—Additional Service Result Data, Tag DF1F—Mastercard Digital Enablement Service Indicator for Acquirer to acquirers.\n\nThis field is in ANS, EBCDIC format and flows in Field 34, DSID 04 Tag DF1F, mapped to Mastercard Data Element DE119, Sub-element 004.\n\nThis field is supported for all flavors of Authorization response only.\n\n#### Used by\n**Authorization Response**\nResponse field only.\n" captureOptions: type: object properties: finalCapture: type: string maxLength: 5 description: 'Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments Possible Values: - `true` - `false` ' authorizationOptions: type: object properties: serviceType: type: string maxLength: 10 description: "Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time \nfunding or a live-load. This type of transaction can also be connected to a purchase. \nIn back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: \n- account one is used to make the purchase\n- account two is used to automatically fund or reimburse account one\n\nPossible values:\n- 0B = back to back funding transaction\n- 00 = normal transaction\n- 01 = originator hold\n- 02 = Visa deferred OCT hold, default interval\n- 03 = Visa deferred OCT hold, user-defined interval\n- 09 = Cancel pending deferred OCT request\n- 0I = Visa Direct custom program 1\n- 0Q = uery the status of the deferred OCT\n- A0 = Alias Directory 2\n" purchaseOptions: type: object properties: eligibilityIndicator: type: string maxLength: 20 description: "This field contains installment data defined by MasterCard.\nPossible values:\n - Y = eligible\n - N = not eligile\n" type: type: string maxLength: 20 description: 'Data mapped received in response from MasterCard. Possible values: - 01 = Meal Voucher - Employee Nutrition Program - 02 = Food Voucher - Employee Nutrition Program - 03 = Culture Voucher - Worker''s Culture Program - 04 = Meal Voucher - Consolidation of Labor Laws - 05 = Food Voucher - Consolidation of Labor Laws ' benefitAmount: type: string maxLength: 20 description: Workplace benefit amount. benefitType: type: string maxLength: 100 description: 'Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education ' processorInformation: type: object properties: authIndicator: type: string maxLength: 1 description: "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - `0`: Preauthorization\n - `1`: Final authorization\n" approvalCode: type: string maxLength: 6 description: 'Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. ' cardReferenceData: type: string maxLength: 56 description: 'The Scheme reference data is a variable length data element up to a maximum of 56 characters. It may be sent by the acquirer in the authorisation response message, and by the terminal (unchanged) in subsequent authorisation request messages associated with the same transaction. This field is used by Streamline and HSBC UK only, at present. ' transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' networkTransactionId: type: string description: Same value as `processorInformation.transactionId` responseCode: type: string maxLength: 10 description: 'For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. ' responseCodeSource: type: string maxLength: 1 description: 'Used by Visa only and contains the response source/reason code that identifies the source of the response decision. ' responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' responseCategoryCode: type: string maxLength: 36 description: "Processor-defined response category code. The associated detail error code is in the `processorInformation.responseCode` or `issuerInformation.responseCode`\nfield of the service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino—processor transaction ID required for troubleshooting\n\n#### Maximum length for processors\n\n - Comercio Latino: 36\n - All other processors: 3\n" responseSourceCode: type: string maxLength: 1 description: 'This field is used by Visa only and contains the response source/reason code that identifies the source of the response decision. Use this field only for clearing with your acquirer. ' forwardedAcquirerCode: type: string maxLength: 32 description: 'Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway. Please contact the CyberSource Japan Support Group for more information. ' settlementDate: type: string maxLength: 4 description: 'Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day. ' sequenceNumber: type: string maxLength: 50 description: 'This field serves as a unique identifier for initial and subsequent recurring transactions, specific to the payment brand, and is crucial for transaction tracking and recurrence management. Not all processors provide this value. Returned by the authorization service. ' avs: type: object properties: code: type: string maxLength: 1 description: 'AVS result code. Returned by authorization service. ' codeRaw: type: string maxLength: 10 description: 'AVS result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of AVS. Use for debugging purposes only. Returned by authorization service. ' cardVerification: type: object properties: resultCode: type: string maxLength: 1 description: 'CVN result code. ' resultCodeRaw: type: string maxLength: 10 description: 'CVN result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only. ' merchantAdvice: type: object properties: code: type: string maxLength: 2 description: "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" codeRaw: type: string maxLength: 4 description: 'Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme ' nameMatch: type: string maxLength: 2 description: '#### Visa Platform Connect The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are: 00 = Name Match Performed 01 = Name Match not Performed 02 = Name Match not supported ' electronicVerificationResults: type: object properties: code: type: string maxLength: 1 description: 'Mapped Electronic Verification response code for the customer''s name. ' codeRaw: type: string maxLength: 1 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''s email address. ' emailRaw: type: string maxLength: 1 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''s phone number. ' phoneNumberRaw: type: string maxLength: 1 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''s postal code. ' postalCodeRaw: type: string maxLength: 1 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''s street address. ' streetRaw: type: string maxLength: 1 description: Raw Electronic Verification response code from the processor for the customer's street address. name: type: string maxLength: 30 description: '#### Visa Platform Connect Mapped Electronic Verification response code for the customer''s name. Valid values : ''Y'' Yes, the data Matches ''N'' No Match ''O'' Partial Match ' nameRaw: type: string maxLength: 30 description: '#### Visa Platform Connect Raw Electronic Verification response code from the processor for the customer''s name. Valid values : ''01'' Match ''50'' Partial Match ''99'' No Match ' firstNameRaw: type: string maxLength: 2 description: '#### Visa Platform Connect Raw electronic verification response code from the processor for the customer''s first name. Valid values : ''01'' Match ''50'' Partial Match ''99'' No Match ' firstName: type: string maxLength: 1 description: '#### Visa Platform Connect Mapped electronic verification response code from the processor for the customer''s first name. Valid values : ''Y'' Yes, the data Matches ''N'' No Match ''O'' Partial Match ' middleNameRaw: type: string maxLength: 2 description: '#### Visa Platform Connect Raw electronic verification response code from the processor for the customer''s middle name. Valid values : ''01'' Match ''50'' Partial Match ''99'' No Match ' middleName: type: string maxLength: 1 description: '#### Visa Platform Connect Mapped electronic verification response code from the processor for the customer''s middle name. Valid values : ''Y'' Yes, the data Matches ''N'' No Match ''O'' Partial Match ' lastNameRaw: type: string maxLength: 2 description: '#### Visa Platform Connect Raw electronic verification response code from the processor for the customer''s last name. Valid values : ''01'' Match ''50'' Partial Match ''99'' No Match ' lastName: type: string maxLength: 1 description: '#### Visa Platform Connect Mapped electronic verification response code from the processor for the customer''s last name. Valid values : ''Y'' Yes, the data Matches ''N'' No Match ''O'' Partial Match ' achVerification: type: object properties: resultCode: type: string maxLength: 2 description: 'Results from the ACH verification service. ' resultCodeRaw: type: string maxLength: 10 description: 'Raw results from the ACH verification service. ' customer: type: object properties: personalIdResult: type: string maxLength: 1 description: "Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included `buyerInformation.personalIdentification[].ID` in the request, this\nvalue indicates whether or not `buyerInformation.personalIdentification[].ID` matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - `Y`: Match\n - `N`: No match\n - `K`: Not supported\n - `U`: Unknown\n - `Z`: No response returned\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America.The information in this field description is for the specific processing\nconnection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" consumerAuthenticationResponse: type: object properties: code: type: string maxLength: 3 description: 'Mapped response code for Visa Secure and American Express SafeKey. ' codeRaw: type: string maxLength: 3 description: 'Raw response code sent directly from the processor for Visa Secure and American Express SafeKey: ' systemTraceAuditNumber: type: string maxLength: 6 description: 'This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer''s receipt. ' paymentAccountReferenceNumber: type: string maxLength: 29 description: 'Payment Account Reference (PAR) is a non-financial reference assigned to each unique payment account and used to link a payment account to associated network tokens, i.e. the same PAR is returned for PAN-based and tokenized transactions, such as from digital wallets. PAR can be returned in authorisation responses for requests initiated with both real PANs and tokenized PANs. PAR can be used by merchants for fraud detection and regulatory compliance across different channels and digital wallets. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. **Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR8 - Position: 79-110 - Field: Payment Account Reference The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. ' transactionIntegrityCode: type: string maxLength: 2 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 maxLength: 6 description: 'Referral response number for a verbal authorization with FDMS Nashville when using an American Express card. Give this number to American Express when you call them for the verbal authorization. ' masterCardServiceCode: type: string maxLength: 2 description: "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for CyberSource through VisaNet.\n" masterCardServiceReplyCode: type: string maxLength: 1 description: "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - `C`: Service completed successfully.\n - `F`: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - `I`: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - `T`: Invalid combination of token requestor ID and token.\n - `U`: Expired token.\n - `W`: Primary account number (PAN) listed in electronic warning bulletin.\n\n**Note** This field is returned only for **CyberSource through VisaNet**.\n" masterCardAuthenticationType: type: string maxLength: 1 description: "Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - `1`: Transaction qualifies for Mastercard authentication type 1.\n - `2`: Transaction qualifies for Mastercard authentication type 2.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 132\n- Field: Mastercard Member Defined service.\n**Note** This field is returned only for CyberSource through VisaNet.\n" name: type: string maxLength: 30 description: 'Name of the Processor. ' routing: type: object properties: network: type: string maxLength: 4 description: 'PIN Debit Services: Contains the ID of the debit network to which the transaction was routed. | Code | Network | | --- | --- | | 0000 | Priority Routing or Generic File Update | | 0002 | Visa programs, Private Label and non-Visa Authorization Gateway Services | | 0003 | Interlink | | 0004 | Plus | | 0008 | Star | | 0009 | Pulse| | 0010 | Star | | 0011 | Star | | 0012 | Star (primary network ID) | | 0013 | AFFN | | 0015 | Star | | 0016 | Maestro | | 0017 | Pulse (primary network ID) | | 0018 | NYCE (primary network ID) | | 0019 | Pulse | | 0020 | Accel | | 0023 | NETS | | 0024 | CU24 | | 0025 | Alaska Option | | 0027 | NYCE | | 0028 | Shazam | | 0029 | EBT POS | FDC Nashville Global authorization service: Indicates whether the transaction was routed to a credit network, a debit network, or the STAR signature debit network. - `C`: Credit network - `D`: Debit network (without signature) - `S`: STAR signature debit network ' networkName: type: string maxLength: 10 description: 'Name of the network to which the transaction was routed. ' customerSignatureRequired: type: string maxLength: 1 description: 'Indicates whether you need to obtain the cardholder''s signature. Possible values: - `Y`: You need to obtain the cardholder''s signature. - `N`: You do not need to obtain the cardholder''s signature. ' merchantNumber: type: string maxLength: 15 description: 'Identifier that was assigned to you by your acquirer. This value must be printed on the receipt. #### Returned by Authorizations and Credits. This reply field is only supported by merchants who have installed client software on their POS terminals and use these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' retrievalReferenceNumber: type: string maxLength: 20 description: '#### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. ' paymentUrl: type: string maxLength: 2048 description: Direct the customer to this URL to complete the payment. completeUrl: type: string maxLength: 2048 description: 'The redirect URL for forwarding the consumer to complete page. This redirect needed by PSP to track browser information of consumer. PSP then redirect consumer to merchant success URL. ' signature: type: string publicKey: type: string sellerProtection: type: object properties: type: type: string description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection eligibility value is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values - ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received. - UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments. One or both values can be returned. ' eligibility: type: string maxLength: 36 description: 'Indicates whether the transaction is eligible for seller protection. The values returned are described below. Possible values: - `ELIGIBLE` - `PARTIALLY_ELIGIBLE` - `INELIGIBLE` - `NOT_ELIGIBLE` ' disputeCategories: type: array items: type: string description: 'An array of conditions that are covered for the transaction. ' eligibilityType: type: string maxLength: 60 description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection_eligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values: - `ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received.` - `UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments.` One or both values can be returned. ' transactionExpiryDate: type: string maxLength: 8 description: 'The date on which the transaction expires and payment cannot be made. ' customUrl: type: string description: 'For merchants to declare customs Customs declaration service URL. ' schemeAssignedId: type: string maxLength: 150 description: 'Unique id assigned to a merchant by the APM and not PSP The merchant ID, as boarded with Alipay ' deviceUrl: type: string maxLength: 50 description: 'The QR code value. Convert this value into an image and send it to the POS terminal to be displayed. The terminal can also perform the conversion. The value is a URL like in the example below: https://qr.alipay.com/pmxabcka1ts5grar12. ' disbursementMode: type: string description: "The funds are released to the merchant immediately.\nINSTANT\tThe funds are released to the merchant immediately.\nDELAYED\tThe funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.\n" updateTimeUtc: type: string description: 'The date and time when the transaction was last updated, in Internet date and time format. ' expirationTimeUtc: type: string description: 'The date and time when the authorized payment expires, in Internet date and time format. ' orderId: type: string description: 'The id of the order ' orderStatus: type: string maxLength: 255 description: "The order status. \nPossible values:\n- `CREATED`\n- `VOIDED`\n- `COMPLETED`\n- `PAYER_ACTION_REQUIRED`\n- `STEP_UP_REQUIRED`\n" merchantRiskPrediction: type: string maxLength: 150 description: 'Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. ' network: type: object properties: economicallyRelatedTxnId: type: string maxLength: 50 description: Indicates the economically related transaction id cedpVerifiedIndicator: type: string maxLength: 1 description: 'Merchant Commercial Enhanced Data Program (CEDP) verified indicator received in authorization response messages for U.S. domestic transactions containing a credential for the commercial credit products. This field flows in ISO field 34, DSID 02 tag DA, in AN, EBCDIC format. Possible values: - `Y`: Merchant CEDP verified This field is for internal processing only (TC33A usage) and is not sent back to the merchant. #### Used by **Authorization Response** Response field only. ' issuerInformation: type: object properties: country: type: string maxLength: 3 description: 'Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. ' discretionaryData: type: string maxLength: 255 description: 'Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. ' countrySpecificDiscretionaryData: type: string maxLength: 140 description: 'Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. ' responseCode: type: string maxLength: 6 description: "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n" pinRequestIndicator: type: string maxLength: 1 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" paymentAccountInformation: type: object properties: card: type: object properties: suffix: type: string description: 'Last four digits of the cardholder''s account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' expirationMonth: type: string maxLength: 2 description: 'Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' expirationYear: type: string maxLength: 4 description: 'Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' prefix: type: string maxLength: 6 description: 'Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' hashedNumber: type: string maxLength: 60 description: '#### Visa Platform Connect This API field will contain the SHA 256 hashed value of PAN. ' tokenizedCard: type: object properties: prefix: type: string maxLength: 6 description: 'First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. ' suffix: type: string maxLength: 4 description: 'Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' assuranceLevel: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. **Note** Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field. ' expirationMonth: type: string maxLength: 2 description: 'One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. ' expirationYear: type: string maxLength: 4 description: 'One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' requestorId: type: string maxLength: 11 description: 'Value that identifies your business and indicates that the cardholder''s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider''s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. ' assuranceMethod: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** ' paymentInformation: type: object properties: card: type: object properties: suffix: type: string description: 'Last four digits of the cardholder''s account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX ' expirationMonth: type: string maxLength: 2 description: 'Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' expirationYear: type: string maxLength: 4 description: 'Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' prefix: type: string maxLength: 6 description: 'Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' hashedNumber: type: string maxLength: 60 description: '#### Visa Platform Connect This API field will contain the SHA 256 hashed value of PAN. ' tokenizedCard: type: object properties: prefix: type: string maxLength: 6 description: 'First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. ' suffix: type: string maxLength: 4 description: 'Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' assuranceLevel: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. **Note** Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field. ' expirationMonth: type: string maxLength: 2 description: 'One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. ' expirationYear: type: string maxLength: 4 description: 'One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' requestorId: type: string maxLength: 11 description: 'Value that identifies your business and indicates that the cardholder''s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider''s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. ' assuranceMethod: type: string maxLength: 2 description: 'Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** ' tokenizedPaymentMethod: type: object properties: id: type: string maxLength: 255 description: 'The PayPal-generated ID for the token. ' status: type: string maxLength: 255 description: "The vault status.\n Possible Values:\n - `VAULTED`\n - `CREATED`\n - `APPROVED`\n" accountFeatures: type: object properties: accountType: type: string maxLength: 2 description: "Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - `00`: Not applicable or not specified\n - `10`: Savings account\n - `20`: Checking account\n - `30`: Credit card account\n - `40`: Universal account\n\n#### PIN debit\nType of account. This value is returned only if you requested a balance inquiry.\n\nPossible values:\n- `00`: Not applicable or not specified\n- `10`: Savings account\n- `20`: Checking account\n- `40`: Universal account\n- `96`: Cash benefits account\n- `98`: Food stamp account\n\nReturned by PIN debit purchase.\n" accountStatus: type: string maxLength: 1 description: 'Possible values: - `N`: Nonregulated - `R`: Regulated Returned by PIN debit credit or PIN debit purchase. **Note** This field is returned only for CyberSource through VisaNet. ' balances: type: array description: This is an array of multiple balances information an issuer can return for a given card. items: type: object properties: accountType: type: string maxLength: 2 description: "Type of account.\n\nThis value is returned only if you request a balance inquiry.\n\nPossible values:\n\n - `00`: Not applicable or not specified\n - `10`: Savings account\n - `20`: Checking account\n - `30`: Credit card account\n - `40`: Universal account\n\nBalance Account Types returned on EBT Debit card transactions:\n\n - `96`: Cash Benefits Account (PIN Debit Gateway EBT only)\n - `98`: Food Stamp Account (PIN Debit Gateway EBT only)\n" amount: type: string maxLength: 13 description: 'Remaining balance on the account. If the processor returns the sign, positive or negative, this sign is prefixed to the amount value as (+/-). ' amountType: type: string maxLength: 2 description: "Type of amount. This value is returned only if you request a balance inquiry. The issuer determines the value\nthat is returned.\n\nPossible values for deposit accounts:\n\n - `01`: Current ledger (posted) balance.\n - `02`: Current available balance, which is typically the ledger balance minus outstanding authorizations. Some\n depository institutions also include pending deposits and the credit or overdraft line associated with the account.\n\nPossible values for credit card accounts:\n\n - `01`: Credit amount remaining for customer (open to buy).\n - `02`: Credit limit.\n" currency: type: string maxLength: 3 description: 'Currency of the remaining balance on the account. ' balanceAmount: type: string maxLength: 12 description: 'Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase. ' balanceAmountType: type: string maxLength: 2 description: "Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - `01`: Current ledger (posted) balance.\n - `02`: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - `01`: Credit amount remaining for customer (open to buy).\n - `02`: Credit limit.\n" currency: type: string maxLength: 5 description: 'Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) Returned by authorization service. #### PIN debit Currency of the remaining balance on the prepaid card. Returned by PIN debit purchase. ' balanceSign: type: string maxLength: 8 description: 'Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values: Possible values: - `Positive` - `Negative` #### PIN debit Sign for the remaining balance on the prepaid card. Returned only when the processor returns this value. Returned by PIN debit purchase. ' affluenceIndicator: type: string maxLength: 13 description: "**Chase Paymentech Solutions**\n\nIndicates whether a customer has high credit limits. This information enables you to market high cost items to\nthese customers and to understand the kinds of cards that high income customers are using.\n\nThis field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n\n#### Litle\n\nFlag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories.\nPossible values:\n\n - `AFFLUENT`: High income customer with high spending pattern (>100k USD annual income and >40k USD annual\n card usage).\n - `MASS AFFLUENT`: High income customer (>100k USD annual income).\n\n Maximum length is 13.\n\n#### Chase Paymentech Solutions\n Maximum length is 1.\n" category: type: string maxLength: 7 description: '#### GPX Mastercard product ID associated with the primary account number (PAN). Returned by authorization service. #### CyberSource through VisaNet Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### GPN Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### Worldpay VAP **Important** Before using this field on Worldpay VAP, you must contact CyberSource Customer Support to have your account configured for this feature. Type of card used in the transaction. The only possible value is: - `PREPAID`: Prepaid Card Data Length: String (7) #### RBS WorldPay Atlanta Type of card used in the transaction. Possible values: - `B`: Business Card - `O`: Noncommercial Card - `R`: Corporate Card - `S`: Purchase Card - `Blank`: Purchase card not supported Data Length: String (1) ' commercial: type: string maxLength: 1 description: "Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" group: type: string maxLength: 1 description: "Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values:\n\n - `B`: Business card\n - `R`: Corporate card\n - `S`: Purchasing card\n - `0`: Noncommercial card\n\nReturned by authorization service.\n" healthCare: type: string maxLength: 1 description: "Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" payroll: type: string maxLength: 1 description: "Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" level3Eligible: type: string maxLength: 1 description: "Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" pinlessDebit: type: string maxLength: 1 description: "Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" signatureDebit: type: string maxLength: 1 description: "Indicates whether the card is a signature debit card.\n\nThis information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" prepaid: type: string maxLength: 1 description: "Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" regulated: type: string maxLength: 1 description: "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n" accountHolderType: type: string maxLength: 25 description: "This is the account owner information, valid values are:\n- `01` : primary account holder\n- `02` : secondary account holder\nThis is returned in the response of an account verification transaction by the Issuer. \n" bank: type: object properties: account: type: object properties: correctedAccountNumber: type: string maxLength: 17 description: 'Corrected account number from the ACH verification service. ' correctedRoutingNumber: type: string maxLength: 9 description: 'Corrected account number from the ACH verification service. ' customer: type: object properties: customerId: type: string description: 'Unique identifier for the customer''s card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer''s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn''t need to pass in data such as the card number or expiration date in the request itself. ' id: type: string description: 'Unique identifier for the Customer token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. ' minLength: 1 maxLength: 32 paymentInstrument: type: object properties: id: type: string description: 'Unique identifier for the Payment Instrument token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. ' minLength: 1 maxLength: 32 instrumentIdentifier: type: object properties: id: type: string description: 'Unique identifier for the Instrument Identifier token used in the transaction. When you include this value in your request, many of the fields that can be supplied for an authorization or credit become optional. ' minLength: 12 maxLength: 32 state: type: string description: 'Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed. ' shippingAddress: type: object properties: id: type: string description: 'Unique identifier for the Customers Shipping Address token used in the transaction. When you include this value in your request, many of the shipping fields that can be supplied for an authorization or credit become optional. ' minLength: 1 maxLength: 32 scheme: type: string maxLength: 255 description: 'Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. ' bin: type: string maxLength: 255 description: 'Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. ' accountType: type: string maxLength: 255 description: 'Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. ' issuer: type: string maxLength: 255 description: 'Name of the bank or entity that issued the card account. ' binCountry: type: string maxLength: 255 description: 'Country (two-digit country code) associated with the BIN of the customer''s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. ' eWallet: type: object properties: fundingSource: type: string maxLength: 30 description: 'Payment mode for the reference transaction. Possible values: - `INSTANT_TRANSFER` - `MANUAL_BANK_TRANSFER` - `DELAYED_TRANSFER` - `ECHECK` ' accountId: type: string maxLength: 30 description: 'The ID of the customer, passed in the return_url field by PayPal after customer approval. ' paymentInsightsInformation: type: object properties: responseInsights: type: object properties: category: type: string maxLength: 60 description: 'Categorization of response message from processor Possible Values: - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANNOT_APPROVE_AT_THIS_TIME` - `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `PAYMENT_INSIGHTS_INTERNAL_ERROR` - `OTHERS` - `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND` ' categoryCode: type: string maxLength: 2 description: 'Categorization Code of response message from processor Possible Values: - `01` : ISSUER_WILL_NEVER_APPROVE - `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME - `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS - `04` : GENERIC_ERROR - `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR - `98` : OTHERS - `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND ' processorRawName: type: string maxLength: 40 description: 'Raw name of the processor used for the transaction processing, especially useful during acquirer swing to see which processor transaction settled with ' orchestration: type: object properties: infoCodes: type: array items: type: string maxLength: 60 description: 'Infocodes indicating which rules were triggered by the Service Orchestration product. ' orderInformation: type: object properties: amountDetails: type: object properties: totalAmount: type: string maxLength: 15 description: 'Amount you requested for the payment or capture. This value is returned for partial authorizations. This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations. ' authorizedAmount: type: string maxLength: 15 description: 'Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. ' cashbackAmount: type: string maxLength: 12 description: "This field contains the purchase cashback amount expressed in the acquirer transaction currency. \nUse this field only for clearing with your acquirer.\n" currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' 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''s account. This field is returned for OCT transactions. ' settlementCurrency: type: string maxLength: 3 description: 'This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder''s account. This field is returned for OCT transactions. ' originalAmount: type: string maxLength: 15 description: 'Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. ' originalCurrency: type: string maxLength: 15 description: 'Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) ' processorTransactionFee: type: string maxLength: 15 description: 'Amount up to N digit after the decimals separator as defined in ISO 4217 for the appropriate currency code. ' exchangeRate: type: string maxLength: 17 description: 'The rate of conversion of the currency given in the request to CNY. The conversion happens at the time when Alipay''s trade order is created ' foreignCurrency: type: string maxLength: 3 description: 'Currency code for the transaction performed in cross border currency. ' foreignAmount: type: string maxLength: 11 description: 'The transaction amount in CNY. ' discountAmount: type: string maxLength: 11 description: 'If coupons/vouchers are used in the transaction, the discount amount redeemed in the settlement currency will be returned. Otherwise, no return. ' invoiceDetails: type: object properties: level3TransmissionStatus: type: string description: 'Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. Possible values: - **Y** for true - **N** for false ' salesSlipNumber: type: integer maximum: 99999 description: 'Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. ' rewardPointsDetails: type: object properties: pointsBeforeRedemption: type: string maxLength: 10 description: 'Loyalty points total balance before redemption. For Example: Points, such as 100 ' pointsValueBeforeRedemption: type: string maxLength: 12 description: 'The total value of loyalty points before redemption in the default currency. Max characters is 12 excluding the "." symbol For Example: Points, such as 20.00 ' pointsRedeemed: type: string maxLength: 10 description: 'Number of loyalty points that were redeemed. For Example: Points, such as 100 ' pointsValueRedeemed: type: string maxLength: 12 description: 'The value of the loyalty points that were redeemed in the default currency. Max characters is 12 excluding the "." symbol For Example: Points, such as 100.00 ' pointsAfterRedemption: type: string maxLength: 10 description: 'Loyalty Points remaining total balance after redemption. For Example: Points, such as 20.00 ' pointsValueAfterRedemption: type: string maxLength: 12 description: 'The value of the remaining loyalty points after redumption in the default currency. Max characters is 12 excluding the "." symbol For Example: Points, such as 20.00 ' billTo: type: object properties: firstName: type: string lastName: type: string address1: type: string maxLength: 60 description: 'First line of the billing street address. ' address2: type: string maxLength: 60 description: 'Second line of the billing street address. ' locality: type: string maxLength: 60 description: 'City of the billing address. ' postalCode: type: string maxLength: 10 description: "Postal code for the billing address. The postal code must consist of 5 to 9 digits. \nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\nExample: 12345-6789\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample: A1B 2C3\n" administrativeArea: type: string maxLength: 60 description: 'State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. ' country: type: string maxLength: 2 description: 'Country of the billing address. Use the two-character ISO Standard Country Codes. ' email: type: string maxLength: 256 description: 'Email address of the customer. ' alternatePhoneNumberVerificationStatus: type: string maxLength: 15 description: '#### Visa Platform Connect Contains one of the following values that will identify the phone number result code in the account verification response message: ''VERIFIED'' - Customer verified ''UNVERIFIED'' - Customer not verified ''FAILED'' - Customer verification failed ' alternateEmailVerificationStatus: type: string maxLength: 15 description: '#### Visa Platform Connect Contains one of the following values that will identify the phone number result code in the account verification response message: ''VERIFIED'' - Customer verified ''UNVERIFIED'' - Customer not verified ''FAILED'' - Customer verification failed ' phoneNumber: type: string maxLength: 15 description: 'Customer''s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. ' nameSuffix: type: string maxLength: 60 description: 'Customer''s name suffix. ' shipTo: type: object properties: firstname: type: string maxLength: 60 description: 'First name of the recipient. ' lastname: type: string maxLength: 60 description: 'Last name of the recipient. ' address1: type: string maxLength: 100 description: 'First line of the shipping address. ' address2: type: string maxLength: 100 description: 'Second line of the shipping address. ' locality: type: string maxLength: 50 description: 'City of the shipping address. ' administrativeArea: type: string maxLength: 40 description: 'State or province of shipping address. This is a State, Province, and Territory Codes for the United States and Canada. ' postalCode: type: string maxLength: 20 description: 'Postal code of the shipping address. Consists of 5 to 9 digits. ' country: type: string maxLength: 2 description: 'Country of shipping address. This is a two-character ISO Standard Country Codes. ' phoneNumber: type: string maxLength: 20 description: 'Phone number of the recipient. ' pointOfSaleInformation: type: object properties: emv: type: object properties: 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 \"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\nFor Mastercard Transactions, Optionally Tag 9F60 (Authenticated Application Data) and \nTag 96 (Kernel Identifier - Terminal) can be included in the Field.\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 maxLength: 2 description: "Entity or service that provided the validation results returned in `chipValidationResult`.\n\nPossible values:\n - `02`: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.)\n - `03`: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.)\n - `50`: Issuer\n - `90`: Chip fall-back transaction downgrade process (The chip could not be read.)\n\nThis field is returned only for NFC payment network tokenization transactions with MasterCard.\n\n**Note** No CyberSource through VisaNet acquirers support EMV at this time.\n" chipValidationResult: type: string maxLength: 1 description: 'Cryptogram validation results returned by the entity or service specified in `chipValidationType`. Possible values: - `A`: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.) - `C`: Chip validation was completed successfully. - `E`: Application cryptogram is valid but the ATC indicates possible replay fraud. - `F`: Format error in the chip data. - `G`: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC). - `I`: Application cryptogram is invalid. - `T`: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid. - `U`: Application cryptogram could not be validated because of a technical error. This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. ' amexCapnData: type: string maxLength: 15 description: 'Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. ' terminalId: type: string maxLength: 8 description: "Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.\n\n#### CyberSource through VisaNet\nA list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for\nyour CyberSource account, the value you send for this field is validated against the list each time you include\nthe field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support.\n\nWhen you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account.\n\n#### FDC Nashville Global\nTo have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you.\n\n#### For Payouts\nThis field is applicable for CyberSource through VisaNet.\n\n#### GPX\nIdentifier for the terminal at your retail location. A list of all possible values is stored in your account.\nIf terminal ID validation is enabled for your account, the value you send for this field is validated against\nthe list each time you include the field in a request. To enable or disable terminal ID validation, contact\ncustomer support.\n\nWhen you do not include this field in a request, the default value that is defined in your account is used.\n\nOptional for authorizations.\n\n#### Used by\n**Authorization**\nOptional for the following processors. When you do not include this field in a request, the default value that is\ndefined in your account is used.\n - American Express Direct\n - Credit Mutuel-CIC\n - FDC Nashville Global\n - SIX\n- Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`.\n- FDMS Nashville: The default value that is defined in your account is used.\n- GPX\n- OmniPay Direct: Optional field.\n\nFor the following processors, this field is not used.\n- GPN\n- JCN Gateway\n- RBS WorldPay Atlanta\n- TSYS Acquiring Solutions\n- Worldpay VAP\n\n#### Card Present reply\nTerminal identifier assigned by the acquirer. This value must be printed on the receipt.\n" installmentInformation: type: object properties: additionalCosts: type: string maxLength: 12 description: 'Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs ' additionalCostsPercentage: type: string maxLength: 4 description: 'Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs ' amount: type: string maxLength: 13 description: 'Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. ' amountFunded: type: string maxLength: 12 description: 'Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded ' amountRequestedPercentage: type: string maxLength: 4 description: 'Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested ' annualFinancingCost: type: string maxLength: 7 description: 'Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing ' annualInterestRate: type: string maxLength: 7 description: 'Annual interest rate. This field is returned only for two kinds of installment payments on Visa Platform Connect: - Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer''s request for Crediario installment payments. - Mastercard in all countries except Brazil, Croatia, Georgia, and Greece. Example: A value of 1.0 specifies 1%. Example: A value of 4.0 specifies 4%. #### Brazil The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate #### Other Countries The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 58-62 SCMP API Fields| 216 - Field: Mastercard Annual Percentage Rate ' expenses: type: string maxLength: 12 description: 'Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses ' expensesPercentage: type: string maxLength: 4 description: 'Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses ' fees: type: string maxLength: 12 description: 'Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees ' feesPercentage: type: string maxLength: 4 description: 'Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees ' frequency: type: string maxLength: 1 description: 'Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency ' insurance: type: string maxLength: 12 description: 'Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance ' insurancePercentage: type: string maxLength: 4 description: 'Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance ' invoiceData: type: string maxLength: 20 description: 'Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification ' monthlyInterestRate: type: string maxLength: 7 description: 'Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate ' planType: type: string maxLength: 1 description: '#### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) ' sequence: type: integer maximum: 999 description: 'Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ' taxes: type: string maxLength: 12 description: 'Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes ' taxesPercentage: type: string maxLength: 4 description: 'Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder''s request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes ' totalAmount: type: string maxLength: 13 description: 'Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. ' totalCount: type: integer maximum: 999 description: 'Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant''s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ' minimumTotalCount: type: string maximum: 99 description: '"Minimum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard on CyberSource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 75-76 - Field: Mastercard Minimum Number Of Installments ' maximumTotalCount: type: string maximum: 99 description: 'Maximum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard on CyberSource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR5 - Position: 77-78 - Field: Mastercard Maximum Number Of Installments ' firstInstallmentAmount: type: string maxLength: 13 description: 'Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment ' firstInstallmentDate: type: string maxLength: 6 description: 'Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment ' tokenInformation: type: object properties: instrumentidentifierNew: type: boolean description: 'A value of true means the card number or bank account used to create an Instrument Identifier was new and did not already exist in the token vault. A value of false means the card number or bank account used to create an Instrument Identifier already existed in the token vault. ' customer: type: object properties: id: type: string description: 'Unique identifier for the Customer token that was created as part of a bundled TOKEN_CREATE action. ' minLength: 1 maxLength: 32 paymentInstrument: type: object properties: id: type: string description: 'Unique identifier for the Payment Instrument token that was created as part of a bundled TOKEN_CREATE action. ' minLength: 1 maxLength: 32 shippingAddress: type: object properties: id: type: string description: 'Unique identifier for the Customers Shipping Address token that was created as part of a bundled TOKEN_CREATE action. ' minLength: 1 maxLength: 32 instrumentIdentifier: type: object properties: id: type: string description: 'Unique identifier for the Instrument Identifier token that was created as part of a bundled TOKEN_CREATE action. ' minLength: 12 maxLength: 32 state: type: string description: 'Issuers state for the card number. Valid values: - ACTIVE - CLOSED : The account has been closed. ' thirdPartyToken: type: object properties: source: type: string maxLength: 64 description: 'This field identifies the third party that provided the Third Party Token identification value. ' id: type: string maxLength: 16 description: 'When a third party is being used for tokenization, this field contains the token ID. See tokenInformation.thirdPartyToken.source to identify the provider. ' buyerInformation: type: object properties: merchantCustomerId: type: string maxLength: 100 description: '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. ' dateOfBirth: type: string maxLength: 8 description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' vatRegistrationNumber: type: string maxLength: 20 description: 'Customer''s government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. ' personalIdentification: type: array items: type: object properties: type: type: string description: "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n -\t`BR_CPF` The individual tax ID type, typically is 11 characters long\n -\t`BR_CNPJ` The business tax ID type, typically is 14 characters long.\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" id: type: string maxLength: 26 description: "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" issuedBy: type: string description: 'The government agency that issued the driver''s license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer''s driver''s license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder''s passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. ' verificationResults: type: string description: 'Verification results received from Issuer or Card Network for verification transactions. Response Only Field. ' taxId: type: string description: The description for this field is not available. loginId: type: string maxLength: 64 description: 'The buyer''s Alipay login Id, the id might be an email or mobile number. The id is partially masked for privacy. cao***@126.com or 186***22156 ' riskInformation: type: object description: Contains the result of risk assessment. properties: profile: type: object properties: name: type: string maxLength: 30 description: 'Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. **Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field only if you want to specify the name of a different profile. The passed-in profile will then become the active profile. ' desinationQueue: type: string maxLength: 255 description: 'Name of the queue where orders that are not automatically accepted are sent. ' selectorRule: type: string maxLength: 255 description: 'Name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile. ' rules: type: array items: type: object properties: name: type: string maxLength: 255 description: Description of the rule as it appears in the Profile Editor. decision: type: string maxLength: 255 description: 'Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` ' infoCodes: type: object properties: velocity: type: array description: 'List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. ' items: type: string description: Indicates excessive volume of transactions. address: type: array description: 'Indicates a mismatch between the customer''s billing and shipping addresses. ' items: type: string customerList: type: array description: 'Indicates that customer information is associated with transactions that are either on the negative or the positive list. ' items: type: string deviceBehavior: type: array description: 'Indicates the device behavior information code(s) returned from device fingerprinting. ' items: type: string identityChange: type: array description: 'Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. ' items: type: string internet: type: array description: 'Indicates a problem with the customer''s email address, IP address, or billing address. ' items: type: string phone: type: array description: 'Indicates a problem with the customer''s phone number. ' items: type: string suspicious: type: array description: 'Indicates that the customer provided potentially suspicious information. ' items: type: string globalVelocity: type: array description: 'Indicates that the customer has a high purchase frequency. ' items: type: string velocity: type: object properties: morphing: type: array description: 'List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. Returned by scoring service. ' items: type: object properties: count: type: integer maxLength: 5 description: 'Morphing count specified by the number #. **Note** The count is not returned for the initial transaction. ' fieldName: type: string maxLength: 255 description: 'Field name of the morphing element. specified by the setting that you chose in the Velocity Editor. For all possible values, see the `decisionReply_morphingElement_#_fieldName` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' informationCode: type: string maxLength: 255 description: "Identifier that CyberSource assigned to the velocity rule specified by the number #.\n\nFor all possible values, see the `decision_velocity_morphing_#_info_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > \n" address: type: array items: type: string maxLength: 255 description: 'Indicates a mismatch between the customer''s billing and shipping addresses. For all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' casePriority: type: integer maxLength: 1 description: 'You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order. For all possible values, see the `decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' localTime: type: string maxLength: 255 description: 'The customer''s local time (`hh:mm:ss`), which is calculated from the transaction request time and the customer''s billing address. For details, see the `score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) ' score: type: object properties: factorCodes: type: array items: type: string description: 'This field contains information that affected the score of the order. This field will contain one or more codes, separated by carets (^). For all possible values, see the `score_factors` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' 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, this field contains the name of CyberSource''s default model. For all possible values, see the `score_model_used` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' result: type: string maxLength: 255 description: 'Total score calculated for this order. The value cannot be negative. For all possible values, see the `score_score_result` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' ipAddress: type: object description: Contains detailed response information about the customer's IP address. properties: anonymizerStatus: type: string maxLength: 255 description: 'Indicates whether the transaction IP address is associated with a known anonymous proxy. For all possible values, see the `score_ip_anonymizer_status` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' locality: type: string maxLength: 255 description: 'Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the `score_ip_city` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' country: type: string maxLength: 255 description: 'Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the `score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' administrativeArea: type: string maxLength: 255 description: 'Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the `score_ip_state` 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). ' routingMethod: type: string maxLength: 255 description: 'Routing method decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the `score_ip_routing_method` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' carrier: type: string maxLength: 255 description: 'Provides the name of the organization that owns the ASN. The carrier is responsible for the traffic carried on the network or set of networks designated as an Autonomous System (AS) and identified by the ASN. While there are more than 27,000 active ASNs, there are fewer carriers, because a single carrier often manages several ASNs. ' organization: type: string maxLength: 255 description: 'The Registering Organization is the entity responsible for the actions and content associated with a given block of IP addresses. This is in contrast to the carrier, which is responsible for the routing of traffic for network blocks. Registering Organizations include many types of entities, including corporate, government, or educational entities, and ISPs managing the allocation and use of network blocks. ' providers: type: object description: 'Name of the 3rd party provider, for example, Emailage. For all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).' additionalProperties: type: object description: 'Field name, for example, email address domain name (domain_name). For all possible values, see the `decision_provider_#_field_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ' additionalProperties: type: string travel: type: object properties: actualFinalDestination: type: object properties: country: type: string maxLength: 90 description: Country of actual final destination on the route. locality: type: string maxLength: 90 description: City of actual final destination on the route. latitude: type: string maxLength: 10 description: Latitude of actual final destination on the route. longitude: type: string maxLength: 10 description: Longitude of actual final destination on the route. firstDeparture: type: object properties: country: type: string maxLength: 90 description: Country of first departure on the route. locality: type: string maxLength: 90 description: City of first departure on the route. latitude: type: string maxLength: 10 description: Latitude of first departure on the route. longitude: type: string maxLength: 10 description: Longitude of first departure on the route. firstDestination: type: object properties: country: type: string maxLength: 90 description: Country of first destination on the route. locality: type: string maxLength: 90 description: City of first destination on the route. latitude: type: string maxLength: 10 description: Latitude of first destination on the route. longitude: type: string maxLength: 10 description: Longitude of first destination on the route. lastDestination: type: object properties: country: type: string maxLength: 90 description: Country of last destination on the route. locality: type: string maxLength: 90 description: City of last destination on the route. latitude: type: string maxLength: 10 description: Latitude of last destination on the route. longitude: type: string maxLength: 10 description: Longitude of last destination on the route. processorResults: type: object properties: fraudDecision: type: string maxLength: 60 description: 'Type of filter. Possible values: - ACCEPT - PENDING - DENY - REPORT ' fraudDecisionReason: type: string maxLength: 60 description: 'possible values - AVS_NO_MATCH - AVS_PARTIAL_MATCH - AVS_UNAVAILABLE_OR_UNSUPPORTED - CARD_SECURITY_CODE_MISMATCH - MAXIMUM_TRANSACTION_AMOUNT - UNCONFIRMED_ADDRESS - COUNTRY_MONITOR - LARGE_ORDER_NUMBER - BILLING_OR_SHIPPING_ADDRESS_MISMATCH - RISKY_ZIP_CODE - SUSPECTED_FREIGHT_FORWARDER_CHECK - TOTAL_PURCHASE_PRICE_MINIMUM - IP_ADDRESS_VELOCITY - RISKY_EMAIL_ADDRESS_DOMAIN_CHECK - RISKY_BANK_IDENTIFICATION_NUMBER_CHECK, RISKY_IP_ADDRESS_RANGE - PAYPAL_FRAUD_MODEL ' consumerAuthenticationInformation: type: object properties: accessToken: type: string description: 'JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay. Note - Max Length of this field is 2048 characters. ' acsRenderingType: type: string description: 'Identifies the UI Type the ACS will use to complete the challenge. **NOTE**: Only available for App transactions using the Cardinal Mobile SDK. ' acsTransactionId: type: string maxLength: 36 description: 'Unique transaction identifier assigned by the ACS to identify a single transaction. ' acsUrl: type: string maxLength: 2048 description: 'URL for the card-issuing bank''s authentication form that you receive when the card is enrolled. The value can be very large. ' authenticationPath: type: string description: 'Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer''s authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. ' authorizationPayload: type: string description: 'The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow ' authenticationTransactionId: type: string maxLength: 26 description: 'Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. ' 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. For example, "Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.". The Issuing Bank can optionally support this value. ' cavv: type: string maxLength: 255 description: 'Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. ' cavvAlgorithm: type: string maxLength: 1 description: 'Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard ' challengeCancelCode: type: string maxLength: 2 description: 'An indicator as to why the transaction was canceled. Possible Values: - `01`: Cardholder selected Cancel. - `02`: Reserved for future EMVCo use (values invalid until defined by EMVCo). - `03`: Transaction Timed Out—Decoupled Authentication - `04`: Transaction timed out at ACS—other timeouts - `05`: Transaction Timed out at ACS - First CReq not received by ACS - `06`: Transaction Error - `07`: Unknown - `08`: Transaction Timed Out at SDK ' challengeRequired: type: string maxLength: 1 description: 'Indicates whether a challenge is required in order to complete authentication. **Note** Regional mandates might determine that a challenge is required. Possible values: - `Y`: Challenge required - `N`: Challenge not required **Note** Used by the Hybrid integration. ' decoupledAuthenticationIndicator: type: string maxLength: 1 description: 'Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible Values: Y - Decoupled Authentication is supported and preferred if challenge is necessary N - Do not use Decoupled Authentication **Default Value**: N ' directoryServerErrorCode: type: string description: 'The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters. ' directoryServerErrorDescription: type: string maxLength: 4096 description: 'Directory server text and additional detail about the error for this transaction. ' ecommerceIndicator: type: string maxLength: 255 description: 'Commerce indicator for cards not enrolled. This field contains one of these values: - `internet`: Card not enrolled, or card type not supported by payer authentication. No liability shift. - `js_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `js_failure`: J/Secure directory service is not available. No liability shift. - `spa`: Mastercard card not enrolled in the SecureCode program. No liability shift. - `vbv_attempted`: Card not enrolled, but attempt to authenticate is recorded. Liability shift. - `vbv_failure`: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa''s directory service is not available. No liability shift. ' eci: type: string description: 'Note This field applies only to non-U.S-issued cards. For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions when the card is not enrolled. For more information, see "Interpreting the Reply," page 22. If you are not using the CyberSource payment services, you must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `06`: The card can be enrolled. Liability shift. - `07`: The card cannot be enrolled. No liability shift. For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, and Discover transactions. The field is absent when authentication fails. You must send this value to your payment processor in the subsequent request for card authorization. This field contains one of these values: - `05`: Successful authentication - `06`: Authentication attempted - `07`: Failed authentication (No response from the merchant because of a problem.) ' eciRaw: type: string description: 'ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) ' effectiveAuthenticationType: type: string maxLength: 2 description: 'This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). ' ivr: type: object properties: enabledMessage: type: boolean description: 'Flag to indicate if a valid IVR transaction was detected. ' encryptionKey: type: string maxLength: 16 description: 'Encryption key to be used in the event the ACS requires encryption of the credential field. ' encryptionMandatory: type: boolean description: 'Flag to indicate if the ACS requires the credential to be encrypted. ' encryptionType: type: string maxLength: 20 description: 'An indicator from the ACS to inform the type of encryption that should be used in the event the ACS requires encryption of the credential field. ' label: type: string maxLength: 20 description: 'An ACS Provided label that can be presented to the Consumer. Recommended use with an application. ' prompt: type: string maxLength: 80 description: 'An ACS provided string that can be presented to the Consumer. Recommended use with an application. ' statusMessage: type: string maxLength: 80 description: 'An ACS provided message that can provide additional information or details. ' strongAuthentication: type: object properties: issuerInformation: type: object title: paymentsStrongAuthIssuerInformation properties: riskAnalysisExemptionResult: type: string maxLength: 80 description: 'Possible values: Visa Platform Connect - `8401` Merchant not participating in Visa Trusted Listing Program. - `8402` Issuer not participating in Visa Trusted Listing Program. - `8403` Cardholder has not trusted the merchant (supplied by Visa Net). - `8404` Indeterminate or invalid issuer response. - `8473` Cardholder has not trusted the merchant (issuer-supplied). - `8474` Did not meet the exemption criteria (issuer-supplied). Upto 20 Values may be received in a transaction. ' trustedMerchantExemptionResult: type: string maxLength: 4 description: 'Possible values: Visa Platform Connect - `2` Trusted merchant exemption validated/honored. - `3` Trusted merchant exemption failed validation/not honored. ' lowValueExemptionResult: type: string maxLength: 1 description: 'This will be the value returned by Visanet when low value exemption has been requested. Valid values: Visa Platform Connect - `2` Low value exemption validated/honored - `3` Low value exemption failed validation/not honored ' secureCorporatePaymentResult: type: string maxLength: 1 description: 'This will be the value returned by Visanet when secure corporate payment (scp) exemption has been requested. Valid values: Visa Platform Connect - `2` Secure corporate payment exemption validated/honored - `3` Secure corporate payment exemption failed validation/not honored ' transactionRiskAnalysisExemptionResult: type: string maxLength: 1 description: "This will be the value returned by Visanet when transaction risk analysis (TRA) exemption has been requested.\n\n Valid values: Visa Platform Connect\n - `2` transaction risk analysis (TRA) exemption validated/honored\n - `3` transaction risk analysis (TRA) exemption failed validation/not honored\n" delegatedAuthenticationResult: type: string maxLength: 1 description: 'This will be the value returned by Visanet when delegated authentication has been requested. ' outageExemptionIndicator: type: string maxLength: 1 description: 'This field will contain the outage exemption indicator with one of the following values: Possible values: - `0` (Outage Authentication exemption does not apply to the transaction) - `1` (Outage exempt from SCA as authentication could not be done due to outage) ' networkScore: type: string maxLength: 2 description: 'The global score calculated by the CB scoring platform and returned to merchants. ' pareq: type: string description: 'Payer authentication request (PAReq) message that you need to forward to the ACS. The value can be very large. The value is in base64. ' paresStatus: type: string description: 'Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated. ' proofXml: type: string description: "Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need\nto show proof of enrollment checking, you may need to parse the string for the information required by the\npayment card company. The value can be very large. \nFor cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment\nchecking for any payer authentication transaction that you re-present because of a chargeback.\n" proxyPan: type: string description: 'Encrypted version of the card number used in the payer authentication request message. ' sdkTransactionId: type: string maxLength: 36 description: 'SDK unique transaction identifier that is generated on each new transaction. ' signedParesStatusReason: type: string maxLength: 2 description: 'Provides additional information as to why the PAResStatus has a specific value. ' specificationVersion: type: string description: 'This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 ' stepUpUrl: type: string maxLength: 2048 description: 'The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. ' threeDSServerTransactionId: type: string maxLength: 36 description: 'Unique transaction identifier assigned by the 3DS Server to identify a single transaction. ' ucafAuthenticationData: type: string description: 'AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check transactions after the customer is authenticated. The value is in base64. Include the data in the card authorization request. ' ucafCollectionIndicator: type: string description: 'For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication. ' veresEnrolled: type: string description: 'Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. ' whiteListStatusSource: type: string maxLength: 2 description: 'This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS ' xid: type: string description: 'Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) ' directoryServerTransactionId: type: string maxLength: 36 description: 'The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID ' dataQualityIndicator: type: string maxLength: 10 description: The field is used to indicate that a transaction does not meet the Visa Secure authentication data quality requirements. authenticationResult: type: string description: 'Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication. ' authenticationStatusMsg: type: string description: 'Message that explains the authenticationResult reply field. ' indicator: type: string description: 'Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard Identity Check authentication verified successfully. - `spa_failure`: Mastercard Identity Check failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable. ' interactionCounter: type: string maxLength: 2 description: 'Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1. When customer gets the challenge window and the bank asks if they want to have the one time password sent to their phone or their email and they have to choose before going to the next screen to enter in their one time password then this interaction count would be 2. One for the selection of how they want the one time password delivered and another with them actually entering in the one time password and hitting the submit button. ' whiteListStatus: type: string maxLength: 1 description: 'Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder ' token: type: string description: '' acsReferenceNumber: type: string maxLength: 50 description: Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. acsOperatorID: type: string description: Directory Server assigned ACS identifier. idciScore: type: integer description: Risk Assessment from Mastercard idciDecision: type: string maxLength: 20 description: Decision on the Risk Assessment from Mastercard. idciReasonCode1: type: string maxLength: 20 description: ReasonCode from Mastercard idciReasonCode2: type: string maxLength: 20 description: ReasonCode from Mastercard merchantInformation: type: object properties: merchantName: type: string maxLength: 25 description: 'Use this field only if you are requesting payment with Payer Authentication serice together. Your company''s name as you want it to appear to the customer in the issuing bank''s authentication form. This value overrides the value specified by your merchant bank. ' merchantDescriptor: type: object properties: storeId: type: string maxLength: 50 description: 'The identifier of the store. ' storeName: type: string maxLength: 50 description: 'The name of the store. ' categoryCode: type: string 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''s cards. When you do not include this field in your request, Cybersource uses the value in your Cybersource account. Use this field only for clearing with your acquirer. ' returnUrl: type: string maxLength: 255 minLength: 7 description: 'URL for displaying payment results to the consumer (notifications) after the transaction is processed. Usually this URL belongs to merchant and its behavior is defined by merchant ' clearingInformation: type: object properties: authorizationCharacteristicsIndicator: type: string maxLength: 1 description: "This field contains the code used by the acquirer to request CPS qualification. \nIf applicable, V.I.P. changes the code to reflect the results of its CPS evaluation. \nUse this field only for clearing with your acquirer.\n" accountfundingSource: type: string maxLength: 1 description: 'This field contains the product account funding source value from Visa required for Clearing. Use this field only for clearing with your acquirer. Possible values: - C (Credit) - D (Debit) - H (Charge) - P (Prepaid) - R (Deferred debit) ' cardholderIdMethod: type: string maxLength: 1 description: 'This 1-digit code identifies the cardholder identification method used for a transaction. Use this field only for clearing with your acquirer. Possible values: - 0 - Not specified - 1 - Signature - 2 - Online PIN - 3 - Unattended terminal, no PIN pad - 4 - Mail/Telephone/Electronic Commerce ' marketSpecificDataIdentifier: type: string maxLength: 1 description: 'This field contains the industry for which market-specific data has been provided. Use this field only for clearing with your acquirer. Possible values: - A: Auto Rental - B: Bill Payment - E: Electronic commerce transaction aggregation - H: Hotel - J: B2B invoice payments - M: Healthcare (medical) - N: Failed Market-Specific Data edit, or not applicable - T: Transit (in healthcare transactions only) - X: Extended Authorization ' posEntryMode: type: string maxLength: 4 description: "This field contains a 4-digit code indicating the method used to enter the account number\nand card expiration date and, if an electronic terminal is used, the capability of the terminal to capture online PINs for \ntransactions processed through VisaNet.\nUse this field only for clearing with your acquirer.\n\nPossible Values:\n\nPositions 1-2: PAN and Date Entry Mode\n- 00 - Unknown or terminal not used.\n- 01 - Manual (key entry).\n- 02 - Visa: Magnetic stripe read; CVV checking may not be possible. PLUS: Track 2 contents read, but transaction not eligible for CVV checking.\n- 03 - Optical code\n- 04 - Reserved for future use.\n- 05 - Contact integrated circuit card read using VSDC chip data rules; Online CAM authentication method; iCVV checking possible.\n- 06 - Reserved for future use.\n- 07 - Contactless device-read-originated using qVSDC chip data rules; Online CAM authentication method; iCVV checking possible.\n- 10 - Credential on file: Transaction initiated using a credential that has previously been stored on file.\n- 90 - Magnetic stripe read and exact content of Track 1 or Track 2 included (CVV check possible).\n- 91 - Contactless device-read-originated using magnetic stripe data rules; dCVV checking is possible; Online CAM checking possible for MSD CVN 17 only.\n- 95 - Integrated circuit card read; CVV or iCVV checking may not be possible.\n\nPosition 3: PIN Entry Capability\n- 0 - Unknown.\n- 1 - Indicates terminal can accept and forward online PINs.\n- 2 - Indicates terminal cannot accept and forward online PINs.\n- 8 - Terminal PIN pad down.\n- 9 - Reserved for future use.\n\nPosition 4: Fill\n- 0 - Unused.\n" electronicCommerceIndicator: type: string maxLength: 2 description: "This field contains 2-digit code that identifies the level of \nsecurity used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order.\nUse this field only for clearing with your acquirer.\n\nPossible values:\n- 00 - Not applicable\n- 01 - Single transaction of a mail/phone order\n- 02 - Recurring transaction\n- 03 - Installment payment\n- 04 - Unknown classification\n- 05 - Secure electronic commerce transaction\n- 06 - Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure\n- 07 - Non-authenticated Security Transaction\n- 08 - Non-secure transaction\n" spendQualifiedIndicator: type: string maxLength: 1 description: "This field is determined using the point-of-sale spend history and the defined \nproduct-level spend requirement for the country of issuance.\nUse this field only for clearing with your acquirer.\n\nPossible values:\n- Space - Spend-processing does not apply.\n- B - Base spend-assessment threshold defined by Visa has been met.\n- N - Spend-assessment threshold defined by Visa has not been met.\n- Q - Qualified spend-assessment threshold defined by Visa has been met.\n" validationCode: type: string maxLength: 4 description: 'This field ensures that key fields used in authorization messages match their respective fields in clearing transaction. Use this field only for clearing with your acquirer. ' embeddedActions: type: object description: Contains embedded actions, that includes status and response for every actions in the list. properties: CAPTURE: type: object properties: status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n - TRANSMITTED (Only for Online Capture enabled merchants)\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - EXCEEDS_AUTH_AMOUNT\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. DECISION: type: object properties: status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - `ACCEPTED`\n - `REJECTED`\n - `PENDING_REVIEW`\n - `DECLINED`\n - `PENDING_AUTHENTICATION`\n - `INVALID_REQUEST`\n - `AUTHENTICATION_FAILED`\n - `CHALLENGE`\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - `EXPIRED_CARD`\n - `SCORE_EXCEEDS_THRESHOLD`\n - `DECISION_PROFILE_REVIEW`\n - `DECISION_PROFILE_REJECT`\n - `CONSUMER_AUTHENTICATION_REQUIRED`\n - `INVALID_MERCHANT_CONFIGURATION`\n - `CONSUMER_AUTHENTICATION_FAILED`\n - `DECISION_PROFILE_CHALLENGE`\n - `CUSTOMER_WATCHLIST_MATCH`\n - `ADDRESS_COUNTRY_WATCHLIST_MATCH`\n - `EMAIL_COUNTRY_WATCHLIST_MATCH`\n - `IP_COUNTRY_WATCHLIST_MATCH`\n" message: type: string description: The detail message related to the status and reason listed above. CONSUMER_AUTHENTICATION: type: object properties: status: type: string description: 'The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` ' reason: type: string description: 'The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` ' message: type: string description: 'The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. ' VALIDATE_CONSUMER_AUTHENTICATION: type: object properties: status: type: string description: 'The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` ' reason: type: string description: 'The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` ' message: type: string description: 'The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. ' WATCHLIST_SCREENING: type: object properties: status: type: string description: 'The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED ' reason: type: string description: "The reason of the status. Value can be\n - `CUSTOMER_WATCHLIST_MATCH`\n - `ADDRESS_COUNTRY_WATCHLIST_MATCH`\n - `EMAIL_COUNTRY_WATCHLIST_MATCH`\n - `IP_COUNTRY_WATCHLIST_MATCH`\n - `INVALID_MERCHANT_CONFIGURATION`\n" message: type: string description: "The message describing the reason of the status. Value can be\n - The customer matched the Denied Parties List\n - The Export bill_country/ship_country match\n - Export email_country match\n - Export hostname_country/ip_country match\n" TOKEN_CREATE: type: object properties: status: type: string description: "The status of the token create.\n\nPossible value is:\n - SUCCESS\n - SERVER_ERROR\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - INVALID_DATA\n - SYSTEM_ERROR\n - MISSING_FIELD\n" message: type: string description: The detail message related to the status and reason listed above. TOKEN_UPDATE: type: object properties: status: type: string description: "The status of the token update.\n\nPossible value is:\n - SUCCESS\n - SERVER_ERROR\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\nPossible values:\n - INVALID_DATA\n - SYSTEM_ERROR\n - MISSING_FIELD\n" message: type: string description: The detail message related to the status and reason listed above. watchlistScreeningInformation: type: object properties: ipCountryConfidence: type: integer minimum: -1 maximum: 100 description: 'Likelihood that the country associated with the customer''s IP address was identified correctly. Returns a value from 1–100, where 100 indicates the highest likelihood. If the country cannot be determined, the value is –1. ' infoCodes: type: array items: type: string maxLength: 255 description: 'Returned when the Denied Parties List check (first two codes) or the export service (all others) would have declined the transaction. This field can contain one or more of these values: - `MATCH-DPC`: Denied Parties List match. - `UNV-DPC`: Denied Parties List unavailable. - `MATCH-BCO`: Billing country restricted. - `MATCH-EMCO`: Email country restricted. - `MATCH-HCO`: Host name country restricted. - `MATCH-IPCO`: IP country restricted. - `MATCH-SCO`: Shipping country restricted. ' watchList: type: object properties: matches: type: array items: type: object properties: addresses: type: array items: type: string maxLength: 255 description: 'Address found on the list specified in export_matchN_list for the entity (name and address) in the request. ' sanctionList: type: string maxLength: 255 description: 'List on which the first Denied Parties List check match appears. For a list of codes, see "Denied Parties List Check Codes," page 56. ' aliases: type: array items: type: string maxLength: 255 description: 'Name found on the list specified in export_matchN_list for the entity (name and address) in the request. ' programs: type: array items: type: string maxLength: 255 description: Sub-lists matched by the order data. List members are separated by carets (^). example: _links: self: href: /pts/v2/payments/4963015972176007901546 method: GET authReversal: href: /pts/v2/payments/4963015972176007901546/reversals method: POST capture: href: /pts/v2/payments/4963015972176007901546/captures method: POST refund: href: /pts/v2/payments/4963015972176007901546/refunds method: POST void: href: /pts/v2/payments/4963015972176007901546/voids method: POST id: '4963015972176007901546' submitTimeUtc: 2017-06-01T071957Z status: '200' reconciliationId: 39570726X3E1LBQR statusInformation: reason: SUCCESS message: Successful transaction. clientReferenceInformation: code: TC50171_3 orderInformation: amountDetails: authorizedAmount: '102.21' currency: USD processorInformation: approvalCode: '888888' cardVerification: resultCode: '' avs: code: X codeRaw: I1 responseCode: '100' merchantRiskPrediction: ATT consumerAuthenticationInformation: dataQualityIndicator: '1' paymentInformation: accountFeatures: accountHolderType: '01' processingInformation: authorizationOptions: serviceType: '02' purchaseOptions: eligibilityIndicator: Y type: '01' benefitAmount: '10.00' benefitType: 4T '400': description: Invalid request. schema: type: object title: ptsV2PaymentsPost400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2PaymentsPost502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. x-example: example0: summary: Simple Authorization(Internet) sample-name: Process Payment processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' orderInformation: amountDetails: totalAmount: '102.21' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' example1: summary: Authorization with Capture(Sale) sample-name: Process Payment Simple Authorization with Capture(Sale) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: capture: true paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' orderInformation: amountDetails: totalAmount: '102.21' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' example2: summary: Payment with Flex Token sample-name: Payment with Flex Token processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 tokenInformation: transientTokenJwt: eyJraWQiOiIwN0JwSE9abkhJM3c3UVAycmhNZkhuWE9XQlhwa1ZHTiIsImFsZyI6IlJTMjU2In0.eyJkYXRhIjp7ImV4cGlyYXRpb25ZZWFyIjoiMjAyMCIsIm51bWJlciI6IjQxMTExMVhYWFhYWDExMTEiLCJleHBpcmF0aW9uTW9udGgiOiIxMCIsInR5cGUiOiIwMDEifSwiaXNzIjoiRmxleC8wNyIsImV4cCI6MTU5MTc0NjAyNCwidHlwZSI6Im1mLTAuMTEuMCIsImlhdCI6MTU5MTc0NTEyNCwianRpIjoiMUMzWjdUTkpaVjI4OVM5MTdQM0JHSFM1T0ZQNFNBRERCUUtKMFFKMzMzOEhRR0MwWTg0QjVFRTAxREU4NEZDQiJ9.cfwzUMJf115K2T9-wE_A_k2jZptXlovls8-fKY0muO8YzGatE5fu9r6aC4q7n0YOvEU6G7XdH4ASG32mWnYu-kKlqN4IY_cquRJeUvV89ZPZ5WTttyrgVH17LSTE2EvwMawKNYnjh0lJwqYJ51cLnJiVlyqTdEAv3DJ3vInXP1YeQjLX5_vF-OWEuZfJxahHfUdsjeGhGaaOGVMUZJSkzpTu9zDLTvpb1px3WGGPu8FcHoxrcCGGpcKk456AZgYMBSHNjr-pPkRr3Dnd7XgNF6shfzIPbcXeWDYPTpS4PNY8ZsWKx8nFQIeROMWCSxIZOmu3Wt71KN9iK6DfOPro7w orderInformation: billTo: country: US lastName: VDP address1: 201 S. Division St. postalCode: 48104-2201 locality: Ann Arbor administrativeArea: MI firstName: RTS phoneNumber: '999999999' district: MI buildingNumber: '123' email: test@cybs.com amountDetails: totalAmount: '102.21' currency: USD example3: summary: Payment with Flex Token(Create Permanent TMS token) sample-name: Payment with Flex Token(Create Permanent TMS token) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - TOKEN_CREATE actionTokenTypes: - customer - paymentInstrument - shippingAddress orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com shipTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US amountDetails: totalAmount: '102.21' currency: USD tokenInformation: transientTokenJwt: eyJraWQiOiIwODVLd3ZiZHVqZW1DZDN3UnNxVFg3RG5nZzlZVk04NiIsImFsZyI6IlJTMjU2In0.eyJkYXRhIjp7Im51bWJlciI6IjQxMTExMVhYWFhYWDExMTEiLCJ0eXBlIjoiMDAxIn0sImlzcyI6IkZsZXgvMDgiLCJleHAiOjE1OTU2MjAxNTQsInR5cGUiOiJtZi0wLjExLjAiLCJpYXQiOjE1OTU2MTkyNTQsImp0aSI6IjFFMTlWWVlBUEFEUllPSzREUUM1NFhRN1hUVTlYN01YSzBCNTc5UFhCUU1HUUExVU1MOFI1RjFCM0IzQTU4MkIifQ.NKSM8zuT9TQC2OIUxIFJQk4HKeHhj_RGWmEqOQhBi0TIynt_kCIup1UVtAlhPzUfPWLwRrUVXnA9dyjLt_Q-pFZnvZ2lVANbiOq_R0us88MkM_mqaELuInCwxFeFZKA4gl8XmDFARgX1aJttC19Le6NYOhK2gpMrV4i0yz-IkbScsk0_vCH3raayNacFU2Wy9xei6H_V0yw2GeOs7kF6wdtMvBNw_uoLXd77LGE3LmV7z1TpJcG1SXy2s0bwYhEvkQGnrq6FfY8w7-UkDBWT1GhU3ZVP4y7h0l1WEX2xqf_ze25ZiYJQfWrEWPBHXRubOpAuaf4rfeZei0mRwPU-sQ example4: summary: Authorization with Customer Token Creation sample-name: Authorization with Customer Token Creation processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - TOKEN_CREATE actionTokenTypes: - customer - paymentInstrument - shippingAddress orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com shipTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US amountDetails: totalAmount: '102.21' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' parentTag: Authorization with Token Create example5: summary: Authorization with Customer Token Id sample-name: Authorization with Customer Token Id processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 orderInformation: amountDetails: totalAmount: '102.21' currency: USD paymentInformation: customer: id: B21E6717A6F03479E05341588E0A303F parentTag: Authorization using Tokens example6: summary: Authorization & Create Default Payment Instrument, Shipping Address for existing Customer sample-name: Authorization & Create Default Payment Instrument, Shipping Address for existing Customer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - TOKEN_CREATE actionTokenTypes: - paymentInstrument - shippingAddress orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com shipTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US amountDetails: totalAmount: '102.21' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' customer: id: B21E6717A6F03479E05341588E0A303F tokenInformation: paymentInstrument: default: true shippingAddress: default: true parentTag: Authorization with Token Create example7: summary: Authorization with Instrument Identifier Token Id bypassing Network Token sample-name: Authorization with Instrument Identifier Token Id bypassing Network Token processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 orderInformation: amountDetails: totalAmount: '102.21' currency: USD tokenInformation: networkTokenOption: ignore paymentInformation: instrumentIdentifier: id: '7010000000016241111' parentTag: Authorization using Tokens example8: summary: Authorization with Customer, Payment Instrument and Shipping Address Token Id sample-name: Authorization with Customer, Payment Instrument and Shipping Address Token Id processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 orderInformation: amountDetails: totalAmount: '102.21' currency: USD paymentInformation: customer: id: B21E6717A6F03479E05341588E0A303F paymentInstrument: id: B21E6B7E8BB3388EE05341588E0AFC84 shippingAddress: id: B21E6717A6F33479E05341588E0A303F parentTag: Authorization using Tokens example9: summary: Authorization with Instrument Identifier Token Creation sample-name: Authorization with Instrument Identifier Token Creation processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - TOKEN_CREATE actionTokenTypes: - instrumentIdentifier commerceIndicator: internet orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com shipTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US amountDetails: totalAmount: '102.21' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' parentTag: Authorization with Token Create example10: summary: Authorization with Decision Manager sample-name: Authorization with Decision Manager processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TSYS_Eh_FE_01 orderInformation: billTo: firstName: JSON lastName: RTS address1: 201 S. Division St._1 locality: Foster City administrativeArea: CA postalCode: '94404' country: US email: beforeauth@cybersource.com phoneNumber: '6504327113' amountDetails: totalAmount: '10' currency: USD paymentInformation: card: number: '4111111111111111' expirationMonth: '11' expirationYear: '2025' parentTag: Authorization with Decision Manager example11: summary: Authorization - Skip DecisionManager for single transaction sample-name: Authorization - Skip DecisionManager for single transaction processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: processingInformation: actionList: - DECISION_SKIP clientReferenceInformation: code: TC50171_16 orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' amountDetails: totalAmount: '10' currency: USD paymentInformation: card: number: '4111111111111111' expirationMonth: '11' expirationYear: '2025' parentTag: Authorization with Decision Manager example12: summary: Authorization with Decision Manager (Device Information) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '54323007' paymentInformation: card: expirationMonth: '12' expirationYear: '2030' number: '4444444444444448' orderInformation: billTo: firstName: James lastName: Smith locality: Clearwater milford address1: 96, powers street email: test@visa.com country: US administrativeArea: NH postalCode: '03055' phoneNumber: '7606160717' amountDetails: currency: USD totalAmount: '144.14' deviceInformation: cookiesAccepted: 'yes' hostName: host.com httpBrowserEmail: xyz@gmail.com userAgent: Chrome ipAddress: 64.124.61.215 parentTag: Authorization with Decision Manager example13: summary: Authorization with Decision Manager (Merchant Defined Information) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '54323007' paymentInformation: card: expirationMonth: '12' expirationYear: '2030' number: '4444444444444448' orderInformation: billTo: firstName: James lastName: Smith locality: Clearwater milford address1: 96, powers street email: test@visa.com country: US administrativeArea: NH postalCode: '03055' phoneNumber: '7606160717' amountDetails: currency: USD totalAmount: '144.14' merchantDefinedInformation: - key: '1' value: Test - key: '2' value: Test2 parentTag: Authorization with Decision Manager example14: summary: Authorization with Decision Manager (Travel Information) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '54323007' paymentInformation: card: expirationMonth: '12' expirationYear: '2030' number: '4444444444444448' orderInformation: billTo: firstName: James lastName: Smith locality: Clearwater milford address1: 96, powers street email: test@visa.com country: US administrativeArea: NH postalCode: '03055' phoneNumber: '7606160717' amountDetails: currency: USD totalAmount: '144.14' travelInformation: completeRoute: SFO-JFK:JFK-BLR departureTime: 2011-03-20 11:30pm GMT journeyType: One way legs: - destination: JFK origination: SFO - destination: BLR origination: JFK parentTag: Authorization with Decision Manager example15: summary: Authorization with Decision Manager (Buyer Information) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '54323007' paymentInformation: card: expirationMonth: '12' expirationYear: '2030' number: '4444444444444448' orderInformation: billTo: firstName: James lastName: Smith locality: Clearwater milford address1: 96, powers street email: test@visa.com country: US administrativeArea: NH postalCode: '03055' phoneNumber: '7606160717' amountDetails: currency: USD totalAmount: '144.14' buyerInformation: hashedPassword: '' dateOfBirth: '19980505' personalIdentification: - id: 1a23apwe98 type: CPF parentTag: Authorization with Decision Manager example16: summary: Authorization with Decision Manager (Shipping Information) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '54323007' paymentInformation: card: expirationMonth: '12' expirationYear: '2030' number: '4444444444444448' orderInformation: billTo: firstName: James lastName: Smith locality: Clearwater milford address1: 96, powers street email: test@visa.com country: US administrativeArea: NH postalCode: '03055' phoneNumber: '7606160717' amountDetails: currency: USD totalAmount: '144.14' shipTo: address1: 96, powers street locality: Clearwater milford country: IN firstName: James lastName: Smith phoneNumber: '7606160717' administrativeArea: KA postalCode: '560056' parentTag: Authorization with Decision Manager example17: summary: Authorization with Decision Manager (custom setup) sample-name: Authorization with Decision Manager (custom setup) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: processingInformation: actionList: - DECISION clientReferenceInformation: code: TC50171_16 orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' amountDetails: totalAmount: '10' currency: USD paymentInformation: card: number: '4111111111111111' expirationMonth: '11' expirationYear: '2025' parentTag: Authorization with Decision Manager example18: summary: Authorization with PA Enroll (Authentication Needed) sample-name: Authorization with PA Enroll (Authentication Needed) processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - CONSUMER_AUTHENTICATION consumerAuthenticationInformation: referenceId: CybsCruiseTester-8ac0b02f requestorId: '123123197675' authenticationBrand: VISA orderInformation: billTo: firstName: John lastName: Smith address1: 201 S. Division St._1 address2: Suite 500 locality: Foster City administrativeArea: CA postalCode: '94404' country: US phoneNumber: '6504327113' email: accept@cybersource.com amountDetails: totalAmount: '100.00' currency: usd paymentInformation: card: expirationYear: '2030' number: '4000000000001091' expirationMonth: '12' parentTag: Authorization with Payer Authentication example19: summary: Authorization with Payer Auth Validation sample-name: Authorization with Payer Auth Validation processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - VALIDATE_CONSUMER_AUTHENTICATION consumerAuthenticationInformation: authenticationTransactionId: OiCtXA1j1AxtSNDh5lt1 authenticationBrand: VISA orderInformation: billTo: firstName: John lastName: Smith address1: 201 S. Division St._1 address2: Suite 500 locality: Foster City administrativeArea: CA postalCode: '94404' country: US phoneNumber: '6504327113' email: accept@cybs.com amountDetails: amount: '100.00' currency: USD paymentInformation: card: expirationYear: '2030' number: '4000000000001091' expirationMonth: '01' parentTag: Authorization with Payer Authentication example20: summary: Authorization with DM(Accept) + PA Enroll sample-name: Authorization with DM(Accept) + PA Enroll processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: cbys_test processingInformation: actionList: - CONSUMER_AUTHENTICATION orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US phoneNumber: '4158880000' email: accept@cybersource.com amountDetails: totalAmount: '1.00' currency: usd paymentInformation: card: expirationYear: '2031' number: '340000000001007' securityCode: '1234' expirationMonth: '12' parentTag: Authorization with Payer Authentication example21: summary: Authorization with DM(Review) + PA Enroll sample-name: Authorization with DM(Review) + PA Enroll processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - CONSUMER_AUTHENTICATION paymentInformation: card: expirationYear: '2031' number: '372425119311008' securityCode: '1234' expirationMonth: '12' orderInformation: amountDetails: totalAmount: '102.21' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: review@domain.com phoneNumber: '4158880000' parentTag: Authorization with Payer Authentication example22: summary: Authorization with DM(Reject) + PA Enroll sample-name: Authorization with DM(Reject) + PA Enroll processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - CONSUMER_AUTHENTICATION paymentInformation: card: expirationYear: '2031' number: '372425119311008' securityCode: '1234' expirationMonth: '12' orderInformation: amountDetails: totalAmount: '102.21' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: reject@domain.com phoneNumber: '4158880000' parentTag: Authorization with Payer Authentication example23: summary: Payment Network Tokenization sample-name: Process Payment with Network Tokenization processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC_123122 processingInformation: commerceIndicator: vbv originalPaymentId: '1111' orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com amountDetails: totalAmount: '100' currency: USD paymentInformation: tokenizedCard: expirationYear: '2031' number: '4111111111111111' expirationMonth: '12' transactionType: '1' consumerAuthenticationInformation: cavv: AAABCSIIAAAAAAACcwgAEMCoNh+= xid: T1Y0OVcxMVJJdkI0WFlBcXptUzE= authenticationBrand: VISA example24: summary: Digital Payment - GooglePay sample-name: Process Payment with GooglePay processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC_1231223 processingInformation: paymentSolution: '012' purposeOfPayment: '16' languageCode: US authorizationOptions: serviceType: '00' originalPaymentId: '1111' orderInformation: billTo: country: US firstName: John lastName: Deo phoneNumber: '6504327113' address1: 901 Metro Center Blvd postalCode: '94404' locality: Foster City administrativeArea: CA email: test@cybs.com amountDetails: totalAmount: '20' currency: USD paymentInformation: tokenizedCard: expirationYear: '2030' number: '4111111111111111' expirationMonth: '12' transactionType: '1' cryptogram: EHuWW9PiBkWvqE5juRwDzAUFBAk= example25: summary: Digital Payments - ApplePay sample-name: Process Payment with ApplePay processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC_1231223 processingInformation: paymentSolution: '001' purposeOfPayment: '16' languageCode: US authorizationOptions: serviceType: '01' originalPaymentId: '1111' orderInformation: billTo: country: US firstName: John lastName: Deo phoneNumber: '6504327113' address1: 901 Metro Center Blvd postalCode: '94404' locality: Foster City administrativeArea: CA email: test@cybs.com amountDetails: totalAmount: '10' currency: USD paymentInformation: tokenizedCard: expirationYear: '2031' number: '4111111111111111' expirationMonth: '12' transactionType: '1' cryptogram: AceY+igABPs3jdwNaDg3MAACAAA= example26: summary: Zero Dollar Authorization sample-name: Process Payment for Zero Dollar Authorization processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '1234567890' orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com amountDetails: totalAmount: 0 currency: USD paymentInformation: card: expirationYear: '2031' number: '5555555555554444' securityCode: '123' expirationMonth: '12' example27: summary: Level II Data sample-name: Process Payment with Level II Data processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_12 orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com invoiceDetails: purchaseOrderNumber: LevelII Auth Po amountDetails: totalAmount: '112.00' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' example28: summary: Level III Data sample-name: Process Payment with Level III Data processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_14 processingInformation: purchaseLevel: '3' orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com invoiceDetails: purchaseOrderNumber: LevelIII Auth Po lineItems: - discountApplied: 'false' quantity: '10' unitPrice: '10.00' totalAmount: '100' productCode: default amountIncludesTax: 'false' amountDetails: totalAmount: '100.00' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' example29: summary: Partial Authorization sample-name: Process Payment with Partial Authorization processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '1234567890' pointOfSaleInformation: cardPresent: 'true' catLevel: '6' emv: fallbackCondition: '1' fallback: 'false' terminalCapability: '4' orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com amountDetails: totalAmount: '7012.00' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' example30: summary: Account Funding Transaction sample-name: Process Account Funding Transaction processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: RTS-AFT3-8 processingInformation: capture: true commerceIndicator: internet businessApplicationId: AA authorizationOptions: aftIndicator: true ignoreAvsResult: true ignoreCvResult: false orderInformation: billTo: firstName: Joe middleName: S lastName: Root address1: 34 Orchard Grove locality: Southampton postalCode: DE6 1BE country: GB email: test@cybs.com amountDetails: totalAmount: '28.00' currency: GBP paymentInformation: card: number: '4539791001730106' securityCode: '351' expirationMonth: '03' expirationYear: '2025' type: '001' senderInformation: firstName: Joe middleName: S lastName: Root address1: 34 Orchard Grove locality: Southampton countryCode: GB aliasName: Joe My Friend recipientInformation: firstName: Ben middleName: Ann lastName: Stokes accountId: '4929421234600821' accountType: '03' address1: 1 High Street country: GB aliasName: Ben My Friend nationality: GB countryOfBirth: GB occupation: freelancer email: joe@visa.com example31: summary: Electronic Check Debits sample-name: Process Payment ECheck Debits processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 paymentInformation: paymentType: name: CHECK bank: account: type: C number: '4100' routingNumber: 71923284 orderInformation: amountDetails: totalAmount: '100' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com parentTag: Electronic Check(eCheck) and ServiceFees example32: summary: Electronic Check Debits with Legacy Token sample-name: Process Payment ECheck Debits with Legacy Token processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 paymentInformation: paymentType: name: CHECK legacyToken: id: 7500BB199B4270EFE05340588D0AFCAD orderInformation: amountDetails: totalAmount: '100' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com parentTag: Electronic Check(eCheck) and ServiceFees example33: summary: Service Fees with Credit Card transaction sample-name: Process Payment Service Fees with Credit Card transaction processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com amountDetails: totalAmount: '2325.00' currency: USD serviceFeeAmount: '30.0' paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' merchantInformation: serviceFeeDescriptor: name: Vacations Service Fee contact: '8009999999' state: CA parentTag: Electronic Check(eCheck) and ServiceFees example34: summary: Authorization Using Swiped Track Data sample-name: Authorization Using Swiped Track Data processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: ABC123 partner: thirdPartyCertificationNumber: '123456789012' processingInformation: commerceIndicator: retail authorizationOptions: partialAuthIndicator: 'true' pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?' cardPresent: Y entryMode: swiped terminalCapability: '4' orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example35: summary: Sale Using Swiped Track Data with Visa Platform Connect sample-name: Sale Using Swiped Track Data with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: '123456' processingInformation: commerceIndicator: retail capture: 'true' authorizationOptions: partialAuthIndicator: 'true' pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?;38000000000006=20121210197611868000?' cardPresent: Y entryMode: swiped terminalCapability: '4' orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example36: summary: Sale Using Keyed Data with Visa Platform Connect sample-name: Sale Using Keyed Data with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail capture: true authorizationOptions: partialAuthIndicator: true ignoreAvsResult: true ignoreCvResult: true serviceType: '02' purposeOfPayment: '16' languageCode: US pointOfSaleInformation: cardPresent: Y entryMode: keyed terminalCapability: 4 paymentInformation: card: number: 4111111111111111 securityCode: 123 expirationMonth: 12 expirationYear: 2031 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example37: summary: Sale Using Keyed Data with Balance Inquiry sample-name: Sale Using Keyed Data with Balance Inquiry processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 partner: thirdPartyCertificationNumber: 123456789012 processingInformation: commerceIndicator: retail capture: true authorizationOptions: partialAuthIndicator: true ignoreAvsResult: true ignoreCvResult: true serviceType: '03' purposeOfPayment: '16' languageCode: US pointOfSaleInformation: cardPresent: Y entryMode: keyed terminalCapability: 4 paymentInformation: card: number: 4111111111111111 securityCode: 123 expirationMonth: 12 expirationYear: 2031 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example38: summary: Sale Using EMV Technology with Contact Read with Visa Platform Connect sample-name: Sale Using EMV Technology with Contact Read with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail authorizationOptions: partialAuthIndicator: true pointOfSaleInformation: trackData: '%B4111111111111111^TEST/CYBS ^2412121019761100 00868000000?;' cardPresent: Y catLevel: 7 emv: cardSequenceNumber: 1 tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contact terminalCapability: 4 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example39: summary: Sale Using EMV Technology with Contactless Read with Visa Platform Connect sample-name: Sale Using EMV Technology with Contactless Read with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail authorizationOptions: partialAuthIndicator: true pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?;38000000000006=20121210197611868000?' cardPresent: Y catLevel: 2 entryMode: contactless emv: cardSequenceNumber: 1 tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 terminalCapability: 5 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example40: summary: Authorization Using Bluefin PCI P2PE with Visa Platform Connect sample-name: Authorization Using Bluefin PCI P2PE with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: demomerchant pointOfSaleInformation: cardPresent: Y catLevel: 1 entryMode: keyed terminalCapability: 2 processingInformation: commerceIndicator: retail authorizationOptions: partialAuthIndicator: true ignoreAvsResult: true ignoreCvResult: true orderInformation: billTo: country: US lastName: Deo address1: 201 S. Division St. postalCode: 48104-2201 locality: Ann Arbor administrativeArea: MI firstName: John phoneNumber: 999999999 district: MI email: test@cybs.com amountDetails: totalAmount: '100.00' currency: USD paymentInformation: card: expirationYear: 2050 expirationMonth: 12 fluidData: descriptor: Ymx1ZWZpbg== value: 02d700801f3c20008383252a363031312a2a2a2a2a2a2a2a303030395e46444d53202020202020202020202020202020202020202020205e323231322a2a2a2a2a2a2a2a3f2a3b363031312a2a2a2a2a2a2a2a303030393d323231322a2a2a2a2a2a2a2a3f2a7a75ad15d25217290c54b3d9d1c3868602136c68d339d52d98423391f3e631511d548fff08b414feac9ff6c6dede8fb09bae870e4e32f6f462d6a75fa0a178c3bd18d0d3ade21bc7a0ea687a2eef64551751e502d97cb98dc53ea55162cdfa395431323439323830303762994901000001a000731a8003 parentTag: Card Present with Visa Platform Connect example41: summary: Restaurant Authorization sample-name: Restaurant Authorization processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: demomerchant partner: thirdPartyCertificationNumber: 123456789012 pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?' cardPresent: Y entryMode: swiped terminalCapability: 4 processingInformation: commerceIndicator: retail authorizationOptions: partialAuthIndicator: true orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present with Visa Platform Connect example42: summary: Sale Using EMV Technology with a Contactless sample-name: Sale Using EMV Technology with a Contactless processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?;38000000000006=20121210197611868000?' cardPresent: Y catLevel: 2 entryMode: contactless emv: cardSequenceNumber: 999 terminalCapability: 4 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example43: summary: Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer sample-name: Sale Using EMV Technology with Contact Read (One) for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail pointOfSaleInformation: trackData: '%B4111111111111111^TEST/CYBS ^2412121019761100 00868000000?;' cardPresent: Y catLevel: 7 emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 cardSequenceNumber: 0 entryMode: contact terminalCapability: 4 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example44: summary: Swiped sample-name: Swiped processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?;38000000000006=20121210197611868000?' cardPresent: Y entryMode: swiped terminalCapability: 4 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example45: summary: Sale Using Swiped Track Data for Card Present Enabled Acquirer sample-name: Sale Using Swiped Track Data for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail capture: true pointOfSaleInformation: trackData: '%B38000000000006^TEST/CYBS ^2412121019761100 00868000000?;38000000000006=20121210197611868000?' cardPresent: Y entryMode: swiped terminalCapability: 4 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example46: summary: Sale Using Keyed Data for Card Present Enabled Acquirer sample-name: Sale Using Keyed Data for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 processingInformation: commerceIndicator: retail capture: true pointOfSaleInformation: cardPresent: Y entryMode: keyed terminalCapability: 4 paymentInformation: card: number: 4111111111111111 securityCode: 123 expirationMonth: 12 expirationYear: 2031 orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example47: summary: American Express Direct - EMV with Contact Read sample-name: American Express Direct - EMV with Contact Read processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 partner: originalTransactionId: 510be4aef90711e6acbc7d88388d803d processingInformation: commerceIndicator: retail pointOfSaleInformation: trackData: '%B4111111111111111^TEST/CYBS ^2412121019761100 00868000000?;' cardPresent: Y catLevel: 1 emv: cardSequenceNumber: 1 cardholderVerificationMethodUsed: 2 tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contact terminalCapability: 4 encryptedKeySerialNumber: 1043191 cardholderVerificationMethod: - pin - signature terminalInputCapability: - contact - contactless - keyed - swiped terminalCardCaptureCapability: 1 deviceId: 123lkjdIOBK34981slviLI39bj orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example48: summary: Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer sample-name: Sale Using EMV Technology with Contact Read (Two) for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 partner: originalTransactionId: 510be4aef90711e6acbc7d88388d803d processingInformation: commerceIndicator: retail capture: true pointOfSaleInformation: trackData: '%B4111111111111111^TEST/CYBS ^2412121019761100 00868000000?;' cardPresent: Y catLevel: 1 emv: cardSequenceNumber: 1 cardholderVerificationMethodUsed: 2 tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contact terminalCapability: 4 encryptedKeySerialNumber: 1043191 cardholderVerificationMethod: - pin - signature terminalInputCapability: - contact - contactless - keyed - swiped terminalCardCaptureCapability: 1 deviceId: 123lkjdIOBK34981slviLI39bj orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example49: summary: Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer sample-name: Sale Using EMV Technology with Contactless Read for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: 123456 partner: originalTransactionId: 510be4aef90711e6acbc7d88388d803d processingInformation: commerceIndicator: retail capture: true pointOfSaleInformation: trackData: '%B4111111111111111^TEST/CYBS ^2412121019761100 00868000000?;' cardPresent: Y catLevel: 1 emv: cardSequenceNumber: 1 cardholderVerificationMethodUsed: 2 tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contactless terminalCapability: 5 encryptedKeySerialNumber: 1043191 cardholderVerificationMethod: - pin - signature terminalInputCapability: - contact - contactless - keyed - swiped terminalCardCaptureCapability: 1 deviceId: 123lkjdIOBK34981slviLI39bj orderInformation: amountDetails: totalAmount: '100.00' currency: USD parentTag: Card Present Enabled Acquirer example50: summary: Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer sample-name: Authorization Using Bluefin PCI P2PE for Card Present Enabled Acquirer processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: demomerchant pointOfSaleInformation: cardPresent: Y catLevel: 1 entryMode: keyed terminalCapability: 2 processingInformation: commerceIndicator: retail orderInformation: billTo: country: US lastName: Deo address1: 201 S. Division St. postalCode: 48104-2201 locality: Ann Arbor administrativeArea: MI firstName: John phoneNumber: 999999999 district: MI email: test@cybs.com amountDetails: totalAmount: '100.00' currency: USD paymentInformation: card: expirationYear: 2050 expirationMonth: 12 fluidData: descriptor: Ymx1ZWZpbg== value: 02d700801f3c20008383252a363031312a2a2a2a2a2a2a2a303030395e46444d53202020202020202020202020202020202020202020205e323231322a2a2a2a2a2a2a2a3f2a3b363031312a2a2a2a2a2a2a2a303030393d323231322a2a2a2a2a2a2a2a3f2a7a75ad15d25217290c54b3d9d1c3868602136c68d339d52d98423391f3e631511d548fff08b414feac9ff6c6dede8fb09bae870e4e32f6f462d6a75fa0a178c3bd18d0d3ade21bc7a0ea687a2eef64551751e502d97cb98dc53ea55162cdfa395431323439323830303762994901000001a000731a8003 parentTag: Card Present Enabled Acquirer example51: summary: Authorization with Instrument Identifier Token Id sample-name: Authorization with Instrument Identifier Token Id processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: internet orderInformation: billTo: country: US firstName: John lastName: Deo phoneNumber: '9321499232' address1: 900 Metro Center Blvd postalCode: 48104-2201 locality: Foster City administrativeArea: CA email: test@cybs.com amountDetails: totalAmount: '200' currency: usd paymentInformation: card: expirationYear: '2031' expirationMonth: '03' type: '001' instrumentIdentifier: id: '7010000000016241111' parentTag: Authorization using Tokens example52: summary: Authorization with Legacy Token sample-name: Authorization with Legacy Token processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 paymentInformation: legacyToken: id: B21E6717A6F03479E05341588E0A303F orderInformation: amountDetails: totalAmount: '22' currency: USD billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' parentTag: Authorization using Tokens example53: summary: Authorization with PA Enroll (Authentication Needed) & Customer Token Creation sample-name: Authorization with PA Enroll (Authentication Needed) & Customer Token Creation processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: actionList: - TOKEN_CREATE - CONSUMER_AUTHENTICATION actionTokenTypes: - customer - paymentInstrument - shippingAddress consumerAuthenticationInformation: challengeCode: 4 requestorId: 123123197675 referenceId: CybsCruiseTester-8ac0b02f authenticationBrand: VISA orderInformation: billTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US phoneNumber: '4158880000' email: test@cybs.com shipTo: firstName: John lastName: Doe address1: 1 Market St postalCode: '94105' locality: san francisco administrativeArea: CA country: US amountDetails: totalAmount: '102.21' currency: USD paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' parentTag: Authorization with Token Create example54: summary: Authorization with Transit Tap Id sample-name: Authorization with Transit Tap Id processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: retail industryDataType: transit authorizationOptions: transportationMode: 4 aggregatedAuthIndicator: true deferredAuthIndicator: true orderInformation: amountDetails: totalAmount: 4.21 currency: USD pointOfSaleInformation: catLevel: 2 entryMode: contactless terminalCapability: 5 tokenInformation: jti: a96392f4-cde4-11eb-b8bc-0242ac130002 parentTag: Authorization using Tokens example55: summary: Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect sample-name: Pin Debit Purchase Using Swiped Track Data with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: Pin Debit Purchase Using Swiped Track Data partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: '%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?' entryMode: swiped terminalCapability: 4 pinBlockEncodingFormat: 1 encryptedPin: 52F20658C04DB351 encryptedKeySerialNumber: FFFF1B1D140000000005 processingInformation: commerceIndicator: retail networkRoutingOrder: VMHF orderInformation: amountDetails: totalAmount: '202.00' currency: USD paymentInformation: paymentType: name: CARD subTypeName: DEBIT card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example56: summary: Pin Debit Purchase Using EMV Contact with Visa Platform Connect sample-name: Pin Debit Purchase Using EMV Contact with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd 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 card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example57: 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 processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: Pin Debit Purchase Using EMV Contactless partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: ;4111111111111111=33121019761186800000? entryMode: contactless terminalCapability: 4 emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 cardSequenceNumber: 1 processingInformation: commerceIndicator: retail networkRoutingOrder: VMHF orderInformation: amountDetails: totalAmount: '202.00' currency: USD paymentInformation: paymentType: name: CARD subTypeName: DEBIT card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example58: summary: Pin Debit Purchase with Cashback Request with Visa Platform Connect sample-name: Pin Debit Purchase with Cashback Request with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: Pin Debit Purchase With Cashback partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: ;4111111111111111=33121019761186800000? entryMode: contactless terminalCapability: 4 emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 cardSequenceNumber: 1 processingInformation: commerceIndicator: retail networkRoutingOrder: VMHF orderInformation: amountDetails: totalAmount: '204.00' currency: USD cashbackAmount: '45.00' paymentInformation: paymentType: name: CARD subTypeName: DEBIT card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example59: 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 processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: Pin Debit Purchase - Balance Inquiry partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: ;4111111111111111=33121019761186800000? entryMode: contactless terminalCapability: 4 emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 cardSequenceNumber: 1 processingInformation: commerceIndicator: retail authorizationOptions: balanceInquiry: 'true' networkRoutingOrder: VMHF orderInformation: amountDetails: totalAmount: '0.00' currency: USD paymentInformation: paymentType: name: CARD subTypeName: DEBIT card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example60: summary: EBT - Purchase from SNAP Account with Visa Platform Connect sample-name: EBT - Purchase from SNAP Account with Visa Platform Connect processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: EBT - Purchase From SNAP Account partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: '%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?' entryMode: swiped terminalCapability: 4 pinBlockEncodingFormat: 1 encryptedPin: 52F20658C04DB351 encryptedKeySerialNumber: FFFF1B1D140000000005 processingInformation: commerceIndicator: retail networkRoutingOrder: K purchaseOptions: isElectronicBenefitsTransfer: true eligibilityIndicator: Y benefitAmount: '10.00' benefitType: '52' electronicBenefitsTransfer: category: FOOD orderInformation: amountDetails: totalAmount: '101.00' currency: USD merchantInformation: categoryCode: '5499' paymentInformation: paymentType: name: CARD subTypeName: DEBIT parentTag: Card Present with Visa Platform Connect example61: 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 processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: EBT - Purchase From SNAP Account (Available Balance) partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: '%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?' entryMode: swiped terminalCapability: 4 pinBlockEncodingFormat: 1 encryptedPin: 52F20658C04DB351 encryptedKeySerialNumber: FFFF1B1D140000000005 processingInformation: commerceIndicator: retail networkRoutingOrder: K purchaseOptions: isElectronicBenefitsTransfer: true eligibilityIndicator: N benefitAmount: '10.00' benefitType: '70' electronicBenefitsTransfer: category: FOOD orderInformation: amountDetails: totalAmount: '6022.00' currency: USD merchantInformation: categoryCode: '5499' paymentInformation: paymentType: name: CARD subTypeName: DEBIT parentTag: Card Present with Visa Platform Connect example62: 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 processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: EBT - Voucher Purchase From SNAP Account partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: '%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?' entryMode: keyed terminalCapability: 4 processingInformation: commerceIndicator: retail networkRoutingOrder: K purchaseOptions: isElectronicBenefitsTransfer: true eligibilityIndicator: Y benefitAmount: '10.00' benefitType: '53' electronicBenefitsTransfer: voucherSerialNumber: '123451234512345' category: FOOD orderInformation: amountDetails: totalAmount: '103.00' currency: USD merchantInformation: categoryCode: '5999' paymentInformation: card: number: '4012002000013007' expirationMonth: '12' expirationYear: '25' paymentType: name: CARD subTypeName: DEBIT parentTag: Card Present with Visa Platform Connect example63: summary: EBT - Purchase from Cash Benefits Account with Cashback sample-name: EBT - Purchase from Cash Benefits Account with Cashback processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: EBT - Purchase from Cash Benefits Account with CB partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: '%B4111111111111111^JONES/JONES ^3312101976110000868000000?;4111111111111111=33121019761186800000?' entryMode: swiped terminalCapability: 4 pinBlockEncodingFormat: 1 encryptedPin: 52F20658C04DB351 encryptedKeySerialNumber: FFFF1B1D140000000005 processingInformation: commerceIndicator: retail networkRoutingOrder: K purchaseOptions: isElectronicBenefitsTransfer: true eligibilityIndicator: Y benefitAmount: '10.00' benefitType: '59' electronicBenefitsTransfer: category: CASH orderInformation: amountDetails: totalAmount: '702.00' currency: USD cashbackAmount: '45.00' merchantInformation: categoryCode: '5411' paymentInformation: card: type: '001' paymentType: name: CARD subTypeName: DEBIT parentTag: Card Present with Visa Platform Connect example64: summary: SI Completion Amount>0 sample-name: SI Completion processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: deviceInformation: httpAcceptBrowserValue: http userAgentBrowserValue: safari ipAddress: 10.10.10.10 consumerAuthenticationInformation: authenticationTransactionContextId: '100000000000000000000000025253' transactionToken: AxjzbwSTcz9aHyOIL490/949UafAxfvksgAxHXa2/+xcVZ0CtA+AbkvF authenticationBrand: MASTERCARD processingInformation: commerceIndicator: rpy actionList: - BILLING_AGREEMENT_CREATE aggregatorInformation: subMerchant: name: rupay name: aggregatorname orderInformation: billTo: country: SG lastName: VDP address2: test address1: 201 S. Division St. postalCode: 48104-2201 locality: Ann Arbor administrativeArea: MI firstName: RTS phoneNumber: '999999999' district: MI buildingNumber: '123' company: name: Visa email: test@cybs.com amountDetails: totalAmount: '100.0' currency: INR paymentInformation: card: expirationYear: '2031' number: '5082794233463' securityCode: '123' expirationMonth: '12' type: '061' installmentInformation: paymentType: '1' example65: summary: Redirectional SI Completion Amount > 0 sample-name: S2S SI Completion processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: deviceInformation: httpAcceptBrowserValue: http userAgentBrowserValue: safari ipAddress: 10.10.10.10 consumerAuthenticationInformation: cavv: MTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDI1MjM2 xid: OTE0OTE2MzI5MzE1MDUyOTU4Mjc= authenticationBrand: MASTERCARD processingInformation: commerceIndicator: rpy actionList: - BILLING_AGREEMENT_CREATE aggregatorInformation: subMerchant: name: rupay name: aggregatorname streetAddress: 202 S. Division St. city: Phoenix state: Arizona postalCode: '560048' country: USA orderInformation: billTo: country: IN firstName: Krishna lastName: CYBS phoneNumber: '9999999999' address1: 201 S. Division St. district: BLR postalCode: '560048' locality: NPCI company: name: Visa administrativeArea: MI email: test@cybs.com amountDetails: totalAmount: '00.00' currency: INR paymentInformation: card: expirationYear: '2026' number: '50823043205909' securityCode: '123' expirationMonth: 08 type: '061' installmentInformation: paymentType: '1' example66: summary: PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50 sample-name: PIN-less Debit Purchase Using EMV Technology with Contactless Less Than or Equal to $50 processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: PIN-less Debit Purchase Using EMV Contactless partner: thirdPartyCertificationNumber: PTP1234 pointOfSaleInformation: trackData: ;4111111111111111=33121019761186800000? entryMode: contactless terminalCapability: 4 terminalPinCapability: 0 emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 cardSequenceNumber: 1 processingInformation: commerceIndicator: retail networkRoutingOrder: VMHF orderInformation: amountDetails: totalAmount: '10.00' currency: USD paymentInformation: paymentType: name: CARD subTypeName: DEBIT card: useAs: '' sourceAccountType: UA parentTag: Card Present with Visa Platform Connect example67: summary: CIT Initiating Recurring Subscription sample-name: CIT Initiating Recurring Subscription processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: vbv authorizationOptions: initiator: credentialStoredOnFile: true recurringOptions: firstRecurringPayment: true paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= authenticationBrand: MASTERCARD parentTag: MIT Framework example68: summary: MIT Recurring sample-name: MIT Recurring processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: recurring authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: previousTransactionId: '123456789012345' paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' type: '001' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' parentTag: MIT Framework example69: summary: CIT Initiating Instalment Subscription - UK sample-name: CIT Initiating Instalment Subscription - UK processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: vbv authorizationOptions: initiator: credentialStoredOnFile: true recurringOptions: firstRecurringPayment: true paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= authenticationBrand: MASTERCARD parentTag: MIT Framework example70: summary: MIT Instalment sample-name: MIT Instalment processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: install authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: previousTransactionId: '123456789012345' paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' type: '001' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' parentTag: MIT Framework example71: summary: CIT Placing Credential on File sample-name: CIT Placing Credential on File processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: vbv authorizationOptions: initiator: credentialStoredOnFile: true paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= authenticationBrand: MASTERCARD parentTag: MIT Framework example72: summary: MIT Unscheduled Credential on File sample-name: MIT Unscheduled Credential on File processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: internet authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: previousTransactionId: '123456789012345' paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' type: '001' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' parentTag: MIT Framework example73: summary: MIT Industry Practice - Resubmission sample-name: MIT Industry Practice - Resubmission processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: moto authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: reason: '1' previousTransactionId: '123456789012345' paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' type: '001' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' parentTag: MIT Framework example74: summary: MIT Industry Practice - Delayed Charge - 3RI Visa sample-name: MIT Industry Practice - Delayed Charge - 3RI Visa processor-type: - Chase Paymentech (Default) - FDI Global - Visa Platform Connect - American Express Direct - Barclays - Barclays Merchant Services - AMEX Direct - Bank of America ACH - Credit Mutuel-CIC - China UnionPay - Elavon Americas - FDC Compass - eCheck - GPX - Prosa - Rupay - SIX - FDMS Nashville - Software Express - Streamline - ValueLink - Worldpay VAP - Vero - TSYS Acquiring Solutions - Wells Fargo ACH - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC50171_3 processingInformation: commerceIndicator: vbv authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: reason: '2' previousTransactionId: '123456789012345' paymentInformation: card: number: '4111111111111111' expirationMonth: '12' expirationYear: '2031' type: '001' orderInformation: amountDetails: totalAmount: '102.21' currency: GBP billTo: firstName: John lastName: Doe address1: 1 Market St locality: san francisco administrativeArea: CA postalCode: '94105' country: US email: test@cybs.com phoneNumber: '4158880000' consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= paresStatus: Y authenticationBrand: VISA parentTag: MIT Framework example75: summary: 1. Auth Bill MC Spa CIT Auth Reason Blank sample-name: 1. Auth Bill MC Spa CIT Auth Reason Blank batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC01_01 processingInformation: commerceIndicator: spa capture: true authorizationOptions: initiator: credentialStoredOnFile: true paymentInformation: card: number: '5188690467086204' expirationMonth: '12' expirationYear: '2040' securityCode: '123' orderInformation: amountDetails: totalAmount: '100.00' currency: USD billTo: firstName: John lastName: Doe address1: Auth_Bill_MC_Spa_CIT_Auth_Reason_Blank_Street locality: TestCity administrativeArea: CA postalCode: '96162' country: US email: test@visa.com phoneNumber: '9999999999' shipTo: firstName: Olivia lastName: White address1: 1295 Charleston Rd address2: Cube 2386 locality: Mountain View administrativeArea: CA postalCode: '94041' country: AE email: null2@cybersource.com phoneNumber: 650-965-6000 consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: MASTERCARD ucafCollectionIndicator: '2' ucafAuthenticationData: test merchantInformation: merchantDescriptor: submerchantId: ABCDE1234567890 aggregatorId: '10046356' parentTag: CIT-MIT Framework example76: summary: 1. Auth Bill Retail Keyed AX sample-name: 1. Auth Bill Retail Keyed AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: clientReferenceInformation: code: TC02_24 orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: address1: Auth_Bill_Retail_Keyed_AX locality: TestCity administrativeArea: CA postalCode: '00000' country: US email: test@visa.com firstName: Raghu24cp lastName: Krishnan phoneNumber: '9999999999' invoiceDetails: merchantDescriptor: name: Test Merchant address1: Merchant Street locality: Test City administrativeArea: CA postalCode: '96162' country: US phoneNumber: '9999999999' paymentInformation: card: number: '377671320002630' expirationMonth: '12' expirationYear: '2040' securityCode: '123' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE commerceIndicator: retail processingInformation: capture: true commerceIndicator: retail pointOfSaleInformation: entryMode: keyed trackData: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: Y terminalCapability: '4' merchantInformation: merchantDescriptor: name: Test Merchant address1: Merchant Street locality: Test City administrativeArea: CA postalCode: '96162' country: US phoneNumber: '9999999999' merchantId: fildrop_vdcacpcaymannb subMerchant: id: ABCDE1234567890 name: Sub Merchant deviceInformation: terminalId: '123' capability: posEntryMode: keyed terminalCapability: '4' processingOptions: authorizationOptions: initiator: credentialStoredOnFile: true senderInformation: referenceNumber: '7364259856903551938920' address: address1: Sender Address locality: Sender City administrativeArea: CA country: US name: John clientInfo: clientLibrary: libraryName: BellSoft libraryVersion: 17.0.9 osName: Linux osVersion: 4.18.0-553.32.1.el8_10.x86_64 javaVersion: 5.3.4 trackData: track1: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' track2: ; thirdPartyCertification: number: '1.23457E+11' parentTag: Auth-Bill-Retail-Framework example77: summary: 2. Auth Bill Retail Contact VI sample-name: 2. Auth Bill Retail Contact VI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: aggregatorId: '10046356' billTo: address1: Auth_Bill_Retail_Contact_VI locality: TestCity country: US administrativeArea: CA postalCode: '00000' processingInformation: captureDate: '0711' cardPresent: true commerceIndicator: retail terminalCapability: '4' thirdPartyCertificationNumber: '12345700000' card: type: '001' cavv: ABCDEabcde12345678900987654321abcdeABCDE clientReferenceInformation: code: TC02_07 clientSoftwareInformation: clientLibVersion: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 orderInformation: amountDetails: totalAmount: '98.50' currency: USD billTo: email: test@visa.com firstName: Raghu7cp lastName: Krishnan phoneNumber: '9999999999' shipTo: name: John invoiceDetails: merchantDescriptor: name: Test Merchant locality: Test City contact: '9999999999' country: US phoneNumber: '9999999999' postalCode: '96162' administrativeArea: CA street: Merchant Street pointOfSaleInformation: entryMode: contact trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;4111111111111111=24121019761186800000?' emv: cardSequenceNumber: '123' combinedTags: 5F2A02084082021C005009496E7465726C696E6B9F1C0831363032313133339F0607A00000000330105F300202205F3401018407A0000000033010950580000480009A031409039B0268009C01009F02060000000020009F03060000000000009F0902008C9F100706010A03A010009F120706010A03A010009F1A0208409F1E0831363032313133339F26089C402634428CF8739F2701809F3303E0F8C89F34030203009F3501229F360200049F37047118AE3E senderInformation: address1: Sender Address locality: Sender City country: US senderId: ms_user merchantInformation: merchantDescriptor: name: Test Merchant locality: Test City contact: '9999999999' country: US phoneNumber: '9999999999' postalCode: '96162' administrativeArea: CA street: Merchant Street merchantId: fildrop_vdcacpcaymannb subMerchant: id: ABCDE1234567890 requestId: '7364259685083551938920' parentTag: Auth-Bill-Retail-Framework example78: summary: 1. Auth Bill Install AFT MC sample-name: 1. Auth Bill Install AFT MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: processingInformation: capture: true authorizationOptions: aftIndicator: true commerceIndicator: install orderInformation: amountDetails: totalAmount: '1064.00' currency: USD surchargeAmount: '123456.78' surchargeSign: D billTo: address1: Auth_Bill_MC_Install_Street_AFT address2: Test Street 2 locality: Emerald City administrativeArea: MI postalCode: 48104-20 country: US firstName: Big lastName: Bird middleName: Middle email: null@cybersource.com phoneNumber: 999-999-9999 shipTo: address1: recipientAddress1 address2: recipientAddress2 locality: recipientAddress1_addres2 postalCode: 571216 country: GBR firstName: John lastName: Doe middleName: '' buildingNumber: 266 streetName: recipientSteet merchantInformation: merchantDescriptor: merchantName: aft_manmid_fit_US merchantRefNumber: CP09_AFT_3 paymentInformation: card: number: 5555555555554444 expirationMonth: 12 expirationYear: 2025 type: '002' clientReferenceInformation: code: 7.364259123003552e+21 recipientInformation: accountNumber: 98765432112377826427ABCDefgh1235wq accountType: 99 senderInformation: accountNumber: 1.5426476537657613e+33 address: testingaddresscharacterlength35char locality: testingcitycharacter25chr administrativeArea: ss country: GBR firstName: senderfirstname_senderfirstname_35C lastName: senderlastname_senderlastname@@_35D middleName: sendermiddlename_sendermiddlename35 name: testingname_name_testing_test1 identificationNumber: 12345678910111214000 referenceNumber: 1542647653765767 personalIdType: TXIN type: B deviceInformation: clientLibraryVersion: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 applicationInformation: application: ics_auth, ics_bill initiatorInformation: type: S parentTag: AFT-Framework example79: summary: 3. Auth Bill Retail Contactless VI sample-name: 3. Auth Bill Retail Contactless VI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: aggregatorId: '10046356' orderInformation: billTo: address1: Auth_Bill_Retail_Contactless_VI locality: TestCity country: US administrativeArea: CA postalCode: '00000' firstName: Raghu1cp lastName: Krishnan email: test@visa.com phoneNumber: '9999999999' amountDetails: totalAmount: '9850' currency: USD invoiceDetails: merchantDescriptor: name: Test Merchant locality: Test City contact: '9999999999' country: US phoneNumber: '9999999999' postalCode: '96162' administrativeArea: CA street: Merchant Street shipTo: firstName: John processingInformation: capture: true commerceIndicator: retail cardPresent: true posEntryMode: contactless terminalCapability: '4' categoryCode: '1' thirdPartyCertificationNumber: '12345700000' paymentInformation: card: number: '4761340000000019' expirationMonth: '12' expirationYear: '2025' securityCode: '123' type: '001' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' emv: cardSequenceNumber: '123' combinedTags: 5F2A02084082021C005009496E7465726C696E6B9F1C0831363032313133339F0607A00000000330105F300202205F3401018407A0000000033010950580000480009A031409039B0268009C01009F02060000000020009F03060000000000009F0902008C9F100706010A03A010009F120706010A03A010009F1A0208409F1E0831363032313133339F26089C402634428CF8739F2701809F3303E0F8C89F34030203009F3501229F360200049F37047118AE3E clientReferenceInformation: code: '7364259605883551938920' pointOfSaleInformation: entryMode: contactless trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' merchantInformation: merchantId: fildrop_vdcacpcaymannb merchantReferenceNumber: TC02_01 recipientInformation: name: John senderInformation: address: Sender Address locality: Sender City country: US id: ms_user deviceInformation: clientLibraryVersion: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 applicationInformation: application: ics_auth subMerchant: subMerchantId: ABCDE1234567890 parentTag: Auth-Bill-Retail-Framework example80: summary: 1. Auth Bill VBV VI sample-name: 1. Auth Bill VBV VI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: billTo: address1: Auth_Bill_VI_VBV_Street address2: Test Street 2 address3: Test Street 3 address4: null locality: TestCity country: US administrativeArea: CA postalCode: '96162' amountDetails: currency: USD totalAmount: '6846.22' invoiceDetails: invoiceNumber: TC01_01 merchantDescriptor: name: Test Merchant address: Merchant Street locality: Merchant City country: US administrativeArea: CA postalCode: '96162' phoneNumber: '9999999999' contact: '9999999999' shipTo: address1: 1295 Charleston Rd address2: Cube 2386 locality: Mountain View country: AE administrativeArea: CA postalCode: '94041' email: null2@cybersource.com firstName: Olivia lastName: White phoneNumber: 650-965-6000 recipientDetails: recipientName: Recipient Name senderInformation: address: Sender Address locality: Test city country: US id: ms_user name: John administrativeArea: CA clientReferenceInformation: code: TC01_01 paymentInformation: card: type: '001' expirationMonth: '12' expirationYear: '2040' number: '4183590332526103' securityCode: '123' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE xid: 12345678909876543210ABCDEabcdeABCDEF1234 ecommerceIndicator: vbv clientLibraryInformation: version: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 merchantInformation: merchantDescriptor: name: Test Merchant address: Merchant Street locality: Merchant City country: US administrativeArea: CA postalCode: '96162' phoneNumber: '9999999999' contact: '9999999999' merchantId: fildrop_vdc4 subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA processingInformation: captureDate: '0711' icsApplications: ics_auth, ics_bill capture: true buyerInformation: email: test@visa.com firstName: John lastName: Doe phoneNumber: '9999999999' parentTag: Auth-Bill-Card-Not-Present-Framework example81: summary: 1. Auth Bill Lodging MC sample-name: 1. Auth Bill Lodging MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: aggregatorId: '00000123456' subMerchant: administrativeArea: CA country: US email: test@visa.com id: ABCDE1234567890 name: fildrop_vdc4 postalCode: '96162' region: NE orderInformation: amountDetails: totalAmount: '10000.00' currency: USD billTo: address1: Auth_MC_Internet_Lodging_Duration_3 locality: TestCity administrativeArea: CA postalCode: '00000' country: US email: test@visa.com firstName: Raghu24cp lastName: Krishnan phoneNumber: '9999999999' invoiceDetails: merchantDescriptor: name: Test Merchant address1: Merchant Street locality: Test City administrativeArea: CA postalCode: '96162' country: US phoneNumber: '9999999999' purchaseTotals: currency: USD grandTotalAmount: '10000.00' card: expirationMonth: '12' expirationYear: '2040' number: '5480950023974102' cvNumber: '123' cardType: '002' shipTo: address1: 1295 Charleston Rd address2: Cube 2386 city: Mountain View country: AE email: test@cybersource.com firstName: Olivia lastName: White phoneNumber: 650-965-6000 state: CA postalCode: '94041' paymentInformation: card: number: '5480950023974102' expirationMonth: '12' expirationYear: '2040' securityCode: '123' merchantReferenceCode: TC03_02 clientLibrary: version: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 industryDatatype: lodging merchantInformation: merchantDescriptor: name: fildrop_vdc4 ecpInformation: indicator: internet consumerAuthenticationInformation: ucafAuthenticationData: jHeY+igABPs3jdwNaDg3MAACAAA= emvRequest: cardSequenceNumber: '1' combinedTags: 5F2A02084082021C005009496E7465726C696E6B9F1C0831363032313133339F0607A00000000330105F300202205F3401018407A0000000033010950580000480009A031409039B0268009C01009F02060000000020009F03060000000000009F0902008C9F100706010A03A010009F120706010A03A010009F1A0208409F1E0831363032313133339F26089C402634428CF8739F2701809F3303E0F8C89F34030203009F3501229F360200049F37047118AE3E salesOrganization: id: '45890500000' sender: id: ms_user terminalCapability: '1' trackData: '%B5100039901230025^TEST/CYBS ^4012121019761100 00868000000?;' icsApplications: - ics_auth duration: '3' captureDate: '0711' cardPresent: N catLevel: '1' requestId: '7364259493973551938920' parentTag: Auth-Bill-Lodging-Framework example82: summary: 1. Auth Bill Airline DC sample-name: 1. Auth Bill Airline DC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: travelInformation: transit: airline: legs: - arrivalTimeMeridian: P documentType: A customerCode: '1234567890' arrivalDate: '0711' carrierCode: '005' flightNumber: '123' class: C exchangeTicketNumber: '123456789012345' fareBasis: Y feeAmount: '50.00' orderInformation: amountDetails: totalAmount: '515' currency: USD billTo: address1: Auth_Bill_Airline_DC_Internet_Street address2: TestStreet2 city: TestCity country: US state: CA postalCode: '96162' firstName: FIVE6cnp lastName: test email: test@visa.com phoneNumber: '9999999999' invoiceDetails: merchantDescriptor: name: Test Merchant address1: Merchant Street locality: Test City administrativeArea: CA postalCode: '96162' country: US phoneNumber: '9999999999' shipTo: address1: 1295 Charleston Rd address2: Cube 2386 city: Mountain View country: AE state: CA postalCode: '94041' firstName: Olivia lastName: White email: null2@cybersource.com phoneNumber: 650-965-6000 card: number: '3643899996001600' expirationMonth: '12' expirationYear: '2040' cvNumber: '123' cardType: '005' present: Y cavv: ABCDEabcde12345678900987654321abcdeABCDE purchaseTotals: currency: USD grandTotalAmount: '515' paymentInformation: card: type: '005' expirationMonth: '12' expirationYear: '2040' number: '3643899996001600' securityCode: '123' icsApplications: ics_auth merchantID: fildrop_vdc4 merchantReferenceNumber: TC05_07 requestID: '7364259278873551938920' senderID: ms_user subMerchantID: ABCDE1234567890 userPO: USERPO1 trackData: '%B3643899996001600^TEST/CYBS ^231212101976110000868000000?;3643899996001600=20121210197611868000?' clientLibraryVersion: BellSoft/17.0.9/Linux/4.18.0-553.32.1.el8_10.x86_64/-/Java/5.3.4 duration: '1' ecommerceIndicator: internet emv: requestCombinedTags: 9F2607AB245F7DEE996C950445BCD4EF9F100706010A03A000009F5B0706010A03A000009C01EE9A032620129F33030A00CB9F1A0208409F370403A000AB9F36020002820256BF9F02065678341243829F6E04ABCDF06F9F2701AB9F340356BF679F090200349F4104000000039F0702ABC09F061110010A03A00008010A03A00008010A03A0911110010A03A00008010A03010A03A0000801 parentTag: Auth-Bill-Airline-Framework example83: summary: 2. Auth Bill DC Moto sample-name: 2. Auth Bill DC Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '183' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DC_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_115 paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example84: summary: 1. Pin Debit MC Retail Contact sample-name: 1. Pin Debit MC Retail Contact batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: paymentInformation: card: expirationYear: '2025' orderInformation: amountDetails: totalAmount: '320.00' currency: USD billTo: address1: Pin_Debit_MC_Retail_Contact clientReferenceInformation: code: '33557799' pointOfSaleInformation: cardPresent: Y terminalCapability: '1' encryptedKeySerialNumber: FFFF1B1D140000000005 catLevel: '1' entryMode: contact encryptedPin: 52F20658C04DB351 trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 processingInformation: commerceIndicator: retail capture: true parentTag: Pin-Debit-Framework example85: summary: 1. Auth Bill Internet VI Purchase Level 3 sample-name: 1. Auth Bill Internet VI Purchase Level 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: processingInformation: purchaseLevel: '3' commerceIndicator: internet capture: true orderInformation: amountDetails: totalAmount: '400' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Internet_VI_Purchase_Level_3_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC04_01 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC parentTag: Level-2-Level3-Framework example86: summary: 2. Auth AX Internet Lodging sample-name: 2. Auth AX Internet Lodging batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.03' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_AX_Internet_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B377678000174340^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC03_03 travelInformation: duration: '3' paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging commerceIndicator: internet capture: true parentTag: Auth-Bill-Lodging-Framework example87: summary: 2. Auth Bill Airline AX Internet sample-name: 2. Auth Bill Airline AX Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '500' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: FIVE4cnp postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Airline_AX_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View invoiceDetails: purchaseOrderNumber: USERPO1 installmentInformation: sequence: '10' frequency: B aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC05_05 travelInformation: transit: airline: ticketIssuer: address: issuer address duration: '1' paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true pointOfSaleInformation: cardPresent: N parentTag: Auth-Bill-Airline-Framework example88: summary: 3. Auth Bill Airline DI sample-name: 3. Auth Bill Airline DI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '503' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: FIVE5cnp postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Airline_DI_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View invoiceDetails: purchaseOrderNumber: USERPO1 installmentInformation: sequence: '10' frequency: B aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC05_06 travelInformation: transit: airline: ticketIssuer: address: issuer address duration: '1' paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true pointOfSaleInformation: cardPresent: N parentTag: Auth-Bill-Airline-Framework example89: summary: 4. Auth Bill Airline VI sample-name: 4. Auth Bill Airline VI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '500' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: FIVE1cnp postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Airline_VI_VBV_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View invoiceDetails: purchaseOrderNumber: USERPO1 installmentInformation: sequence: '10' frequency: B aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC05_01 travelInformation: transit: airline: ticketIssuer: address: issuer address duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590114593107' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: vbv capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE pointOfSaleInformation: cardPresent: N parentTag: Auth-Bill-Airline-Framework example90: summary: 5. Auth Bill Airline MC sample-name: 5. Auth Bill Airline MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.01' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: FIVE2cnp postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Airline_MC_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View invoiceDetails: purchaseOrderNumber: USERPO1 installmentInformation: sequence: '10' frequency: B aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC05_04 travelInformation: transit: airline: ticketIssuer: address: issuer address duration: '1' paymentInformation: card: type: '002' expirationYear: '2040' number: '5480950023974102' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true merchantInformation: salesOrganizationId: '45890500000' pointOfSaleInformation: cardPresent: N parentTag: Auth-Bill-Airline-Framework example91: summary: 6. Auth Bill Airline JC sample-name: 6. Auth Bill Airline JC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '515' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: FIVE3cnp postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Airline_JC_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View invoiceDetails: purchaseOrderNumber: USERPO1 aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC05_02 travelInformation: transit: airline: ticketIssuer: address: issuer address duration: '1' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true pointOfSaleInformation: cardPresent: Y parentTag: Auth-Bill-Airline-Framework example92: summary: 3. Auth Bill AX AESK sample-name: 3. Auth Bill AX AESK batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_AX_AESK_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_04 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' processingInformation: commerceIndicator: aesk capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example93: summary: 4. Auth Bill AX Install sample-name: 4. Auth Bill AX Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_AX_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_10 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' processingInformation: commerceIndicator: install capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example94: summary: 5. Auth Bill AX Internet sample-name: 5. Auth Bill AX Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9024.3' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_AX_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_16 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' processingInformation: commerceIndicator: internet capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example95: summary: 6. Auth Bill AX Moto sample-name: 6. Auth Bill AX Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '186' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_AX_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_118 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' processingInformation: commerceIndicator: moto capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example96: summary: 7. Auth Bill AX Recurring sample-name: 7. Auth Bill AX Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_AX_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_112 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example97: summary: 8. Auth Bill DC Install sample-name: 8. Auth Bill DC Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '146' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DC_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_09 paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example98: summary: 9. Auth Bill DC Internet sample-name: 9. Auth Bill DC Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9024.3' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DC_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_15 paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example99: summary: 10. Auth Bill DC PB sample-name: 10. Auth Bill DC PB batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DC_PB_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_03 paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: pb capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example100: summary: 11. Auth Bill DC Recurring sample-name: 11. Auth Bill DC Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DC_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_109 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example101: summary: 12. Auth Bill DI DIPB sample-name: 12. Auth Bill DI DIPB batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DI_DIPB_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_06 paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: dipb capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example102: summary: 13. Auth Bill DI Install sample-name: 13. Auth Bill DI Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '146' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DI_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_12 paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example103: summary: 14. Auth Bill DI Internet sample-name: 14. Auth Bill DI Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9024.3' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DI_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_18 paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example104: summary: 15. Auth Bill DI Moto sample-name: 15. Auth Bill DI Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '185' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DI_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_117 paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example105: summary: 16. Auth Bill DI Recurring sample-name: 16. Auth Bill DI Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_DI_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_111 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example106: summary: 1. Auth Bill DC DCC sample-name: 1. Auth Bill DC DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '260.01' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Install_DC_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: 020000000005999 clientReferenceInformation: code: TC01_D17 paymentInformation: card: type: '005' expirationYear: '2040' number: '36070500001012' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-DCC-Framework example107: summary: 2. Auth Bill JC DCC sample-name: 2. Auth Bill JC DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '260.01' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Install_JC_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: 020000000005999 aggregatorId: '10046356' clientReferenceInformation: code: TC01_D14 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-DCC-Framework example108: summary: 3. Auth Bill MC DCC sample-name: 3. Auth Bill MC DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '116.4344' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Install_MC_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: 020000000005999 aggregatorId: '00000123456' clientReferenceInformation: code: TC01_D12 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-DCC-Framework example109: summary: 4. Auth Bill VI DCC sample-name: 4. Auth Bill VI DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '116.4344' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Install_VI_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: '555555555555555' aggregatorId: '10046356' clientReferenceInformation: code: TC01_D11 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-DCC-Framework example110: summary: 2. Auth Bill MC Purchase Level 2 sample-name: 2. Auth Bill MC Purchase Level 2 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.02' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Internet_MC_Purchase_Level_2_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC04_02 travelInformation: duration: '1' paymentInformation: card: type: '002' expirationYear: '2040' number: '5100039901230025' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC salesOrganizationId: '45890500000' processingInformation: commerceIndicator: internet capture: true parentTag: Level-2-Level3-Framework example111: summary: 3. Auth Bill MC Purchase Level 3 sample-name: 3. Auth Bill MC Purchase Level 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: processingInformation: purchaseLevel: '3' commerceIndicator: internet capture: true orderInformation: amountDetails: totalAmount: '401' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Internet_MC_Purchase_Level_3_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC04_02 travelInformation: duration: '1' paymentInformation: card: type: '002' expirationYear: '2040' number: '5100039901230025' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC salesOrganizationId: '45890500000' parentTag: Level-2-Level3-Framework example112: summary: 4. Auth Bill VI Purchase Level 2 sample-name: 4. Auth Bill VI Purchase Level 2 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '400' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Internet_VI_Purchase_Level_2_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC04_01 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC processingInformation: commerceIndicator: internet capture: true parentTag: Level-2-Level3-Framework example113: summary: 17. Auth Bill JC Install sample-name: 17. Auth Bill JC Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '146' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '10046356' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_11 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example114: summary: 18. Auth Bill JC Internet sample-name: 18. Auth Bill JC Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9024.3' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '10046356' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_17 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example115: summary: 19. Auth Bill JC JS sample-name: 19. Auth Bill JC JS batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_JS_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '10046356' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_05 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: js capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example116: summary: 20. Auth Bill JC Moto sample-name: 20. Auth Bill JC Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '184' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_116 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example117: summary: 21. Auth Bill JC Recurring sample-name: 21. Auth Bill JC Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_110 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example118: summary: 22. Auth Bill JC Recurring Internet sample-name: 22. Auth Bill JC Recurring Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_JC_Recurring_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_104 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example119: summary: 23. Auth Bill MC Install sample-name: 23. Auth Bill MC Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '146' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_08 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true parentTag: Auth-Bill-Card-Not-Present-Framework example120: summary: 2. Auth Bill MC CIT Auth Reason 7 sample-name: 2. Auth Bill MC CIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Install_CIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example121: summary: 3. Auth Bill MC CIT Auth Reason 9 sample-name: 3. Auth Bill MC CIT Auth Reason 9 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Install_Internet_CIT_Auth_Reason_9_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example122: summary: 4. Auth Bill MC MIT Auth Reason Blank sample-name: 4. Auth Bill MC MIT Auth Reason Blank batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Install_Internet_MIT_Auth_Reason_Blank_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: install pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example123: summary: 5. Auth Bill MC MIT Auth Reason 8 sample-name: 5. Auth Bill MC MIT Auth Reason 8 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Install_MIT_Auth_Reason_8_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: install pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example124: summary: 24. Auth Bill MC Internet sample-name: 24. Auth Bill MC Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.06' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_14 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: internet parentTag: Auth-Bill-Card-Not-Present-Framework example125: summary: 6. Auth Bill MC Internet CIT Auth Reason Blank sample-name: 6. Auth Bill MC Internet CIT Auth Reason Blank batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.07' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_MC_Internet_CIT_Auth_Reason_Blank_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: internet pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example126: summary: 25. Auth Bill MC Moto sample-name: 25. Auth Bill MC Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.08' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_113 paymentInformation: card: type: '002' expirationYear: '2040' number: '5100039901230025' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: moto parentTag: Auth-Bill-Card-Not-Present-Framework example127: summary: 26. Auth Bill MC Recurring sample-name: 26. Auth Bill MC Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD totalAmount: '10000.09' clientReferenceInformation: code: TC01_108 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '002' expirationYear: '2040' number: '5480950023974102' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring parentTag: Auth-Bill-Card-Not-Present-Framework example128: summary: 7. Auth Bill MC Recurring CIT Auth Reason 7 sample-name: 7. Auth Bill MC Recurring CIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.10' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Recurring_CIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example129: summary: 27. Auth Bill MC Recurring Internet sample-name: 27. Auth Bill MC Recurring Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Recurring_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD totalAmount: '604.00' clientReferenceInformation: code: TC01_102 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '002' expirationYear: '2040' number: '5480950023974102' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring parentTag: Auth-Bill-Card-Not-Present-Framework example130: summary: 8. Auth Bill MC Recurring CIT Auth Reason 8 sample-name: 8. Auth Bill MC Recurring CIT Auth Reason 8 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Recurring_Internet_CIT_Auth_Reason_8_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example131: summary: 9. Auth Bill MC Recurring MIT Auth Reason 7 sample-name: 9. Auth Bill MC Recurring MIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Recurring_Internet_MIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: recurring pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example132: summary: 10. Auth Bill MC Recurring MIT Auth Reason 9 sample-name: 10. Auth Bill MC Recurring MIT Auth Reason 9 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MC_Recurring_MIT_Auth_Reason_9_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: recurring pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example133: summary: 1. Auth Bill MC Retail Transit sample-name: 1. Auth Bill MC Retail Transit batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu2cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_Bill_MC_Retail_Transit pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B5100039901230025^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y emv: cardSequenceNumber: '123' clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_02 processingInformation: capture: true authorizationOptions: transportationMode: '01' debtRecoveryIndicator: Y industryDataType: transit commerceIndicator: retail aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' paymentInformation: card: type: '002' merchantInformation: salesOrganizationId: '45890500000' parentTag: Auth-Bill-Card-Present-Framework example134: summary: 2. Auth Bill MC Retail AFT sample-name: 2. Auth Bill MC Retail AFT batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '1064.00' surcharge: amount: '123456.78' currency: USD billTo: email: null@cybersource.com lastName: Bird country: US firstName: Big postalCode: 48104-20 phoneNumber: 999-999-9999 locality: Emerald City administrativeArea: MI address2: Test Street 2 address1: Auth_Bill_MC_Retail_Street_AFT senderInformation: referenceNumber: '1542647653765767' locality: testingcitycharacter25chr personalIdType: TXIN name: testingname_name_testing_test1 address1: testingaddresscharacterlength35char firstName: senderfirstname_senderfirstname_35C middleName: sendermiddlename_sendermiddlename35 administrativeArea: ss account: number: '1542647653765761265716526751761287' type: B countryCode: GBR identificationNumber: '12345678910111213223' lastName: senderlastname_senderlastname@@_35D recipientInformation: lastName: recipientlastnmerecipientlastname35 locality: recipientAddress1_addres2 accountId: 98765432112377826427ABCDefgh1235wq middleName: recipientmiddlename_recipientmid345 country: GBR postalCode: '571216' firstName: recipientfirstnm_recipientfirstname pointOfSaleInformation: trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contact cardPresent: Y clientReferenceInformation: code: CP09_AFT_3 paymentInformation: card: type: '002' expirationYear: '2025' number: '5555555555554444' expirationMonth: '12' processingInformation: capture: true commerceIndicator: retail authorizationOptions: aftIndicator: y parentTag: AFT-Framework example135: summary: 2. Auth Bill MC Spa sample-name: 2. Auth Bill MC Spa batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Spa_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_02 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: spa consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: MASTERCARD ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: Auth-Bill-Card-Present-Framework example136: summary: 11. Auth Bill MC Spa CIT Auth Reason Blank sample-name: 11. Auth Bill MC Spa CIT Auth Reason Blank batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '100.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_MC_Spa_CIT_Auth_Reason_Blank_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: spa pointOfSaleInformation: cardPresent: N parentTag: CIT-MIT Framework example137: summary: 1. Auth Bill MC Wallet 103 sample-name: 1. Auth Bill MC Wallet 103 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '100' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Wallet_103_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_118 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' tokenizedCard: transactionType: '1' number: '5188690467086204' consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= ucafCollectionIndicator: '2' processingInformation: capture: true commerceIndicator: spa walletType: '103' parentTag: Auth-Bill-Wallet example138: summary: 2. Auth Bill MC Wallet 116 sample-name: 2. Auth Bill MC Wallet 116 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '100' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Wallet_116_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_118 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' tokenizedCard: transactionType: '1' number: '5188690467086204' consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= ucafCollectionIndicator: '2' processingInformation: capture: true commerceIndicator: spa walletType: '116' parentTag: Auth-Bill-Wallet example139: summary: 3. Auth Bill MC Wallet VCIND sample-name: 3. Auth Bill MC Wallet VCIND batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '100' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_MC_Wallet_VCIND_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_118 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' tokenizedCard: transactionType: '1' number: '5188690467086204' consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= ucafCollectionIndicator: '2' processingInformation: commerceIndicator: spa walletType: VCIND capture: true parentTag: Auth-Bill-Wallet example140: summary: 5. Auth Bill Moto DC Additional Data sample-name: 5. Auth Bill Moto DC Additional Data batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.04' nationalTaxIncluded: '1' currency: USD billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Moto_DC_Additional_Data_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: purchaseOrderNumber: USERPO1 pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC08_09 travelInformation: duration: '1' paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: moto parentTag: Level-2-Level3-Framework example141: summary: 6. Auth Bill Moto AX Additional Data sample-name: 6. Auth Bill Moto AX Additional Data batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '800' nationalTaxIncluded: '1' currency: USD billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Moto_AX_Additional_Data_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: purchaseOrderNumber: USERPO1 pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC08_07 travelInformation: duration: '1' paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true parentTag: Level-2-Level3-Framework example142: summary: 7. Auth Bill Moto DI Additional Data sample-name: 7. Auth Bill Moto DI Additional Data batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '10000.05' nationalTaxIncluded: '1' currency: USD billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Moto_DI_Additional_Data_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: purchaseOrderNumber: USERPO1 pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC08_08 travelInformation: duration: '1' paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true parentTag: Level-2-Level3-Framework example143: summary: 8. Auth Bill Moto JC Additional Data sample-name: 8. Auth Bill Moto JC Additional Data batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '805' nationalTaxIncluded: '1' currency: USD billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Moto_JC_Additional_Data_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: purchaseOrderNumber: USERPO1 pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC08_06 travelInformation: duration: '1' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true parentTag: Level-2-Level3-Framework example145: summary: 9. Auth Bill Moto VI Additional Data sample-name: 9. Auth Bill Moto VI Additional Data batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '800' nationalTaxIncluded: '1' currency: USD billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Moto_VI_Additional_Data_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: purchaseOrderNumber: USERPO1 pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC08_01 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true parentTag: Level-2-Level3-Framework example146: summary: 12. Auth Bill MZ Install CIT Auth Reason 7 sample-name: 12. Auth Bill MZ Install CIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Install_Internet_CIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example147: summary: 13. Auth Bill MZ CIT Auth Reason 9 sample-name: 13. Auth Bill MZ Internet CIT Auth Reason 9 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Install_Internet_Internet_CIT_Auth_Reason_9_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example148: summary: 14. Auth Bill MZ MIT Auth Reason Blank sample-name: 14. Auth Bill MZ MIT Auth Reason Blank batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Install_Internet_MIT_Auth_Reason_Blank_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: install pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example149: summary: 15. Auth Bill MZ Install MIT Auth Reason 8 sample-name: 15. Auth Bill MZ Install MIT Auth Reason 8 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Install_MIT_Auth_Reason_8_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: install pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example150: summary: 16. Auth Bill MZ Recurring CIT Auth Reason 7 sample-name: 16. Auth Bill MZ Recurring CIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Recurring_CIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example151: summary: 17. Auth Bill MZ Recurring Internet CIT Auth Reason 8 sample-name: 17. Auth Bill MZ Recurring Internet CIT Auth Reason 8 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Recurring_Internet_CIT_Auth_Reason_8_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: recurring pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example152: summary: 18. Auth Bill MZ Recurring Internet MIT Auth Reason 7 sample-name: 18. Auth Bill MZ Recurring Internet MIT Auth Reason 7 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Recurring_Internet_MIT_Auth_Reason_7_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: recurring pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example153: summary: 19. Auth Bill MZ Recurring MIT Auth Reason 9 sample-name: 19. Auth Bill MZ Recurring MIT Auth Reason 9 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90.00' currency: EGP billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_MZ_Recurring_MIT_Auth_Reason_9_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View installmentInformation: sequence: '1' frequency: M aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC01_01 travelInformation: duration: '3' paymentInformation: card: type: '067' expirationYear: '2040' number: '6250947000000014' expirationMonth: '12' securityCode: '123' processingInformation: capture: true authorizationOptions: initiator: type: Y commerceIndicator: recurring pointOfSaleInformation: cardPresent: N consumerAuthenticationInformation: cavv: jHeY+igABPs3jdwNaDg3MAACAAA= authenticationBrand: Meeza ucafCollectionIndicator: '2' ucafAuthenticationData: test parentTag: CIT-MIT Framework example154: summary: 3. Auth Bill Retail Contact AX sample-name: 3. Auth Bill Retail Contact AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu12cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Contact_AX pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contact cardPresent: Y emv: cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_12 aggregatorInformation: subMerchant: id: ABCDE1234567890 paymentInformation: card: type: '003' processingInformation: capture: true commerceIndicator: retail consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Present-Framework example155: summary: 4. Auth Bill Retail Contactless AX sample-name: 4. Auth Bill Retail Contactless AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu6cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Contactless_AX pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y emv: cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_06 aggregatorInformation: subMerchant: id: ABCDE1234567890 processingInformation: capture: true commerceIndicator: retail consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Present-Framework example156: summary: 5. Auth Bill Retail Contactless Tap To Phone MC sample-name: 5. Auth Bill Retail Contactless Tap To Phone MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu2cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Contactless_TapPhone_MC pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B5100039901230025^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y emv: cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City salesOrganizationId: '45890500000' senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_02 aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' paymentInformation: tokenizedCard: requestorId: '12345678901' transactionType: '1' card: type: '002' processingInformation: capture: true commerceIndicator: retail parentTag: Auth-Bill-Card-Present-Framework example157: summary: 10. Auth Bill Retail Contactless VI Level2 sample-name: 10. Auth Bill Retail Contactless VI Level2 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '600' taxAppliedLevel: '3' discountAmount: '4.65' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: TEST country: US firstName: SIX1cp postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_Retail_Contactless_VI_Level2 shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City cardAcceptorReferenceNumber: ABC12PC senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC06_01 paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Level-2-Level3-Framework example158: summary: 6. Auth Bill Retail Keyed AX sample-name: 6. Auth Bill Retail Keyed AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu24cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Keyed_AX pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: keyed cardPresent: Y emv: cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_24 aggregatorInformation: subMerchant: id: ABCDE1234567890 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Present-Framework example159: summary: 1. Auth Bill Retail MC DCC sample-name: 1. Auth Bill Retail MC DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '116.4344' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: DCCUSD1 postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Retail_MC_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: 020000000005999 aggregatorId: '00000123456' clientReferenceInformation: code: TC01_D12 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: retail paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: DCC-Framework example160: summary: 11. Auth Bill Retail MC Purchase Level 3 sample-name: 11. Auth Bill Retail MC Purchase Level 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '401' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Retail_MC_Purchase_Level_3_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC04_02 travelInformation: duration: '1' paymentInformation: card: type: '002' expirationYear: '2040' number: '5100039901230025' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC salesOrganizationId: '45890500000' processingInformation: commerceIndicator: retail capture: true parentTag: Level-2-Level3-Framework example161: summary: 7. Auth Bill Retail Swiped AX sample-name: 7. Auth Bill Retail Swiped AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu18cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_AX pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B372425119311008^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y emv: cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_18 aggregatorInformation: subMerchant: id: ABCDE1234567890 paymentInformation: card: type: '003' processingInformation: commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Present-Framework example162: summary: 1. Auth Bill Retail Swiped AX Auto Rental sample-name: 1. Auth Bill Retail Swiped AX Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW06cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_AX_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 entryMode: contact cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC50000_6 travelInformation: duration: '1' paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auto-Rental-Framework example163: summary: 2. Auth Bill Retail Swiped DC Auto Rental sample-name: 2. Auth Bill Retail Swiped DC Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW03cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_DC_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC50000_3 travelInformation: duration: '1' paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auto-Rental-Framework example164: summary: 3. Auth Bill Retail Swiped DI Auto Rental sample-name: 3. Auth Bill Retail Swiped DI Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW04cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_DI_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC50000_4 travelInformation: duration: '1' paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auto-Rental-Framework example165: summary: 8. Auth Bill Retail Swiped Fallback MC sample-name: 8. Auth Bill Retail Swiped Fallback MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu14cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_Fallback_MC pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B5100039901230025^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y emv: fallback: Y fallbackCondition: '1' cardSequenceNumber: '123' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City salesOrganizationId: '45890500000' senderInformation: locality: Sender City address1: Sender Address countryCode: US clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_14 aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' paymentInformation: card: type: '002' processingInformation: commerceIndicator: retail capture: true parentTag: Auth-Bill-Card-Present-Framework example166: summary: 4. Auth Bill Retail Swiped JC Auto Rental sample-name: 4. Auth Bill Retail Swiped JC Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW05cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address1: Auth_Bill_Retail_Swiped_JC_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC50000_5 travelInformation: duration: '1' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auto-Rental-Framework example167: summary: 5. Auth Bill Retail Swiped MC Auto Rental sample-name: 5. Auth Bill Retail Swiped MC Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW02cp postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_Retail_Swiped_MC_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City salesOrganizationId: '45890500000' senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC50000_2 travelInformation: duration: '1' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true parentTag: Auto-Rental-Framework example168: summary: 6. Auth Bill Retail Swiped VI Auto Rental sample-name: 6. Auth Bill Retail Swiped VI Auto Rental batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '102' currency: USD billTo: email: test@visa.com lastName: test country: US firstName: ONECSW01cp postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address1: Auth_Bill_Retail_Swiped_VI_Auto_Rental pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: swiped cardPresent: Y merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Test City senderInformation: locality: Sender City address1: Sender Address countryCode: US aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC50000_1 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: auto_rental commerceIndicator: retail capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auto-Rental-Framework example169: summary: 2. Auth Bill Retail VI DCC sample-name: 2. Auth Bill Retail VI DCC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '17581' originalCurrency: USD originalAmount: '151' exchangeRate: '116.4344' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '00000' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Retail_VI_DCC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountdetails: currencyConversion: indicator: '1' pointOfSaleInformation: emv: cardholderVerificationMethodUsed: '2' cardSequenceNumber: '123' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y installmentInformation: sequence: '2' frequency: B aggregatorInformation: subMerchant: id: '555555555555555' aggregatorId: '10046356' clientReferenceInformation: code: TC01_D11 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: retail paymentSolution: mpos capture: true merchantInformation: salesOrganizationId: '45890500000' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: DCC-Framework example170: summary: 12. Auth Bill Retail VI Purchase Level 2 sample-name: 12. Auth Bill Retail VI Purchase Level 2 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '400' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Retail_VI_Purchase_Level_2_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC04_01 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC processingInformation: commerceIndicator: retail capture: true parentTag: Level-2-Level3-Framework example171: summary: 13. Auth Bill Retail VI Purchase Level 3 sample-name: 13. Auth Bill Retail VI Purchase Level 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: processingInformation: purchaseLevel: '3' commerceIndicator: retail capture: true orderInformation: amountDetails: totalAmount: '400' taxAppliedLevel: '3' discountAmount: '4.65' freightAmount: '5.85' dutyAmount: '12.11' nationalTaxIncluded: '1' currency: USD taxAppliedAfterDiscount: '0' taxDetails[]: rate: '12.5' billTo: email: test@visa.com lastName: Smith country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: TestStreet2 address1: Auth_Bill_Retail_VI_Purchase_Level_3_Street shippingDetails: shipFromPostalCode: 94404-5674 invoiceDetails: vatInvoiceReferenceNumber: EDFGFd54 purchaseOrderNumber: USERPO1 purchaseOrderDate: '140330' commodityCode: aBBa purchaseContactName: TestContact! order: orderDiscountAmountSign: positive vatTaxAmountSign: positive pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC04_01 travelInformation: duration: '1' paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' merchantInformation: cardAcceptorReferenceNumber: ABC12#PC parentTag: Level-2-Level3-Framework example172: summary: 28. Auth Bill VI Install sample-name: 28. Auth Bill VI Install batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '90' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_Install_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US installmentInformation: sequence: '1' planId: '1' frequency: M identifier: '1' planType: '1' clientReferenceInformation: code: TC01_07 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: install capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example173: summary: 3. Auth Bill VI Install AFT sample-name: 3. Auth Bill VI Install AFT batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '1064.00' surcharge: amount: '123456.78' currency: USD billTo: email: null@cybersource.com lastName: Bird country: US firstName: Big postalCode: 48104-20 phoneNumber: 999-999-9999 locality: Emerald City administrativeArea: MI address2: Test Street 2 address1: Auth_Bill_VI_Install_Street_AFT senderInformation: referenceNumber: '1542647653765767' locality: testingcitycharacter25chr personalIdType: TXIN name: testingname_name_testing_test1 address1: testingaddresscharacterlength35char firstName: senderfirstname_senderfirstname_35C middleName: sendermiddlename_sendermiddlename35 administrativeArea: ss account: number: '1542647653765761265716526751761287' type: B countryCode: GBR identificationNumber: '12345678910111213223' lastName: senderlastname_senderlastname@@_35D recipientInformation: lastName: recipientlastnmerecipientlastname35 locality: recipientAddress1_addres2 accountId: 98765432112377826427ABCDefgh1235wq middleName: recipientmiddlename_recipientmid345 country: GBR postalCode: '571216' firstName: recipientfirstnm_recipientfirstname clientReferenceInformation: code: CP09_AFT_1 paymentInformation: card: type: '001' expirationYear: '2025' number: '4111111111111111' expirationMonth: '12' processingInformation: commerceIndicator: install capture: true authorizationOptions: aftIndicator: y parentTag: AFT-Framework example174: summary: 29. Auth Bill VI Internet sample-name: 29. Auth Bill VI Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9024.3' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_13 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: internet capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example175: summary: 30. Auth Bill VI Moto sample-name: 30. Auth Bill VI Moto batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '182' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_Moto_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_114 paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: moto capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example176: summary: 31. Auth Bill VI Recurring sample-name: 31. Auth Bill VI Recurring batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_Recurring_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_107 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example177: summary: 32. Auth Bill VI Recurring Internet sample-name: 32. Auth Bill VI Recurring Internet batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US orderInformation: billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_Recurring_Internet_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View amountDetails: currency: USD clientReferenceInformation: code: TC01_101 recurringPaymentInformation: numberOfPayments: '4' paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: commerceIndicator: recurring capture: true consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example178: summary: 9. Auth Bill VI Retail Transit sample-name: 9. Auth Bill VI Retail Transit batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '9850' currency: USD billTo: email: test@visa.com lastName: Krishnan country: US firstName: Raghu1cp postalCode: '00000' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_Bill_VI_Retail_Transit pointOfSaleInformation: terminalCapability: '4' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' entryMode: contactless cardPresent: Y emv: cardSequenceNumber: '123' clientReferenceInformation: partner: thirdPartyCertificationNumber: '1.23457E+11' code: TC02_01 processingInformation: capture: true authorizationOptions: transportationMode: '01' debtRecoveryIndicator: Y industryDataType: transit commerceIndicator: retail aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' paymentInformation: card: type: '001' merchantInformation: salesOrganizationId: '45890500000' parentTag: Auth-Bill-Card-Present-Framework example179: summary: 4. Auth Bill VI Retail AFT sample-name: 4. Auth Bill VI Retail AFT batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '1064.00' surcharge: amount: '123456.78' currency: USD billTo: email: null@cybersource.com lastName: Bird country: US firstName: Big postalCode: 48104-20 phoneNumber: 999-999-9999 locality: Emerald City administrativeArea: MI address2: Test Street 2 address1: Auth_Bill_VI_Retail_Street_AFT senderInformation: referenceNumber: '1542647653765767' locality: testingcitycharacter25chr personalIdType: TXIN name: testingname_name_testing_test1 address1: testingaddresscharacterlength35char firstName: senderfirstname_senderfirstname_35C middleName: sendermiddlename_sendermiddlename35 administrativeArea: ss account: number: '1542647653765761265716526751761287' type: B countryCode: GBR identificationNumber: '12345678910111213223' lastName: senderlastname_senderlastname@@_35D recipientInformation: lastName: recipientlastnmerecipientlastname35 locality: recipientAddress1_addres2 accountId: 98765432112377826427ABCDefgh1235wq middleName: recipientmiddlename_recipientmid345 country: GBR postalCode: '571216' firstName: recipientfirstnm_recipientfirstname pointOfSaleInformation: entryMode: contact cardPresent: Y trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 clientReferenceInformation: code: CP09_AFT_1 paymentInformation: card: type: '001' expirationYear: '2025' number: '4111111111111111' expirationMonth: '12' processingInformation: commerceIndicator: retail capture: true authorizationOptions: aftIndicator: y parentTag: AFT-Framework example180: summary: 33. Auth Bill VI VBV sample-name: 33. Auth Bill VI VBV batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Auth_Bill_VI_VBV_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US clientReferenceInformation: code: TC01_01 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' processingInformation: capture: true commerceIndicator: vbv consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: Auth-Bill-Card-Not-Present-Framework example181: summary: 3. Auth DC Internet Lodging Duration 3 sample-name: 3. Auth DC Internet Lodging Duration 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '300' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_DC_Internet_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B3643899996001600^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC03_05 travelInformation: duration: '3' paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: internet parentTag: Auth-Bill-Lodging-Framework example182: summary: 4. Auth DI Internet Lodging Duration 3 sample-name: 4. Auth DI Internet Lodging Duration 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '300' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_DI_Internet_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B6011111111111117^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC03_04 travelInformation: duration: '3' paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: internet parentTag: Auth-Bill-Lodging-Framework example183: summary: 5. Auth JC Internet Lodging Duration 3 sample-name: 5. Auth JC Internet Lodging Duration 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '300' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_JC_Internet_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B3562330041073110^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 clientReferenceInformation: code: TC03_06 travelInformation: duration: '3' paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: internet parentTag: Auth-Bill-Lodging-Framework example184: summary: 6. Auth MC Internet Lodging Duration 3 sample-name: 6. Auth MC Internet Lodging Duration 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '301' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_MC_Internet_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B5100039901230025^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC03_02 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5480950023974102' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: internet merchantInformation: salesOrganizationId: '45890500000' parentTag: Auth-Bill-Lodging-Framework example185: summary: 34. Auth MC SPA Split Shipment sample-name: 34. Auth MC SPA Split Shipment batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '250.00' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_MC_SPA_Split_Shipment_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' cardPresent: N aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '00000123456' clientReferenceInformation: code: TC01_02 travelInformation: duration: '3' paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: spa merchantInformation: salesOrganizationId: '45890500000' parentTag: Auth-Bill-Card-Not-Present-Framework example186: summary: 7. Auth VI Retail Lodging Duration 3 sample-name: 7. Auth VI Retail Lodging Duration 3 batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '300' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' locality: TestCity phoneNumber: '9999999999' administrativeArea: CA address2: TestStreet 2 address1: Auth_VI_Retail_Lodging_Duration_3_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View pointOfSaleInformation: terminalCapability: '1' catLevel: '1' trackData: '%B4761340000000019^TEST/CYBS ^4012121019761100 00868000000?;' cardPresent: N emv: cardSequenceNumber: '1' aggregatorInformation: subMerchant: id: ABCDE1234567890 aggregatorId: '10046356' clientReferenceInformation: code: TC03_01 travelInformation: duration: '3' paymentInformation: card: type: '001' expirationYear: '2040' number: '4761340000000019' expirationMonth: '12' securityCode: '123' processingInformation: industryDataType: lodging capture: true commerceIndicator: internet parentTag: Auth-Bill-Lodging-Framework example193: summary: 1. Stand Alone Credit AX sample-name: 1. Stand Alone Credit AX batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_AX_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' clientReferenceInformation: code: TC01_04 paymentInformation: card: type: '003' expirationYear: '2040' number: '377671320002630' expirationMonth: '12' securityCode: '1234' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: StandAlone-Credit-Framework example194: summary: 2. Stand Alone Credit DC sample-name: 2. Stand Alone Credit DC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_DC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' commerceIndicator: internet clientReferenceInformation: code: TC01_03 paymentInformation: card: type: '005' expirationYear: '2040' number: '3643899996001600' expirationMonth: '12' securityCode: '123' parentTag: StandAlone-Credit-Framework example195: summary: 3. Stand Alone Credit JC sample-name: 3. Stand Alone Credit JC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_JC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '10046356' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' clientReferenceInformation: code: TC01_05 paymentInformation: card: type: '007' expirationYear: '2040' number: '3562330041073110' expirationMonth: '12' securityCode: '123' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: StandAlone-Credit-Framework example196: summary: 4. Stand Alone Credit MC sample-name: 4. Stand Alone Credit MC batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_MC_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA aggregatorId: '00000123456' merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street salesOrganizationId: '45890500000' senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' clientReferenceInformation: code: TC01_02 paymentInformation: card: type: '002' expirationYear: '2040' number: '5188690467086204' expirationMonth: '12' securityCode: '123' parentTag: StandAlone-Credit-Framework example197: summary: 5. Stand Alone Credit VI sample-name: 5. Stand Alone Credit VI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_VI_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' clientReferenceInformation: code: TC01_01 paymentInformation: card: type: '001' expirationYear: '2040' number: '4183590332526103' expirationMonth: '12' securityCode: '123' consumerAuthenticationInformation: cavv: ABCDEabcde12345678900987654321abcdeABCDE parentTag: StandAlone-Credit-Framework example198: summary: 6. Stand Alone Credit DI sample-name: 6. Stand Alone Credit DI batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: orderInformation: amountDetails: totalAmount: '6846.22' currency: USD billTo: email: test@visa.com lastName: Doe country: US firstName: John postalCode: '96162' phoneNumber: '9999999999' locality: TestCity administrativeArea: CA address2: Test Street 2 address3: Test Street 3 address1: Stand_Alone_Credit_DI_Street shipTo: postalCode: '94041' address2: Cube 2386 address1: 1295 Charleston Rd firstName: Olivia phoneNumber: 650-965-6000 country: AE locality: Mountain View aggregatorInformation: subMerchant: email: test_merchant@test.com id: ABCDE1234567890 administrativeArea: CA merchantInformation: merchantDescriptor: contact: '9999999999' postalCode: '96162' administrativeArea: CA locality: Merchant City address1: Merchant Street senderInformation: locality: Test city name: John address1: Sender Address administrativeArea: CA countryCode: US processingInformation: capture: true japanPaymentOptions: terminalId: '1234567890123' commerceIndicator: internet clientReferenceInformation: code: TC01_06 paymentInformation: card: type: '004' expirationYear: '2040' number: '6011111111111117' expirationMonth: '12' securityCode: '123' parentTag: StandAlone-Credit-Framework example199: summary: 2. Pin Debit Refund MC Retail Contact sample-name: 2. Pin Debit Refund MC Retail Contact batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: paymentInformation: card: expirationYear: '2025' orderInformation: amountDetails: totalAmount: '420.00' currency: USD billTo: address1: Pin_Debit_Refund_MC_Retail_Contact clientReferenceInformation: code: '33557799' pointOfSaleInformation: cardPresent: Y terminalCapability: '1' encryptedKeySerialNumber: FFFF1B1D140000000005 catLevel: '1' entryMode: contact encryptedPin: 52F20658C04DB351 trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 processingInformation: capture: true commerceIndicator: retail parentTag: Pin-Debit-Framework example200: summary: 3. Pin Debit VI Retail Contact sample-name: 3. Pin Debit VI Retail Contact batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: paymentInformation: card: expirationYear: '2025' orderInformation: amountDetails: totalAmount: '120.00' currency: USD billTo: address1: Pin_Debit_VI_Retail_Contact clientReferenceInformation: code: '33557799' pointOfSaleInformation: cardPresent: Y terminalCapability: '1' encryptedKeySerialNumber: FFFF1B1D140000000005 catLevel: '1' entryMode: contact encryptedPin: 52F20658C04DB351 trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 processingInformation: capture: true commerceIndicator: retail parentTag: Pin-Debit-Framework example201: summary: 4. Pin Debit Refund VI Retail Contact sample-name: 4. Pin Debit Refund VI Retail Contact batchable: true processor-type: - Visa Platform Connect Certification Testing - VDC National Australia Bank Ltd value: paymentInformation: card: expirationYear: '2025' orderInformation: amountDetails: totalAmount: '220.00' currency: USD billTo: address1: Pin_Debit_Refund_VI_Retail_Contact clientReferenceInformation: code: '33557799' pointOfSaleInformation: cardPresent: Y terminalCapability: '1' encryptedKeySerialNumber: FFFF1B1D140000000005 catLevel: '1' entryMode: contact encryptedPin: 52F20658C04DB351 trackData: ;4111111111111111=33121019761186800000? emv: tags: 9F3303204000950500000000009F3704518823719F100706011103A000009F26081E1756ED0E2134E29F36020015820200009C01009F1A0208409A030006219F02060000000020005F2A0208409F0306000000000000 processingInformation: capture: true commerceIndicator: retail parentTag: Pin-Debit-Framework example202: summary: 3DS Purchase with MADA Card sample-name: 3DS Purchase with MADA Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_01 consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20300413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: mada capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100.00' currency: SAR invoiceDetails: purchaseOrderNumber: PurchaseOrderNumber123 aggregatorInformation: subMerchant: id: '001' travelInformation: transit: airline: ticketNumber: PNR123 merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '9682087345433240' securityCode: '123' expirationMonth: '12' type: '060' parentTag: 3DS Purchase example203: summary: 3DS Purchase with VISA Card sample-name: 3DS Purchase with VISA Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_02 consumerAuthenticationInformation: cavv: 107b965bd3e20645afa84e63b91c03cc05050409 dsReferenceNumber: dsReferenceNumber-3DS-vbv123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 xid: lEmYpm61EduaVZjPG1/HsgkAAQc= authenticationDate: '20230413121212' directoryServerTransactionId: f25084f05b164c0aae5db24808a95e4b specificationVersion: '2' acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: vbv capture: true industryDataType: auto_rental aggregatorInformation: subMerchant: id: '001' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '20100.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' parentTag: 3DS Purchase example204: summary: 3DS Purchase with MASTERCARD Card sample-name: 3DS Purchase with MASTERCARD Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_03 consumerAuthenticationInformation: dsReferenceNumber: dsReferenceNumber-3DS-vbv123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 authenticationDate: '20230413121212' ucafCollectionIndicator: '2' ucafAuthenticationData: EHuWW9PiBkWvqE5juRwDzAUFBAk= directoryServerTransactionId: f25084f05b164c0aae5db24808a95e4b specificationVersion: '2' acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: spa capture: true industryDataType: auto_rental transactionTypeIndicator: '209' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '20101.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '5555555555554444' securityCode: '123' expirationMonth: '12' type: '002' parentTag: 3DS Purchase example205: summary: 3DS Preauthorization with MADA Card sample-name: 3DS Preauthorization with MADA Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_04 consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: mada orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '3001' currency: SAR invoiceDetails: purchaseOrderNumber: PurchaseOrderNumber123 aggregatorInformation: subMerchant: id: '001' merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '9682087345433240' securityCode: '123' expirationMonth: '12' type: '060' parentTag: 3DS Preauthorization example206: summary: REGISTERED INITIAL sample-name: REGISTERED INITIAL processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_05 consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: mada authorizationOptions: initiator: credentialStoredOnFile: true capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '9682087345433240' securityCode: '123' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example207: summary: REGISTERED SUBSEQUENT sample-name: REGISTERED SUBSEQUENT processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_06 consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: mada authorizationOptions: initiator: storedCredentialUsed: true capture: true originalPaymentId: '{id}' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: number: '9682087345433240' expirationYear: '2031' securityCode: '123' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example208: summary: UNSCHEDULED INITIAL sample-name: UNSCHEDULED INITIAL processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_07 consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: authorizationOptions: initiator: credentialStoredOnFile: true merchantInitiatedTransaction: agreementId: AggrrementId123 capture: true unscheduledPaymentInformation: type: '1' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '9682087345433240' securityCode: '123' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example209: summary: UNSCHEDULED SUBSEQUENT sample-name: UNSCHEDULED SUBSEQUENT processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_08 processingInformation: capture: true originalPaymentId: '{id}' authorizationOptions: initiator: type: merchant storedCredentialUsed: true merchantInitiatedTransaction: agreementId: AggrrementId123 unscheduledPaymentInformation: type: '2' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: number: '9682087345433240' expirationYear: '2031' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example210: summary: RECURRING INITIAL sample-name: RECURRING INITIAL processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_09 recurringPaymentInformation: amountType: '0' numberOfPayments: 3 type: '1' consumerAuthenticationInformation: cavv: EHuWW9PiBkWvqE5juRwDzAUFBAk= dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: authorizationOptions: initiator: credentialStoredOnFile: true merchantInitiatedTransaction: agreementId: AggrrementId123 capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '9682087345433240' securityCode: '123' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example211: summary: RECURRING SUBSEQUENT sample-name: RECURRING SUBSEQUENT processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_10 recurringPaymentInformation: amountType: '0' numberOfPayments: 3 sequenceNumber: 1 processingInformation: commerceIndicator: recurring capture: true originalPaymentId: '{id}' authorizationOptions: initiator: storedCredentialUsed: true type: merchant merchantInitiatedTransaction: agreementId: AggrrementId123 orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: number: '9682087345433240' expirationYear: '2031' expirationMonth: '12' type: '060' parentTag: COF CIT-MIT example212: summary: INSTALLMENT INITIAL sample-name: INSTALLMENT INITIAL processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_11 consumerAuthenticationInformation: paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 authenticationDate: '20230413121212' ucafCollectionIndicator: '2' ucafAuthenticationData: EHuWW9PiBkWvqE5juRwDzAUFBAk= directoryServerTransactionId: f25084f05b164c0aae5db24808a95e4b specificationVersion: '2' acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: spa authorizationOptions: initiator: credentialStoredOnFile: true merchantInitiatedTransaction: agreementId: AggrrementId123 capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2026' number: '5555555555554444' securityCode: '123' expirationMonth: '12' type: '002' installmentInformation: sequence: 1 amount: '210' totalCount: 3 paymentType: '1' parentTag: COF CIT-MIT example213: summary: INSTALLMENT SUBSEQUENT sample-name: INSTALLMENT SUBSEQUENT processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_12 processingInformation: commerceIndicator: install authorizationOptions: initiator: type: merchant merchantInitiatedTransaction: agreementId: AggrrementId123 storedCredentialUsed: true originalPaymentId: '{id}' capture: true aggregatorInformation: subMerchant: id: SubMerId123 orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '5555555555554444' expirationMonth: '12' type: '002' installmentInformation: sequence: 2 amount: '210' totalCount: 3 parentTag: COF CIT-MIT example214: summary: APPLE PAY sample-name: APPLE PAY processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_13 processingInformation: paymentSolution: '001' capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: type: '060' tokenizedCard: expirationYear: '2031' transactionType: '1' number: '5069681916100419' expirationMonth: '10' cryptogram: BQFgixWPAAsDwxoO4OsYQwACAAA= requestorId: '37810030273' parentTag: Digital Wallets example215: summary: GOOGLE PAY sample-name: GOOGLE PAY processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_14 processingInformation: paymentSolution: '012' capture: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '100' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: API Address postalCode: 12987-7318 locality: Riyadh name: KSA Merchant-Name paymentInformation: card: type: '060' tokenizedCard: expirationYear: '2031' transactionType: '1' number: '5069681916100419' expirationMonth: '10' cryptogram: BQFgixWPAAsDwxoO4OsYQwACAAA= requestorId: '37810030273' parentTag: Digital Wallets example216: summary: MAIL ORDER sample-name: MAIL ORDER processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_15 processingInformation: commerceIndicator: moto orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '20100.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' example217: summary: Account Verification sample-name: Account Verification processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_16 consumerAuthenticationInformation: cavv: 107b965bd3e20645afa84e63b91c03cc05050409 dsReferenceNumber: dsReferenceNumber-3DS-mada123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 paSpecificationVersion: '2' xid: lEmYpm61EduaVZjPG1/HsgkAAQc= authenticationDate: '20230413121212' directoryServerTransactionId: f25084f0-5b16-4c0a-ae5d-b24808a95e4b acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: vbv authorizationOptions: cardVerificationIndicator: true orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: 'P.O.Box: 16335' address1: Al Dariyah Dist. postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '0' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' example218: summary: 3DS Preauthorization with VISA Card sample-name: 3DS Preauthorization with VISA Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_17 consumerAuthenticationInformation: cavv: 107b965bd3e20645afa84e63b91c03cc05050409 dsReferenceNumber: dsReferenceNumber-3DS-vbv123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 xid: lEmYpm61EduaVZjPG1/HsgkAAQc= authenticationDate: '20230413121212' directoryServerTransactionId: f25084f05b164c0aae5db24808a95e4b specificationVersion: '2' acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: vbv industryDataType: auto_rental aggregatorInformation: subMerchant: id: '001' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '20100.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '4111111111111111' securityCode: '123' expirationMonth: '12' type: '001' parentTag: 3DS Preauthorization example219: summary: 3DS Preauthorization with MASTERCARD Card sample-name: 3DS Preauthorization with MASTERCARD Card processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_18 consumerAuthenticationInformation: dsReferenceNumber: dsReferenceNumber-3DS-vbv123 paresStatus: Y acsReferenceNumber: 3DS_LOA_ACS_201_13579 authenticationDate: '20230413121212' ucafCollectionIndicator: '2' ucafAuthenticationData: EHuWW9PiBkWvqE5juRwDzAUFBAk= directoryServerTransactionId: f25084f05b164c0aae5db24808a95e4b specificationVersion: '2' acsTransactionId: f25084f0-5b16-4c0a-ae5d-b248083334b2 processingInformation: commerceIndicator: spa industryDataType: auto_rental transactionTypeIndicator: '209' orderInformation: billTo: firstName: KSA lastName: SPG phoneNumber: 01-4844094 address2: (PO)Box 16335 address1: Al Dariyah Dist postalCode: '22028' email: ksaspg@cybersource.com amountDetails: totalAmount: '20101.00' currency: SAR merchantInformation: categoryCode: 5411 merchantDescriptor: country: SA address1: Kharj Road postalCode: '12211' locality: Riyadh name: KSA Merchant-Name paymentInformation: card: expirationYear: '2031' number: '5555555555554444' securityCode: '123' expirationMonth: '12' type: '002' parentTag: 3DS Preauthorization example220: summary: Preauthorization Extension sample-name: Preauthorization Extension processor-type: - Saudi Payments Gateway (SPG/NPG) - VDC National Australia Bank Ltd value: clientReferenceInformation: code: SPG_REQ_19 processingInformation: authorizationOptions: extendAuthIndicator: 'true' originalPaymentId: '{id}' orderInformation: amountDetails: totalAmount: '0' currency: SAR parentTag: 3DS Preauthorization /pts/v2/payments/{id}: patch: summary: Increment an Authorization description: 'Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization. ' tags: - payments operationId: incrementAuth x-devcenter-metaData: categoryTag: Payments developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: id in: path description: The ID returned from the original authorization request. required: true type: string - name: incrementAuthRequest in: body required: true schema: type: object properties: clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' partner: type: object properties: originalTransactionId: type: string maxLength: 32 description: 'Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal''s software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal''s software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. ' developerId: type: string maxLength: 8 description: 'Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. ' solutionId: type: string maxLength: 8 description: 'Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. ' applicationName: type: string description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. ' applicationVersion: type: string description: 'Version of the CyberSource application or integration used for a transaction. ' applicationUser: type: string description: 'The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. ' transactionId: type: string maxLength: 30 description: 'Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. ' processingInformation: type: object properties: authorizationOptions: type: object properties: initiator: type: object properties: storedCredentialUsed: type: boolean description: 'Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **true** means the merchant-initiated transaction came from a card that was already stored on file. - **false** means the merchant-initiated transaction came from a card that was not stored on file. ' network: type: object properties: economicallyRelatedTxnId: type: string maxLength: 50 description: Indicates the economically related transaction id orderInformation: type: object properties: amountDetails: type: object properties: additionalAmount: type: string maxLength: 19 description: 'Additional charges that have to be authorized against a lodging or auto-rental order. This value cannot be negative. You can include a decimal point (.), but no other special characters. ' currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' merchantInformation: type: object properties: transactionLocalDateTime: type: string maxLength: 14 description: "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where:\n - `YYYY` = year\n - `MM` = month\n - `DD` = day\n - `hh` = hour\n - `mm` = minutes\n - `ss` = seconds\n\n#### Used by\n**Authorization**\nRequired for these processors:\n- American Express Direct - American Express Direct\n- Credit Mutuel-CIC\n- FDC Nashville Global\n- SIX\n\nOptional for all other processors.\n" travelInformation: type: object properties: duration: type: string maxLength: 2 description: 'Duration for which the vehicle was rented or lodge/hotel was booked. ' example: clientReferenceInformation: code: TC50171_3 processingInformation: authorizationOptions: initiator: storedCredentialUsed: true orderInformation: amountDetails: additionalAmount: '22.49' currency: USD merchantInformation: transactionLocalDateTime: 20191002080000 travelInformation: duration: '4' responses: '201': description: Successful response. schema: title: ptsV2IncrementalAuthorizationPatch201Response type: object properties: _links: type: object properties: self: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - AUTHORIZED\n - AUTHORIZED_PENDING_REVIEW\n - DECLINED\n" reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' errorInformation: type: object properties: reason: type: string description: "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - BLOCKED_BY_CARDHOLDER\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - CONSUMER_AUTHENTICATION_REQUIRED\n - ALLOWABLE_PIN_RETRIES_EXCEEDED\n - PROCESSOR_ERROR\n - DAGGREJECTED\n - DAGGDENIED\n - DSYSREJECTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' processorInformation: type: object properties: approvalCode: type: string maxLength: 6 description: 'Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. ' transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' networkTransactionId: type: string description: Same value as `processorInformation.transactionId` responseCode: type: string maxLength: 10 description: 'For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. ' systemTraceAuditNumber: type: string maxLength: 6 description: 'This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer''s receipt. ' responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' merchantAdvice: type: object properties: code: type: string maxLength: 2 description: "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\n#### Possbile values for Barclays processor:\n- 00: No information, or response not provided.\n- 01: New account information available\n- 02: Try again later\n- 03: Do not try again\n- 05: Payment blocked by the payment card company\n" codeRaw: type: string maxLength: 4 description: 'Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code #### Possbile values for Barclays processor: - 01: Updated/additional information needed - 02: Cannot approve at this time; try again later - 04: Do not try again - 08: Payment blocked by card scheme ' nameMatch: type: string maxLength: 2 description: '#### Visa Platform Connect The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are: 00 = Name Match Performed 01 = Name Match not Performed 02 = Name Match not supported ' merchantRiskPrediction: type: string maxLength: 150 description: 'Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. ' sellerProtection: type: object properties: type: type: string description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection eligibility value is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values - ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received. - UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments. One or both values can be returned. ' eligibility: type: string maxLength: 36 description: 'Indicates whether the transaction is eligible for seller protection. The values returned are described below. Possible values: - `ELIGIBLE` - `PARTIALLY_ELIGIBLE` - `INELIGIBLE` - `NOT_ELIGIBLE` ' disputeCategories: type: array items: type: string description: 'An array of conditions that are covered for the transaction. ' eligibilityType: type: string maxLength: 60 description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection_eligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values: - `ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received.` - `UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments.` One or both values can be returned. ' network: type: object properties: economicallyRelatedTxnId: type: string maxLength: 50 description: Indicates the economically related transaction id paymentInformation: type: object properties: accountFeatures: type: object properties: category: type: string maxLength: 7 description: '#### GPX Mastercard product ID associated with the primary account number (PAN). Returned by authorization service. #### CyberSource through VisaNet Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### GPN Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### Worldpay VAP **Important** Before using this field on Worldpay VAP, you must contact CyberSource Customer Support to have your account configured for this feature. Type of card used in the transaction. The only possible value is: - `PREPAID`: Prepaid Card Data Length: String (7) #### RBS WorldPay Atlanta Type of card used in the transaction. Possible values: - `B`: Business Card - `O`: Noncommercial Card - `R`: Corporate Card - `S`: Purchase Card - `Blank`: Purchase card not supported Data Length: String (1) ' orderInformation: type: object properties: amountDetails: type: object properties: totalAmount: type: string maxLength: 15 description: 'Amount you requested for the payment or capture. This value is returned for partial authorizations. This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations. ' authorizedAmount: type: string maxLength: 15 description: 'Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. ' cashbackAmount: type: string maxLength: 12 description: "This field contains the purchase cashback amount expressed in the acquirer transaction currency. \nUse this field only for clearing with your acquirer.\n" currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' 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''s account. This field is returned for OCT transactions. ' settlementCurrency: type: string maxLength: 3 description: 'This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder''s account. This field is returned for OCT transactions. ' originalAmount: type: string maxLength: 15 description: 'Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. ' originalCurrency: type: string maxLength: 15 description: 'Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) ' processorTransactionFee: type: string maxLength: 15 description: 'Amount up to N digit after the decimals separator as defined in ISO 4217 for the appropriate currency code. ' exchangeRate: type: string maxLength: 17 description: 'The rate of conversion of the currency given in the request to CNY. The conversion happens at the time when Alipay''s trade order is created ' foreignCurrency: type: string maxLength: 3 description: 'Currency code for the transaction performed in cross border currency. ' foreignAmount: type: string maxLength: 11 description: 'The transaction amount in CNY. ' discountAmount: type: string maxLength: 11 description: 'If coupons/vouchers are used in the transaction, the discount amount redeemed in the settlement currency will be returned. Otherwise, no return. ' invoiceDetails: type: object properties: productId: type: string maxLength: 35 description: 'Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. ' example: _links: self: href: /pts/v2/payments/4963015972176007901546 method: GET id: '4963015972176007901546' submitTimeUtc: 2017-06-01T071957Z status: '200' reconciliationId: 39570726X3E1LBQR clientReferenceInformation: code: TC50171_3 orderInformation: amountDetails: authorizedAmount: '22.49' currency: USD processorInformation: approvalCode: '888888' responseCode: '100' '400': description: Invalid request. schema: type: object title: ptsV2IncrementalAuthorizationPatch400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2IncrementalAuthorizationPatch502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. x-example: example0: summary: Incremental Authorization sample-name: Incremental Authorization value: clientReferenceInformation: code: TC50171_3 processingInformation: authorizationOptions: initiator: storedCredentialUsed: true orderInformation: amountDetails: additionalAmount: '22.49' currency: USD merchantInformation: transactionLocalDateTime: 20191002080000 travelInformation: duration: '4' /pts/v2/refresh-payment-status/{id}: post: summary: Check a Payment Status description: 'Checks and updates the payment status ' tags: - payments operationId: refreshPaymentStatus x-devcenter-metaData: categoryTag: Payments testingTriggers: https://developer.cybersource.com/hello-world/testing-guide.html responseCodes: https://developer.cybersource.com/api/reference/response-codes.html developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: id in: path description: The payment id whose status needs to be checked and updated. required: true type: string - name: refreshPaymentStatusRequest in: body required: true schema: type: object properties: paymentInformation: type: object properties: customer: type: object properties: customerId: type: string description: 'Unique identifier for the customer''s card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer''s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn''t need to pass in data such as the card number or expiration date in the request itself. ' paymentType: type: object properties: name: type: string description: 'A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) ' method: type: object properties: name: type: string description: 'A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, bofaPayByBank, payToPayByBank, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data #### Via KCP - `KCP` : Local Card, Bank Transfer and Carrier Billing. - `PAYCO` - `KAKAOPAY` - `NAVERPAY` ' clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' agreementInformation: type: object properties: agreementId: type: string description: 'The identifier for the billing agreement. ' processingInformation: type: object properties: actionList: type: array description: "Array of actions (one or more) to be included in the payment to invoke bundled services along with payment status.\n\nPossible values are one or more of follows:\n\n - `AP_STATUS`: Use this when Alternative Payment check status service is requested.\n\n - `AP_SESSION_STATUS`: Use this when Alternative Payment check status service for Paypal, Klarna is requested.\n\n - `AP_INITIATE_STATUS`: Use this when Alternative Payment check status service for KCP is requested.\n\n - `AP_ORDER_STATUS`: Use this when Alternative Payment check status service for order status request.\n\n - `AP_AUTH_STATUS`: Use this when Alternative Payment check status service for auth status request.\n\n - `AP_CAPTURE_STATUS`: Use this when Alternative Payment check status service for capture status request.\n\n - `AP_REFUND_STATUS`: Use this when Alternative Payment check status service for refund status request.\n" items: type: string responses: '201': description: Successful response. schema: title: ptsV2PaymentsPost201Response type: object properties: id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - AUTHORIZED\n - PARTIAL_AUTHORIZED\n - AUTHORIZED_PENDING_REVIEW\n - AUTHORIZED_RISK_DECLINED\n - PENDING_AUTHENTICATION\n - PENDING_REVIEW\n - DECLINED\n - INVALID_REQUEST\n" submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' processorInformation: type: object properties: transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' tradeNumber: type: string description: The description for this field is not available. rawResponse: type: string maxLength: 255 description: Failure reason returned by the processor. rawResponseLocal: type: string maxLength: 255 description: Failure reason returned by the processor in the local language of the processor. responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' responseCode: type: string description: 'This field is set to the value of response code returned by the processor. ' sellerProtection: type: object properties: type: type: string description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection eligibility value is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values - ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received. - UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments. One or both values can be returned. ' eligibility: type: string maxLength: 36 description: 'Indicates whether the transaction is eligible for seller protection. The values returned are described below. Possible values: - `ELIGIBLE` - `PARTIALLY_ELIGIBLE` - `INELIGIBLE` - `NOT_ELIGIBLE` ' disputeCategories: type: array items: type: string description: 'An array of conditions that are covered for the transaction. ' eligibilityType: type: string maxLength: 60 description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection_eligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values: - `ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received.` - `UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments.` One or both values can be returned. ' avs: type: object properties: codeRaw: type: string maxLength: 10 description: 'AVS result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of AVS. Use for debugging purposes only. Returned by authorization service. ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' paymentInformation: type: object properties: paymentType: type: object properties: method: type: object 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''s site, and the payment channel is known. Possible Values: #### Via PPRO - `alfaVa` - `kredivo` - `consumerBarCode` - `merchantQrCode` - `dokuWallet` ' eWallet: type: object properties: name: type: string maxLength: 30 description: 'Valid Values: - CreditCard - BankTransfer - MobileTransfer - KakaoMoney - NaverPayPoint ' fundingSource: type: string maxLength: 30 description: 'Valid Values: - PAYCO - Kakaopay - NaverPay - SSG Pay - L.Pay - Apple Pay - TOSS Pay - Samsung Pay ' customer: type: object properties: customerId: type: string description: 'Unique identifier for the customer''s card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer''s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn''t need to pass in data such as the card number or expiration date in the request itself. ' bank: type: object properties: account: type: object properties: ibanSuffix: type: string description: The description for this field is not available. orderInformation: type: object properties: billTo: type: object properties: firstName: type: string maxLength: 60 description: 'Customer''s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' lastName: type: string maxLength: 60 description: 'Customer''s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' nameSuffix: type: string maxLength: 60 description: 'Customer''s name suffix. ' address1: type: string maxLength: 60 description: 'Payment card billing street address as it appears on the credit card issuer''s records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' address2: type: string maxLength: 60 description: 'Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) ' locality: type: string maxLength: 50 description: 'Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' administrativeArea: type: string maxLength: 50 description: 'State or province of the billing 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' postalCode: type: string maxLength: 10 description: "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### SEPA\nRequired for Create Mandate and Import Mandate\n\n#### For Payouts:\n This field may be sent only for FDC Compass.\n\n#### American Express Direct\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### CyberSource through VisaNet\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet\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 ASCII\ncharacters for transmission to the credit card networks.\n\n#### FDMS Nashville\nRequired if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada.\nOptional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada.\nNot used if swiped.\n\n#### RBS WorldPay Atlanta:\nFor best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### All other processors:\nOptional field.\n" country: type: string maxLength: 3 description: 'Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' email: type: string maxLength: 255 description: 'Customer''s email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won''t work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' verificationStatus: type: string description: 'Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED ' shipTo: type: object properties: firstName: type: string maxLength: 60 description: 'First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' lastName: type: string maxLength: 60 description: 'Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' address1: type: string maxLength: 60 description: 'First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' address2: type: string maxLength: 60 description: 'Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' locality: type: string maxLength: 50 description: 'City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' administrativeArea: type: string maxLength: 50 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: 32 description: 'Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' 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) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' maxLength: 3 phoneNumber: type: string maxLength: 15 description: Phone number associated with the shipping address. amountDetails: type: object properties: refundBalance: type: string maxLength: 15 description: The remaining amount which can be refunded. clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' issuerInformation: type: object properties: name: type: string maxLength: 20 description: 'Name of the card issuer provided by the processor. ' code: type: string maxLength: 10 description: Unique code for card issuer provided by the processor. errorInformation: type: object properties: reason: type: string description: 'The reason of the status. ' message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '400': description: Invalid request. schema: type: object title: ptsV2PaymentsPost400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2PaymentsPost502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. /pts/v2/payment-references/{id}/intents: post: summary: Create a Payment Order Request description: Create a Payment Order Request tags: - payments operationId: createOrderRequest x-devcenter-metaData: categoryTag: Payments developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: OrderPaymentRequest in: body required: true schema: type: object properties: clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' processingInformation: type: object properties: actionList: type: array description: 'Array of actions (one or more) to be included in the order to invoke bundled services along with order. Possible values: - `AP_ORDER`: Use this when Alternative Payment Order service is requested. ' items: type: string paymentInformation: type: object properties: paymentType: type: object properties: method: type: object properties: name: type: string description: 'Identifier for the payment type ' eWallet: type: object properties: accountId: type: string maxLength: 26 description: The ID of the customer, passed in the return_url field by PayPal after customer approval. orderInformation: type: object properties: amountDetails: type: object properties: totalAmount: type: string maxLength: 10 description: 'Grand total for the order. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places ' currency: type: string maxLength: 5 description: 'Currency used for the order ' subTotalAmount: type: string maxLength: 15 description: 'Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' handlingAmount: type: string maxLength: 15 description: 'Aggregate handling charges for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' shippingAmount: type: string maxLength: 15 description: 'Aggregate shipping charges for the transaction If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' shippingDiscountAmount: type: string maxLength: 15 description: 'Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. ' taxAmount: type: string maxLength: 10 description: 'Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. ' insuranceAmount: type: string maxLength: 15 description: 'Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal. ' giftWrapAmount: type: string maxLength: 15 description: "Amount being charged as gift wrap fee.\n \n" - name: id in: path description: 'Request identifier number for the order request. ' required: true type: string responses: '201': description: Successful response. schema: title: ptsV2PaymentsOrderPost201Response type: object properties: id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' processorInformation: type: object properties: sellerProtection: type: object properties: eligibilty: type: string maxLength: 60 description: 'The level of seller protection in force for the transaction. Possible values: - `ELIGIBLE` - `PARTIALLY_ELIGIBLE` - `INELIGIBLE` ' type: type: string maxLength: 60 description: 'The kind of seller protection in force for the transaction. This field is returned only when the protection eligibility is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Possible values: - `ITEM_NOT_RECEIVED_ELIGIBLE: Sellers are protected against claims for items not received.` - `UNAUTHORIZED_PAYMENT_ELIGIBLE: Sellers are protected against claims for unauthorized payments.One or both values can be returned.` ' avs: type: object properties: codeRaw: type: string maxLength: 10 description: 'AVS result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of AVS. Use for debugging purposes only. Returned by authorization service. ' transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' orderInformation: type: object properties: billTo: type: object properties: title: type: string maxLength: 60 description: 'Title. ' firstName: type: string maxLength: 60 description: 'Customer''s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' middleName: type: string maxLength: 60 description: 'Customer''s middle name. ' lastName: type: string maxLength: 60 description: 'Customer''s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. ' nameSuffix: type: string maxLength: 60 description: 'Customer''s name suffix. ' address1: type: string maxLength: 60 description: 'First line of the billing street address. ' address2: type: string maxLength: 60 description: 'Second line of the billing street address. ' locality: type: string maxLength: 50 description: 'City of the billing address. ' postalCode: type: string maxLength: 10 description: 'Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example: A1B 2C3 ' administrativeArea: type: string maxLength: 2 description: 'State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. ' country: type: string maxLength: 20 description: 'Country of the billing address. Use the two-character ISO Standard Country Codes. ' email: type: string maxLength: 256 description: 'Customer''s email address. ' phoneNumber: type: string maxLength: 15 description: 'Customer''s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. ' verificationStatus: type: string description: 'Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED ' shipTo: type: object properties: method: type: string maxLength: 225 description: 'shipping method for the product. Possible values are: - `sameday` - `oneday` - `twoday` - `threeday` - `lowcost` - `pickup` - `other` - `none` ' firstName: type: string maxLength: 60 description: 'First name of the recipient. ' lastName: type: string maxLength: 60 description: 'Last name of the recipient. ' address1: type: string maxLength: 100 description: 'First line of the shipping address. ' address2: type: string maxLength: 100 description: 'Second line of the shipping address ' locality: type: string maxLength: 50 description: 'City of the shipping address. ' postalCode: type: string maxLength: 20 description: 'Postal code of shipping address. Consists of 5 to 9 digits. ' administrativeArea: type: string maxLength: 40 description: 'State or province of shipping address. This is a State, Province, and Territory Codes for the United States and Canada. ' country: type: string maxLength: 2 description: 'Country of shipping address. This is a two-character ISO Standard Country Codes. ' phoneNumber: type: string maxLength: 20 description: 'Phone number of shipping address. ' amountDetails: type: object properties: totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" currency: type: string maxLength: 5 description: 'Currency used for the order ' shippingDetails: type: object properties: shippingMethod: type: string maxLength: 32 description: "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n\nKlarna Advantage Plus additional values:\n - `TO_DOOR`: Delivery to door\n - `TO_CURB`: Delivery to curb\n - `TO_MAILBOX`: Delivery to mailbox\n - `PICKUP_BOX`: Pickup from box\n - `PICKUP_POINT`: Pickup from point\n - `PICKUP_STORE`: Pickup from store\n - `PICKUP_WAREHOUSE`: Pickup from warehouse\n - `DIGITAL_EMAIL`: Digital delivery via email\n - `DIGITAL_DOWNLOAD`: Digital download\n - `DIGITAL_OTHER`: Other digital delivery\n - `PHYSICAL_OTHER`: Other physical delivery\n" paymentInformation: type: object properties: eWallet: type: object properties: accountId: type: string maxLength: 26 description: The ID of the customer, passed in the return_url field by PayPal after customer approval. fundingSource: type: string maxLength: 30 description: Payment mode for the authorization or order transaction.  INSTANT_TRANSFER  MANUAL_BANK_TRANSFER  DELAYED_TRANSFER  ECHECK  UNRESTRICTED (default)—this value is available only when configured by PayPal for the merchant. INSTANT fundingSourceSale: type: string maxLength: 30 description: 'Payment method for the unit purchase. Possible values: - `UNRESTRICTED (default)—this value is only available if configured by PayPal for the merchant.` - `INSTANT` ' userName: type: string description: 'The Venmo user name chosen by the user, also known as a Venmo handle. ' processingInformation: type: object properties: intentsId: type: string maxLength: 26 description: Set to the value of the requestID field returned in the order service response. buyerInformation: type: object properties: personalIdentification: type: array items: type: object properties: type: type: string description: "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n - `PASSPORT_NUMBER`\n - `PERSONAL_ID`\n - `TAX_ID`\n -\t`BR_CPF` The individual tax ID type, typically is 11 characters long\n -\t`BR_CNPJ` The business tax ID type, typically is 14 characters long.\n\nThis field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n" id: type: string maxLength: 26 description: "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\nPossible values:\n - CREATED\n - SAVED\n - APPROVED\n - VOIDED\n - COMPLETED\n - PAYER_ACTION_REQUIRED\n" reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' riskInformation: type: object properties: fraudDecision: type: string maxLength: 60 description: 'Type of filter. Possible values: - ACCEPT - PENDING - DENY - REPORT ' fraudDecisionReason: type: string maxLength: 60 description: 'possible values - AVS_NO_MATCH - AVS_PARTIAL_MATCH - AVS_UNAVAILABLE_OR_UNSUPPORTED - CARD_SECURITY_CODE_MISMATCH - MAXIMUM_TRANSACTION_AMOUNT - UNCONFIRMED_ADDRESS - COUNTRY_MONITOR - LARGE_ORDER_NUMBER - BILLING_OR_SHIPPING_ADDRESS_MISMATCH - RISKY_ZIP_CODE - SUSPECTED_FREIGHT_FORWARDER_CHECK - TOTAL_PURCHASE_PRICE_MINIMUM - IP_ADDRESS_VELOCITY - RISKY_EMAIL_ADDRESS_DOMAIN_CHECK - RISKY_BANK_IDENTIFICATION_NUMBER_CHECK, RISKY_IP_ADDRESS_RANGE - PAYPAL_FRAUD_MODEL ' '400': description: Invalid request. schema: type: object title: ptsV2PaymentsPost400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2PaymentsPost502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. x-example: example0: summary: Create a Payment Order Request sample-name: Create a Payment Order Request value: clientReferenceInformation: code: TC0824-06 reconciliationId: TC0120-15 processingInformation: actionList: AP_ORDER orderInformation: amountDetails: totalAmount: '100' currency: GBP paymentInformation: eWallet: accountId: XX00XX00XX paymentType: method: name: PAYPAL name: EWALLET /pts/v2/payment-references: post: summary: Create Alternative Payments Sessions Request description: Create Alternative Payments Sessions Request tags: - payments operationId: CreateSessionRequest x-devcenter-metaData: categoryTag: Payments developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: createSessionReq in: body required: true schema: type: object properties: clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' processingInformation: type: object properties: sessionType: type: string maxLength: 5 description: 'Will have 2 values, ''U'' (Update) , ''N'' (New). Any other values will be rejected. Default will be ''N'' ' paymentFlowMode: type: string maxLength: 50 description: 'Whether merchant wants to pass the flow Inline or want to invoke Klarna Hosted Page ' actionList: type: array description: "Possible values are one or more of follows:\n\n - `AP_SESSIONS`: Use this when Alternative Payment Sessions service is requested.\n" items: type: string paymentInformation: type: object properties: card: type: object properties: number: type: string maxLength: 20 description: 'The customer''s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' expirationMonth: type: string maxLength: 2 description: 'Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' expirationYear: type: string maxLength: 4 description: 'Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' securityCode: type: string maxLength: 4 description: 'Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional. ' useAs: type: string maxLength: 20 description: "Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect.\nThe cardholder provides this information during the payment process. This field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n\n**China UnionPayCard Transactions on China UnionPay:**\nPossible values:\n - C: Domestic credit card\n - D: Domestic debit card\n - F: International credit card\n - I: International debit card\n\nWhen the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request.\nWhen the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request.\n\n**Cielo and Comercio Latino Credit Card Transactions:**\nOn these processors, this field is supported only for authorizations. Possible values:\n - CR: Credit card\n - DB: Debit card \n\n**Visa Platform Connect Credit Card Transactions:**\nThis field is supported for all card types on Visa Platform Connect.\nFor combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - CR: Credit card\n - DB: Debit Card\n\nFor combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - C: Credit card\n - D: Debit card\n\nA value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.\n" bank: type: object properties: swiftCode: type: string description: 'Bank''s SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. ' account: type: object properties: number: type: string maxLength: 30 description: 'Account number. When processing encoded account numbers, use this field for the encoded account number. ' iban: type: string maxLength: 50 description: 'International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. ' eWallet: type: object properties: fundingSource: type: string maxLength: 30 description: "Payment method for the unit purchase.\n Possible values:\n UNRESTRICTED (default)—this value is\n available only when configured by PayPal\n for the merchant.\n INSTANT.\n" options: type: object properties: id: type: string maxLength: 255 description: 'Identifier for a PayPal credit transaction. Value: Credit ' paymentType: type: object properties: name: type: string description: 'A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) ' subTypeName: type: string description: 'In case the APM supports multiple modes of initiation (e.g. Alipay via QR Code or Barcode) ' method: type: object properties: name: type: string description: 'A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, bofaPayByBank, payToPayByBank, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data #### Via KCP - `KCP` : Local Card, Bank Transfer and Carrier Billing. - `PAYCO` - `KAKAOPAY` - `NAVERPAY` ' 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''s site, and the payment channel is known. Possible Values: #### Via PPRO - `alfaVa` - `kredivo` - `consumerBarCode` - `merchantQrCode` - `dokuWallet` ' orderInformation: type: object properties: billTo: type: object properties: name: type: string maxLength: 87 description: 'Company Name. ' shipTo: type: object properties: email: type: string maxLength: 60 description: 'Customer''s primary email address, including the full domain name. ' title: type: string description: The title of the person receiving the product. maxLength: 60 firstName: type: string maxLength: 60 description: 'First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' middleName: type: string maxLength: 60 description: 'Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' lastName: type: string maxLength: 60 description: 'Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' company: type: string maxLength: 60 description: 'Name of the customer''s company. ' address1: type: string maxLength: 60 description: 'First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' address2: type: string maxLength: 60 description: 'Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' district: type: string maxLength: 50 description: Neighborhood, community, or region within a city or municipality. locality: type: string maxLength: 50 description: 'City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' administrativeArea: type: string maxLength: 50 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: 32 description: 'Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' 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) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' maxLength: 3 buildingNumber: type: string maxLength: 15 description: 'Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 ' phoneNumber: type: string maxLength: 15 description: Phone number associated with the shipping address. immutable: type: string description: 'Indicates whether customers are permitted to edit the shipping address in their PayPal account. Possible values: - true: Customer cannot edit the shipping address. - false (default): Customer can edit the shipping address. ' maxLength: 100 notApplicable: type: string description: 'Indicates whether the shipping address is displayed to the customer in their PayPal account. Possible values: - true: Shipping address is not displayed. - false (default): Shipping address is displayed. For example, for digital downloads and services in which a shipping address is not required, set the value to true. ' maxLength: 10 county: type: string description: U.S. county if available. maxLength: 30 amountDetails: type: object properties: totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' discountAmount: type: string maxLength: 15 description: 'Total discount amount applied to the order. ' taxAmount: type: string maxLength: 12 description: 'Total tax amount for all the items in the order. ' dutyAmount: type: string maxLength: 15 description: 'Total charges for any import or export duties included in the order. ' exchangeRate: type: string maxLength: 13 description: 'Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. ' exchangeRateTimeStamp: type: string maxLength: 16 description: 'Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. ' settlementCurrency: type: string maxLength: 3 description: 'This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder''s account. This field is returned for OCT transactions. ' invoiceAmount: type: string maxLength: 12 description: 'Invoice amount. The invoice amount issued by the Merchant to the Cardholder, which includes VAT (excluding items such as TIPS or CASHBACK). For transactions that do not have applicable Benefit Laws, the field may be entered as zeros. This field is only applicable for Uruguay market. Example: 100.00 Uruguay The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 7-18 - Field: Invoice Amount ' giftwrapAmount: type: string maxLength: 19 description: giftwrap amount (RFU). handlingAmount: type: string maxLength: 19 description: handling amount (RFU) shippingAmount: type: string maxLength: 19 description: shipping amount (RFU) shippingDiscountAmount: type: string maxLength: 19 description: shipping discount amount (RFU) insuranceAmount: type: string maxLength: 19 description: insurance amount (RFU) lineItems: type: array items: type: object description: List of the line items from the order, which are included in an invoice. properties: productSku: type: string maxLength: 255 description: 'Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. ' productName: type: string maxLength: 255 description: 'For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' quantity: type: integer minimum: 1 maximum: 999999999 default: 1 description: 'Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' unitPrice: type: string maxLength: 15 description: 'Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) ' discountAmount: type: string maxLength: 13 description: Discount applied to the item. discountRate: type: string maxLength: 6 description: 'Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) ' taxAmount: type: string maxLength: 15 description: "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nOptional field.\n\n#### Airlines processing\nTax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s).\nFormat: English characters only.\nOptional request field for a line item.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nNote if you send this field in your tax request, the value in the field will override the tax engine\n" taxRate: type: string maxLength: 7 description: 'Tax rate applied to the item. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). ' totalAmount: type: string maxLength: 13 description: 'Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is "gift_card", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 ' productCode: type: string maxLength: 255 description: 'Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The 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]. ' productDescription: type: string description: Brief description of item. invoiceDetails: type: object properties: costCenter: type: string description: Cost centre of the merchant. productDescription: type: string description: Brief description of item. shippingDetails: type: object properties: shippingMethod: type: string maxLength: 32 description: "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n\nKlarna Advantage Plus additional values:\n - `TO_DOOR`: Delivery to door\n - `TO_CURB`: Delivery to curb\n - `TO_MAILBOX`: Delivery to mailbox\n - `PICKUP_BOX`: Pickup from box\n - `PICKUP_POINT`: Pickup from point\n - `PICKUP_STORE`: Pickup from store\n - `PICKUP_WAREHOUSE`: Pickup from warehouse\n - `DIGITAL_EMAIL`: Digital delivery via email\n - `DIGITAL_DOWNLOAD`: Digital download\n - `DIGITAL_OTHER`: Other digital delivery\n - `PHYSICAL_OTHER`: Other physical delivery\n" buyerInformation: type: object properties: dateOfBirth: type: string maxLength: 8 description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' gender: type: string maxLength: 3 description: Customer's gender. Possible values are F (female), M (male),O (other). language: type: string maxLength: 5 description: "language setting of the user. \nSupports 2-character language codes (e.g., en, fr) and 5-character locale values (e.g., en-US, fr-CA).\n" noteToSeller: type: string maxLength: 255 description: Note to the recipient of the funds in this transaction personalIdentification: type: array items: type: object properties: id: type: string maxLength: 26 description: "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" deviceInformation: type: object properties: ipAddress: type: string maxLength: 45 description: 'IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. ' deviceType: type: string maxLength: 60 description: The device type at the client side. id: type: string maxLength: 50 description: ../../../commons/definitions/device.yaml#/properties/id userAgent: type: string maxLength: 40 description: 'Customer''s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. ' merchantInformation: type: object properties: merchantDescriptor: type: object properties: name: type: string description: 'Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. **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. **Important** This value must consist of English characters. Required for captures and credits. ' alternateName: type: string maxLength: 13 description: 'An alternate name for the merchant. ' contact: type: string maxLength: 25 description: 'Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) ' address1: type: string maxLength: 60 description: 'First line of merchant''s address. ' locality: type: string maxLength: 30 description: 'Merchant''s City. #### PIN debit City for your business location. This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. ' country: type: string maxLength: 3 description: 'Merchant''s country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** 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`. Optional field for PIN debit credit or PIN debit purchase. ' postalCode: type: string maxLength: 14 description: 'Merchant''s postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder''s statement. If 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` If 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` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. ' administrativeArea: type: string description: 'The state where the merchant is located. #### PIN debit State 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. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase. ' phone: type: string maxLength: 13 description: 'Merchant phone as contact information for CNP transactions ' url: type: string maxLength: 255 description: 'Address of company''s website provided by merchant ' countryOfOrigin: type: string maxLength: 2 description: '#### Visa Platform Connect This field will indicate merchant country of origin ' storeId: type: string maxLength: 50 description: 'The identifier of the store. ' storeName: type: string maxLength: 50 description: 'The name of the store. ' customerServicePhoneNumber: type: string maxLength: 27 description: '#### Visa Platform Connect Indicates customer service phone number of Merchant. ' cancelUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction successUrl: type: string maxLength: 2048 description: customer would be redirected to this url based on the decision of the transaction failureUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction noteToBuyer: type: string maxLength: 25 description: Free-form text field. userInterface: type: object properties: borderRadius: type: string maxLength: 19 description: 'Border Radius, Allowed Values - Number, Chars, SPACE, Percentage(%), DOT(.), Example ''25px 10px 25px 10px''; ''2em 1em 0.5em 3em'' ' theme: type: string maxLength: 19 description: 'UI Theme Name/Design Name - Allowed Chars: Alpha Numeric, Dot (.), Hyphen (-), Underscore (_) ' color: type: object properties: border: type: string description: 'Border Color ' maxLength: 10 borderSelected: type: string description: 'Selected Border Color ' maxLength: 10 button: type: string description: 'Button Color ' maxLength: 10 buttonText: type: string description: 'Button Text Color ' maxLength: 10 checkbox: type: string description: 'Checkbox Color ' maxLength: 10 checkboxCheckMark: type: string description: 'Checkbox Checkmark Color ' maxLength: 10 header: type: string description: 'Header Color ' maxLength: 10 link: type: string description: 'Link Color ' maxLength: 10 text: type: string description: 'Text Color ' maxLength: 10 merchantDefinedInformation: type: array description: 'The object containing the custom data that the merchant defines. ' items: type: object properties: key: type: string maxLength: 50 description: 'The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. ' value: type: string maxLength: 800 description: "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" agreementInformation: type: object properties: indicator: type: string description: 'Indicates whether the transaction is a billing agreement. Possible values - true - false (default) ' description: type: string description: Description of the billing agreement travelInformation: type: object properties: autoRental: type: object properties: companyName: type: string maxLength: 50 description: 'Merchant to send their auto rental company name ' affiliateName: type: string maxLength: 50 description: 'When merchant wants to send the affiliate name. ' rentalAddress: type: object properties: city: type: string maxLength: 25 description: 'City in which the auto was rented. For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for American Express. For all other card types, this field is ignored. ' state: type: string maxLength: 3 description: 'State in which the auto was rented. 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). ' country: type: string maxLength: 3 description: 'Country where the auto was rented. Use the [ISO Standard Country Codes.](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This field is supported only for American Express. ' locationId: type: string maxLength: 10 description: 'The agency code, address, phone number, etc., used to identify the location where the vehicle was rented. ' address1: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' address2: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where a taxi passenger was picked up or where an auto rental vehicle was picked up. In most cases, this is the rental agency''s business name that appears on the storefront and/or customer receipts, commonly referred to as the DBA (Doing Business As) name. However, if the vehicle was picked up at another location (e.g., a hotel,auto dealership, repair shop, etc.), the name of that location should be used. This entry must be easily recognized by the Cardmember to avoid unnecessary inquiries. If the name is more than 38 characters, use proper and meaningful abbreviation, when possible. ' returnAddress: type: object properties: city: type: string maxLength: 25 description: 'City where the auto was returned to the rental agency. ' state: type: string maxLength: 3 description: 'State in which the auto was returned to the rental agency. 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). For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for MasterCard and American Express. ' country: type: string maxLength: 3 description: 'Country where the auto was returned to the rental agency. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). ' locationId: type: string maxLength: 10 description: 'Code, address, phone number, etc. used to identify the location of the auto rental return. This field is supported only for MasterCard and American Express. ' address1: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s street address. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the return address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where the taxi passenger was dropped off or where the auto rental vehicle was returned. ' returnDateTime: type: string maxLength: 21 description: 'Date/time the auto was returned to the rental agency. Format: ``yyyy-MM-dd HH-mm-ss z`` This field is supported for Visa, MasterCard, and American Express. ' rentalDateTime: type: string maxLength: 21 description: 'Date/time the auto was picked up from the rental agency. Format: `yyyy-MM-dd HH-mm-ss z` This field is supported for Visa, MasterCard, and American Express. ' customerName: type: string maxLength: 40 description: 'Name of the individual making the rental agreement. Valid data lengths by card: |Card Specific Validation|VISA|MasterCard|Discover|AMEX| |--- |--- |--- |--- | | Filed Length| 40| 40| 29| 26| | Field Type| AN| ANS| AN| AN| | M/O/C| O| M| M| M| ' x-example: example0: summary: Alternative Payments Create Sessions Request sample-name: Create Sessions Request value: clientReferenceInformation: code: TC0824-06 processingInformation: actionList: AP_SESSIONS orderInformation: amountDetails: totalAmount: '1999.99' currency: USD paymentInformation: paymentType: method: name: KLARNA name: invoice responses: '201': description: Successful response. schema: title: ptsV2PaymentsPost201Response type: object properties: _links: type: object properties: self: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' reversal: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' capture: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' customer: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' paymentInstrument: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' shippingAddress: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' instrumentIdentifier: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: 'Status of the sessions request. Possible values:  Created  Failed ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' errorInformation: type: object properties: reason: type: string description: "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - BLOCKED_BY_CARDHOLDER\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n - ACH_VERIFICATION_FAILED\n - DECISION_PROFILE_REVIEW\n - CONSUMER_AUTHENTICATION_REQUIRED\n - CONSUMER_AUTHENTICATION_FAILED\n - ALLOWABLE_PIN_RETRIES_EXCEEDED\n - PROCESSOR_ERROR\n - CUSTOMER_WATCHLIST_MATCH\n - ADDRESS_COUNTRY_WATCHLIST_MATCH\n - EMAIL_COUNTRY_WATCHLIST_MATCH\n - IP_COUNTRY_WATCHLIST_MATCH\n - INVALID_MERCHANT_CONFIGURATION\n - DAGGREJECTED\n - DAGGDENIED\n - DSYSREJECTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' submitLocalDateTime: type: string maxLength: 14 description: 'Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds #### PIN Debit Optional field for PIN Debit purchase and credit requests. ' ownerMerchantId: type: string description: 'Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. ' processorInformation: type: object properties: transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' paymentUrl: type: string maxLength: 2048 description: Direct the customer to this URL to complete the payment. responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' token: type: string maxLength: 24 description: 'Payment gateway/processor assigned session token. ' responseCode: type: string maxLength: 10 description: 'Transaction status from the processor. ' paymentInformation: type: object properties: eWallet: type: object properties: fundingSource: type: string maxLength: 24 description: 'Payment mode for the transaction, possible values - INSTANT_TRANSFER - MANUAL_BANK_TRANSFER - DELAYED_TRANSFER - ECHECK ' orderInformation: type: object properties: amountDetails: type: object properties: totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" '400': description: Invalid request. schema: type: object title: ptsV2PaymentsPost400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2PaymentsPost502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. /pts/v2/payment-references/{id}: patch: summary: Update Alternative Payments Sessions Request description: Update Alternative Payments Sessions Request tags: - payments operationId: UpdateSessionReq x-devcenter-metaData: categoryTag: Payments developerGuides: https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html isMLEsupported: true mleForRequest: optional parameters: - name: createSessionRequest in: body required: true schema: type: object properties: clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' processingInformation: type: object properties: sessionType: type: string maxLength: 5 description: 'Will have 2 values, ''U'' (Update) , ''N'' (New). Any other values will be rejected. Default will be ''N'' ' paymentFlowMode: type: string maxLength: 50 description: 'Whether merchant wants to pass the flow Inline or want to invoke Klarna Hosted Page ' actionList: type: array description: "Possible values are one or more of follows:\n\n - `AP_SESSIONS`: Use this when Alternative Payment Sessions service is requested.\n" items: type: string paymentInformation: type: object properties: card: type: object properties: number: type: string maxLength: 20 description: 'The customer''s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ' expirationMonth: type: string maxLength: 2 description: 'Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' expirationYear: type: string maxLength: 4 description: 'Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. ' type: type: string description: 'Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe''s Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick''s Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam''s Club Consumer - `026`: Sam''s Club Business - `027`: Nico''s - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International ' securityCode: type: string maxLength: 4 description: 'Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional. ' useAs: type: string maxLength: 20 description: "Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect.\nThe cardholder provides this information during the payment process. This field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n\n**China UnionPayCard Transactions on China UnionPay:**\nPossible values:\n - C: Domestic credit card\n - D: Domestic debit card\n - F: International credit card\n - I: International debit card\n\nWhen the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request.\nWhen the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request.\n\n**Cielo and Comercio Latino Credit Card Transactions:**\nOn these processors, this field is supported only for authorizations. Possible values:\n - CR: Credit card\n - DB: Debit card \n\n**Visa Platform Connect Credit Card Transactions:**\nThis field is supported for all card types on Visa Platform Connect.\nFor combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - CR: Credit card\n - DB: Debit Card\n\nFor combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values:\n - C: Credit card\n - D: Debit card\n\nA value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.\n" bank: type: object properties: swiftCode: type: string description: 'Bank''s SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. ' account: type: object properties: number: type: string maxLength: 30 description: 'Account number. When processing encoded account numbers, use this field for the encoded account number. ' iban: type: string maxLength: 50 description: 'International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. ' eWallet: type: object properties: fundingSource: type: string maxLength: 30 description: "Payment method for the unit purchase.\n Possible values:\n UNRESTRICTED (default)—this value is\n available only when configured by PayPal\n for the merchant.\n INSTANT.\n" options: type: object properties: id: type: string maxLength: 255 description: 'Identifier for a PayPal credit transaction. Value: Credit ' paymentType: type: object properties: name: type: string description: 'A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) ' subTypeName: type: string description: 'In case the APM supports multiple modes of initiation (e.g. Alipay via QR Code or Barcode) ' method: type: object properties: name: type: string description: 'A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, bofaPayByBank, payToPayByBank, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data #### Via KCP - `KCP` : Local Card, Bank Transfer and Carrier Billing. - `PAYCO` - `KAKAOPAY` - `NAVERPAY` ' 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''s site, and the payment channel is known. Possible Values: #### Via PPRO - `alfaVa` - `kredivo` - `consumerBarCode` - `merchantQrCode` - `dokuWallet` ' orderInformation: type: object properties: billTo: type: object properties: name: type: string maxLength: 87 description: 'Company Name. ' shipTo: type: object properties: email: type: string maxLength: 60 description: 'Customer''s primary email address, including the full domain name. ' title: type: string description: The title of the person receiving the product. maxLength: 60 firstName: type: string maxLength: 60 description: 'First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' middleName: type: string maxLength: 60 description: 'Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' lastName: type: string maxLength: 60 description: 'Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. ' company: type: string maxLength: 60 description: 'Name of the customer''s company. ' address1: type: string maxLength: 60 description: 'First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' address2: type: string maxLength: 60 description: 'Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' district: type: string maxLength: 50 description: Neighborhood, community, or region within a city or municipality. locality: type: string maxLength: 50 description: 'City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' administrativeArea: type: string maxLength: 50 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: 32 description: 'Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' 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) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder''s location when shipTo objects are not present. ' maxLength: 3 buildingNumber: type: string maxLength: 15 description: 'Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 ' phoneNumber: type: string maxLength: 15 description: Phone number associated with the shipping address. immutable: type: string description: 'Indicates whether customers are permitted to edit the shipping address in their PayPal account. Possible values: - true: Customer cannot edit the shipping address. - false (default): Customer can edit the shipping address. ' maxLength: 100 notApplicable: type: string description: 'Indicates whether the shipping address is displayed to the customer in their PayPal account. Possible values: - true: Shipping address is not displayed. - false (default): Shipping address is displayed. For example, for digital downloads and services in which a shipping address is not required, set the value to true. ' maxLength: 10 county: type: string description: U.S. county if available. maxLength: 30 amountDetails: type: object properties: totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" currency: type: string maxLength: 3 description: 'Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ' discountAmount: type: string maxLength: 15 description: 'Total discount amount applied to the order. ' taxAmount: type: string maxLength: 12 description: 'Total tax amount for all the items in the order. ' dutyAmount: type: string maxLength: 15 description: 'Total charges for any import or export duties included in the order. ' exchangeRate: type: string maxLength: 13 description: 'Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. ' exchangeRateTimeStamp: type: string maxLength: 16 description: 'Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. ' settlementCurrency: type: string maxLength: 3 description: 'This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder''s account. This field is returned for OCT transactions. ' invoiceAmount: type: string maxLength: 12 description: 'Invoice amount. The invoice amount issued by the Merchant to the Cardholder, which includes VAT (excluding items such as TIPS or CASHBACK). For transactions that do not have applicable Benefit Laws, the field may be entered as zeros. This field is only applicable for Uruguay market. Example: 100.00 Uruguay The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 7-18 - Field: Invoice Amount ' giftwrapAmount: type: string maxLength: 19 description: giftwrap amount (RFU). handlingAmount: type: string maxLength: 19 description: handling amount (RFU) shippingAmount: type: string maxLength: 19 description: shipping amount (RFU) shippingDiscountAmount: type: string maxLength: 19 description: shipping discount amount (RFU) insuranceAmount: type: string maxLength: 19 description: insurance amount (RFU) lineItems: type: array items: type: object description: List of the line items from the order, which are included in an invoice. properties: productSku: type: string maxLength: 255 description: 'Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. ' productName: type: string maxLength: 255 description: 'For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' quantity: type: integer minimum: 1 maximum: 999999999 default: 1 description: 'Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. ' unitPrice: type: string maxLength: 15 description: 'Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) ' discountAmount: type: string maxLength: 13 description: Discount applied to the item. discountRate: type: string maxLength: 6 description: 'Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) ' taxAmount: type: string maxLength: 15 description: "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nOptional field.\n\n#### Airlines processing\nTax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s).\nFormat: English characters only.\nOptional request field for a line item.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nNote if you send this field in your tax request, the value in the field will override the tax engine\n" taxRate: type: string maxLength: 7 description: 'Tax rate applied to the item. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). ' totalAmount: type: string maxLength: 13 description: 'Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is "gift_card", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 ' productCode: type: string maxLength: 255 description: 'Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The 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]. ' productDescription: type: string description: Brief description of item. invoiceDetails: type: object properties: costCenter: type: string description: Cost centre of the merchant. productDescription: type: string description: Brief description of item. shippingDetails: type: object properties: shippingMethod: type: string maxLength: 32 description: "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n\nKlarna Advantage Plus additional values:\n - `TO_DOOR`: Delivery to door\n - `TO_CURB`: Delivery to curb\n - `TO_MAILBOX`: Delivery to mailbox\n - `PICKUP_BOX`: Pickup from box\n - `PICKUP_POINT`: Pickup from point\n - `PICKUP_STORE`: Pickup from store\n - `PICKUP_WAREHOUSE`: Pickup from warehouse\n - `DIGITAL_EMAIL`: Digital delivery via email\n - `DIGITAL_DOWNLOAD`: Digital download\n - `DIGITAL_OTHER`: Other digital delivery\n - `PHYSICAL_OTHER`: Other physical delivery\n" buyerInformation: type: object properties: dateOfBirth: type: string maxLength: 8 description: 'Recipient''s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. ' gender: type: string maxLength: 3 description: Customer's gender. Possible values are F (female), M (male),O (other). language: type: string maxLength: 5 description: "language setting of the user. \nSupports 2-character language codes (e.g., en, fr) and 5-character locale values (e.g., en-US, fr-CA).\n" noteToSeller: type: string maxLength: 255 description: Note to the recipient of the funds in this transaction personalIdentification: type: array items: type: object properties: id: type: string maxLength: 26 description: "The value of the identification type. This field is supported only on the following processors.\n\n#### ComercioLatino\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n#### CyberSource Latin American Processing\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. \nIf `type = PASSPORT`, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" deviceInformation: type: object properties: ipAddress: type: string maxLength: 45 description: 'IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. ' deviceType: type: string maxLength: 60 description: The device type at the client side. id: type: string maxLength: 50 description: ../../../commons/definitions/device.yaml#/properties/id userAgent: type: string maxLength: 40 description: 'Customer''s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser. ' merchantInformation: type: object properties: merchantDescriptor: type: object properties: name: type: string description: 'Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder''s statement. When you include more than one consecutive space, extra spaces are removed. **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. **Important** This value must consist of English characters. Required for captures and credits. ' alternateName: type: string maxLength: 13 description: 'An alternate name for the merchant. ' contact: type: string maxLength: 25 description: 'Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) ' address1: type: string maxLength: 60 description: 'First line of merchant''s address. ' locality: type: string maxLength: 30 description: 'Merchant''s City. #### PIN debit City for your business location. This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. ' country: type: string maxLength: 3 description: 'Merchant''s country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder''s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** 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`. Optional field for PIN debit credit or PIN debit purchase. ' postalCode: type: string maxLength: 14 description: 'Merchant''s postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder''s statement. If 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` If 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` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. ' administrativeArea: type: string description: 'The state where the merchant is located. #### PIN debit State 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. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase. ' phone: type: string maxLength: 13 description: 'Merchant phone as contact information for CNP transactions ' url: type: string maxLength: 255 description: 'Address of company''s website provided by merchant ' countryOfOrigin: type: string maxLength: 2 description: '#### Visa Platform Connect This field will indicate merchant country of origin ' storeId: type: string maxLength: 50 description: 'The identifier of the store. ' storeName: type: string maxLength: 50 description: 'The name of the store. ' customerServicePhoneNumber: type: string maxLength: 27 description: '#### Visa Platform Connect Indicates customer service phone number of Merchant. ' cancelUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction successUrl: type: string maxLength: 2048 description: customer would be redirected to this url based on the decision of the transaction failureUrl: type: string maxLength: 255 description: customer would be redirected to this url based on the decision of the transaction noteToBuyer: type: string maxLength: 25 description: Free-form text field. userInterface: type: object properties: borderRadius: type: string maxLength: 19 description: 'Border Radius, Allowed Values - Number, Chars, SPACE, Percentage(%), DOT(.), Example ''25px 10px 25px 10px''; ''2em 1em 0.5em 3em'' ' theme: type: string maxLength: 19 description: 'UI Theme Name/Design Name - Allowed Chars: Alpha Numeric, Dot (.), Hyphen (-), Underscore (_) ' color: type: object properties: border: type: string description: 'Border Color ' maxLength: 10 borderSelected: type: string description: 'Selected Border Color ' maxLength: 10 button: type: string description: 'Button Color ' maxLength: 10 buttonText: type: string description: 'Button Text Color ' maxLength: 10 checkbox: type: string description: 'Checkbox Color ' maxLength: 10 checkboxCheckMark: type: string description: 'Checkbox Checkmark Color ' maxLength: 10 header: type: string description: 'Header Color ' maxLength: 10 link: type: string description: 'Link Color ' maxLength: 10 text: type: string description: 'Text Color ' maxLength: 10 merchantDefinedInformation: type: array description: 'The object containing the custom data that the merchant defines. ' items: type: object properties: key: type: string maxLength: 50 description: 'The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. ' value: type: string maxLength: 800 description: "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" agreementInformation: type: object properties: indicator: type: string description: 'Indicates whether the transaction is a billing agreement. Possible values - true - false (default) ' description: type: string description: Description of the billing agreement travelInformation: type: object properties: autoRental: type: object properties: companyName: type: string maxLength: 50 description: 'Merchant to send their auto rental company name ' affiliateName: type: string maxLength: 50 description: 'When merchant wants to send the affiliate name. ' rentalAddress: type: object properties: city: type: string maxLength: 25 description: 'City in which the auto was rented. For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for American Express. For all other card types, this field is ignored. ' state: type: string maxLength: 3 description: 'State in which the auto was rented. 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). ' country: type: string maxLength: 3 description: 'Country where the auto was rented. Use the [ISO Standard Country Codes.](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This field is supported only for American Express. ' locationId: type: string maxLength: 10 description: 'The agency code, address, phone number, etc., used to identify the location where the vehicle was rented. ' address1: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' address2: type: string maxLength: 13 description: 'Address from where the vehicle was rented. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where a taxi passenger was picked up or where an auto rental vehicle was picked up. In most cases, this is the rental agency''s business name that appears on the storefront and/or customer receipts, commonly referred to as the DBA (Doing Business As) name. However, if the vehicle was picked up at another location (e.g., a hotel,auto dealership, repair shop, etc.), the name of that location should be used. This entry must be easily recognized by the Cardmember to avoid unnecessary inquiries. If the name is more than 38 characters, use proper and meaningful abbreviation, when possible. ' returnAddress: type: object properties: city: type: string maxLength: 25 description: 'City where the auto was returned to the rental agency. ' state: type: string maxLength: 3 description: 'State in which the auto was returned to the rental agency. 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). For authorizations, this field is supported for Visa, MasterCard, and American Express. For captures, this field is supported only for MasterCard and American Express. ' country: type: string maxLength: 3 description: 'Country where the auto was returned to the rental agency. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). ' locationId: type: string maxLength: 10 description: 'Code, address, phone number, etc. used to identify the location of the auto rental return. This field is supported only for MasterCard and American Express. ' address1: type: string maxLength: 50 description: 'When merchant wants to send the rental address''s street address. ' postalCode: type: string maxLength: 50 description: 'When merchant wants to send the return address''s postal code. ' location: type: string maxLength: 38 description: 'This field contains the location where the taxi passenger was dropped off or where the auto rental vehicle was returned. ' returnDateTime: type: string maxLength: 21 description: 'Date/time the auto was returned to the rental agency. Format: ``yyyy-MM-dd HH-mm-ss z`` This field is supported for Visa, MasterCard, and American Express. ' rentalDateTime: type: string maxLength: 21 description: 'Date/time the auto was picked up from the rental agency. Format: `yyyy-MM-dd HH-mm-ss z` This field is supported for Visa, MasterCard, and American Express. ' customerName: type: string maxLength: 40 description: 'Name of the individual making the rental agreement. Valid data lengths by card: |Card Specific Validation|VISA|MasterCard|Discover|AMEX| |--- |--- |--- |--- | | Filed Length| 40| 40| 29| 26| | Field Type| AN| ANS| AN| AN| | M/O/C| O| M| M| M| ' - name: id in: path description: The payment ID. This ID is returned from a previous payment request. required: true type: string x-example: example0: summary: Alternative Payments Create Sessions Request sample-name: Create Sessions Request value: clientReferenceInformation: code: TC0824-06 processingInformation: actionList: AP_SESSIONS orderInformation: amountDetails: totalAmount: '1999.99' currency: USD paymentInformation: paymentType: method: name: KLARNA name: invoice responses: '201': description: Successful response. schema: title: ptsV2PaymentsPost201Response type: object properties: _links: type: object properties: self: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' reversal: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' capture: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' customer: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' paymentInstrument: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' shippingAddress: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' instrumentIdentifier: type: object properties: href: type: string description: This is the endpoint of the resource that was created by the successful request. method: type: string description: '`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.' id: type: string maxLength: 26 description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. ' submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: 'Status of the sessions request. Possible values:  Created  Failed ' reconciliationId: type: string maxLength: 60 description: 'Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. ' errorInformation: type: object properties: reason: type: string description: "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - BLOCKED_BY_CARDHOLDER\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n - PENDING_AUTHENTICATION\n - ACH_VERIFICATION_FAILED\n - DECISION_PROFILE_REVIEW\n - CONSUMER_AUTHENTICATION_REQUIRED\n - CONSUMER_AUTHENTICATION_FAILED\n - ALLOWABLE_PIN_RETRIES_EXCEEDED\n - PROCESSOR_ERROR\n - CUSTOMER_WATCHLIST_MATCH\n - ADDRESS_COUNTRY_WATCHLIST_MATCH\n - EMAIL_COUNTRY_WATCHLIST_MATCH\n - IP_COUNTRY_WATCHLIST_MATCH\n - INVALID_MERCHANT_CONFIGURATION\n - DAGGREJECTED\n - DAGGDENIED\n - DSYSREJECTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" clientReferenceInformation: type: object properties: code: type: string maxLength: 59 description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ' submitLocalDateTime: type: string maxLength: 14 description: 'Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds #### PIN Debit Optional field for PIN Debit purchase and credit requests. ' ownerMerchantId: type: string description: 'Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. ' processorInformation: type: object properties: transactionId: type: string maxLength: 255 description: 'Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "processorInformation.networkTransactionId" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 ' paymentUrl: type: string maxLength: 2048 description: Direct the customer to this URL to complete the payment. responseDetails: type: string maxLength: 255 description: 'This field might contain information about a decline. ' token: type: string maxLength: 24 description: 'Payment gateway/processor assigned session token. ' responseCode: type: string maxLength: 10 description: 'Transaction status from the processor. ' paymentInformation: type: object properties: eWallet: type: object properties: fundingSource: type: string maxLength: 24 description: 'Payment mode for the transaction, possible values - INSTANT_TRANSFER - MANUAL_BANK_TRANSFER - DELAYED_TRANSFER - ECHECK ' orderInformation: type: object properties: amountDetails: type: object properties: totalAmount: type: string maxLength: 19 description: "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing / Pay By Link\nRequired for creating a new invoice or payment link.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. \n\n#### DCC for First Data\nNot used.\n" '400': description: Invalid request. schema: type: object title: ptsV2PaymentsPost400Response properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - NOT_SUPPORTED\n" message: type: string description: The detail message related to the status and reason listed above. details: type: array items: type: object properties: field: type: string description: This is the flattened JSON object field name/path that is either missing or invalid. reason: type: string description: "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" '502': description: Unexpected system error or system timeout. schema: title: ptsV2PaymentsPost502Response type: object properties: submitTimeUtc: type: string description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. ' status: type: string description: "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" reason: type: string description: "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" message: type: string description: The detail message related to the status and reason listed above. x-devcenter-metaData: categoryTagArray: - name: Payments description: For more information about Payments transactions, see the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). - name: Transaction_Batches description: For more information about Transaction Batches, see the [Transaction Batches Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-transaction-batch-api/txn_batch_api_intro.html). - name: eCheck_AVS description: For more information about eCheck Account Validation, see the [Account Validation Developer Guides Page](https://...). - name: Token_Management description: For more information about the Token Management Service (TMS) see the [Token Management Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/all/rest/tms/tms-overview.html) - name: Flex_Microform description: Microform Integration is a lightweight acceptance solution designed to safely and securely accept payment information within your web page. Microform is designed to a be embedded seamlessly within your existing webpage experience, blending in with your existing acceptance form. This solution allows for the replacement of sensitive payment date with a transient token (a short lived reference to the sensitive payment data). 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=) - name: Flex_API description: For more information about Flex API, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/digital-accept-flex/developer/all/rest/digital-accept-flex/da-flex-api-intro.html). - name: Risk_Management - name: Payouts description: 'For more information about Payouts, see the [Payouts Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payouts/Introduction.html). ' - name: Installments description: For more information about Installment contact Cybersource Support. For Visa installments contact VISthroughCYBS@visa.com - name: Recurring_Billing_Subscriptions description: For more information about Recurring Billing, see the [Recurring Billing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-developer/recur-bill-services-intro.html). - name: BIN_Lookup description: 'The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks (such as Visa, American Express, Discover and regional networks) which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant. ' - name: Transaction_Details description: For more information about Transaction Details, see the [Transaction Details Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_details_api.html). - name: Transaction_Search description: For more information about Transaction Search, see the [Transaction Search Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api.html). - name: Reporting description: 'For more information about Reporting, see the [Reporting Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-reporting-rest-api-dev-guide-102718/reporting_api.html). ' - name: Secure_File_Share description: For more information about Secure File Share, see the [Secure File Share Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html). - name: Invoices description: For more information about Invoicing, see the [Invoicing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/invoicing/developer/all/rest/invoicing/Introduction.html). - name: Pay_By_Link description: For more information about PayByLink, see the [PBL Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/boarding/user/all/rest/boarding/templates-matrix-intro/templates-matrix-pay-by-link.html). - name: User_Management description: For more information about User Management, see the [User Managment Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-user-management-api-102718/user_management_api_intro.html). - name: Value_Added_Service - name: Fee Service - name: Merchant_Boarding description: For more information about Merchant Boarding, please see [Developer Guides Page](https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html). - name: Webhooks description: For more information about Webhooks, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html). - name: Unified_Checkout description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). - name: Unified_Checkoutv1 description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html). - name: Account_Updater description: For more information about Account Updater, see the [Account Updater Developer Guides Page:](https://developer.cybersource.com/library/documentation/dev_guides/Account_Updater_UG/html/index.html). - name: Visa_Bank_Account_Validation description: 'The Visa Bank Account Validation Service is a new standalone product designed to validate customer''s routing and bank account number combination for ACH transactions. Merchant''s can use this standalone product to validate their customer''s account prior to processing an ACH transaction against the customer''s account to comply with Nacha''s account validation mandate for Web-debit transactions. ' - name: Currency Conversion description: 'Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates and clear cost disclosure. **Key Benefits:** - **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers. - **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules. - **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture. - **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent. Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce. **Key Features:** - **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization. - **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant''s local currency and their card''s billing currency. - **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc. **Supported Scenarios:** - Dynamic Currency Conversion when cardholder''s billing currency differs from merchant''s pricing currency. - Merchant and acquirer must support the cardholder''s billing currency. **Core API Endpoints:** **Currency Conversion API** Returns eligibility and exchange rate details, including: - exchangeRate - marginRate - reconciliationId and Id (for subsequent payment requests) **Payment Authorization with DCC*** POST /pts/v2/payments Required fields include: - orderInformation.amountDetails.currency - orderInformation.amountDetails.originalCurrency - orderInformation.amountDetails.originalAmount - orderInformation.amountDetails.exchangeRate - currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined) **Capture with DCC*** POST /pts/v2/payments/{id}/captures Maps from original authorization and includes original and converted amounts. **Refund with DCC*** POST /pts/v2/captures/{id}/refunds Maps from original authorization and includes original and converted amounts. *Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information. **Compliance & Disclosure:** Merchants must: - Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions. - Display the converted amount, exchange rate, and markup percentage and other required disclosures. - Obtain explicit cardholder consent before applying DCC. - Work with your acquirer to obtain full set of compliance requirements. For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html). ' - name: Intelligent_Commerce_Connect description: For more information about Intelligent Commerce Cross Network Service API, please see [Developer Guides](https://developer.cybersource.com/docs/cybs/en-us/intelligent-commerce/developer/all/rest/intelligent-commerce/intelligent-commerce-about-guide.html).