Cards

Select the following:
Home

>

API Products

>

Australia - Cards API Documentation

Cards

Summary

This API is used for listing all the cards a customer holds with Citi

Want to try this API out on our Playground?

Go play now
Endpoints on this page
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/cards Retrieve all cards
post /v1/creditCards/creditLimits Request credit limit increase
post /v1/creditCards/{cardId}/supplementary/applications Supplementary Card Application
get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan Transaction Eligibility and Easy Payment Plans
post /v1/creditCards/{cardId}/easyPaymentPlans/bookings Easy Payment Plan Booking
get /v1/creditCards/{cardId}/easyPaymentPlans/repaymentSchedules Easy Payment Plan Repayment Schedule

Update local usage activation

put /v1/cards/{cardId}/activations/{cardActivationCode}
Description

Activates or deactivates the specified card's ability to be used locally.

Path Parameters
cardId
string required
Card Id in encrypted format
cardActivationCode
string required
Activation Code for card Usage. Possible values:ACTIVATE, DEACTIVATE.This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardActivationCode} resource to get valid value of this field with description. You can use the cardActivationCode as the referenceCode parameter to retrieve the values.
Body Parameters
CardUsageRequest
Optional
Show schema
Header Parameters
uuid
string required
128 bit random UUID generated uniquely for every request.
client_id
string required
Client ID generated during application registration.
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
  • 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
errorinvalidActivationRequestCard is already activated.Selected card must be inactive
errorinvalidDeActivationRequestCard is already de-activated.Selected card must be active
errormaximumAttemptsLimitExceededMaximum attempt limit exceeded
errordecryptionFailedPIN decryption is failed
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}/activations/{cardActivationCode}
{
    "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}/activations/{cardActivationCode}
{
    "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 put /v1/cards/{cardId}/activations/{cardActivationCode}
{
    "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}/activations/{cardActivationCode}
{
    "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"
    ]
}

Report card as lost or stolen

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

Reports a specified card as lost or stolen and returns a reference number to track the request.

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
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Path Parameters
cardId
string required
Unique Id of the card in encrypted format
Body Parameters
ReportLostStolenCardRequest
required
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.
Definitions
  • referenceId
    • Unique reference ID associated with the lost or stolen card request.
    • type : string
Example Response for put /v1/cards/{cardId}/lostStolen
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorrequestNotProcessedRequest is not processed.
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}/lostStolen
{
    "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}/lostStolen
{
    "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 put /v1/cards/{cardId}/lostStolen
{
    "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}/lostStolen
{
    "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"
    ]
}

Update overseas usage activation

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

Activates or deactivates a specified card's ability to be used overseas. Cards can be activated for overseas usage permanently or for a set period of time.

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
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Path Parameters
cardId
string required
Unique Id of the card for activation or de-activation.
Body Parameters
OverseasCardUsageRequest
required
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
errorinvalidDateRangeDate range is invalid
errorinvalidActivationRequestCard is already activated.Selected card must be inactive
errorinvalidDeActivationRequestCard is already de-activated.Selected card must be 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}/overseasUsage
{
    "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}/overseasUsage
{
    "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 put /v1/cards/{cardId}/overseasUsage
{
    "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}/overseasUsage
{
    "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"
    ]
}

Retrieve all cards

get /v1/cards
Description

Returns an array of credit card numbers, credit limits, statuses and types for the customer who authorized your app.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
client_id
string required
client id generated during consumer onboarding
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
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. You can use the field name as the referenceCode parameter to retrieve the values.
  • 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
  • cardDetails
      • 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. You can use the field name as the referenceCode parameter to retrieve the values.
        • 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. You can use the field name as the referenceCode parameter to retrieve the values.
        • type : string
      • perpetualActivationFlag
        • Flag to specify whether the card is activated perpetually, till card expiration
        • type : boolean
      • overseasCardActivationStartDate
        • format : date
        • Card activation start date in ISO 8601 date format YYYY-MM-DD for overseas usage.
        • type : string
      • overseasCardActivationEndDate
        • format : date
        • 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
      • currentCreditLimitAmount
        • format : double
        • Current credit limit amount on the credit card
        • type : number
      • maximumPermanentCreditLimitAmount
        • format : double
        • Maximum permanent credit limit amount allowed on the credit card
        • type : number
      • maximumTemporaryCreditLimitAmount
        • format : double
        • Maximum temporary credit limit amount allowed on the credit card
        • type : number
      • 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. You can use the field name as the referenceCode parameter to retrieve the values.
        • 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
Example Response for get /v1/cards
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 /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 /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 /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"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
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 /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 /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"
    ]
}

Request credit limit increase

post /v1/creditCards/creditLimits
Description

Requests a permanent or temporary credit limit increase. For a temporary credit limit increase, the request must incidate that the type of request is temporary and include Card ID, requested limit and duration. For permanent increases, the Card ID and requested limit are the only required parameters.

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
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Body Parameters
CreditLimitIncreaseRequest
required
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.
Definitions
  • responseCode
    • Response code.This is a reference data field. Please use /v1/apac/utilities/referenceData/{responseCode} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
    • type : string
Example Response for post /v1/creditCards/creditLimits
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
invalidexceedsEligibleCreditLimitEligible creditlimit is exceeded
invalidinvalideDateRangeDate Range Mismatch
invalidexceedsMaximumAllowableDateRangeAllowable date range is exceeded.
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/creditCards/creditLimits
{
    "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 post /v1/creditCards/creditLimits
{
    "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 post /v1/creditCards/creditLimits
{
    "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 post /v1/creditCards/creditLimits
{
    "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"
    ]
}

Supplementary Card Application

post /v1/creditCards/{cardId}/supplementary/applications
Description

Requests an authorized Citi Customer to add a Supplementary card to their existing primary card.

Body Parameters
SupplementaryCardRequest
Optional
Show schema
Path Parameters
cardId
string required
Primary card id in encrypted format.
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.
client_id
string required
Client ID generated during application registration.
  • 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
  • applicationId
    • Unique identifier for the supplementary card application
    • type : string
Example Response for post /v1/creditCards/{cardId}/supplementary/applications
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorineligibleCardCard not eligible to request supplementary cards
errorinvalidConsentThe value provided for consentGivenFlag is incorrect
errormaximumSupplementaryCardsExceededAllowed maximum number of supplementary cards exceeded
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/creditCards/{cardId}/supplementary/applications
{
    "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 credential is 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/creditCards/{cardId}/supplementary/applications
{
    "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 post /v1/creditCards/{cardId}/supplementary/applications
{
    "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 post /v1/creditCards/{cardId}/supplementary/applications
{
    "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"
    ]
}

Transaction Eligibility and Easy Payment Plans

get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
Description

This API is used to check the Easy Payment Plans eligibility for a card and the available Payment Plans details.

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.
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
Path Parameters
cardId
string required
The card id in encrypted format.
Query Parameters
eligbleLoanAmount
number required
Elligible loan amount for easy payment plan booking..
{
    "format": "double"
}
  • 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
  • tenor
    • Tenure of loan in months.
    • type : string
  • effectiveInterestRate
    • The interest rate applicable on loan amount.
    • type : number
    • format : double
  • annualPercentageRate
    • Interest rate for a whole year. This includes any fees or additional cost associated.
    • type : number
    • format : double
  • installmentAmount
    • Installment amount to be paid by customer in order to repay the loan.
    • type : number
    • format : double
  • oneTimeProcessingFeeIndicator
    • One time processing fee indicator. Valid values : PERCENTAGE, FIXED_AMOUNT. This is a reference data field. Please use /v1/apac/utilities/referenceData/{oneTimeProcessingFeeIndicator} resource to get valid value of this field with description.
    • type : string
  • oneTimeProcessingFeeAmount
    • Fee charged as part of one time processing.
    • type : number
    • format : double
  • oneTimeProcessingFeePercentage
    • Percentage of one time processing fee charged.
    • type : number
    • format : double
  • offerIndicator
    • This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description.
    • type : string
Example Response for get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
204

No content
This operation returns no content.
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 get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
{
    "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 get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
{
    "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"
    ]
}
422

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidCardCard is invalid
errorinvalidOfferOffer 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 get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
{
    "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 get /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan
{
    "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"
    ]
}

Easy Payment Plan Booking

post /v1/creditCards/{cardId}/easyPaymentPlans/bookings
Description

This API is called after the Easy Payment Plan selection and completes the booking of the selected payment plan.Post payment plan booking an acknowledgement is sent to the customer.

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
Path Parameters
cardId
string required
The card id in encrypted format.
Body Parameters
EppLoanBookingRequest
required
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.
Definitions
  • eppTransaction
      • referenceId
        • Reference Id to uniquely identify the loan.
        • type : string
      • installmentAmount
        • Installment amount to be paid by customer in order to repay the loan.
        • type : number
        • format : double
      • principalAmount
        • The portion of the Principal Amount Paid for the loan.
        • type : number
        • format : double
      • installmentInterestAmount
        • The interest amount to be paid as installment.
        • type : number
        • format : double
      • initialInterestAmount
        • Initial interest amount charged to customer from the epp booking date to the first installment start date
        • type : number
        • format : double
      • statementUnpaidBalanceAmount
        • This field indicates the remaining statement balance amount that remains due and payable.
        • type : number
        • format : double
Example Response for post /v1/creditCards/{cardId}/easyPaymentPlans/bookings
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidCardIdCard ID is invalid
errorinvalidOfferOffer 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/creditCards/{cardId}/easyPaymentPlans/bookings
{
    "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 credential is 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/creditCards/{cardId}/easyPaymentPlans/bookings
{
    "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 post /v1/creditCards/{cardId}/easyPaymentPlans/bookings
{
    "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 post /v1/creditCards/{cardId}/easyPaymentPlans/bookings
{
    "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"
    ]
}

Easy Payment Plan Repayment Schedule

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

This API allows the customer to view the payment breakdown details and the repayment schedule for the Easy Payment Plan selected.

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
Path Parameters
cardId
string required
The card id in encrypted format.