On This Page

Incremental Authorization for Flexible Scenario

Use this information to process an incremental authorization for a Flexible transaction. You can process multiple incremental authorizations for a single EV charging session. Use this type of authorization when the final transaction amount of the charging session is more than the amount of the initial authorization. When the final transaction amount is less than the total authorized amount, an automatic, host-generated partial reversal request is sent.

For more information about this payment service, see Flexible Transaction Scenario.

IMPORTANT

You must meet authentication requirements when processing incremental authorizations in the EU. For more information, see Authentication Requirements for Incremental Authorizations in the European Union.

Endpoint

Production:

PATCH https://api.cybersource.com/pts/v2/payments/{id}

Test:

PATCH https://apitest.cybersource.com/pts/v2/payments/{id}

The

{id}

is the transaction ID returned in the original authorization response.

Required Fields for an Incremental Authorization in Flexible Scenario

clientReferenceInformation.code
clientReferenceInformation.comments: Set the value to
Incremental Auth
.
clientReferenceInformation.partner.developerId: Cybersource provides the value for this field.
clientReferenceInformation.partner.solutionId: Cybersource provides the value for this field.
clientReferenceInformation.partner.thirdPartyCertificationNumber: Cybersource provides the value for this field.
clientReferenceInformation.transactionId
merchantInformation.transactionLocalDateTime
orderInformation.amountDetails.additionalAmount
orderInformation.amountDetails.currency
processingInformation.authorizationOptions.initiator.credentialStoredOnFile

Related Information

API field reference guide for the REST API

REST Example: Incremental Authorization for Visa in Flexible Scenario

Request

{
  "clientReferenceInformation": {
    "code": "test123",
    "comments": "Flexible Incremental Auth",
    "partner": {
      "developerId": "prodDeveloperId",
      "thirdPartyCertificationNumber": "prodTPCN",
      "solutionId": "prodSolutionId"
    }
   },
  "processingInformation": {
    "authorizationOptions": {
      "initiator": {
        "storedCredentialUsed": true
      }
    }
  },
  "orderInformation": {
    "amountDetails": {
      "additionalAmount": "10.00",
      "currency": "USD"
    }
  },
  "merchantInformation": {
    "transactionLocalDateTime": 20191002080000
  }
}

Response to a Successful Request

{
  "_links": {
    "authReversal": {
      "method": "POST",
      "href": "/pts/v2/payments/7474221808366131703814/reversals"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/payments/7474222613396289103814"
    },
    "capture": {
      "method": "POST",
      "href": "/pts/v2/payments/7474221808366131703814/captures"
    }
  },
  "clientReferenceInformation": {
    "comments": "Flexible Incremental Auth",
    "code": "test123",
    "partner": {
      "developerId": "prodDeveloperId",
      "solutionId": "prodSolutionId"
    }
  },
  "id": "7474222613396289103814",
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "30.00",
      "authorizedAmount": "10.00",
      "currency": "USD"
    }
  },
  "paymentInformation": {
    "accountFeatures": {
      "category": "F"
    }
  },
  "processorInformation": {
    "systemTraceAuditNumber": "067388",
    "approvalCode": "033470",
    "transactionId": "305136685813069",
    "responseCode": "00"
  },
  "reconciliationId": "7474221808366131703814",
  "status": "AUTHORIZED",
  "submitTimeUtc": "2025-05-16T19:04:21Z"
}