On This Page
Token and NTID
When the customer selects an installment plan from the eligible plan options and accepts
the terms and conditions for that plan, you must confirm the selection by requesting the
Select Installment Plan service.
IMPORTANT
You must get the customer's consent on the
terms and conditions for the installment plan that they selected.
The Select Installment Plan request requires you to use one of the plan IDs listed in the
Get Installment Plans response. The plan IDs are shown as the values of the
installmentInformation.planDetails.planId
fields.Token Information
Include the token information in the service request with one of these token
identifier fields:
- Flex API transient token:tokenInformation.transientTokenJwt
- TMScustomer token:paymentInformation.customer.id
- TMSinstrument identifier token:paymentInformation.instrumentIdentifier.id
- TMSpayment instrument token:paymentInformation.paymentInstrument.id
- TMStransient token:tokenInformation.jti
For more information about token types, see the Token Types section in the .
Token Management Service
Developer GuideEndpoint
Production
: POST
https://api.cybersource.com
/fin/v1/plan-acceptance/Test
: POST
https://apitest.cybersource.com
/fin/v1/plan-acceptance/Required Fields for Selecting an Installment Plan with a Token
Include these required fields when you request the select an installment plan service
with a token.
- Set to plan ID shown in the get installment plans response as theplanDetails.planIdfield.
- Set to the terms and conditions version number shown in the get installment plans response as theplanDetails.termsAndConditions.versionfield.
- Set to the identifier from theprocessorInformation.networkTransactionIdfield in the authorization response.
- Set toVisa.
Required Token Fields
Include only one of these token identifier fields:
Related Information
REST API Example: Select an Installment Plan with a Token
REST API
Example: Select an Installment Plan with a TokenRequest
{ "processingInformation": { "installmentServiceProvider": "Visa", "authorizationOptions": { "networkTransactionId": "178896882917745", "authorizationDateTime": "2020-09-02T16:40:45.827Z" } }, "orderInformation": { "amountDetails": { "totalAmount": "500", "currency": "USD" } }, "installmentInformation": { "planId": "1cc80cb6-866d-0a3e-7c52-18f6aced3201", "tcVersion": "1" }, "paymentInformation": { "instrumentIdentifier": { "id": "7030000000012249793" } } }
Response
{ "id": "6903019542136782103955", "submitTimeUtc": "2023-07-25T16:19:14Z", "status": "ACCEPTED", "processorInformation": { "responseCode": "200" }, "paymentInformation": { "paymentAccountReference": { "id": "V0010013020261601352183794986" } }, "installmentInformation": { "id": "4be11ad6-d0a8-c59a-1a57-1235d7f79302", "planId": "1cc80cb6-866d-0a3e-7c52-18f6aced3201" } }