Tags:
- Phase›Realized
Custom Gateway API Endpoint
Paths
/v1/oauth2/customers/consent
This API is used to Opt-in Check during Consent
This API is used to Opt-in Check during Consent
pv52735
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| error | invalidCredentials | User credentials are invalid |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| invalid | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request or Products from the response are not supported currently |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"properties": {
"consentVersion": {
"description": "consent version details",
"type": "string",
"example": "1.0"
}
}
}
{
"properties": {
"code": {
"description": "Code",
"type": "string",
"example": "AAItTtGiPYFYQjhBMiv0jrhd4-rxNNE_21sO3C5gpYDq6yEmTs8rJTQMSS2b8Qtody_BsEK5Muin1vD074ryYfkYpQdiIC"
}
}
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}