On This Page {#jumplink-list} [Markdown](/docs/cybs/en-us/credentials/developer/ctv/rest/credentials/credentials-install-intro/credentials-install-cit-tms-iid-intro.md) Filter FILTER BY TAG 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. In Brazil, installment payments are also known as *parcelados* and *parcelas*. > IMPORTANT > Do not use this document if you are using the Installments service. When using the Installments service, ` Cybersource ` saves and stores payment credentials for installment transactions, ensuring compliance with COF best practices. Installment Payment Types ------------------------- `Visa Platform Connect` enables you to process installment payments but does not have a role in setting the terms for the installment plan. `Visa Platform Connect` enables you to process these types of installments payments: Issuer-Funded Installment Payments : The customer pays for goods or services using an installment plan agreed upon by the customer and their issuing bank. The issuer controls how the customer's account is debited. Your account is credited for the entire amount in a single transaction. The issuer assumes the risk and establishes credit rates and fees that are charged to the customer. The customer pays the funding cost, which is a fee for paying in installments. In Brazil, a *Crediario* is a special type of issuer-funded installment payment plan that enables the customer to request information about the terms of the installment plan before approving the installment payments. Merchant-Funded Installment Payments : The customer pays for goods or services using an installment plan agreed upon by you and the customer. The issuer controls how the customer's account is debited. Your account is credited periodically for partial amounts as the customer's account is debited. You assume the risk and establish the credit rate and fees that are charged to the customer. Co-Branded Merchant Financed Installment Payments---Brazil Only : You and the issuer determine the terms for this kind of installment plan. The funding varies depending on the agreement between you, the issuer, and the customer. This funding method is available only for Mastercard installment payments in Brazil. Issuer Merchant Co-Financed Installment Payments---Brazil Only : The issuer creates the installment plan. You and the issuer determine the service fees that the customer pays to you and the issuer. The acquirer is paid in full while the issuer is paid in installments by the customer. You or the customer pay the funding cost, which is a fee for paying in installments. This funding method is available only for Mastercard installment payments in Brazil. Supported Card Types -------------------- These are the supported card types for processing credentialed transactions: * American Express{#credentials-install-cit-tms-iid-intro_d7e282} {#credentials-install-cit-tms-iid-intro_d7e282} * Carta Si{#credentials-install-cit-tms-iid-intro_d7e285} {#credentials-install-cit-tms-iid-intro_d7e285} * Cartes Bancaires{#credentials-install-cit-tms-iid-intro_d7e288} {#credentials-install-cit-tms-iid-intro_d7e288} * Dankort{#credentials-install-cit-tms-iid-intro_d7e291} {#credentials-install-cit-tms-iid-intro_d7e291} * Delta{#credentials-install-cit-tms-iid-intro_d7e294} {#credentials-install-cit-tms-iid-intro_d7e294} * Eurocard{#credentials-install-cit-tms-iid-intro_d7e298} {#credentials-install-cit-tms-iid-intro_d7e298} * JCB{#credentials-install-cit-tms-iid-intro_d7e301} {#credentials-install-cit-tms-iid-intro_d7e301} * Maestro (UK Domestic){#credentials-install-cit-tms-iid-intro_d7e304} {#credentials-install-cit-tms-iid-intro_d7e304} * Mastercard{#credentials-install-cit-tms-iid-intro_d7e307} {#credentials-install-cit-tms-iid-intro_d7e307} * Visa{#credentials-install-cit-tms-iid-intro_d7e310} {#credentials-install-cit-tms-iid-intro_d7e310} * Visa Electron{#credentials-install-cit-tms-iid-intro_d7e313} {#credentials-install-cit-tms-iid-intro_d7e313} 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" ] ``` : For more information about this `TMS` token type, see [Customer Tokens](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-overview/tms-token-types/tms-cust-tkn.md "") in the *`Token Management Service` Developer Guide*. **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" ] ``` : For more information about this `TMS` token type, see [Payment Instrument Token](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-overview/tms-token-types/tms-pi-tkn.md "") in the *`Token Management Service` Developer Guide*. **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" ] ``` : For more information about this TMS token type, see [Instrument Identifier Token](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-overview/tms-token-types/tms-ii-tkn.md "") in the *`Token Management Service` Developer Guide*. **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.cybersource.com``/pts/v2/payments`{#credentials-install-cit-tms-iid-intro_d8e25} **Test:** `POST ``https://apitest.cybersource.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](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "") : [orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "") : [orderInformation.billTo.address1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-address1.md "") : [orderInformation.billTo.administrativeArea](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-admin-area.md "") : [orderInformation.billTo.country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-company-country.md "") : [orderInformation.billTo.email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-email.md "") : [orderInformation.billTo.firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-first-name.md "") : [orderInformation.billTo.lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-last-name.md "") : [orderInformation.billTo.locality](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-locality.md "") : [orderInformation.billTo.phoneNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-phone-num.md "") : [orderInformation.billTo.postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-bill-to-postal-code.md "") : [paymentInformation.card.expirationMonth](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-exp-mo.md "") : [paymentInformation.card.expirationYear](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-exp-year.md "") : [paymentInformation.card.number](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/payment-info-aa/payment-info-card-number.md "") : [processingInformation.actionList](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-list.md "") : Set the value to `TOKEN_CREATE`. [processingInformation.actionTokenTypes](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-action-token-types.md "") : Set to one or more of these values: * `customer` * `instrumentIdentifier` * `paymnentInstrument` [processingInformation.commerceIndicator](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/processing-info-aa/processing-info-commerce-ind.md "") : 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@cybs.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" } } } ``` RELATED TO THIS PAGE