On This Page {#jumplink-list} [Markdown](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials.md) Credentialed Transactions Developer Guide {#credentials-about-guide} ==================================================================== This section describes how to use this developer guide and where to find further information. Audience and Purpose : This guide is written for application developers who want to use the `REST API` to integrate payment card processing using credentials into an order management system. Implementing the `Visa Acceptance Solutions` payment services requires software development skills. You must write code that uses the API request and response fields to integrate the credit card services into your existing order management system. Convention : This statement appears in this document: > IMPORTANT > An *Important* statement contains information essential to successfully completing a task or learning a concept. Customer Support : For support information about any service, visit the Support Center: Recent Revisions to This Document {#credentials-doc-revisions} ============================================================== 26.02.01 -------- Added industry and use case information to the introduction topics. See [Industry Practice Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-intro/credentials-mit-industry.md "") and [Standing Instruction Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-intro/credentials-intro-stdinst.md ""). 25.12.01 -------- This revision contains only editorial changes and no technical updates. 25.11.01 -------- Removed Mastercard required field for retrieving customer credentials during a CIT request. See [Using Stored Customer Credentials During a CIT](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-cit-intro/credentials-cit-using-intro.md ""). Introduction to Credentialed Transactions {#credentials-intro} ============================================================== Credentialed transactions, also known as credentials‑on‑file (COF) or card‑on‑file transactions, are payments that either store a customer's payment credentials for future use or use previously stored credentials to complete a transaction. All COF transactions begin with a customer-initiated transaction, in which the customer actively participates, such as a card‑present purchase, online checkout, or use of a stored credential. Benefits of Credentialed Transactions ------------------------------------- Merchants following the stored credentials framework experience these benefits: * Better visibility into transaction risk. * Improved authorization success rates. * A smoother customer experience. * Fewer disputes and customer complaints. * Use of Real Time Visa Account Updater for fresher card details. For more information on the stored credentials framework, see [Improving Authorization Management for Transactions with Stored Credentials](https://usa.visa.com/dam/VCOM/global/support-legal/documents/stored-credential-transaction-framework-vbs-10-may-17.pdf ""). Types of Credentialed Transactions ---------------------------------- There are several types of credentialed transactions: * **Customer-initiated transaction (CIT):** During a CIT, customers can elect to have their credentials stored for future CITs or for merchant‑initiated transactions (MITs). * **Merchant-initiated transaction (MIT):** A MIT is processed without the customer's active involvement and include these transactions: * **Industry practice transaction:** This MIT is performed as a subsequent transaction to a CIT because the initial transaction could not be completed in one transaction. Not every industry practice transaction involves a stored credential. If a stored credential is used only for one transaction, that transaction is not considered a credentialed transaction. * **Standing instruction transactions:** This MIT is performed to follow agreed-upon instructions from the customer for the provision of goods and services. Industry Practice Transactions {#credentials-mit-industry} ========================================================== Industry practice transactions are MITs performed as follow‑on actions to a previous CIT. Although not all of them require stored credentials, repeated use of credentials qualifies them as COF transactions. These industry practice transactions and industry examples are available with your processor: `Business Center` Transactions ------------------------------ You can create an industry practice transaction in the `Business Center` by requesting a new authorization. Go to the Transaction Management section and confirm that the new authorization is a MIT. Choose one of these reason types for the authorization: * Account Top Up * Delayed Charges * No Show * Reauthorization * Resubmission This process requires you to have already stored the customer's credentials from a previous customer-initiated transaction. For more information on storing a customer's credentials in the `Business Center`, see [Customer-Initiated Transactions with Credentials on File](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-cit-intro.md ""). To create an incremental transaction in the `Business Center`, choose one of these options: * Account Top Up * No Show Standing Instruction Transactions {#credentials-intro-stdinst} ============================================================== Standing instruction transactions are MITs that rely on stored credentials and follow agreed‑upon customer instructions for scheduled or ongoing payments. These transactions must comply with the stored credentials framework, which ensures secure storage and use of customer payment data. All standing instruction transactions begin with a CIT, when customers elect to store their credentials. These standing instruction transactions and industry examples are available with your processor: * [Unscheduled COF](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ucof-intro.md ""): Occasional, non‑scheduled charges that are made under a customer authorization for these industries: * Rideshare and transportation: cleaning fees, damage fees * Home services: irregular invoice-based jobs, such as repairs * Professional services: unplanned billable hours or fees * E‑commerce: back-order fulfillment outside a schedule * [Installments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-install-intro.md ""): A fixed purchase that is split into multiple scheduled payments for these industries: * Retail and electronics: installment plans for device purchases * Furniture and home goods: multi‑month payment plans * Education: tuition installment schedules * Healthcare financing: payment plans for procedures * [Recurring](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-recur-intro.md ""): Repeated charges for ongoing services for these industries: * Streaming services: video, music, gaming subscriptions * Fitness and wellness: gym memberships, coaching subscriptions * Insurance: monthly premiums * Software and SaaS: business application licenses * [Subscription Transactions for Mastercard](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""): Mastercard‑specific recurring billing for subscription‑based services for these industries: * Digital media: news, magazines, premium content * Subscription boxes: food kits, beauty boxes, hobby crates * Online services: cloud storage, identity monitoring * Educational platforms: e‑learning subscriptions * [Standing Order Transactions for Mastercard](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md ""): Merchant‑initiated charges made at regular, agreed-upon intervals for these industries: * Utilities: monthly electricity, water, gas payments * Telecommunications: phone and internet service billing * Loan and mortgage payments: fixed monthly obligations * Charitable donations: recurring monthly contributions Requirements for Standing Instruction Transactions {#credentials-reqs} ====================================================================== Merchants who offer stored credentials must: * Disclose to cardholders how their credentials will be used. * Obtain the customer's consent to store their credentials. * Notify customers when the terms of use change. * Inform the card issuer during an authorization that the credentials are stored on file. * Identify all transactions that use stored credentials. {#credentials-reqs_ul_j2t_dqy_3tb} Recurring Billing for Recurring Payments {#credentials-mit-recur-rb} ==================================================================== If you are using the Recurring Billing service, do not use this document. `Visa Acceptance Solutions` saves and stores payment credentials for recurring transactions, ensuring compliance with COF best practices. Transaction-Specific Fields {#credentials-matrix} ================================================= To make an authorization request into a credentialed transaction, you must include additional fields that inform `Visa Acceptance Solutions` to either store the customer's payment information for future use, or to use an already stored card-on-file for the payment. This section describes the additional required fields that create an initial and subsequent credentialed transaction. Initial Transactions -------------------- For an initial transaction, include these fields with a standard authorization request: processingInformation.authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction.reason : Some processors and card types require a reason code when storing payment credentials. processingInformation. authorizationOptions. initiator. type : Set the value to `customer`. processingInformation. commerceIndicator : Set to one of these possible values: * `internet`: Online transaction. * `MOTO`: Mail order/telephone order transaction. * A payer authentication value. See [Payer Authentication Values](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/credentials-ref-info-payerauth.md ""). {#credentials-matrix_ul_ejm_5rv_yhc} {#credentials-matrix_dl_jjm_5rv_yhc} ``` { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "type": "customer", "credentialStoredOnFile": true, "merchantInitiatedTransaction": { "reason": "7" } } } } } ``` When you receive the initial transaction response, save the transaction identifier, which is located in the id field. You need the transaction identifier for subsequent transactions. If you are using the Token Management Service (TMS), `Visa Acceptance Solutions` stores the transaction identifier for you. This table shows the fields required for each type of CIT and initial transaction. Subsequent Transactions ----------------------- For a subsequent transaction, include these fields with a standard authorization request: processingInformation.authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID : * American Express: Set the value to the transaction ID from the original transaction. * Discover: Set the value to the transaction ID from the original transaction. * Visa: set the value to the last successful transaction ID. processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction.reason : Some processors and card types require a reason code when you use stored payment credentials. processingInformation. authorizationOptions. initiator. storedCredentialUsed : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `merchant` for MIT transactions. processingInformation. commerceIndicator : Set to one of these possible values: * `install`: Installment payment * `internet`: E-commerce order * `MOTO`: Mail order or telephone order * `recurring`: Recurring payment * A payer authentication value. See [Payer Authentication Values](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/credentials-ref-info-payerauth.md ""). {#credentials-matrix_ul_drx_ds1_zhc} {#credentials-matrix_dl_crx_ds1_zhc} ``` { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "type": "merchant", "storedCredentialUsed": true, "merchantInitiatedTransaction": { "reason": "7", "previousTransactionId": "123456789123" } } } } } ``` {#credentials-matrix_codeblock_sx1_gyb_tvb} This table shows the values for subsequent authorization fields. IMPORTANT Certain processors do not support all of the following transaction types. Customer-Initiated Transactions with Credentials on File {#credentials-cit-intro} ================================================================================= A customer-initiated transaction (CIT) is a transaction initiated by the customer. There are two types of CITs: * Customer transactions during which the credentials are stored for future **customer**-initiated transactions. * Customer transactions during which the credentials are stored for future **merchant**-initiated transactions. Customers can initiate a CIT at a merchant payment terminal, through an online purchase transaction, or by making a purchase using a previously stored credential. When storing cardholder data for a CIT, you must also include 3-D Secure authentication credentials to ensure that the CIT can successfully process. Authentication credentials can be stored for future use with the card credentials by doing a non-payment authentication (NPA). `Business Center` ----------------- You can create a new customer-initiated transaction in the `Business Center` by going to the One-Time Payments section and requesting a new authorization. When you have entered the customer's information, you can store the customer's credentials with the customer's permission in the Payment Information section. By doing so, you can perform merchant-initiated transactions for payments that the customer has pre-approved. Storing Customer Credentials with a CIT and PAN {#credentials-cit-storing-intro} ================================================================================ Before you can perform a merchant-initiated transaction (MIT) or a customer-initiated transaction (CIT) with credentials-on-file (COF), you must store the customer's credentials for later use. Further, before you can store the user's credentials, you must get the customer's consent to store their private information. This is also known as establishing a relationship with the customer. Endpoint {#credentials-cit-storing-intro_d8e16} ----------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-cit-storing-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-cit-storing-intro_d8e35} Required Fields for Storing Customer Credentials During a CIT {#credentials-cit-storing-required} ================================================================================================= > IMPORTANT > When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see [Relaxed Requirements for Address Data and Expiration Date in Payment Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/payments-relax-reqs.md ""). orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. REST Example: Storing Customer Credentials During a CIT {#credentials-cit-storing-ex-rest} ========================================================================================== Request ```keyword { "processingInformation": { "authorizationOptions": { "initiator": { "credentialStoredOnFile": "true" } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "email": "test@vas.com", "phoneNumber": "5554327113" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6528187198946076303004" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/captures" } }, "clientReferenceInformation": { "code": "1652818719876" }, "id": "6528187198946076303004", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "63165088Z3AHV91G", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-17T20:18:40Z" } ``` Storing Customer Credentials with a CIT and `TMS` {#credentials-cit-initial-tms-intro} ====================================================================================== Before you can perform a merchant-initiated transaction (MIT) or a customer-initiated transaction (CIT) with credentials-on-file (COF), you must get the customer's consent to store their payment credentials. This is also known as establishing a relationship with the customer. After you have their consent, you can store their payment credentials for later use. Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Endpoint {#credentials-cit-initial-tms-intro_d8e16} --------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-cit-initial-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-cit-initial-tms-intro_d8e35} Required Fields for Storing Customer Credentials with a CIT and `TMS` {#credentials-cit-initial-tms-req-fields} =============================================================================================================== > IMPORTANT > When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see [Relaxed Requirements for Address Data and Expiration Date in Payment Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/payments-relax-reqs.md ""). orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE` processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymnentInstrument` {#credentials-cit-initial-tms-req-fields_ul_lpg_4mc_1dc} REST Example: Storing Customer Credentials with a CIT and `TMS` {#credentials-cit-initial-tms-ex-rest} ====================================================================================================== Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "instrumentIdentifier" ] }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031", "securityCode": "123" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "4158880000" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6972267090226779103955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6972267090226779103955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6972267090226779103955/captures" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6972267090226779103955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62506622XNMR6Q1Y", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-13T19:51:49Z", "tokenInformation": { "instrumentidentifierNew": false, "instrumentIdentifier": { "state": "ACTIVE", "id": "7010000000016241111" } } } ``` Using Stored Customer Credentials During a CIT {#credentials-cit-using-intro} ============================================================================= After customers store their credentials on file, you can retrieve these credentials to use with subsequent transactions when the customer is present. Endpoint {#credentials-cit-using-intro_d8e16} --------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-cit-using-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-cit-using-intro_d8e35} Required Fields for Using Customer Credentials During a CIT {#credentials-cit-using-required} ============================================================================================= > IMPORTANT > When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see [Relaxed Requirements for Address Data and Expiration Date in Payment Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/payments-relax-reqs.md ""). orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.authorizationOptions. initiator. storedCredentialUsed : Set the value to `true`. Card-Specific Required Field for Retrieving Customer Credentials During a MIT {#credentials-install-mit-card-type} ================================================================================================================== Discover -------- Discover requires the authorization amount from the original transaction in addition to the above required fields. processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction. originalAuthorizedAmount : REST Example: Using Customer Credentials During a CIT {#credentials-cit-using-ex-rest} ====================================================================================== Request ```keyword { "processingInformation": { "authorizationOptions": { "initiator": { "storedCredentialUsed": "true" } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "email": "test@vas.com", "phoneNumber": "5554327113" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC", "originalAmount": "100" // Discover card Only } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } }, "processorInformation": { "transactionId": "12345678961000" } } ``` Response to a Successful Request ``` }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "63740353A3AJ2NSH", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T19:13:06Z" } ``` Installment Payments {#credentials-install-intro} ================================================= An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer. The agreement enables you to charge a specific amount at specified intervals. Installments Service for Installment Payments {#credentials-install-intro_install-service} ------------------------------------------------------------------------------------------ > IMPORTANT > Do not use this document if you are using the Installments service. When using the Installments service, ` Visa Acceptance Solutions ` saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices. Customer-Initiated Installment Payments with PAN {#credentials-mit-cit-install-initial-intro} ============================================================================================= An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer, and sometimes, the issuing bank. The agreement enables you to charge a specific amount at specified intervals. For customers, installment payments provide greater purchasing power and lower impact on their monthly budget. For you, offering installment payments at checkout can help increase the number of successfully completed purchases. Before you can accept installment payments, you and your acquirer must agree on the maximum number of installments you can accept, which can be different for each card type. > IMPORTANT > Do not use this document if you are using the Installments service. When using the Installments service, ` Visa Acceptance Solutions ` saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * Discover * Mastercard * Visa Endpoint {#credentials-mit-cit-install-initial-intro_d8e16} ----------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-install-initial-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-install-initial-intro_d8e35} Successful Response ------------------- You must store the *network transaction ID* from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the processorInformation.networkTransactionId field value. Store the *network transaction ID* , which is the processorInformation.networkTransactionId field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT. Required Fields for Initial Customer-Initiated Installment Payment with a PAN {#credentials-mit-install-initial-reqfields} ========================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation. authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `customer`. processingInformation. commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. Card-Specific Required Fields for Authorizing Initial Installment Payments {#credentials-mit-install-initial-reqfields_initial-cit-card} ---------------------------------------------------------------------------------------------------------------------------------------- Use this required field if you are authorizing an initial installment payment using the card type referenced below. Mastercard : processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.reason : Set the value to `9`. REST Example: Authorizing Initial Customer-Initiated Installment Payments with a PAN {#credentials-mit-install-initial-ex-rest} =============================================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "type": "customer", "credentialStoredOnFile": "true", "merchantInitiatedTransaction": { "reason": "9" //Mastercard only } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6528187198946076303004" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/captures" } }, "clientReferenceInformation": { "code": "1652818719876" }, "id": "6528187198946076303004", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "63165088Z3AHV91G", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-17T20:18:40Z" } ``` Customer-Initiated Installment Payment with `TMS` {#credentials-install-cit-tms-iid-intro} ========================================================================================== An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer, and sometimes, the issuing bank. The agreement enables you to charge a specific amount at specified intervals. For customers, installment payments provide greater purchasing power and lower impact on their monthly budget. For you, offering installment payments at checkout can help increase the number of successfully completed purchases. Before you can accept installment payments, you and your acquirer must agree on the maximum number of installments you can accept, which can be different for each card type. > IMPORTANT > Do not use this document if you are using the Installments service. When using the Installments service, ` Visa Acceptance Solutions ` saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-install-cit-tms-iid-intro_d7e156} {#credentials-install-cit-tms-iid-intro_d7e156} * Carta Si{#credentials-install-cit-tms-iid-intro_d7e159} {#credentials-install-cit-tms-iid-intro_d7e159} * Cartes Bancaires{#credentials-install-cit-tms-iid-intro_d7e162} {#credentials-install-cit-tms-iid-intro_d7e162} * Dankort{#credentials-install-cit-tms-iid-intro_d7e165} {#credentials-install-cit-tms-iid-intro_d7e165} * Delta{#credentials-install-cit-tms-iid-intro_d7e168} {#credentials-install-cit-tms-iid-intro_d7e168} * Discover{#credentials-install-cit-tms-iid-intro_d7e172} {#credentials-install-cit-tms-iid-intro_d7e172} * Eurocard{#credentials-install-cit-tms-iid-intro_d7e175} {#credentials-install-cit-tms-iid-intro_d7e175} * JCB{#credentials-install-cit-tms-iid-intro_d7e178} {#credentials-install-cit-tms-iid-intro_d7e178} * Maestro (UK Domestic){#credentials-install-cit-tms-iid-intro_d7e181} {#credentials-install-cit-tms-iid-intro_d7e181} * Mastercard{#credentials-install-cit-tms-iid-intro_d7e184} {#credentials-install-cit-tms-iid-intro_d7e184} * Visa{#credentials-install-cit-tms-iid-intro_d7e187} {#credentials-install-cit-tms-iid-intro_d7e187} * Visa Electron{#credentials-install-cit-tms-iid-intro_d7e191} {#credentials-install-cit-tms-iid-intro_d7e191} Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Endpoint {#credentials-install-cit-tms-iid-intro_d8e16} ------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-install-cit-tms-iid-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-install-cit-tms-iid-intro_d8e35} Required Fields for CIT Installment Payments with TMS {#credentials-install-cit-tms-iid-reqfields} ================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymnentInstrument` processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. {#credentials-install-cit-tms-iid-reqfields_dl_cbq_dwl_bwb} Card-Specific Required Fields for Authorizing Initial Installment Payments {#credentials-install-cit-tms-iid-reqfields_section_sqm_shj_mxb} ------------------------------------------------------------------------------------------------------------------------------------------- Use this required field if you are authorizing an initial installment payment using the card type referenced below. Mastercard : processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.reason : Set the value to `9`. REST Example: CIT Installment Payment with TMS {#credentials-install-cit-tms-iid-ex-rest} ========================================================================================= Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "instrumentIdentifier" ], "commerceIndicator": "internet" }, "paymentInformation": { "card": { "number": "411111111111XXXX", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "4158880000" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6972267090226779103955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6972267090226779103955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6972267090226779103955/captures" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6972267090226779103955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62506622XNMR6Q1Y", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-13T19:51:49Z", "tokenInformation": { "instrumentidentifierNew": false, "instrumentIdentifier": { "state": "ACTIVE", "id": "7010000000016241111" } } } ``` Customer-Initiated Installment Payment with Enrollable Network Tokens {#credentials-install-cit-dw-intro} ========================================================================================================= An installment payment is a single purchase of goods or services billed to a customer in multiple transactions over a period of time agreed to by you and the customer, and sometimes, the issuing bank. The agreement enables you to charge a specific amount at specified intervals. For customers, installment payments provide greater purchasing power and lower impact on their monthly budget. For you, offering installment payments at checkout can help increase the number of successfully completed purchases. > IMPORTANT > Do not use this document if you are using the Installments service. When using the Installments service, ` Visa Acceptance Solutions ` saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices. Using Enrollable Network Tokens ------------------------------- The `Token Management Service` can enroll certain *network tokens* , known as device tokens, into an instrument identifier token for future payments. *Device tokens* store and encrypt card-on-file information which enables customers to make quick and easy purchases using their mobile device. When authorizing a credentialed payment with a device token, you must create and store the device token in a `TMS` instrument identifier token. To do this, include the device token information in the paymentInformation.tokenizedCard fields and set the token creation fields to create an instrument identifier token. Follow-on merchant-initiated transactions are performed using the created instrument identifier as the payment information. For more information about how to request a merchant-initiated transaction, see [Merchant-Initiated Installment Payment with TMS](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-install-intro/credentials-install-mit-tms-intro.md ""). Device tokens are also known as *digital payments* , *digital wallets* , and *tokenized cards*. Network Token Types ------------------- In your request, include the processingInformation.paymentSolution field to identify the device token type you are using, and set it to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-install-cit-dw-intro_d13e71} {#credentials-install-cit-dw-intro_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-install-cit-dw-intro_d13e76} {#credentials-install-cit-dw-intro_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. {#credentials-install-cit-dw-intro_d13e67} Endpoint {#credentials-install-cit-dw-intro_d8e16} -------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-install-cit-dw-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-install-cit-dw-intro_d8e35} Required Fields for a CIT Installment Payment with Enrollable Network Tokens {#credentials-install-cit-dw-reqfields} ==================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.tokenizedCard.expirationMonth : paymentInformation.tokenizedCard.expirationYear : paymentInformation.tokenizedCard.number : paymentInformation.tokenizedCard.transactionType : Set the value to `1`. processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set the value to `instrumentIdentifier`. processingInformation.commerceIndicator : Set the value to `internet`. processingInformation.paymentSolution : Set to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-install-cit-dw-reqfields_d13e71} {#credentials-install-cit-dw-reqfields_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-install-cit-dw-reqfields_d13e76} {#credentials-install-cit-dw-reqfields_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. > IMPORTANT > When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see [Relaxed Requirements for Address Data and Expiration Date in Payment Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/payments-relax-reqs.md ""). REST Example: CIT Installment Payments with Enrollable Network Tokens {#credentials-install-cit-dw-ex-rest} =========================================================================================================== Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "instrumentIdentifier" ], "commerceIndicator": "internet", "paymentSolution": "001" }, "paymentInformation": { "tokenizedCard": { "number": "4111111111111111", "expirationMonth": "02", "expirationYear": "2025", "transactionType": "1" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "locality": "Austin", "administrativeArea": "TX", "postalCode": "78757", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/7094060020036241803954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/captures" } }, "clientReferenceInformation": { "code": "1709406002076" }, "id": "7094060020036241803954", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "60616704ST7Q27K2", "status": "AUTHORIZED", "submitTimeUtc": "2024-03-02T19:00:02Z", "tokenInformation": { "instrumentidentifierNew": false, "instrumentIdentifier": { "state": "ACTIVE", "id": "7010000000016241111" } } } ``` Merchant-Initiated Installment Payments with PAN {#credentials-mit-install-subsequent-intro} ============================================================================================ After the initial CIT installment payment, subsequent installment payments are merchant-initiated transactions (MITs). Prerequisites ------------- The first transaction in an installment payment is a *customer-initiated transaction* (CIT). Before you can perform a subsequent *merchant-initiated transaction* (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-mit-install-subsequent-intro_d7e156} {#credentials-mit-install-subsequent-intro_d7e156} * Carta Si{#credentials-mit-install-subsequent-intro_d7e159} {#credentials-mit-install-subsequent-intro_d7e159} * Cartes Bancaires{#credentials-mit-install-subsequent-intro_d7e162} {#credentials-mit-install-subsequent-intro_d7e162} * Dankort{#credentials-mit-install-subsequent-intro_d7e165} {#credentials-mit-install-subsequent-intro_d7e165} * Delta{#credentials-mit-install-subsequent-intro_d7e168} {#credentials-mit-install-subsequent-intro_d7e168} * Discover{#credentials-mit-install-subsequent-intro_d7e172} {#credentials-mit-install-subsequent-intro_d7e172} * Eurocard{#credentials-mit-install-subsequent-intro_d7e175} {#credentials-mit-install-subsequent-intro_d7e175} * JCB{#credentials-mit-install-subsequent-intro_d7e178} {#credentials-mit-install-subsequent-intro_d7e178} * Maestro (UK Domestic){#credentials-mit-install-subsequent-intro_d7e181} {#credentials-mit-install-subsequent-intro_d7e181} * Mastercard{#credentials-mit-install-subsequent-intro_d7e184} {#credentials-mit-install-subsequent-intro_d7e184} * Visa{#credentials-mit-install-subsequent-intro_d7e187} {#credentials-mit-install-subsequent-intro_d7e187} * Visa Electron{#credentials-mit-install-subsequent-intro_d7e191} {#credentials-mit-install-subsequent-intro_d7e191} Endpoint {#credentials-mit-install-subsequent-intro_d8e16} ---------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mit-install-subsequent-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mit-install-subsequent-intro_d8e35} Required Fields for a Merchant-Initiated Subsequent Installment Payment {#credentials-mit-install-reqfields} ============================================================================================================ orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID : * American Express: set to the transaction ID from the original transaction. * Discover: set to the transaction ID from the original transaction. * Visa: set to the last successful transaction ID. processingInformation. authorizationOptions. initiator. storedCredentialUsed : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `merchant`. processingInformation. commerceIndicator : Set the value to `install`. REST Example: Authorizing Merchant-Initiated Subsequent Installment Payments {#credentials-mit-install-ex-rest} =============================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "install", "authorizationOptions": { "initiator": { "storedCredentialUsed": "true", "type": "merchant", "merchantInitiatedTransaction": { "reason": "9", "previousTransactionId": "123456789619999", "originalAuthorizedAmount": "100" //Discover Only } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Merchant-Initiated Installment Payment with `TMS` {#credentials-install-mit-tms-intro} ====================================================================================== This section describes how to process a merchant-initiated installment payment using these `TMS` token types: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "customer": { "id": "07C9CA98022DA498E063A2598D0AA400" } } ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. : Including a payment instrument eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "paymentInstrument": { "id": "07CA24EF20F9E2C9E063A2598D0A8565" } } ``` **Instrument Identifier** : Instrument identifier tokens store only a PAN. Including an instrument identifier eliminates the need to include a PAN and the previous transaction's ID. : ``` "paymentInformation": { "instrumentIdentifier": { "id": "7010000000016241111" } } ``` Prerequisites ------------- The first transaction in an installment payment is a *customer-initiated transaction* (CIT). Before you can perform a subsequent *merchant-initiated transaction* (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-install-mit-tms-intro_d7e156} {#credentials-install-mit-tms-intro_d7e156} * Carta Si{#credentials-install-mit-tms-intro_d7e159} {#credentials-install-mit-tms-intro_d7e159} * Cartes Bancaires{#credentials-install-mit-tms-intro_d7e162} {#credentials-install-mit-tms-intro_d7e162} * Dankort{#credentials-install-mit-tms-intro_d7e165} {#credentials-install-mit-tms-intro_d7e165} * Delta{#credentials-install-mit-tms-intro_d7e168} {#credentials-install-mit-tms-intro_d7e168} * Discover{#credentials-install-mit-tms-intro_d7e172} {#credentials-install-mit-tms-intro_d7e172} * Eurocard{#credentials-install-mit-tms-intro_d7e175} {#credentials-install-mit-tms-intro_d7e175} * JCB{#credentials-install-mit-tms-intro_d7e178} {#credentials-install-mit-tms-intro_d7e178} * Maestro (UK Domestic){#credentials-install-mit-tms-intro_d7e181} {#credentials-install-mit-tms-intro_d7e181} * Mastercard{#credentials-install-mit-tms-intro_d7e184} {#credentials-install-mit-tms-intro_d7e184} * Visa{#credentials-install-mit-tms-intro_d7e187} {#credentials-install-mit-tms-intro_d7e187} * Visa Electron{#credentials-install-mit-tms-intro_d7e191} {#credentials-install-mit-tms-intro_d7e191} Endpoint {#credentials-install-mit-tms-intro_d8e16} --------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-install-mit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-install-mit-tms-intro_d8e35} Required Fields for MIT Installment Payments with `TMS` {#credentials-install-mit-tms-reqfields} ================================================================================================ Include these Required Fields ----------------------------- orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : paymentInformation.\[tokentype\].id : Where \[tokentype\] is the `TMS` token type you are using: : * customer * instrumentIdentifier * paymentInstrument processingInformation.commerceIndicator : Set the value to `install`. Instrument Identifier Required Fields ------------------------------------- If you are using the paymentInformation.instrumentIdentifier.id token, include these required fields in addition to the required fields listed above. orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : REST Example: MIT with `TMS` Instrument Identifier Token {#credentials-install-mit-tms-iid-ex-rest} =================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "install" }, "paymentInformation": { "card": { "expirationMonth": "12", "expirationYear": "2031" }, "instrumentIdentifier": { "id": "7010000000016241111" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "4158880000" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Recurring Payments {#credentials-recur-intro} ============================================= A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer for a fixed amount at regular intervals that do not exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Recurring payments are also known as *subscriptions*. Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Recurring Billing Service for Recurring Payments ------------------------------------------------ IMPORTANT Do not use this document for the Recurring Billing service. Customer-Initiated Recurring Payment with PAN {#credentials-recur-cit-pan-intro} ================================================================================ A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer at a fixed amount, at regular intervals that do not exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * Discover * Mastercard * Visa Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Recurring Billing Service for Recurring Payments ------------------------------------------------ > IMPORTANT Do not use this document for the Recurring Billing service. Address Verification Service for Recurring Payments --------------------------------------------------- If your processor supports the Address Verification Service (AVS), then the AVS should verify every authorization request. `Visa Acceptance Solutions` recommends checking the AVS's results for the first recurring payment to ensure that the payment information is accurate and to reduce the risk of fraud. You must determine how to handle the AVS results for any subsequent recurring payments that are not the same as the already-verified billing address information from the first recurring payment. Endpoint {#credentials-recur-cit-pan-intro_d8e16} ------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-pan-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-pan-intro_d8e35} Successful Response ------------------- You must store the *network transaction ID* from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the processorInformation.networkTransactionId field value. Store the *network transaction ID* , which is the processorInformation.networkTransactionId field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT. Required Fields for Authorizing a Customer-Initiated Recurring Payment with PAN {#credentials-recur-cit-pan-reqfields} ====================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation. authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `customer`. processingInformation. commerceIndicator : Set the value to `internet`, a payer authentication value, or `MOTO`. processingInformation.recurringOptions.firstRecurringPayment : Set the value to `true`. REST Example: Customer-Initiated Recurring Payment Authorization with a PAN {#credentials-recur-cit-pan-ex-rest} ================================================================================================================ Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "credentialStoredOnFile": "true", "type": "customer" } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6528187198946076303004" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/captures" } }, "clientReferenceInformation": { "code": "1652818719876" }, "id": "6528187198946076303004", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "63165088Z3AHV91G", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-17T20:18:40Z" } ``` Customer-Initiated Recurring Payment with `TMS` {#credentials-recur-cit-tms-intro} ================================================================================== A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer at a fixed amount, at regular intervals that do not exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * Discover * Mastercard * Visa Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Recurring Billing Service for Recurring Payments ------------------------------------------------ > IMPORTANT Do not use this document for the Recurring Billing service. Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Address Verification Service for Recurring Payments --------------------------------------------------- If your processor supports the Address Verification Service (AVS), then the AVS should verify every authorization request. `Visa Acceptance Solutions` recommends checking the AVS's results for the first recurring payment to ensure that the payment information is accurate and to reduce the risk of fraud. You must determine how to handle the AVS results for any subsequent recurring payments that are not the same as the already-verified billing address information from the first recurring payment. Endpoint {#credentials-recur-cit-tms-intro_d8e16} ------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-tms-intro_d8e35} Required Fields for Authorizing a Customer-Initiated Recurring Payment with `TMS` {#credentials-recur-cit-tms-reqfields} ======================================================================================================================== Use these required fields to request a customer-initiated recurring payment with `TMS`. orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymentInstrument` processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. [processingInformation.recurringOptions. firstRecurringPayment](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-recurring-ops-first-recurring-paym.md "") : Set the value to `true`. {#credentials-recur-cit-tms-reqfields_dl_dqw_kdt_5wb} REST Example: Authorizing a Customer-Initiated Recurring Payment with `TMS` {#credentials-recur-cit-tms-ex-rest} ================================================================================================================ Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "customer" ], "commerceIndicator": "internet", "recurringOptions": { "firstRecurringPayment": true } }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6976858134106105703954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6976858134106105703954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6976858134106105703954/captures" } }, "clientReferenceInformation": { "code": "1697685813462" }, "id": "6976858134106105703954", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62698397FNN143CC", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-19T03:23:33Z", "tokenInformation": { "customer": { "id": "080A3A742BF87171E063A2598D0AEABE" } } } ``` Customer-Initiated Recurring Payment with Enrollable Network Tokens {#credentials-recur-cit-dw-intro} ===================================================================================================== A recurring payment is a credentials-on-file (COF) transaction in a series of payments that you bill to a customer at a fixed amount, at regular intervals that do not exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Recurring Billing Service for Recurring Payments ------------------------------------------------ > IMPORTANT Do not use this document for the Recurring Billing service. Using Enrollable Network Tokens ------------------------------- The `Token Management Service` can enroll certain *network tokens* , known as device tokens, into an instrument identifier token for future payments. *Device tokens* store and encrypt card-on-file information which enables customers to make quick and easy purchases using their mobile device. When authorizing a credentialed payment with a device token, you must create and store the device token in a `TMS` instrument identifier token. To do this, include the device token information in the paymentInformation.tokenizedCard fields and set the token creation fields to create an instrument identifier token. Follow-on merchant-initiated transactions are performed using the created instrument identifier as the payment information. For more information about how to request a merchant-initiated transaction, see [Merchant-Initiated Recurring Payment with TMS](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-recur-intro/credentials-recur-mit-tms-intro.md ""). Device tokens are also known as *digital payments* , *digital wallets* , and *tokenized cards*. Network Token Types ------------------- In your request, include the processingInformation.paymentSolution field to identify the device token type you are using, and set it to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-recur-cit-dw-intro_d13e71} {#credentials-recur-cit-dw-intro_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-recur-cit-dw-intro_d13e76} {#credentials-recur-cit-dw-intro_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. {#credentials-recur-cit-dw-intro_d13e67} Endpoint {#credentials-recur-cit-dw-intro_d8e16} ------------------------------------------------ **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-dw-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-recur-cit-dw-intro_d8e35} Required Fields for Authorizing a Customer-Initiated Recurring Payments with Enrollable Network Tokens {#credentials-recur-cit-dw-reqfields} ============================================================================================================================================ orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.tokenizedCard.expirationMonth : paymentInformation.tokenizedCard.expirationYear : [paymentInformation.tokenizedCard.number](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-tokenized-card-num.md "") : paymentInformation.tokenizedCard.transactionType : Set the value to `1`. processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set the value to `instrumentIdentifier`. processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. [processingInformation.paymentSolution](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-payment-solution.md "") : Set to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-recur-cit-dw-reqfields_d13e71} {#credentials-recur-cit-dw-reqfields_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-recur-cit-dw-reqfields_d13e76} {#credentials-recur-cit-dw-reqfields_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. > IMPORTANT > When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see [Relaxed Requirements for Address Data and Expiration Date in Payment Transactions](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ref-info-intro/payments-relax-reqs.md ""). REST Example: Authorizing a Customer-Initiated Recurring Payment with Enrollable Network Tokens {#credentials-recur-cit-dw-ex-rest} =================================================================================================================================== Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "instrumentIdentifier" ], "commerceIndicator": "internet", "paymentSolution": "001" }, "paymentInformation": { "tokenizedCard": { "number": "4111111111111111", "expirationMonth": "02", "expirationYear": "2025", "transactionType": "1" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "locality": "Austin", "administrativeArea": "TX", "postalCode": "78757", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/7094060020036241803954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/captures" } }, "clientReferenceInformation": { "code": "1709406002076" }, "id": "7094060020036241803954", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "60616704ST7Q27K2", "status": "AUTHORIZED", "submitTimeUtc": "2024-03-02T19:00:02Z", "tokenInformation": { "instrumentidentifierNew": false, "instrumentIdentifier": { "state": "ACTIVE", "id": "7010000000016241111" } } } ``` Merchant-Initiated Recurring Payments with PAN {#credentials-recur-mit-pan-intro} ================================================================================= After the initial recurring payment (CIT), subsequent recurring payments are merchant-initiated transactions (MITs). Prerequisites ------------- The first transaction in a recurring payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the customer's credentials, you must get their consent to store their private information. This is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * Discover * Mastercard * Visa Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Address Verification Service for Recurring Payments --------------------------------------------------- If your processor supports the Address Verification Service (AVS), then the AVS should verify every authorization request. `Visa Acceptance Solutions` recommends checking the AVS's results for the first recurring payment to ensure that the payment information is accurate and to reduce the risk of fraud. You must determine how to handle the AVS results for any subsequent recurring payments that are not the same as the already-verified billing address information from the first recurring payment. Endpoint {#credentials-recur-mit-pan-intro_d8e16} ------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-recur-mit-pan-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-recur-mit-pan-intro_d8e35} Required Fields for Authorizing a Merchant-Initiated Recurring Payment {#credentials-recur-mit-pan-reqfields} ============================================================================================================= orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation. card. number : [processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-auth-ops-initiator-mit-txn.md "") : For Discover and American Express cards, use the transaction ID from the original transaction. For Visa, use the last successful transaction ID. processingInformation. authorizationOptions. initiator. storedCredentialUsed : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `merchant`. processingInformation.commerceIndicator : Card-Specific Required Fields for Authorizing Subsequent Recurring Payments {#credentials-recur-mit-card-type} ============================================================================================================== Some card companies require additional information when making authorizations with stored credentials. Discover -------- Include the authorization amount from the original transaction in this field: processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction. originalAuthorizedAmount : Mastercard ---------- Mastercard supports subscription and standing order payments instead of recurring payments. See [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md "") and [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md ""). REST Example: Authorizing a Merchant-Initiated Recurring Payment {#credentials-recur-mit-pan-ex-rest} ===================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "recurring", "authorizationOptions": { "initiator": { "storedCredentialUsed": "true", "type": "merchant", "merchantInitiatedTransaction": { "previousTransactionId": "123456789619999", "originalAuthorizedAmount": "100" //Discover Only } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Merchant-Initiated Recurring Payment with `TMS` {#credentials-recur-mit-tms-intro} ================================================================================== After the customer-initiated recurring payment, you can send merchant-initiated recurring payments using one or more `TMS` token types: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "customer": { "id": "07C9CA98022DA498E063A2598D0AA400" } } ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. : Including a payment instrument eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "paymentInstrument": { "id": "07CA24EF20F9E2C9E063A2598D0A8565" } } ``` **Instrument Identifier** : Instrument identifier tokens store only a PAN. Including an instrument identifier eliminates the need to include a PAN and the previous transaction's ID. : ``` "paymentInformation": { "instrumentIdentifier": { "id": "7010000000016241111" } } ``` Prerequisites ------------- The first transaction in a recurring payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the customer's credentials, you must get their consent to store their private information. This is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * Discover * Mastercard * Visa Mastercard uses standing order and subscription payments instead of recurring payments. See [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md "") and [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md ""). Address Verification Service for Recurring Payments --------------------------------------------------- If your processor supports the Address Verification Service (AVS), then the AVS should verify every authorization request. `Visa Acceptance Solutions` recommends checking the AVS's results for the first recurring payment to ensure that the payment information is accurate and to reduce the risk of fraud. You must determine how to handle the AVS results for any subsequent recurring payments that are not the same as the already-verified billing address information from the first recurring payment. Endpoint {#credentials-recur-mit-tms-intro_d8e16} ------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-recur-mit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-recur-mit-tms-intro_d8e35} Required Fields for Authorizing a Merchant-Initiated Recurring Payments with `TMS` {#credentials-recur-mit-tms-reqfields} ========================================================================================================================= Use these required fields to authorize subsequent recurring payments. orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : paymentInformation.\[tokentype\].id : Where \[tokentype\] is the `TMS` token type you are using: : * customer * instrumentIdentifier * paymentInstrument processingInformation.commerceIndicator : Set the value to `recurring`. Instrument Identifier Required Fields ------------------------------------- If you are using the paymentInformation.instrumentIdentifier.id token, include these required fields in addition to the required fields listed above. orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : Card-Specific Field ------------------- Some card companies require additional fields when making authorizations with stored credentials. Include this field if you are using these card types: Discover : processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.originalAuthorizedAmount Mastercard : Mastercard supports subscription and standing order payments instead of recurring payments. See [Mastercard Subscription Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mc-subscription-intro.md "") and [Mastercard Standing Order Payments](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-mit-stand-order-intro.md ""). REST Example: Authorizing a Merchant-Initiated Recurring Payment with a `TMS` Instrument Identifier {#credentials-recur-mit-tms-iid-ex-rest} ============================================================================================================================================ Request ```keyword { "processingInformation": { "commerceIndicator": "recurring" }, "paymentInformation": { "card": { "expirationMonth": "12", "expirationYear": "2025" }, "instrumentIdentifier": { "id": "4111xxxxxxxxxxxx" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "4158880000" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` REST Example: Authorizing a Merchant-Initiated Recurring Payment with `TMS` Payment Instrument {#credentials-recur-mit-tms-pid-ex-rest} ======================================================================================================================================= Request ``` { "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "commerceIndicator": "recurring" }, "paymentInformation": { "paymentInstrument": { "id": "07DB0915C20F2DDBE063A2598D0A6F26" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6974839908106304103955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6974839908106304103955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6974839908106304103955/captures" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6974839908106304103955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "instrumentIdentifier": { "id": "7010000000016241111", "state": "ACTIVE" }, "paymentInstrument": { "id": "07DB0915C20F2DDBE063A2598D0A6F26" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processingInformation": { "paymentSolution": "015" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62599243NNMR6324", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-16T19:19:51Z" } ``` REST Example: Authorizing a Merchant-Initiated Recurring Payment with a `TMS` Customer Token {#credentials-recur-mit-tms-cid-ex-rest} ===================================================================================================================================== Request ``` { "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "commerceIndicator": "recurring" }, "paymentInformation": { "customer": { "id": "07DB50E35AE11DA2E063A2598D0A9995" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6974846967476340503955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6974846967476340503955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6974846967476340503955/captures" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6974846967476340503955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processingInformation": { "paymentSolution": "015" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62599950BNN133LK", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-16T19:31:36Z" } ``` Mastercard Standing Order Payments {#credentials-mit-stand-order-intro} ======================================================================= A standing order payment is a recurring COF transaction that is a variable amount at a regular interval, such as a utility bill, not to exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Mastercard Initial CIT Standing Order Payment {#credentials-mit-cit-stand-order-initial-intro} ============================================================================================== The first transaction in a standing order payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Endpoint {#credentials-mit-cit-stand-order-initial-intro_d8e16} --------------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-stand-order-initial-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-stand-order-initial-intro_d8e35} Successful Response ------------------- You must store the *network transaction ID* from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the processorInformation.networkTransactionId field value. Store the *network transaction ID* , which is the processorInformation.networkTransactionId field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT. Required Fields for Authorizing Initial CIT Standing Order Payments {#credentials-mit-stand-order-initial-reqfields} ==================================================================================================================== Use these required fields to authorize initial customer-initated standing order payments. orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation. authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `customer`. processingInformation. commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. reason : Set the value to `8`. {#credentials-mit-stand-order-initial-reqfields_dl_kmx_yvl_bwb} REST Example: Authorizing Initial CIT Standing Order Payments {#credentials-mit-stand-order-initial-ex-rest} ============================================================================================================ Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "credentialStoredOnFile": "true", "type": "customer", "merchantInitiatedTransaction": { "reason": "8" } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "5555xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Mastercard Initial CIT Standing Order Payment with `TMS` {#credentials-mit-cit-stand-order-initial-tms-intro} ============================================================================================================= The first transaction in a standing order payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Endpoint {#credentials-mit-cit-stand-order-initial-tms-intro_d8e16} ------------------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-stand-order-initial-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mit-cit-stand-order-initial-tms-intro_d8e35} Required Fields for Authorizing Initial CIT Standing Order Payments with `TMS` {#credentials-mit-stand-order-initial-tms-reqfields} =================================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymentInstrument` processingInformation.authorizationOptions. initiator.merchantInitiatedTransaction.reason : Set the value to `8`. processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. {#credentials-mit-stand-order-initial-tms-reqfields_dl_kmx_yvl_bwb} REST Example: Authorizing Initial CIT Standing Order Payments with `TMS` {#credentials-mit-stand-order-initial-tms-ex-rest} =========================================================================================================================== Request ```keyword { "processingInformation": { "actionList": ["TOKEN_CREATE"], "actionTokenTypes": ["customer"], "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "merchantInitiatedTransaction": { "reason": "8" } } } }, "paymentInformation": { "card": { "number": "555555555555xxxx", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "locality": "Sunnyville", "administrativeArea": "CA", "postalCode": "55555", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/7064959411486706503954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/7064959411486706503954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/7064959411486706503954/captures" } }, "clientReferenceInformation": { "code": "1706495941197" }, "id": "7064959411486706503954", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "680915409RRMGL34", "status": "AUTHORIZED", "submitTimeUtc": "2024-01-29T02:39:01Z", "tokenInformation": { "customer": { "id": "100D6CDA178DD64DE063A2598D0AD3D5" } } } ``` Mastercard Subscription Payments {#credentials-mc-subscription-intro} ===================================================================== A subscription payment is a recurring COF transaction that is processed at a fixed amount at regular intervals not to exceed one year between transactions. The series of recurring payments is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Mastercard CIT Initial Subscription Payment {#credentials-mc-subscription-cit-pan-intro} ======================================================================================== The first transaction in a subscription payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Endpoint {#credentials-mc-subscription-cit-pan-intro_d8e16} ----------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mc-subscription-cit-pan-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mc-subscription-cit-pan-intro_d8e35} Successful Response ------------------- You must store the *network transaction ID* from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the processorInformation.networkTransactionId field value. Store the *network transaction ID* , which is the processorInformation.networkTransactionId field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT. Required Fields for Authorizing CIT Initial Subscription Payments {#credentials-mc-subscription-cit-pan-req-fields} =================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.authorizationOptions. initiator.credentialStoredOnFile : Set the value to `true`. processingInformation.authorizationOptions. initiator.type : Set the value to `customer`. processingInformation.commerceIndicator : Set the value to `recurring`. processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.reason : Set the value to `7`. {#credentials-mc-subscription-cit-pan-req-fields_dl_s1l_wvl_bwb} REST Example: Authorizing Initial CIT Subscription Payments {#credentials-mc-subscription-cit-pan-ex-rest} ========================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "type": "customer", "credentialStoredOnFile": "true", "merchantInitiatedTransaction": { "reason": "7" } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Mastercard CIT Initial Subscription Payment with `TMS` {#credentials-mc-subscription-cit-tms-intro} =================================================================================================== The first transaction in a subscription payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Endpoint {#credentials-mc-subscription-cit-tms-intro_d8e16} ----------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mc-subscription-cit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mc-subscription-cit-tms-intro_d8e35} Required Fields for Authorizing CIT Initial Subscription Payments with `TMS` {#credentials-mc-subscription-cit-tms-req-fields} ============================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymentInstrument` processingInformation.commerceIndicator : Set the value to `recurring`. processingInformation.authorizationOptions. initiator.merchantInitiatedTransaction.reason : Set the value to `7`. {#credentials-mc-subscription-cit-tms-req-fields_dl_s1l_wvl_bwb} REST Example: Authorizing Initial CIT Subscription Payments with TMS {#credentials-mc-subscription-cit-tms-ex-rest} =================================================================================================================== Request ```keyword { "processingInformation": { "actionList": ["TOKEN_CREATE"], "actionTokenTypes": ["customer"], "commerceIndicator": "recurring", "authorizationOptions": { "initiator": { "merchantInitiatedTransaction": { "reason": "7" } } } }, "paymentInformation": { "card": { "number": "555555555555xxxx", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "locality": "Sunnyville", "administrativeArea": "CA", "postalCode": "55555", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/7064946846256410103954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/7064946846256410103954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/7064946846256410103954/captures" } }, "clientReferenceInformation": { "code": "1706494684667" }, "id": "7064946846256410103954", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "68091233JRRDUQ34", "status": "AUTHORIZED", "submitTimeUtc": "2024-01-29T02:18:04Z", "tokenInformation": { "customer": { "id": "100D1DC40CC7C803E063A2598D0A29BD" } } } ``` Unscheduled COF Payments {#credentials-ucof-intro} ================================================== An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF. Customer-Initiated Unscheduled COF Payment with PAN {#credentials-cit-ucof-initial-intro} ========================================================================================= An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-cit-ucof-initial-intro_d7e156} {#credentials-cit-ucof-initial-intro_d7e156} * Carta Si{#credentials-cit-ucof-initial-intro_d7e159} {#credentials-cit-ucof-initial-intro_d7e159} * Cartes Bancaires{#credentials-cit-ucof-initial-intro_d7e162} {#credentials-cit-ucof-initial-intro_d7e162} * Dankort{#credentials-cit-ucof-initial-intro_d7e165} {#credentials-cit-ucof-initial-intro_d7e165} * Delta{#credentials-cit-ucof-initial-intro_d7e168} {#credentials-cit-ucof-initial-intro_d7e168} * Discover{#credentials-cit-ucof-initial-intro_d7e172} {#credentials-cit-ucof-initial-intro_d7e172} * Eurocard{#credentials-cit-ucof-initial-intro_d7e175} {#credentials-cit-ucof-initial-intro_d7e175} * JCB{#credentials-cit-ucof-initial-intro_d7e178} {#credentials-cit-ucof-initial-intro_d7e178} * Maestro (UK Domestic){#credentials-cit-ucof-initial-intro_d7e181} {#credentials-cit-ucof-initial-intro_d7e181} * Mastercard{#credentials-cit-ucof-initial-intro_d7e184} {#credentials-cit-ucof-initial-intro_d7e184} * Visa{#credentials-cit-ucof-initial-intro_d7e187} {#credentials-cit-ucof-initial-intro_d7e187} * Visa Electron{#credentials-cit-ucof-initial-intro_d7e191} {#credentials-cit-ucof-initial-intro_d7e191} Endpoint {#credentials-cit-ucof-initial-intro_d8e16} ---------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-cit-ucof-initial-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-cit-ucof-initial-intro_d8e35} Successful Response ------------------- You must store the *network transaction ID* from the successful response message to include in subsequent MIT authorization requests in order to associate the CIT to the MIT. The network transaction ID is the processorInformation.networkTransactionId field value. Store the *network transaction ID* , which is the processorInformation.networkTransactionId field value, from the successful response message. You must include the network transaction ID in subsequent MIT authorization requests in order to associate the CIT to the MIT. Required Fields for a Customer-Initiated Unscheduled COF Payment with PAN {#credentials-cit-ucof-initial-reqfields} =================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation. authorizationOptions. initiator. credentialStoredOnFile : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `customer`. processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. REST Example: Customer-Initiated Unscheduled COF Payment with PAN {#credentials-cit-ucof-initial-ex-rest} ========================================================================================================= Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "credentialStoredOnFile": "true", "type": "customer" } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6528187198946076303004" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6528187198946076303004/captures" } }, "clientReferenceInformation": { "code": "1652818719876" }, "id": "6528187198946076303004", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "63165088Z3AHV91G", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-17T20:18:40Z" } ``` Customer-Initiated Unscheduled COF Payments with `TMS` {#credentials-ucof-cit-tms-intro} ======================================================================================== An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-ucof-cit-tms-intro_d7e156} {#credentials-ucof-cit-tms-intro_d7e156} * Carta Si{#credentials-ucof-cit-tms-intro_d7e159} {#credentials-ucof-cit-tms-intro_d7e159} * Cartes Bancaires{#credentials-ucof-cit-tms-intro_d7e162} {#credentials-ucof-cit-tms-intro_d7e162} * Dankort{#credentials-ucof-cit-tms-intro_d7e165} {#credentials-ucof-cit-tms-intro_d7e165} * Delta{#credentials-ucof-cit-tms-intro_d7e168} {#credentials-ucof-cit-tms-intro_d7e168} * Discover{#credentials-ucof-cit-tms-intro_d7e172} {#credentials-ucof-cit-tms-intro_d7e172} * Eurocard{#credentials-ucof-cit-tms-intro_d7e175} {#credentials-ucof-cit-tms-intro_d7e175} * JCB{#credentials-ucof-cit-tms-intro_d7e178} {#credentials-ucof-cit-tms-intro_d7e178} * Maestro (UK Domestic){#credentials-ucof-cit-tms-intro_d7e181} {#credentials-ucof-cit-tms-intro_d7e181} * Mastercard{#credentials-ucof-cit-tms-intro_d7e184} {#credentials-ucof-cit-tms-intro_d7e184} * Visa{#credentials-ucof-cit-tms-intro_d7e187} {#credentials-ucof-cit-tms-intro_d7e187} * Visa Electron{#credentials-ucof-cit-tms-intro_d7e191} {#credentials-ucof-cit-tms-intro_d7e191} Creating a `TMS` Token ---------------------- When sending the initial CIT, you can create a `TMS` token to store the customer's credentials for the subsequent MITs. To create a `TMS` token, include the processingInformation.actionTokenTypes field in the authorization request. Set the field to one of these values based on the `TMS` token type you want to create: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "customer" ] ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. Including a payment instrument in subsequent MITs eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "paymentInstrument" ] ``` **Instrument Identifier** : Instrument identifier tokens store a PAN. Including an instrument identifier in subsequent MITs eliminates the need to include a PAN and the previous transaction's ID. : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier" ] ``` **Instrument Identifier, Payment Instrument, and Customer Identifier** : You can also create multiple `TMS` token types in the same authorization. This example includes an instrument identifier, a payment instrument, and a customer token in the same authorization: : ``` "processingInformation": { "actionTokenTypes": [ "instrumentIdentifier", "paymentInstrument", "customer" ] ``` Endpoint {#credentials-ucof-cit-tms-intro_d8e16} ------------------------------------------------ **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-cit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-cit-tms-intro_d8e35} Required Fields for CIT Unscheduled COF Payments with `TMS` {#credentials-ucof-cit-tms-reqfields} ================================================================================================= orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation.actionList : Set the value to `TOKEN_CREATE` processingInformation.actionTokenTypes : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymnentInstrument` processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. REST Example: Initial CIT Unscheduled COF Payment in TMS {#credentials-ucof-cit-tms-ex-rest} ============================================================================================ Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "customer" ], "commerceIndicator": "internet" }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6976866073586557303955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6976866073586557303955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6976866073586557303955/captures" } }, "clientReferenceInformation": { "code": "1697686607441" }, "id": "6976866073586557303955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62699023FNN143DG", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-19T03:36:47Z", "tokenInformation": { "customer": { "id": "080A6C3842C72DCBE063A2598D0AA98B" } } } ``` Customer-Initiated Unscheduled COF Payment with Enrollable Network Tokens {#credentials-ucof-cit-dw-intro} ========================================================================================================== An unscheduled credentials-on-file (COF) transaction uses stored payment information for a fixed or variable amount that does not occur regularly. An account top-up is one kind of unscheduled COF. Using Enrollable Network Tokens ------------------------------- The `Token Management Service` can enroll certain *network tokens* , known as device tokens, into an instrument identifier token for future payments. *Device tokens* store and encrypt card-on-file information which enables customers to make quick and easy purchases using their mobile device. When authorizing a credentialed payment with a device token, you must create and store the device token in a `TMS` instrument identifier token. To do this, include the device token information in the paymentInformation.tokenizedCard fields and set the token creation fields to create an instrument identifier token. Follow-on merchant-initiated transactions are performed using the created instrument identifier as the payment information. For more information about how to request a merchant-initiated transaction, see [Merchant-Initiated Unscheduled COF Payments with TMS](/docs/vas/en-us/credentials/developer/vantivcnp/rest/credentials/credentials-ucof-intro/credentials-ucof-mit-tms-intro.md ""). Device tokens are also known as *digital payments* , *digital wallets* , and *tokenized cards*. Network Token Types ------------------- In your request, include the processingInformation.paymentSolution field to identify the device token type you are using, and set it to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-ucof-cit-dw-intro_d13e71} {#credentials-ucof-cit-dw-intro_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-ucof-cit-dw-intro_d13e76} {#credentials-ucof-cit-dw-intro_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. {#credentials-ucof-cit-dw-intro_d13e67} Endpoint {#credentials-ucof-cit-dw-intro_d8e16} ----------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-cit-dw-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-cit-dw-intro_d8e35} Required Fields for CIT Unscheduled COF Payment with Enrollable Network Tokens {#credentials-ucof-cit-dw-reqfields} =================================================================================================================== orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.tokenizedCard.expirationMonth : paymentInformation.tokenizedCard.expirationYear : paymentInformation.tokenizedCard.number : paymentInformation.tokenizedCard.transactionType : Set the value to `1`. processingInformation.actionList : Set the value to `TOKEN_CREATE`. processingInformation.actionTokenTypes : Set the value to `instrumentIdentifier`. processingInformation.commerceIndicator : Set the value to `internet`, `MOTO`, or a payer authentication value. processingInformation.paymentSolution : Set to one of these possible values: * `001`: Apple Pay * `004`: `Visa Acceptance Solutions` In-App Solution * `005`: Masterpass * `006`: Android Pay * `007`: Chase Pay * `008`: Samsung Pay * `012`: Google Pay * `014`: Mastercard credential-on-file (COF) payment network token{#credentials-ucof-cit-dw-reqfields_d13e71} {#credentials-ucof-cit-dw-reqfields_d13e71} * `015`: Visa credential-on-file (COF) payment network token{#credentials-ucof-cit-dw-reqfields_d13e76} {#credentials-ucof-cit-dw-reqfields_d13e76} * `027`: Click to Pay * `visacheckout`: `Visa Click to Pay`. `REST API` Example: CIT Unscheduled COF Payment with Enrollable Network Tokens {#credentials-ucof-cit-dw-ex-rest} ================================================================================================================= Request ```keyword { "processingInformation": { "actionList": [ "TOKEN_CREATE" ], "actionTokenTypes": [ "instrumentIdentifier" ], "commerceIndicator": "internet", "paymentSolution": "001" }, "paymentInformation": { "tokenizedCard": { "number": "4111111111111111", "expirationMonth": "02", "expirationYear": "2025", "transactionType": "1" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "locality": "Austin", "administrativeArea": "TX", "postalCode": "78757", "country": "US", "email": "test@vas.com", "phoneNumber": "444-4444-4444" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/7094060020036241803954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/7094060020036241803954/captures" } }, "clientReferenceInformation": { "code": "1709406002076" }, "id": "7094060020036241803954", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "60616704ST7Q27K2", "status": "AUTHORIZED", "submitTimeUtc": "2024-03-02T19:00:02Z", "tokenInformation": { "instrumentidentifierNew": false, "instrumentIdentifier": { "state": "ACTIVE", "id": "7010000000016241111" } } } ``` Merchant-Initiated Unscheduled COF Payment with PAN {#credentials-mit-unsched-subsequent-intro} =============================================================================================== After the initial CIT unscheduled COF payment, subsequent unscheduled COF transactions are merchant-initiated transactions (MITs). Prerequisites ------------- The first transaction in an unscheduled COF payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-mit-unsched-subsequent-intro_d7e156} {#credentials-mit-unsched-subsequent-intro_d7e156} * Carta Si{#credentials-mit-unsched-subsequent-intro_d7e159} {#credentials-mit-unsched-subsequent-intro_d7e159} * Cartes Bancaires{#credentials-mit-unsched-subsequent-intro_d7e162} {#credentials-mit-unsched-subsequent-intro_d7e162} * Dankort{#credentials-mit-unsched-subsequent-intro_d7e165} {#credentials-mit-unsched-subsequent-intro_d7e165} * Delta{#credentials-mit-unsched-subsequent-intro_d7e168} {#credentials-mit-unsched-subsequent-intro_d7e168} * Discover{#credentials-mit-unsched-subsequent-intro_d7e172} {#credentials-mit-unsched-subsequent-intro_d7e172} * Eurocard{#credentials-mit-unsched-subsequent-intro_d7e175} {#credentials-mit-unsched-subsequent-intro_d7e175} * JCB{#credentials-mit-unsched-subsequent-intro_d7e178} {#credentials-mit-unsched-subsequent-intro_d7e178} * Maestro (UK Domestic){#credentials-mit-unsched-subsequent-intro_d7e181} {#credentials-mit-unsched-subsequent-intro_d7e181} * Mastercard{#credentials-mit-unsched-subsequent-intro_d7e184} {#credentials-mit-unsched-subsequent-intro_d7e184} * Visa{#credentials-mit-unsched-subsequent-intro_d7e187} {#credentials-mit-unsched-subsequent-intro_d7e187} * Visa Electron{#credentials-mit-unsched-subsequent-intro_d7e191} {#credentials-mit-unsched-subsequent-intro_d7e191} Endpoint {#credentials-mit-unsched-subsequent-intro_d8e16} ---------------------------------------------------------- **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-mit-unsched-subsequent-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-mit-unsched-subsequent-intro_d8e35} Required Fields for a Subsequent MIT Unscheduled COF Payment {#credentials-mit-unsched-reqfields} ================================================================================================= orderInformation.amountDetails.currency orderInformation.amountDetails.totalAmount : orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : paymentInformation.card.number : processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID : * American Express: set to the transaction ID from the original transaction. * Discover: set to the transaction ID from the original transaction. * Visa: set to the last successful transaction ID. processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction.reason : Set the value to `10`. : Required only for American Express, Discover and Mastercard. processingInformation. authorizationOptions. initiator. storedCredentialUsed : Set the value to `true`. processingInformation. authorizationOptions. initiator. type : Set the value to `merchant`. processingInformation. commerceIndicator : Set the value to `internet`. REST Example: Authorizing Subsequent MIT Unscheduled COF Payments {#credentials-mit-unsched-ex-rest} ==================================================================================================== Request ```keyword { "processingInformation": { "commerceIndicator": "internet", "authorizationOptions": { "initiator": { "storedCredentialUsed": "true", "type": "merchant", "merchantInitiatedTransaction": { "previousTransactionId": "123456789619999", "originalAuthorizedAmount": "100" <--Discover Only--> } } } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "address1": "201 S. Division St.", "postalCode": "48104-2201", "locality": "Ann Arbor", "administrativeArea": "MI", "country": "US", "phoneNumber": "5554327113", "email": "test@vas.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "ABC" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "4111xxxxxxxxxxxx", "expirationMonth": "12" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6530824710046809304002" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6530824710046809304002/captures" } }, "clientReferenceInformation": { "code": "1653082470983" }, "id": "6530824710046809304002", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "002" } }, "paymentInformation": { "tokenizedCard": { "type": "002" }, "card": { "type": "002" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "authIndicator": "1", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "79710341A39WTT5W", "status": "AUTHORIZED", "submitTimeUtc": "2022-05-20T21:34:31Z" } ``` Merchant-Initiated Unscheduled COF Payments with `TMS` {#credentials-ucof-mit-tms-intro} ======================================================================================== After the customer-initiated unscheduled COF payment, you can send merchant-initiated unscheduled COF payments using one or more `TMS` token types: **Customer** : Customer tokens store one or more customer payment instrument tokens and shipping address tokens. : Including a customer token eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "customer": { "id": "07C9CA98022DA498E063A2598D0AA400" } } ``` **Payment Instrument** : Payment instrument tokens store an instrument identifier token, card information, and billing information. Payment instruments are not linked to a customer token. : Including a payment instrument eliminates the need to include billing information, card information, and the previous transaction's ID. : ``` "paymentInformation": { "paymentInstrument": { "id": "07CA24EF20F9E2C9E063A2598D0A8565" } } ``` **Instrument Identifier** : Instrument identifier tokens store only a PAN. Including an instrument identifier eliminates the need to include a PAN and the previous transaction's ID. : ``` "paymentInformation": { "instrumentIdentifier": { "id": "7010000000016241111" } } ``` Prerequisites ------------- The first transaction in an unscheduled COF payment is a customer-initiated transaction (CIT). Before you can perform a subsequent merchant-initiated transaction (MIT), you must store the customer's credentials for later use. Before you can store the user's credentials, you must get the customer's consent to store their private information. This process is also known as establishing a relationship with the customer. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-ucof-mit-tms-intro_d7e156} {#credentials-ucof-mit-tms-intro_d7e156} * Carta Si{#credentials-ucof-mit-tms-intro_d7e159} {#credentials-ucof-mit-tms-intro_d7e159} * Cartes Bancaires{#credentials-ucof-mit-tms-intro_d7e162} {#credentials-ucof-mit-tms-intro_d7e162} * Dankort{#credentials-ucof-mit-tms-intro_d7e165} {#credentials-ucof-mit-tms-intro_d7e165} * Delta{#credentials-ucof-mit-tms-intro_d7e168} {#credentials-ucof-mit-tms-intro_d7e168} * Discover{#credentials-ucof-mit-tms-intro_d7e172} {#credentials-ucof-mit-tms-intro_d7e172} * Eurocard{#credentials-ucof-mit-tms-intro_d7e175} {#credentials-ucof-mit-tms-intro_d7e175} * JCB{#credentials-ucof-mit-tms-intro_d7e178} {#credentials-ucof-mit-tms-intro_d7e178} * Maestro (UK Domestic){#credentials-ucof-mit-tms-intro_d7e181} {#credentials-ucof-mit-tms-intro_d7e181} * Mastercard{#credentials-ucof-mit-tms-intro_d7e184} {#credentials-ucof-mit-tms-intro_d7e184} * Visa{#credentials-ucof-mit-tms-intro_d7e187} {#credentials-ucof-mit-tms-intro_d7e187} * Visa Electron{#credentials-ucof-mit-tms-intro_d7e191} {#credentials-ucof-mit-tms-intro_d7e191} Endpoint {#credentials-ucof-mit-tms-intro_d8e16} ------------------------------------------------ **Production:** `POST ``https://api.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-mit-tms-intro_d8e25} **Test:** `POST ``https://apitest.visaacceptance.com``/pts/v2/payments`{#credentials-ucof-mit-tms-intro_d8e35} Required Fields for MIT Unscheduled COF Payments with `TMS` {#credentials-ucof-mit-tms-req-fields} ================================================================================================== Include these Required Fields ----------------------------- orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : paymentInformation.\[tokentype\].id : Where \[tokentype\] is the `TMS` token type you are using: : * customer * instrumentIdentifier * paymentInstrument processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction.reason : Set the value to `10`. : Required only for American Express, Discover, and Mastercard. processingInformation.commerceIndicator : Set the value to `internet`. Instrument Identifier Required Fields ------------------------------------- If you are using the paymentInformation.instrumentIdentifier.id token, include these required fields in addition to the required fields listed above. orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.phoneNumber : orderInformation.billTo.postalCode : paymentInformation.card.expirationMonth : paymentInformation.card.expirationYear : Card-Specific Field ------------------- The listed card type requires an additional field. Discover : processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.originalAuthorizedAmount : Provide the original transaction amount. REST Example: MIT Unscheduled COF Payment with TMS Instrument Identifier {#credentials-ucof-mit-tms-iid-ex-rest} ================================================================================================================ Request ```keyword { "processingInformation": { "commerceIndicator": "internet" }, "paymentInformation": { "card": { "expirationMonth": "12", "expirationYear": "2031" }, "instrumentIdentifier": { "id": "7010000000016241111" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@vas.com", "phoneNumber": "4158880000" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6976892714556134003954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6976892714556134003954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6976892714556134003954/captures" } }, "clientReferenceInformation": { "code": "1697689271513" }, "id": "6976892714556134003954", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "instrumentIdentifier": { "id": "7010000000016241111", "state": "ACTIVE" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processingInformation": { "paymentSolution": "015" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62699554NNMR6X7R", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-19T04:21:11Z" } ``` REST Example: MIT Unscheduled COF Payment with TMS Payment Instrument {#credentials-ucof-mit-tms-pid-ex-rest} ============================================================================================================= Request ``` { "processingInformation": { "commerceIndicator": "internet" }, "paymentInformation": { "paymentInstrument": { "id": "080AE120369A7947E063A2598D0A718F" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6976891300676431103955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6976891300676431103955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6976891300676431103955/captures" } }, "clientReferenceInformation": { "code": "1697689130124" }, "id": "6976891300676431103955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "instrumentIdentifier": { "id": "7010000000016241111", "state": "ACTIVE" }, "paymentInstrument": { "id": "080AE120369A7947E063A2598D0A718F" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processingInformation": { "paymentSolution": "015" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62699372XNMR85HS", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-19T04:18:50Z" } ``` REST Example: MIT Unscheduled COF Payment with TMS Customer {#credentials-ucof-mit-tms-cid-ex-rest} =================================================================================================== Request ``` { "processingInformation": { "commerceIndicator": "internet" }, "paymentInformation": { "customer": { "id": "080AC9AB60C92AA2E063A2598D0A0C74" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "ABC" } } } ``` Response to a Successful Request ``` { "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6976889582016147703955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6976889582016147703955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6976889582016147703955/captures" } }, "clientReferenceInformation": { "code": "1697688958296" }, "id": "6976889582016147703955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "ABC" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "instrumentIdentifier": { "id": "7010000000016241111", "state": "ACTIVE" }, "paymentInstrument": { "id": "080AE6DB37B09557E063A2598D0AA4C9" }, "card": { "type": "001" }, "customer": { "id": "080AC9AB60C92AA2E063A2598D0A0C74" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processingInformation": { "paymentSolution": "015" }, "processorInformation": { "paymentAccountReferenceNumber": "V0010013022298169667504231315", "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "62699842BNN13VA0", "status": "AUTHORIZED", "submitTimeUtc": "2023-10-19T04:15:58Z" } ``` Reference Information {#credentials-ref-info-intro} =================================================== This section contains this helpful reference information when processing credentialed transactions. Payer Authentication Values {#credentials-ref-info-payerauth} ============================================================= This section describes the possible payer authentication values you can include in the processingInformation. commerceIndicatorccAuthService_commerceIndicator request field. The level of security in payer authentication is indicated by the two-digit e-commerce indicator (ECI) that is assigned to the transaction. These values have text equivalents that are assigned to the processingInformation.commerceIndicator field. The American Express, China UnionPay, Diners, Discover, and Visa card brands use `05`, `06`, and `07` digit values to express the authentication level for a `3-D Secure` transaction. | ECI Value | Meaning | Visa | Diners | Discover | China UnionPay | American Express | |:----------|--------------------------------------------|:---------------------|:-------------|:---------------|:-----------------------|:-----------------| | `05` | Authenticated | vbv | pb | dipb | up3ds | aesk | | `06` | Attempted authentication with a cryptogram | vbv_attempted | pb_attempted | dipb_attempted | up3ds_attempted | aesk_attempted | | `07` | Internet, not authenticated | vbv_failure/internet | internet | internet | up3ds_failure/internet | internet | [Text Values for ECI Values] Mastercard and Maestro cards use 00, 01, 02, 06, and 07 digit values to indicate the authentication level of the transaction. | ECI Value | Meaning | Mastercard/Maestro | |:----------|:------------------------------------------------------------------|:-------------------| | `00` | Internet, not authenticated | spa/internet | | `01` | Attempted authentication | spa | | `02` | Authenticated | spa | | `06` | Exemption from authentication or network token without 3‑D Secure | spa | | `07` | Authenticated merchant-initiated transaction | spa | [Mastercard/Maestro Text Values for ECI Values] Relaxed Requirements for Address Data and Expiration Date in Payment Transactions {#payments-relax-reqs} ======================================================================================================== With relaxed requirements for address data and the expiration date, not all standard payment request fields are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. Requirements {#payments-relax-reqs-reqs} ======================================== You must contact customer support in order to enable relaxed requirements for address data and expiration date. Services {#payments-relax-reqs-services} ======================================== Relaxed requirements for address data and expiration date are supported for these services: * Authorization * Capture * Stand-alone credit * Subscription create * Subscription update Relaxed Fields {#payments-relax-reqs-fields} ============================================ > IMPORTANT > When relaxed requirements for address data and expiration date are enabled for your ` Visa Acceptance Solutions ` account, and your service request does not include one or more of the fields in the following list, you increase the risk of declined transactions and fraud depending on your location, your processor, and the cardholder's issuing bank. > It is your responsibility to determine whether a field is required for the transaction you are requesting. For example, an issuing bank can decline an authorization request for a recurring transaction with a Visa Europe card if the expiration date is incorrect, invalid, or missing. If you do not provide the correct expiration date for a recurring transaction the authorization request may be declined. orderInformation.billTo.address1 : orderInformation.billTo.administrativeArea : orderInformation.billTo.country : orderInformation.billTo.email : orderInformation.billTo.firstName : orderInformation.billTo.lastName : orderInformation.billTo.locality : orderInformation.billTo.postalCode : When you include this field in your request, you must also include orderInformation.billTo.country paymentInformation.card.expirationMonth : When you include this field in your request, you must also include paymentInformation.card.expirationYear. : This field is required for payment network token transactions and subscription creation requests. paymentInformation.card.expirationYear : When you include this field in your request, you must also include paymentInformation.card.expirationMonth. : This field is required for payment network token transactions and subscription creation requests.