Citi PayLite

Cards

Citi PayLite

Enhance customers' shopping experiences with Citi PayLite by providing them with new ways to pay for merchandise and services. Customers can choose to pay using Citi reward points or miles, pay in installments or a combination of both.

Australia

Hong Kong

Indonesia

Malaysia

Philippines

Singapore

Thailand

Vietnam

Customers can shop at ease with flexible payment options

Customers can enjoy a great shopping experience when they check out on your app or website using Citi PayLite. They have the option to pay for their purchase either entirely or partially with points, and they can choose to pay all at once or in installments by using Easy Payment Plans.


 

Zoom In

Secure identification

Customers can enroll in Shop With Points and Citi PayLite by registering with their preferred Citi credit card. This allows them to verify their identity without compromising on their security. 

 

Refer to the API callout for information about generating a card access token.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Enroll and Generate Card Access Token

This API is used to enroll the customer to avail services like Rewards Redemption and EPP from the partner's site through a common registration.

A one-time password is sent to the customer's registered mobile number. The customer completes his registration by validating the one-time password and receives a notification from the bank after the successful registration.

Endpoint

Australia: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Hong Kong: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Indonesia: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Malaysia: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Singapore: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Philippines: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Thailand: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Vietnam: POST /cardAuth/oauth2/authorize/{countryCode}/{businessCode}

Parameters

PATH

countryCode

businessCode

Body

lastFourDigitsCardNumber
citiCardHolderPhoneNumber
merchantCustomerReferenceId
grant_type

Customers can validate the one-time password sent to their registered mobile number

Customers complete their registration by validating the one-time password sent to their registered mobile number. They’ll receive a notification from their bank after a successful registration.

 

Refer to the API callout for information about activating card access token.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Activate Card Access Token 

This API activates a customer's access token. Separate token activation is required for each credit card held by the customer.

Endpoint

Australia: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Hong Kong: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Indonesia: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Malaysia: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Singapore: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Philippines: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Thailand: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Vietnam: POST  /cardAuth/oauth2/token/{countryCode}/{businessCode}

Parameters

PATH

countryCode

businessCode

Body

controlFlowId
linkageConfirmationCode

Registration completed

Customers are informed when their registration has been completed. 

 

Once they click on 'Shop now', they can retrieve their point balance and see if they are eligible for Easy Payment Plans.

 

Refer to the API Callout 1 for information about retrieving a point balance and API Callout 2 for information about determining Easy Payment Plan eligibility.

 

 

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Get Rewards Points Balance

Returns the Citi rewards points balance and the details for converting the specified token to a dollar amount.

Endpoint

Australia: POST  /v1/creditCards/rewards/pointBalance/search

Hong Kong: POST  /v1/creditCards/rewards/pointBalance/search

Indonesia: POST  /v1/creditCards/rewards/pointBalance/search

Malaysia: POST  /v1/creditCards/rewards/pointBalance/search

Singapore: POST  /v1/creditCards/rewards/pointBalance/search

Philippines: POST  /v1/creditCards/rewards/pointBalance/search

Thailand: POST  /v1/creditCards/rewards/pointBalance/search

Vietnam: POST  /v1/creditCards/rewards/pointBalance/search

Parameters

PATH

NA

Body

cardId

View Api Callout 2 >
×

Use Case Callout

Transaction Eligibility and Easy Payment Plans

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

Endpoint

Australia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Hong Kong: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Indonesia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Malaysia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Singapore: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Philippines: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Thailand: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Vietnam: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Parameters

PATH

cardId

Query

eligbleLoanAmount

Refresh Token

When checking the availability of the access token for a customer’s credit card: 


If the access token is not available, customers need to register themselves to get the access token, as illustrated in the above steps of this journey. 

 

If the token is already available, then the validity of the existing access token is determined. 

 

If the access token has expired, then you can refresh a customer’s access token by calling the Refresh Token API. Subsequent API calls in this journey are dependent on the availability of a valid access token. 

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Refresh Card Access Token 

This API generates a fresh access token. If your access token has expired and you still have a valid refresh token, you can exchange it for a new set of valid access and refresh tokens. 

End Point

Australia: POST /cardAuth/oauth2/refresh

Hong Kong: POST /cardAuth/oauth2/refresh

Indonesia: POST /cardAuth/oauth2/refresh

Malaysia: POST /cardAuth/oauth2/refresh

Singapore: POST /cardAuth/oauth2/refresh

Philippines: POST /cardAuth/oauth2/refresh

Thailand: POST /cardAuth/oauth2/refresh

Vietnam: POST /cardAuth/oauth2/refresh

Parameters

PATH

NA

Body

refresh_token

Customers select the product to purchase

Customers select the product they want and then click on 'Check out' to proceed with their purchase.
Zoom In

Customers decide how to use redemption points and select an Easy Payment Plan

Customers can decide the number of points to redeem and may use them for full or partial payment of their purchases. Based on their inputs, a list of payment plans will be displayed. If they choose to pay partially with points, a part of the transaction amount will be settled through point redemption and the remaining will be billed as per the selected payment plan. Customers then click on 'Proceed' to submit the point redemption and plan booking request.


Refer to the below API callout to check the Easy Payment Plans eligibility for a card and the available Payment Plans details.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Transaction Eligibility and Easy Payment Plans

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

Endpoint

Australia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Hong Kong: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Indonesia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Malaysia: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Singapore: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Philippines: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Thailand: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

Vietnam: GET /v1/creditCards/{cardId}/transactions/eligibility/easyPaymentPlan

 

Parameters

PATH

cardId

Query

eligbleLoanAmount

Point redemption and easy payment plan booking - scenario 1

In this scenario, the partner's app or website already has the customer's credit card details to initiate the authorization.

 

After the customers select the redemption points and payment plan, point redemption occurs in the background by calling the API Callout 1. Plan booking is done in parallel by redirecting the customers to the Association Gateway. 

 

After approval, partner calls Citi to submit the request for the Installment Plan Booking by calling API Callout 2.

 

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

ShopWithPoints-Redemption

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

Endpoint

Australia: POST /v1/rewards/shopWithPoints/redemption

Hong Kong: POST /v1/rewards/shopWithPoints/redemption

Indonesia: POST /v1/rewards/shopWithPoints/redemption

Malaysia: POST /v1/rewards/shopWithPoints/redemption

Singapore: POST /v1/rewards/shopWithPoints/redemption

Philippines: POST /v1/rewards/shopWithPoints/redemption

Thailand: POST /v1/rewards/shopWithPoints/redemption

Vietnam: POST /v1/rewards/shopWithPoints/redemption

Parameters

Body

cardId

transactionReferenceId

transactionAmount

currencyCode

pointsToRedeem

transactionDescription

View Api Callout 2 >
×

Use Case Callout

Easy Payment Plan Booking

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

Endpoint

Australia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Hong Kong: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Indonesia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Malaysia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Singapore: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Philippines: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Thailand: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Vietnam: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Parameters

PATH

cardId

Body

loanAmount
eppLoanBooking
eppLoanBookingType
tenor

Point redemption and easy payment plan booking - scenario 2

In this scenario, customers enter their credit card details on the partner's app or website to initiate the authorization.

 

After the customers select the redemption points and payment plan, point redemption occurs in the background by calling the API Callout 1. Plan booking is done in parallel by redirecting the customers to the Association Gateway. 

 

After approval, partner calls Citi to submit the request for the Installment Plan Booking by calling API Callout 2.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

ShopWithPoints-Redemption

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

Endpoint

Australia: POST /v1/rewards/shopWithPoints/redemption

Hong Kong: POST /v1/rewards/shopWithPoints/redemption

Indonesia: POST /v1/rewards/shopWithPoints/redemption

Malaysia: POST /v1/rewards/shopWithPoints/redemption

Singapore: POST /v1/rewards/shopWithPoints/redemption

Philippines: POST /v1/rewards/shopWithPoints/redemption

Thailand: POST /v1/rewards/shopWithPoints/redemption

Vietnam: POST /v1/rewards/shopWithPoints/redemption

 

Parameters

Body

cardId

transactionReferenceId

transactionAmount

currencyCode

pointsToRedeem

transactionDescription

View Api Callout 2 >
×

Use Case Callout

Easy Payment Plan Booking

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

Endpoint

Australia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Hong Kong: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Indonesia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Malaysia: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Singapore: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Philippines: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Thailand: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

Vietnam: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings

 

Parameters

PATH

cardId

Body

loanAmount
eppLoanBooking
eppLoanBookingType
tenor

Transaction is processed

Customers wait until their transaction is processed.
Zoom In

Order confirmation

After a successful order placement, customers receive a confirmation message that shows the payment amount redeemed through points and paid through an Easy Payment Plan, along with the order number, date and time. They also receive a notification from their bank shortly after.
Zoom In