Cards

Select the following:
Home

>

API Products

>

India - Cards API Documentation

Cards

Summary

The Cards API allows you to perform actions on the actual credit cards of the Citi Customer who authorized your app.

Want to try this API out on our Playground?

Go play now
Endpoints on this page
post /v1/cards/cvv/verification Verify CVV for Debit or Credit Card
get /partner/v1/cards Partner Card List
put /v1/cards/{cardId}/limitsAndEnrollments Enroll for Transaction Limit Setup
get /v1/creditCards/{cardId}/easyPaymentPlans/eligibility Check Easy Payment Plan Eligibility
post /v1/cards/overseasUsage/confirmation Confirm Card Overseas Activation Deactivation
put /v1/cards/{cardId}/activations/{cardActivationCode} Update local usage activation
put /v1/cards/{cardId}/lostStolen Report card as lost or stolen
put /v1/cards/{cardId}/overseasUsage Update overseas usage activation
get /v1/creditCards/{cardId}/easyPaymentPlans/repaymentSchedules Easy Payment Plan Repayment Schedule
post /v1/creditCards/{cardId}/easyPaymentPlans/bookings Book Easy Payment Plan
post /v1/creditCards/rewards/pointBalance/search This API is used to retrieve reward points balance for multiple credit cards
get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan Transaction Eligibility and Easy Payment Plans

Verify CVV for Debit or Credit Card

post /v1/cards/cvv/verification
Description

This API is used to verify the CVV of a debit or a credit card.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Content-Type
string required
application/json
clientDetails
string Optional
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
Body Parameters
CvvVerificationRequest
required
CvvVerificationRequest
Show schema
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidCardCard is invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/cards/cvv/verification
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/cards/cvv/verification
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/cards/cvv/verification
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/cards/cvv/verification
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Partner Card List

get /partner/v1/cards
Description

This API is used to list all the cards held by a customer with Citi partner.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
client id generated during consumer onboarding
clientDetails
string Optional
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
Query Parameters
cardFunction
string required
Card function. This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardFunction} resource to get valid value of this field with description.
linkedSupplementaryCardFlag
boolean Optional
Flag to identify linked supplementary information to be retrieved.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • partnerCardDetails
      • cardId
        • The card id in encrypted format
        • type : string
      • displayCardNumber
        • A masked card number that can be displayed to the customer.
        • type : string
      • localCardActivationIndicator
        • The card activation indicator for local usage. This is a reference data field. Please use /v1/apac/utilities/referenceData/{localCardActivationIndicator} resource to get valid value of this field with description.
        • type : string
      • overseasCardActivationIndicator
        • The card activation indicator for overseas usage. This is a reference data field. Please use /v1/apac/utilities/referenceData/{overseasCardActivationIndicator} resource to get valid value of this field with description.
        • type : string
      • perpetualActivationFlag
        • Flag to specify whether the card is activated perpetually, till card expiration
        • type : boolean
      • overseasCardActivationStartDate
        • Card activation start date in ISO 8601 date format YYYY-MM-DD for overseas usage.
        • type : string
        • format : date
      • overseasCardActivationEndDate
        • Card activation end date in ISO 8601 date format YYYY-MM-DD for overseas usage. For perpetual activation, value is card expiry date
        • type : string
        • format : date
      • currentCreditLimitAmount
        • Current credit limit amount on the credit card
        • type : number
        • format : double
      • maximumPermanentCreditLimitAmount
        • Maximum permanent credit limit amount allowed on the credit card
        • type : number
        • format : double
      • maximumTemporaryCreditLimitAmount
        • Maximum temporary credit limit amount allowed on the credit card
        • type : number
        • format : double
      • subCardType
        • Type of the card. Debit or Credit.This is a reference data field. Please use /v1/apac/utilities/referenceData/{subCardType} resource to get valid value of this field with description.
        • type : string
      • cardHolderType
        • Indicator to specify whether the card is primary or supplementary. This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardHolderType} resource to get valid value of this field with description.
        • type : string
      • cardIssueReason
        • Specifies the reason for the card issuance. Applicable only for recently issued cards. This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardIssueReason} resource to get valid value of this field with description.
        • type : string
      • cardFunctionsAllowed
        • properties : Array
      • embossName
        • Name to be embossed on card.If blank, bank will assign automatically based on the market norms.
        • type : string
      • organization
        • Card issuing organization name
        • type : string
      • logo
        • Product logo to identify the product
        • type : string
      • productName
        • type : string
        • The name of the product
      • primaryCardId
        • The primary card id in encrypted format. Applicable only for supplementary cards.
        • type : string
      • displayPrimaryCardNumber
        • A masked primary card number that can be displayed to the customer. Applicable only for supplementary cards.
        • type : string
      • cardPlasticType
        • Indicates the card plastic type used for embossing.This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardPlasticType} resource to get valid value of this field with description.
        • type : string
      • currentContactlessWthoutPinPmtLimit
        • Current transaction limit for the contact less payments without pin set by the customer
        • type : number
        • format : double
      • maxContactlessWithoutPinPmtLimit
        • Maximum transaction limit for the contact less payments without pin
        • type : number
        • format : double
Example Response for get /partner/v1/cards
204

No content
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/cards
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/cards
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/cards
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/cards
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Enroll for Transaction Limit Setup

put /v1/cards/{cardId}/limitsAndEnrollments
Description

This API is used to update the limits (daily and transaction level) and the enrollments applicable for the credit/debit card of a customer.

Header Parameters
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Content-Type
string required
application/json
clientDetails
string Optional
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
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Path Parameters
cardId
string required
Card Id in encrypted format
Body Parameters
CardsLimitsAndEnrollmentsUpdateRequest
required
CardsLimitsAndEnrollmentsUpdateRequest
Show schema
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidCardCard is invalid
errorinvalidTransactionAmountTransaction Limit amount is invalid
errorlimitAmountExceedsMaximumAllowed limit amount for this transaction exceeded
errorlimitAmountBelowMinimumLimit amount below minimum amount
errorlimitUpdateFailedLimit update failed
errorcardNotActiveCard not active
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/cards/{cardId}/limitsAndEnrollments
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/cards/{cardId}/limitsAndEnrollments
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/cards/{cardId}/limitsAndEnrollments
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/cards/{cardId}/limitsAndEnrollments
{
    "properties": {
        "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"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Check Easy Payment Plan Eligibility

get /v1/creditCards/{cardId}/easyPaymentPlans/eligibility
Description

This API is used to validate the transaction eligibility for EPP conversion.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.