Easy Payment Plan

Cards

Easy Payment Plan

Enhance customers' shopping experiences by providing them with new ways to convert an outstanding credit card or unbilled purchase amount into an easy payment plan (EPP) from Partner platform.

Australia

India

Convert outstanding credit card or purchase amount into an EPP

Easily and conveniently convert an outstanding Citi credit card or unbilled purchase amount into an easy payment plan (EPP) at low interest rates through Partner platform.
Zoom In

Identify yourself securely

Customers are redirected to a modal window (triggered by the OAuth API) where they are asked to log in to their Citi account in order to verify their identity.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Authorization Code

This API gets invoked by a web browser redirection and requires user interaction. It is used to retrieve an authorization code by redirecting the user to a login page followed by the consent approval page. At the end of this flow, this endpoint returns to the redirect_uri configured for the associated application.

Endpoint

Australia: GET /authCode/oauth2/authorize

India: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Customers validate the one-time password

Customers validate the one-time password sent to their registered mobile number. In the three-legged OAuth flow, OTP validation is based on a fraud and risk recommendation, which is not mandatory.
Zoom In

Customer consent

Customers are then presented with Citi’s consent page where they can read the Terms and Conditions and review what account information will be shared with the third-party application. If they agree, they can click ‘Authorize'.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Access Token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will have an expiry, and it will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in Authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

India: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Card selection

From the list of available cards, customers can select the card that has the outstanding amount or the unbilled purchase amount they wish to convert into an EPP.

 

There is a variation in API callouts for listing of cards on this screen for aggregrators and co-brand partners. Please refer to whichever applicable.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve All Cards - For Aggregators

This API is used to retrieve all the credit card numbers and corresponding details of the customers who authorized the application.

Endpoint

Australia : GET /v1/cards

India : GET /v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 2 >
×

Use Case Callout

Retrieve All Cards - For Cobrand Partners

This API is used to list all the cards held by a customer with Citi partner.

Endpoint

Australia : GET /partner/v1/cards

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

Selection of EPP type

Customers need to select either the statement or transaction EPP type to convert the outstanding statement amount or the unbilled purchase amount into an EPP. Once the EPP type is selected, the outstanding statement amount or eligible unbilled transactions are displayed on the next screen.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Check Easy Payment Plan Eligibility

This API is used to validate the transaction eligibility for EPP conversion.

Endpoint

Australia: GET /v1/creditCards/{cardId}/easyPaymentPlans/eligibility

India: GET /v1/creditCards/{cardId}/easyPaymentPlans/eligibility

Parameters

PATH

cardId

Query

eppLoanBookingType

nextStartIndex

Option 1. Credit card statement summary

If customers clicked "Statement" on the previous screen, they can view the statement summary of chosen credit card's outstanding amount on the third-party application. They can choose the amount they wish to convert into an EPP based upon which of the plans (which include components suchs as tenor, interest rate, monthly installment amount, and processing fee) will be retrieved. They need to select one of the plans to proceed.

 

The eligible loan amount will be sent as parameter for EPP of type STATEMENT.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Easy Payment Plans Options

This API retrieves the available Easy Payment Plans to be used by the customer for the repayment of his/her loans.

Endpoint

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

India: POST /v1/creditCards/{cardId}/easyPaymentPlans/search

Parameters

PATH

cardId

Body

eppLoanBookingType

loanAmount (optional)

Option 2. Credit card unbilled transactions

If customers clicked "Transaction" when selecting an EPP type, they can view their credit card transactions on the third-party application. They can choose to convert the complete transaction amount into an EPP based upon which the plans (which include components such as tenor, interest rate, monthly installment amount, and processing fee) will be retrieved. They need to select one of the plans to proceed.

 

The transaction reference ID will be sent as parameter for EPP of type TRANSACTION.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Easy Payment Plans Options

This API retrieves the available Easy Payment Plans to be used by the customer for the repayment of his/her loans.

Endpoint

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

India: POST /v1/creditCards/{cardId}/easyPaymentPlans/search

Parameters

PATH

cardId

Body

eppLoanBookingType

transactionReferenceId (optional)

Review and confirm the EPP booking

Customers can review their EPP details and provide confirmation for EPP booking.

 

API Callout2 is only applicable for India.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Book Easy Payment Plan

This API is triggered after the EPP plan selection and completes the EPP booking. On successful booking, it returns transaction reference in the response.

Endpoint

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

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

Parameters

PATH

cardId

Body

eppLoanBooking (loanAmount)

eppLoanBookingType

tenor

View Api Callout 2 >
×

Use Case Callout

Confirm Easy Payment Plan Booking

This API is triggered after the EPP plan is selected and completes the EPP booking. On successful booking, it returns transaction reference in the response.

Endpoint

India: POST /v1/creditCards/{cardId}/easyPaymentPlans/bookings/confirmation

Parameters

PATH

cardId

Body

controlFlowId

Option 1. Acknowledgement for statement EPP conversion

Customers recieve confirmation that their outstanding credit card amount was converted into an EPP, along with a transaction reference number.
Zoom In

Option 2. Acknowledgement for transaction EPP conversion

Customers recieve confirmation that&nbsp;their unbilled purchase amount was converted into easy payment plan, along with a transaction reference number.
Zoom In

EPP repayment schedule

Customers can view the repayment schedule, including the first month's installment as well as all other subsequent installments included in their chosen plan.
Zoom In