Cancel an Agreement

Cancel a merchant's existing authorization for one or more business scenarios. The target agreements are located by the accountId + authBusinessScenarios combination rather than a single agreement id. Platform partners: Your authentication credentials (your API Key, or the Client-Id header for RSA signature integrations) also identify the authorized platform partner (partnerId).
Request Parameters
accountIdstring
required
WF account ID of the authorizing merchant (the party that granted authorization). Fixed length of 16 characters.
authBusinessScenariosarray
required
Business scenario codes whose authorization is to be cancelled. Provide one element per product; at least one element is required. See AuthBusinessScenario.
Response Parameters
resultResult
API call result. See Result.
agreementsarray
Details of the cancelled authorization agreements, one entry per requested scenario. Returned when resultStatus is S.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
PARAM_ILLEGALFParameter validation failed.Ensure `accountId` is exactly 16 characters and `authBusinessScenarios` contains at least one valid scenario.
AUTHORIZATION_NOT_EXISTFThe specified authorization agreement does not exist.No active agreement matches the given `accountId` + `authBusinessScenarios`. Confirm the authorization exists before cancelling.
PROCESS_FAILFA general business failure occurred. Do not retry.Verify the merchant state, then contact support if the issue persists.
Definition
POST /api/open/v1/agreements/cancel
Request
{
"accountId": "2188000000000123",
"authBusinessScenarios": [
  "AUTH_CHARGE"
]
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"agreements": [
  {
    "id": "agr_20260808000001",
    "accountId": "2188000000000123",
    "accountName": "Example Trading Ltd.",
    "authBusinessScenario": "AUTH_CHARGE",
    "status": "CANCELLED",
    "createdAt": "2026-08-08T13:08:56Z",
    "expiresAt": "2027-08-08T13:08:56Z"
  }
]
}