CRDS-CAU-V-CardAhr

CRDS-CAU-V-CardAhr 1.0.0

0
No votes yet

This Microservice is intended to manage the card information related to the card for which the dynamic CVV2 and 2FA is generated to support online shopping and non-present card transactions

production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext

Paths

/v1/cards/cvv2-generation/validate/detail

post /v1/cards/cvv2-generation/validate/detail
validate-dynamic-cvv2-generation-detail

To validate if is possible to generate a dynamic CVV for the card related with the account

This API is used to validate if the card complies with the business rules to generate a dynamic CVV.

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string

The client ID you received during application registration in the developer portal

Authorization
Required in header
string

Bearer token aquired from APIM token endpoint

uuid
Required in header
string

Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.

Accept
Required in header
string

Content-Types that are acceptable for the response

Accept-Language
Optional in header
string

Language to be send to the backend systems must be 'es' for spanish and 'en' for english

{
    "default": "es"
}
ChannelId
Required in header
string

channel ID used by the user, it is required for the first call in a new session.

Content-Type
Required in header
string

Content-Types that are sent in the request

{
    "default": "application\/json"
}
countryCode
Required in header
string

2 character ISO country code

{
    "default": "MX"
}
businessCode
Required in header
string

3 character business code

{
    "default": "GCB"
}
sid
Required in header
string

Sessionid value from E2EE Key Exchange response.

validateCardRequest
Required in body
object
ValidateCardRequest
200

Successful operation.

400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
errorcannotDecryptData620-Cannot decrypt, please re-check the encrypted value
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
errorproductNotAllowedThe card is not allowed to issue CVV2 and 2FA.
ErrorResponse
404
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
ErrorResponse
422
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
ErrorResponse
500
TypeCodeDetails
errorbackendErrorFailed during a call to backend service
errortimeoutErrorTime to complete a transaction is over
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/cvv2-generation/validate/detail

Definitions 

{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to indentify the account",
            "type": "string",
            "example": "123456"
        }
    },
    "required": [
        "accountId"
    ]
}
              
{
    "required": [
        "code",
        "details",
        "location",
        "moreInfo",
        "timestamp",
        "type"
    ],
    "properties": {
        "type": {
            "type": "string",
            "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"
            ]
        },
        "code": {
            "type": "string",
            "description": "Error code which qualifies the error"
        },
        "details": {
            "type": "string",
            "description": "Human readable explanation specific to the occurrence of the problem"
        },
        "location": {
            "type": "string",
            "description": "The name of the field that resulted in the error"
        },
        "moreInfo": {
            "type": "string",
            "description": "URI to human readable documentation of the error"
        },
        "timestamp": {
            "type": "string",
            "description": "Timestamp of the error"
        }
    }
}