updatePaymentGatewayAuthorizationHealth
put
/ccstore/v1/healthCheck/payments
Update Payment Gateway Authorization Health. Set Payment Gateway authorization health state
Request
Supported Media Types
- application/json
Root Schema : updatePaymentGatewayAuthorizationHealth_request
Type:
Show Source
object
-
gatewayName:
string
Gateway for health check.
-
health(optional):
boolean
Health to set.
-
operation:
string
Operation to health check.
Example:
{
"gatewayName":"cybersource",
"health":true,
"operation":"auth"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updatePaymentGatewayAuthorizationHealth_response
Type:
Show Source
object
-
isHealthy(optional):
boolean
Provides whether the Payment gateway authorized is in a healthy state or not.
Example Response (application/json)
{
"isHealthy":true
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code