Standing Instruction Deregistration (Cancellation)

Cardholder information and payment parameters for SI transactions can be deregistered (or cancelled) at any time. Deregister the cardholder when the cardholder wants to end subsequent SI transactions. After the last scheduled transaction, any associated tokens expire.

Required Fields for Deregistering a Standing Instruction

REST Example: Deregistering a Standing Instruction

REST Example: Deregistering a Standing Instruction (with Token)

Request
POST
https://api.cybersource.com
/pts/v2/billing-agreements/:{id}
{
    "clientReferenceInformation":{
        "code":"cybs_test"
    },
    "orderInformation":{
        "billTo":{
        "firstName":"Suman",
        "lastName":"Kumar",
        "address1":"Bagmane WTC",
        "address2":"Doddenakundi",
        "locality":"Bangalore",
        "country":"IN",
        "administrativeArea":"KA",
        "postalCode":"560048",
        "email":"test@domain.com",
        "phoneNumber":"7606160717"
     },
     "amountDetails":{
        "totalAmount":"100.00",
        "currency":"INR"
     }
},
     "paymentInformation":{
         "tokenizedCard": {
              "transactionType":"1",
              "cryptogram":"AxjzbwSTWXrGh42hi2ugABEBTSoX+EHukDpxAUqXb8n+Wcc3UiIJAPAAhhO5",
              "type":"061",
              "expirationMonth":"12",
              "expirationYear":"2025",
              "number":"5082301226408XXXX",
              "securityCode" :"123"
         }
     },
     "installmentInformation": {
         "identifier": "abcde1345",
         "paymentType": "1",
         "firstInstallmentDate": "01012023",
         "lastInstallmentDate": "01012024",
         "totalCount": "12",
         "minAmount" :"10",
         "maxAmount" :"100",
         "preferredDay":"05",
         "frequency": "1",
         "alertPreference":"SMS",
         "sequence": "2"
     },
     "deviceInformation" :{
         "httpAcceptBrowserValue" : "http",
         "userAgentBrowserValue" : "user",
         "ipAddress":"10.0.0.1"
     }
}
Successful Response
{
     "clientReferenceInformation": {
         "code": "cybs_test"
     },
     "consumerAuthenticationInformation": {
         "validityPeriod": "05",
         "authenticationTransactionContext": "100000000000000000000000025253",
         "authenticationTransactionId": "00000012345342141537264106",
         "veresEnrolled": "Y",
         "authenticationPath": "ENROLLED",
         "authenticationType": "20",
         "specificationVersion": "rupay",
         "token": "AxjzbwSTWmCPKLjUiOgP/989TSoG9526yDpxAU+Xb2/+xcVYlDjA/AAAXwKK"
     },
     "errorInformation": {
         "reason": "CONSUMER_AUTHENTICATION_REQUIRED",
         "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction."
     },
     "id": "6389531274227120400399",
     "status": "PENDING_AUTHENTICATION",
     "submitTimeUtc": "2022-12-08T08:45:37Z"
}
Light Dark
Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
{"clientReferenceInformation":{
        "code":"cybs_test"
    },                
    "orderInformation":{
        "billTo":{
        "firstName":"Suman",
        "lastName":"Kumar",
        "address1":"Bagmane WTC",
        "address2":"Doddenakundi",
        "locality":"Bangalore",
        "country":"IN",
        "administrativeArea":"KA",
        "postalCode":"560048",
        "email":"test@domain.com",
        "phoneNumber":"7606160717"
    },
    "amountDetails":{
        "totalAmount":"100.00",
        "currency":"INR"
    }
},                
    "paymentInformation":{
        "card":{
        "type":"061",
        "expirationMonth":"12",
        "expirationYear":"2025",
        "number":"5082301226408XXXX",
        "securityCode" :"123"
    }
},                
    "installmentInformation": {
        "identifier": "abcde1345",
        "paymentType": "1",
        "firstInstallmentDate": "01012023",
        "lastInstallmentDate": "01012024",
        "totalCount": "12",
        "minAmount" :"10",
        "maxAmount" :"100",
        "preferredDay":"05",
        "frequency": "1",
        "alertPreference":"SMS",
        "sequence": "2"
    },                          
    "deviceInformation" :{
        "httpAcceptBrowserValue" : "http",
        "userAgentBrowserValue" : "user",
        "ipAddress":"10.0.0.1"
    }}
Successful Response
123456789101112131415161718192021
{"clientReferenceInformation": {
          "code": "cybs_test"
    },
    "consumerAuthenticationInformation": {
          "validityPeriod": "05",
          "authenticationTransactionContext": "100000000000000000000000025253",
          "authenticationTransactionId": "00000012345342141537264106",
          "veresEnrolled": "Y",
          "authenticationPath": "ENROLLED",
          "authenticationType": "20",
          "specificationVersion": "rupay",
          "token": "AxjzbwSTWmCPKLjUiOgP/989TSoG9526yDpxAU+Xb2/+xcVYlDjA/AAAXwKK"
     },
     "errorInformation": {
          "reason": "CONSUMER_AUTHENTICATION_REQUIRED",
          "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction."
     },
     "id": "6389531274227120400399",
     "status": "PENDING_AUTHENTICATION",
     "submitTimeUtc": "2022-12-08T08:45:37Z"
  }}