Cards

Select the following:
Home

>

API Products

>

Australia - 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
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 Book Easy Payment Plan
get /v1/creditCards/{cardId}/easyPaymentPlans/repaymentSchedules Easy Payment Plan Repayment Schedule
post /v1/creditCards/{cardId}/easyPaymentPlans/search Retrieve Easy Payment Plans Options
get /v1/creditCards/{cardId}/easyPaymentPlans/eligibility Check Easy Payment Plan Eligibility
get /v1/creditCards/{cardId}/supplementaryCards List Supplementary Cards
put /v1/creditCards/creditLimits/decrease Decrease Credit Limit
put /v1/creditCards/creditLimits/decrease/consents Decrease Credit Limit with Consent
post /v1/creditCards/statements/summary/search Retrieve Composite Credit Cards Statement Summary
put /v1/cards/atmPin/reset Reset ATM Pin
post /v1/cards/atmPin/reset/confirmation Confirm ATM Pin Request
post /v1/prelogin/creditChargeCard/creditPlans/offers/{offerId}/easyPaymentPlans/bookings This API is triggered after the EPP plan is selected and completes the EPP Booking. One of the responses to the execution of this API is the transaction reference/confirmation number.
get /v1/prelogin/creditChargeCard/creditPlans/offers/{offerId}/easyPaymentPlans This API list the Options for Pre Login EPP offers that the customer can avail. It provides the applicable interest rate and tenors.
get /v1/prelogin/creditChargeCard/creditPlans/offers/{offerId}/easyPaymentPlans/repaymentSchedules To allow customers to view the payment breakdown details.
post /v1/cards/activations/confirmation Confirm Card Activation Deactivation
post /v1/creditCards/rewards/pointBalance/search This API is used to retrieve reward points balance for multiple credit cards
put /v1/prelogin/cards/atmPin/change This API is used to change the pin of a debit or credit card in pre-login scenario. This API will not be published in CITI's developer portal. In case this API is exposed to external party, TISO review will be required.
post /partner/v1/creditChargeCard/corporateCards/suspensionAndCashLimitAllowed This API is used to Suspend and Unsuspend corporate card.
post /partner/v1/creditChargeCard/corporateCards/pendingAndIntradayAuthorizationTransactions/retrieve This API used to retrieve the pending Authorization refund and intraday and history transactions
post /partner/v1/creditChargeCard/corporateCards/cardReplacement This API is to do the replacement of credit card for Damage/Lost/Stolen reasons
put /partner/v1/creditChargeCard/corporateCards/lostOrStolen This API is to report lost or stolen card and to apply for Replacement
put /partner/v1/creditChargeCard/corporateCards/spendControl This API will help corporate user to update purchases for specific merchants coming in the API request

Update local usage activation

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

This API is used to activate or deactivate 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

This API is used to report 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

This API is used to activate or deactivate 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 :