Endpoint responsible for returning the status of a 3ds challenge.

GET 
/charge/3ds/:chargeId/status

If the seller needs to retrieve the status of a challenge, it can be done through this endpoint.

Request

Path Parameters

chargeId stringrequired

Header Parameters

caller-origin string

Include the 'caller-origin' property as a string in the header of REST requests only if the application is an e-commerce platform, otherwise, don't include it.

Responses

200

OK

application/json

Schema

Schema

hasChallenged booleanrequired

Confirms if the charge has challenge

status stringrequired

Example (from schema)

{
  "hasChallenged": true,
  "status": "CREATED,AUTHENTICATED,REJECTED, FAILED"
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

404

Not found

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "charge not found with chargeId: {chargeId}",
  "success": false
}

502

Bad Gateway

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Error when making an external call, try again later.",
  "success": false,
  "errors": null
}

Loading...