I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

Australia - Pay With Points API Documentation

Pay With Points

Summary

The Pay with Points API lets Citi customers use their Citi Points to pay for all or part of a transaction on your app. To simplify integration, transaction payments are processed through your existing payment gateway. A matching statement credit is then applied to the customer's Citi account, usually within 1-3 days.

The Pay With Points API uses the client_credentials grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
post /v1/apac/rewards/linkage Enroll in Pay with Points
put /v1/apac/rewards/{rewardLinkCode}/activations Token Activation
get /v1/apac/rewards/{rewardLinkCode}/pointBalance Retrieve rewards balance
post /v1/apac/rewards/{rewardLinkCode}/redemption Submit redemption request
delete /v1/apac/rewards/{rewardLinkCode} PayWithPoints-RewardLinkageDeActivation
get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance Retrieve credit card account reward points balance
post /v1/rewards/shopWithPoints/linkage ShopWithPoints-RewardsLinkage
post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption ShopWithPoints-Redemption
put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations ShopWithPoints-RewardLinkageActivation
delete /v1/rewards/{rewardLinkCode}/shopWithPoints ShopWithPoints-RewardLinkageDeActivation

Enroll in Pay with Points

post /v1/apac/rewards/linkage
Description

Enroll the customer to Pay With Points program and returns a token which require activation and that will be used for subsequent API Calls. Separate enrollment is required for each credit card.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
Content-Type
string required
application/json
Accept-Language
string Optional
Accept-Language header.
client_id
string required
The client ID you received during application registration in the developer portal
Body Parameters
RewardsLinkageRequest
required
card information
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
  • rewardLinkCode
    • Unique link code issued during registration process. This is to be used in all subsequent reward transactions
    • type : string
Example Response for post /v1/apac/rewards/linkage
{
    "rewardLinkCode": "9035268"
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
error cardAlreadyRegisteredThe card is already registered
errorinvalidCardTypeCard type is invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

Token Activation

put /v1/apac/rewards/{rewardLinkCode}/activations
Description

Activates the Rewards token associated with the last four digit of credit card number and mobile number.

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==.
Accept-Language
string Optional
Accept-Language header.
Path Parameters
rewardLinkCode
string required
Unique link code issued during registration process.
Body Parameters
RewardsLinkageActivationRequest
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
erroractivationFailedLink code activation is failed
errorexceedsMaximumAttemptsMaximum attempts exceeded for activation. Link credit card to a merchant again.
errorlinkageConfirmationCodeExpiredLinkage confirmation code is expired. Link credit card to a merchant again
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/apac/rewards/{rewardLinkCode}/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/apac/rewards/{rewardLinkCode}/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/apac/rewards/{rewardLinkCode}/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/apac/rewards/{rewardLinkCode}/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

Retrieve rewards balance

get /v1/apac/rewards/{rewardLinkCode}/pointBalance
Description

Returns the Citi Rewards Points balance and the details for converting the specified token to a dollar amount.

Path Parameters
rewardLinkCode
string required
Unique link code issued during registration process. This is to be used to identify reward transactions
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
The client ID you received during application registration in the developer portal
Accept-Language
string Optional
Accept-Language header.
  • 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
  • availablePointBalance
    • type : number
    • format : int64
    • Number of rewards points or miles available.
  • programConversionRate
    • Points to currency conversion rate for the rewards program
    • type : number
    • format : double
  • currencyCode
    • The currency code of the account in ISO 4217 format
    • type : string
  • maximumPointsToRedeem
    • The maximum number of points that can be used towards a purchase
    • type : number
    • format : int64
  • minimumPointsToRedeem
    • The minimum number of points that can be used towards a purchase
    • type : number
    • format : int64
Example Response for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "availablePointBalance": 10000,
    "programConversionRate": 0.2521,
    "currencyCode": "SGD",
    "maximumPointsToRedeem": 10000,
    "minimumPointsToRedeem": 5000
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidRewardLinkCodeReward link code is invalid
invalidinactiveRewardLinkCodeReward link code is inactive
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/apac/rewards/{rewardLinkCode}/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

Submit redemption request

post /v1/apac/rewards/{rewardLinkCode}/redemption
Description

The customer can pay for any item from partners website using his points that have been accumulated on his Citi credit card. Redemption happens after the transaction and the amount of his points is credited to Citi customer's account.

Path Parameters
rewardLinkCode
string required
Unique link code per card associated with a member account
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.
Content-Type
string required
application/json
client_id
string required
The client ID you received during application registration in the developer portal
Accept-Language
string Optional
Accept-Language header.
Body Parameters
rewardsPointsRedemptionRequest
required
Redemption information
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
  • orderId
    • The unique order id
    • type : string
  • availablePointBalance
    • The new points or miles balance
    • type : integer
    • format : int64
Example Response for post /v1/apac/rewards/{rewardLinkCode}/redemption
{
    "orderId": "T25100025",
    "availablePointBalance": 6000
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidRewardLinkCodeReward link code is invalid
errorerrorGeneratingOrderIdOrder Id is not generated
errorinSufficientPointBalanceThe order points cannot be more than available balance of the member
errorexceedsMaximumPointsAllowedRequested amount or points are more than allowed equivalent points.
errornotEligibleToRedeemMember not eligible to order this item
errorbelowMinimumPointsAllowedRequested amount or points are less than allowed equivalent points.
errorinactiveRewardLinkCodeReward link code is inactive
errorinvalidPointsAndAmountCombinationPoints and amount combination are invalid
errorcurrencyNotSupportedCurrency is not supported
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/{rewardLinkCode}/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/{rewardLinkCode}/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/{rewardLinkCode}/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/apac/rewards/{rewardLinkCode}/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

PayWithPoints-RewardLinkageDeActivation

delete /v1/apac/rewards/{rewardLinkCode}
Description

This API is used to de-register the Pay With Points enrollment in card based on customer 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.
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language
string Optional
Accept-Language header.
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
rewardLinkCode
string required
Unique link code issued during registration process.
  • 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
errorinvalidRewardLinkCodeReward link code is invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/apac/rewards/{rewardLinkCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/apac/rewards/{rewardLinkCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/apac/rewards/{rewardLinkCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/apac/rewards/{rewardLinkCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

Retrieve credit card account reward points balance

get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
Description

Returns the Citi Rewards points balance and details of the points conversion to amount associated with rewards token.

Path Parameters
rewardLinkCode
string required
Unique link code issued during registration process. This is to be used to identify reward transactions
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
The client ID you received during application registration in the developer portal
Accept-Language
string Optional
Accept-Language header.
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
  • 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
  • availablePointBalance
    • type : number
    • format : int64
    • Number of rewards points or miles available.
  • programConversionRate
    • Points to currency conversion rate for the rewards program
    • type : number
    • format : double
  • currencyCode
    • The currency code of the account in ISO 4217 format
    • type : string
  • maximumPointsToRedeem
    • The maximum number of points that can be used towards a purchase
    • type : number
    • format : int64
  • minimumPointsToRedeem
    • The minimum number of points that can be used towards a purchase
    • type : number
    • format : int64
Example Response for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "availablePointBalance": 10000,
    "programConversionRate": 0.2521,
    "currencyCode": "SGD",
    "maximumPointsToRedeem": 10000,
    "minimumPointsToRedeem": 5000
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidRewardLinkCodeReward link code is invalid
invalidinactiveRewardLinkCodeReward link code is inactive
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

ShopWithPoints-RewardsLinkage

post /v1/rewards/shopWithPoints/linkage
Description

Enroll the customer to Show With Points program and returns a token which require activation and that will be used for subsequent API Calls. Separate enrollment is required for each credit card.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
Content-Type
string required
application/json
Accept-Language
string Optional
Accept-Language header.
client_id
string required
The client ID you received during application registration in the developer portal
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Body Parameters
ShopWithPointsRewardsLinkageRequest
required
card information
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
  • rewardLinkCode
    • Unique link code issued during registration process. This is to be used in all subsequent reward transactions
    • type : string
Example Response for post /v1/rewards/shopWithPoints/linkage
{
    "rewardLinkCode": "9035268"
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
error cardAlreadyRegisteredThe card is already registered
errorinvalidCardTypeCard type is invalid
errorregistrationFailedRegistration failed
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/shopWithPoints/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/shopWithPoints/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/shopWithPoints/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/shopWithPoints/linkage
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

ShopWithPoints-Redemption

post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
Description

The customer can buy any item from partners website using his points that have been accumulated on his Citi credit card. Redemption happens before the transaction hence customer can reduce the bill in the amount of his points redeemed.

Path Parameters
rewardLinkCode
string required
Unique link code per card associated with a member account
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.
Content-Type
string required
application/json
client_id
string required
The client ID you received during application registration in the developer portal
Accept-Language
string Optional
Accept-Language header.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Body Parameters
ShopWithPointsRewardPointsRedemptionRequest
required
Redemption information
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
  • orderId
    • The unique order id
    • type : string
  • availablePointBalance
    • The new points or miles balance
    • type : integer
    • format : int64
Example Response for post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
{
    "orderId": "T25100025",
    "availablePointBalance": 6000
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidRewardLinkCodeReward link code is invalid
errorerrorGeneratingOrderIdOrder Id is not generated
errorinSufficientPointBalanceThe order points cannot be more than available balance of the member
errorexceedsMaximumPointsAllowedRequested amount or points are more than allowed equivalent points.
errornotEligibleToRedeemMember not eligible to order this item
errorbelowMinimumPointsAllowedRequested amount or points are less than allowed equivalent points.
errorinactiveRewardLinkCodeReward link code is inactive
errorinvalidPointsAndAmountCombinationPoints and amount combination are invalid
errorcurrencyNotSupportedCurrency is not supported
errortransactionAlreadyRedeemedTransaction is already redeemed
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error/server unavailability
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

ShopWithPoints-RewardLinkageActivation

put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations
Description

Activates the Rewards token associated with the last four digit of credit card number and mobile number.

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==.
Accept-Language
string Optional
Accept-Language header.
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
rewardLinkCode
string required
Unique link code issued during registration process.
Body Parameters
ShopWithPointsRewardsLinkageActivationRequest
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
erroractivationFailedLink code activation is failed
errorexceedsMaximumAttemptsMaximum attempts exceeded for activation. Link credit card to a merchant again.
errorlinkageConfirmationCodeExpiredLinkage confirmation code is expired. Link credit card to a merchant again
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

ShopWithPoints-RewardLinkageDeActivation

delete /v1/rewards/{rewardLinkCode}/shopWithPoints
Description

This API is used to de-register the Shop With Points enrollment in card based on customer 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.
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
Accept-Language
string Optional
Accept-Language header.
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
rewardLinkCode
string required
Unique link code issued during registration process.
  • 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
errorinvalidRewardLinkCodeReward link code is invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/rewards/{rewardLinkCode}/shopWithPoints
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • type : string
    • enum : Array

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/rewards/{rewardLinkCode}/shopWithPoints
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],