Rewards

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.

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	Reward Token Activation
get /v1/apac/rewards/{rewardLinkCode}/pointBalance	Retrieve Rewards Balance
post /v1/apac/rewards/{rewardLinkCode}/redemption	Submit Redemption Request
get /v1/rewards/{rewardLinkCode}/shopWithPoints/pointBalance	Retrieve Credit Card Account Reward Points Balance
post /v1/rewards/shopWithPoints/linkage	Shop With Points- Rewards Linkage
post /v1/rewards/{rewardLinkCode}/shopWithPoints/redemption	Shop With Points-Redemption
put /v1/rewards/{rewardLinkCode}/shopWithPoints/activations	Shop With Points-Rewards Linkage Activation
delete /v1/rewards/{rewardLinkCode}/shopWithPoints	Shop With Points-Rewards Linkage De Activation
post /v1/rewards/shopWithPoints/redemption	Redeem Reward Points
post /v1/rewards/shopWithPoints/redemption/reversals	Shop With Points Point Redemption Reversal
post /v1/creditCards/rewards/pointBalance/search	Get Rewards Points Balance
post /v1/rewards/selectAndCredit/redemption	Select and Credit - Redemption
get /v1/rewards/pointBalance	This API is used to inquire the available rewards points for all the credit cards of the customer
put /v1/rewards/frequentFlyer	This API is used to inquire the details for the Frequent flyer redemption
get /v1/rewards/frequentFlyer	This API is used to inquire the details for the Frequent flyer redemption
get /v1/rewards/catalogue	This API is used to fetch the catalogue list
get /v1/rewards/categories	This API is used to fetch the rewards categories supported for a given card
post /v1/rewards/redemption	This API is used to redeem Rewards points of the card

Enroll in Pay with Points

post /v1/apac/rewards/linkage

Description

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

Swagger

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.

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

{
    "type": "object",
    "required": [
        "lastFourDigitsCardNumber",
        "citiCardHolderPhoneNumber",
        "merchantCustomerReferenceId"
    ],
    "properties": {
        "lastFourDigitsCardNumber": {
            "description": "Last four digits of the card number",
            "type": "string",
            "example": "7411"
        },
        "citiCardHolderPhoneNumber": {
            "description": "Citi registered primary mobile number of the credit card holder",
            "type": "string",
            "example": "2608191234"
        },
        "merchantCustomerReferenceId": {
            "description": "Denotes the unique reference identifier which merchant has for a particular customer.",
            "type": "string",
            "example": "2608191234111"
        }
    }
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	cardAlreadyRegistered	The card is already registered
error	invalidCardType	Card type is invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

Reward Token Activation

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

Description

This API activates the Rewards token associated with the last four digit of credit card number and mobile number.

Swagger

Header Parameters

uuid

string required

128 bit random UUID generated uniquely for every request.

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

{
    "properties": {
        "linkageConfirmationCode": {
            "description": "Confirmation number for reward link code activation.",
            "type": "string",
            "example": "735937"
        }
    },
    "required": [
        "linkageConfirmationCode"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

This operation returns no content.

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	activationFailed	Link code activation is failed
error	exceedsMaximumAttempts	Maximum attempts exceeded for activation. Link credit card to a merchant again.
error	linkageConfirmationCodeExpired	Linkage confirmation code is expired. Link credit card to a merchant again

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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

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

Swagger

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.

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

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	invalidRewardLinkCode	Reward link code is invalid
invalid	inactiveRewardLinkCode	Reward link code is inactive

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

resourceNotFound

Empty resource/resource not found

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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

This API enabled the customer to 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.

Swagger

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.

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

{
    "properties": {
        "transactionReferenceNumber": {
            "description": "This is reference number for the original transaction done at merchant side using the card.",
            "type": "string",
            "example": "132323454de6234543"
        },
        "redemptionOrder": {
            "properties": {
                "transactionAmount": {
                    "description": "The total transaction amount. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic: pointsToRedeem = RoundOf (transactionAmount\/programConversionRate)",
                    "type": "number",
                    "format": "double",
                    "example": 100.5
                },
                "currencyCode": {
                    "description": "The currency code of the account in ISO 4217 format",
                    "type": "string",
                    "example": "AUD"
                },
                "pointsToRedeem": {
                    "description": "The points or miles that needs to redeemed. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount\/programConversionRate)",
                    "type": "number",
                    "format": "int64",
                    "example": 1005
                },
                "transactionDescription": {
                    "description": "Transaction description from the merchant",
                    "type": "string",
                    "example": "Completed"
                }
            },
            "required": [
                "transactionAmount"
            ]
        }
    },
    "required": [
        "transactionReferenceNumber",
        "redemptionOrder"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	invalidRewardLinkCode	Reward link code is invalid
error	errorGeneratingOrderId	Order Id is not generated
error	inSufficientPointBalance	The order points cannot be more than available balance of the member
error	exceedsMaximumPointsAllowed	Requested amount or points are more than allowed equivalent points.
error	notEligibleToRedeem	Member not eligible to order this item
error	belowMinimumPointsAllowed	Requested amount or points are less than allowed equivalent points.
error	inactiveRewardLinkCode	Reward link code is inactive
error	invalidPointsAndAmountCombination	Points and amount combination are invalid
error	currencyNotSupported	Currency is not supported

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

Retrieve Credit Card Account Reward Points Balance

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

Description

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

Swagger

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.

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

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	invalidRewardLinkCode	Reward link code is invalid
invalid	inactiveRewardLinkCode	Reward link code is inactive

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

resourceNotFound

Empty resource/resource not found

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

Shop With Points- Rewards Linkage

post /v1/rewards/shopWithPoints/linkage

Description

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

Swagger

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.

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

Body Parameters

ShopWithPointsRewardsLinkageRequest

required

card information

{
    "type": "object",
    "required": [
        "lastFourDigitsCardNumber",
        "citiCardHolderPhoneNumber",
        "merchantCustomerReferenceId"
    ],
    "properties": {
        "lastFourDigitsCardNumber": {
            "description": "Last four digits of the card number",
            "type": "string",
            "example": "5212"
        },
        "citiCardHolderPhoneNumber": {
            "description": "Citi registered primary mobile number of the credit card holder with Country Code (without + sign).",
            "type": "string",
            "example": "6563471895"
        },
        "merchantCustomerReferenceId": {
            "description": "Denotes the unique reference identifier which merchant has for a particular customer.",
            "type": "string",
            "example": "P125121001"
        }
    }
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	cardAlreadyRegistered	The card is already registered
error	invalidCardType	Card type is invalid
error	registrationFailed	Registration failed

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

Shop With Points-Redemption

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

Description

This API enabled the customer to 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.

Swagger

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.

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

Body Parameters

ShopWithPointsRewardPointsRedemptionRequest

required

Redemption information

{
    "properties": {
        "transactionReferenceNumber": {
            "description": "This is reference number for the original transaction done at merchant side using the card.",
            "type": "string",
            "example": "10001278"
        },
        "redemptionOrder": {
            "properties": {
                "transactionAmount": {
                    "description": "The total transaction amount. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic: pointsToRedeem = RoundOf (transactionAmount\/programConversionRate)",
                    "type": "number",
                    "format": "double",
                    "example": 100.5
                },
                "currencyCode": {
                    "description": "The currency code of the account in ISO 4217 format",
                    "type": "string",
                    "example": "AUD"
                },
                "pointsToRedeem": {
                    "description": "The points or miles that needs to redeemed. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount\/programConversionRate)",
                    "type": "number",
                    "format": "int64",
                    "example": 1005
                },
                "transactionDescription": {
                    "description": "Transaction description from the merchant",
                    "type": "string",
                    "example": "Completed"
                }
            },
            "required": [
                "transactionAmount"
            ]
        }
    },
    "required": [
        "transactionReferenceNumber",
        "redemptionOrder"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

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

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	invalidRewardLinkCode	Reward link code is invalid
error	errorGeneratingOrderId	Order Id is not generated
error	inSufficientPointBalance	The order points cannot be more than available balance of the member
error	exceedsMaximumPointsAllowed	Requested amount or points are more than allowed equivalent points.
error	notEligibleToRedeem	Member not eligible to order this item
error	belowMinimumPointsAllowed	Requested amount or points are less than allowed equivalent points.
error	inactiveRewardLinkCode	Reward link code is inactive
error	invalidPointsAndAmountCombination	Points and amount combination are invalid
error	currencyNotSupported	Currency is not supported
error	transactionAlreadyRedeemed	Transaction is already redeemed

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error/server unavailability

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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"
    ]
}

Shop With Points-Rewards Linkage Activation

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

Description

This API is used to Activate the Rewards token associated with the last four digit of credit card number and mobile number.

Swagger

Header Parameters

uuid

string required

128 bit random UUID generated uniquely for every request.

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

Path Parameters

rewardLinkCode

string required

Unique link code issued during registration process.

Body Parameters

ShopWithPointsRewardsLinkageActivationRequest

required

{
    "properties": {
        "linkageConfirmationCode": {
            "description": "Confirmation number for reward link code activation.",
            "type": "string",
            "example": "9035268"
        }
    },
    "required": [
        "linkageConfirmationCode"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

This operation returns no content.

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters
error	activationFailed	Link code activation is failed
error	exceedsMaximumAttempts	Maximum attempts exceeded for activation. Link credit card to a merchant again.
error	linkageConfirmationCodeExpired	Linkage confirmation code is expired. Link credit card to a merchant again

Definitions

type
- type : string
- enum : error, warn, invalid, fatal
- 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

Menu

Rewards

Warning message

Rewards

Rewards

Summary

Enroll in Pay with Points

Reward Token Activation

Retrieve Rewards Balance

Submit Redemption Request

Retrieve Credit Card Account Reward Points Balance

Shop With Points- Rewards Linkage

Shop With Points-Redemption

Shop With Points-Rewards Linkage Activation