Verify Authorization

GET 
/:installmentPlanNumber/verifyauthorization

You must call Verify Authorization in cases when plan authorization and order closure do not happen simultaneously. An example of this would be when a customer checks out with a Payment Form or Flex Form, or is redirected for 3DS. To call it, you need to provide the plan number you received in the success response from Initiate.

Request

Path Parameters

installmentPlanNumber stringrequired

Header Parameters

X-Splitit-IdempotencyKey string

Responses

200

Success

application/json

Schema

Schema

IsAuthorizedbooleanrequired
AuthorizationAmountdecimal

Authorization

object

Statusstringrequired

Possible values: [NA, Succeeded, Pending3DS, Failed]

Datedate-time

SplititErrorResultCodestring

GatewayTransactionIDstring

GatewayResultCodestring

GatewayResultMessagestring

ThreeDSRedirect

object

Urlstring

Verbstring

Params

object

property name*string

CAVVstring

ECIstring

Example (from schema)

{
  "IsAuthorized": true,
  "AuthorizationAmount": 0,
  "Authorization": {
    "Status": "NA",
    "Date": "2024-07-29T15:51:28.071Z",
    "SplititErrorResultCode": "string",
    "GatewayTransactionID": "string",
    "GatewayResultCode": "string",
    "GatewayResultMessage": "string",
    "ThreeDSRedirect": {
      "Url": "string",
      "Verb": "string",
      "Params": {}
    },
    "CAVV": "string",
    "ECI": "string"
  }
}

401

Unauthorized Request: Token is not authorized or is expired

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

403

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

404

Resource Does Not Exist: Plan or service does not exist; for all APIs, if an invalid plan number is passed in the URL, this error will be returned

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

422

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

500

General Server Error: Server encountered an unexpected condition

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

400-599

General Error: Sorry. There has been an error. Please try again.

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}