Overseas Travel Plan

Cards

Overseas Travel Plan

Notify Citi about your international travel plan to avoid credit card transactions being declined for overseas purchases in high-risk countries.

India

Notify Citi about international travel

Notify Citi about your international travel plan to avoid credit card transactions being declined for overseas purchases in high-risk countries.
Zoom In

Identify yourself securely

The customer is prompted with 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

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 review what account information will and will not be be shared with the third-party as well as the Terms and Conditions. If they agree, customers can click ‘Authorize' to continue.
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

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

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Card selection: Add travel plan

From the list of available cards, customers can select the card they wish to create an international plan for.

 

There is a variation in API callouts for the card listing on this screen for aggregrators and co-brand partners. Please refer to whichever applies.

 

If there is already a plan in place for a selected card, customers will be shown those details.

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

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

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 3 >
×

Use Case Callout

Inquire Current Travel Plan

This API enables customer to inquire current travel plan.

Endpoint

India: GET /v1/cards/overseasTravelPlans

Parameters

Query

cardId

Body

NA

Customers enable international transactions

If customers have not activated their overseas transactions or have disabled them, they will receive a pop-up message to enable them through the 'Manage Cards' section in order for plan set-up to work seamlessly. Customers can click 'OK' to proceed to adding their international travel plan to the card.
Zoom In

Add international travel plan

Customers add a new international travel plan to the card if there is no existing travel plan already added to that card. A customer can add only one travel plan to one card.

 

How far in advance a plan can be established as well as the duration of the plan are configurable based upon the market.

Zoom In

Select travel dates

Customers can select the start and end dates for their plan from the calendar and can click 'Confirm' when they're done. 
Zoom In

Select destination(s)

Customers can select their destination(s) and then click 'Submit'. The maximum number of destination(s) that can be selected at a time are configurable based upon the market.

Zoom In

Review international travel plan

Customers review the travel dates and destination(s), accept terms and conditions and click 'Confirm' to add their international travel plan to the card.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Add New Travel Plan

This API enables customer to add a new travel plan.

Endpoint

India: POST /v1/cards/{cardId}/overseasTravelPlans

Parameters

PATH

cardId

Body

OverseasTravelPlanAddRequest (travelPlanStartDate, travelPlanEndDate)

Confirmation of a new travel plan

Customers recieve a confirmation that their international travel plan has been established successfully.
Zoom In

Card selection: Update travel plan

From the list of available cards, customers can select the card that has the plan they wish to update.

 

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

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

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

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 3 >
×

Use Case Callout

Inquire Current Travel Plan

This API enables customer to inquire current travel plan.

Endpoint

India: GET /v1/cards/overseasTravelPlans

Parameters

Query

cardId

Body

NA

Update international travel plan

Customers can update the existing international travel plan linked to their selected card by clicking 'Update'.
Zoom In

Update existing travel plan

Customers can review the existing plan details on the card and update the travel dates and destination(s).

 

How far in advance the plan can be established and the duration are configurable based upon the market.

Zoom In

Update travel dates

Customers can update the travel dates of the existing plan with the calendar and click 'Confirm'.
Zoom In

Update travel countries

Customers can update the destination(s) for the existing plan and click 'Submit'.

 

The maximum number of destination(s) that can be selected at a time are configurable based upon the market.

Zoom In

Review update to international travel plan

Customers review the updated travel dates and destination(s), accept terms and conditions and click 'Confirm' to update their existing plan.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Update Existing Travel Plan

This API enables customer to update an existing travel plan.

Endpoint

India: PUT /v1/cards/{cardId}/overseasTravelPlans

Parameters

PATH

cardId

Body

OverseasTravelPlanUpdateRequest (travelPlanStartDate, travelPlanEndDate)

Confirmation of updated international travel plan

Customers recieve a confirmation that the existing international travel plan has been updated successully.
Zoom In

Card selection: Delete travel plan

From the list of available cards, customers can select the card that has the international travel plan they wish to delete.

 

There is a variation in API callouts for card listings on this screen for aggregrators and co-brand partners. Please refer to whichever is 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

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

India : GET /partner/v1/cards

Parameters

PATH

NA

Query

cardFunction

View Api Callout 3 >
×

Use Case Callout

Inquire Current Travel Plan

This API enables customer to inquire current travel plan.

Endpoint

India: GET /v1/cards/overseasTravelPlans

Parameters

Query

cardId

Body

NA

Delete international travel plan

Customers can delete the plan on their selected card by clicking 'Delete'.
Zoom In

Customers confirm international travel plan deletion

Customers click 'Delete' in the pop-up window to delete the existing plan from the card.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Delete Existing Travel Plan

This API enables customer to delete an existing travel plan.

Endpoint

India: DELETE /v1/cards/{cardId}/overseasTravelPlans

Parameters

PATH

cardId

Body

NA

Acknowledgement for deleting existing travel plan

Customers recieve a confirmation that they deleted the existing international travel plan successfully.

 

Customers can add a new travel plan to the card after the existing travel plan has been deleted.

Zoom In