Paths
/v1/apac/rewards/{rewardLinkCode}/pointBalance
Retrieve credit card account reward points balance
Get the latest Citi Rewards points / miles balance for credit card enrolled.
Unique link code issued during registration process. This is to be used to identify reward transactions
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
The client ID you received during application registration in the developer portal
Accept-Language header.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidRewardLinkCode | Reward link code is invalid |
| invalid | inactiveRewardLinkCode | Reward link code is inactive |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| error | accountNotFound | Account not found |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/apac/rewards/linkage
Link credit card to a merchant for rewards redemption
Will enroll the customer to the program and register the token which will be used for subsequent API requests. Separate enrollment is required for each credit card that customer may have.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
application/json
Accept-Language header.
The client ID you received during application registration in the developer portal
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
card information
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidCardType | Card type is invalid |
| error | registrationFailed | Registration failed |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/creditCards/rewards/pointBalance/search
This API is used to retrieve reward points balance for multiple credit cards
This API is used to retrieve reward points balance for multiple credit cards
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
The client ID you received during application registration in the developer portal
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
No content.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | exceedsMaximumCardsAllowed | Exceeded the number of cards allowed |
| error | invalidCustomer | Customer not found or invalid |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/rewards/shopWithPoints/linkage
Link credit card to a merchant for rewards redemption
Will enroll the customer to the program and register the token which will be used for subsequent API requests. Separate enrollment is required for each credit card that customer may have.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
application/json
Accept-Language header.
The client ID you received during application registration in the developer portal
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
card information
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidCardType | Card type is invalid |
| error | registrationFailed | Registration failed |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/rewards/{rewardLinkCode}/shopWithPoints/activations
Used to activate reward link code.
This API is used to activate reward link code.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language header.
Unique link code issued during registration process.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | activationFailed | Link code activation is failed |
| error | exceedsMaximumAttempts | Maximum attempts exceeded for activation. Link credit card to a merchant again. |
| error | linkageConfirmationCodeExpired | Linkage confirmation code is expired. Link credit card to a merchant again |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
Retrieve credit card account reward points balance
Get the latest Citi Rewards points / miles balance for credit card enrolled.
Unique link code issued during registration process. This is to be used to identify reward transactions
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
The client ID you received during application registration in the developer portal
Accept-Language header.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidRewardLinkCode | Reward link code is invalid |
| invalid | inactiveRewardLinkCode | Reward link code is inactive |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| error | accountNotFound | Account not found |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/apac/rewards/{rewardLinkCode}/activations
Used to activate reward link code.
This API is used to activate reward link code.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language header.
Unique link code issued during registration process.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | activationFailed | Link code activation is failed |
| error | exceedsMaximumAttempts | Maximum attempts exceeded for activation. Link credit card to a merchant again. |
| error | linkageConfirmationCodeExpired | Linkage confirmation code is expired. Link credit card to a merchant again |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/apac/rewards/{rewardLinkCode}
This API is used to de-register the Pay With Points enrollment in card based on customer request.
This API is used to de-register the Pay With Points enrollment in card based on customer request.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language header.
Unique link code issued during registration process.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidRewardLinkCode | Reward link code is invalid |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewards/{rewardLinkCode}/shopWithPoints
This API is used to de-register the Shop With Points enrollment in card based on customer request.
This API is used to de-register the Shop With Points enrollment in card based on customer request.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language header.
Unique link code issued during registration process.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidRewardLinkCode | Reward link code is invalid |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"availablePointBalance": {
"type": "number",
"format": "int64",
"description": "Number of rewards points or miles available.",
"example": 10000
},
"programConversionRate": {
"description": "Points to currency conversion rate for the rewards program",
"type": "number",
"format": "double",
"example": 0.2521
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"maximumPointsToRedeem": {
"description": "The maximum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 10000
},
"minimumPointsToRedeem": {
"description": "The minimum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 5000
}
},
"required": [
"availablePointBalance"
]
}
{
"type": "object",
"required": [
"lastFourDigitsCardNumber",
"citiCardHolderPhoneNumber",
"merchantCustomerReferenceId"
],
"properties": {
"lastFourDigitsCardNumber": {
"description": "Last four digits of the card number",
"type": "string",
"example": "5212"
},
"citiCardHolderPhoneNumber": {
"description": "Citi registered primary mobile number of the credit card holder with Country Code (without + sign).",
"type": "string",
"example": "6563471895"
},
"merchantCustomerReferenceId": {
"description": "Denotes the unique reference identifier which merchant has for a particular customer.",
"type": "string",
"example": "P125121001"
}
}
}
{
"properties": {
"rewardLinkCode": {
"description": "Unique link code issued during registration process. This is to be used in all subsequent reward transactions",
"type": "string",
"example": "9035268"
}
}
}
{
"properties": {
"cardDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/CardDetails"
}
}
}
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
}
},
"required": [
"cardId"
]
}
{
"properties": {
"rewardAccounts": {
"type": "array",
"items": {
"$ref": "#/definitions/RewardAccount"
}
}
},
"required": [
"rewardAccounts"
]
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"displayCardNumber": {
"description": "A masked card number that can be displayed to the customer.",
"type": "string",
"example": "XXXXXXXXXXXX4521"
},
"availablePointBalance": {
"type": "number",
"format": "int64",
"description": "Number of rewards points or miles available.",
"example": 10000
},
"rewardCategoryCode": {
"description": "Reward category code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{rewardCategoryCode} resource to get valid value of this field with description.",
"type": "string",
"example": "POINTS"
},
"lastStatementPointBalance": {
"description": "Number of rewards points or miles available since last statement balance.",
"type": "number",
"format": "double",
"example": 15000.25
},
"pointsEarned": {
"description": "Number of rewards points or miles earned since last statement date.",
"type": "number",
"format": "double",
"example": 2250.15
},
"rewardAccountErrorDetails": {
"$ref": "#/definitions/ErrorResponse"
},
"programConversionRate": {
"description": "Points to currency conversion rate for the rewards program",
"type": "number",
"format": "double",
"example": 0.2521
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"maximumPointsToRedeem": {
"description": "The maximum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 10000
},
"minimumPointsToRedeem": {
"description": "The minimum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 5000
},
"pointsTransferEligibleFlag": {
"description": "Flag to indicate Cardss eligibility for points transfers",
"type": "boolean",
"example": true
},
"payWithPointsEligibleFlag": {
"description": "Flag to indicate Card's is eligibility for pay with points",
"type": "boolean",
"example": true
},
"eligibleForConvertToCashFlag": {
"description": "Card is Eligible for Pay With Points",
"type": "boolean",
"example": true
},
"programDetails": {
"$ref": "#/definitions/ProgramDetails"
},
"partnerList": {
"type": "array",
"items": {
"$ref": "#/definitions/PartnerDetails"
}
}
},
"required": [
"cardId",
"displayCardNumber",
"availablePointBalance"
]
}
{
"type": "object",
"required": [
"lastFourDigitsCardNumber",
"citiCardHolderPhoneNumber",
"merchantCustomerReferenceId"
],
"properties": {
"lastFourDigitsCardNumber": {
"description": "Last four digits of the card number",
"type": "string",
"example": "5212"
},
"citiCardHolderPhoneNumber": {
"description": "Citi registered primary mobile number of the credit card holder with Country Code (without + sign).",
"type": "string",
"example": "6563471895"
},
"merchantCustomerReferenceId": {
"description": "Denotes the unique reference identifier which merchant has for a particular customer.",
"type": "string",
"example": "P125121001"
}
}
}
{
"properties": {
"rewardLinkCode": {
"description": "Unique link code issued during registration process. This is to be used in all subsequent reward transactions",
"type": "string",
"example": "9035268"
}
}
}
{
"properties": {
"linkageConfirmationCode": {
"description": "Confirmation number for reward link code activation.",
"type": "string",
"example": "9035268"
}
},
"required": [
"linkageConfirmationCode"
]
}
{
"properties": {
"cardLogo": {
"type": "string",
"description": "This denotes the logo details of the card.",
"example": 4412
}
}
}
{
"properties": {
"availablePointBalance": {
"type": "number",
"format": "int64",
"description": "Number of rewards points or miles available.",
"example": 10000
},
"programConversionRate": {
"description": "Points to currency conversion rate for the rewards program",
"type": "number",
"format": "double",
"example": 0.2521
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"maximumPointsToRedeem": {
"description": "The maximum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 10000
},
"minimumPointsToRedeem": {
"description": "The minimum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 5000
}
},
"required": [
"availablePointBalance"
]
}
{
"properties": {
"programType": {
"description": "Type of Program. Program for which the redemption is happening. This is a reference data. /v1/utilities/referenceData/{programType} resource to get possible values of this field with descriptions",
"type": "string",
"example": "CONVERT_TO_CASH"
},
"programConversionRate": {
"description": "Points to amount conversion rate for the rewards program",
"type": "number",
"format": "double",
"example": 140.23
},
"currencyCode": {
"type": "string",
"description": "The currency code of the insurance product in ISO 4217 format",
"example": "EUR"
},
"pointsInterval": {
"type": "number",
"format": "double",
"description": "Points interval for the program",
"example": 2.11
},
"maximumPointsToRedeem": {
"description": "The maximum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 10000
},
"minimumPointsToRedeem": {
"description": "The minimum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 5000
}
}
}
{
"properties": {
"partnerCode": {
"description": "The Registered partner code.",
"type": "string",
"example": "4222521"
},
"partnerCustomerId": {
"description": "Membership number with the registered partner.",
"type": "string",
"example": "12322323222"
}
}
}
{
"properties": {
"linkageConfirmationCode": {
"description": "Confirmation number for reward link code activation.",
"type": "string",
"example": "9035268"
}
},
"required": [
"linkageConfirmationCode"
]
}
{
"properties": {
"cardLogo": {
"type": "string",
"description": "This denotes the logo details of the card.",
"example": 4412
}
}
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}