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

IsAuthorized booleanrequired
AuthorizationAmount decimal

Authorization

object

Status stringrequired

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

Date date-time

SplititErrorResultCode string

GatewayTransactionID string

GatewayResultCode string

GatewayResultMessage string

ThreeDSRedirect

object

Url string

Verb string

Params

object

property name* string

CAVV string

ECI string

Example (from schema)

{
  "IsAuthorized": true,
  "AuthorizationAmount": 0,
  "Authorization": {
    "Status": "NA",
    "Date": "2024-07-24T18:00:33.273Z",
    "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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

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

403

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

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

422

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

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

Loading...