The Cards API allows you to perform actions on the actual credit cards of the Citi Customer who authorized your app.

 

Note: The Developer Hub Sandbox is a test environment that allows you to make API calls that are the same in form and function to our production environments. It contains mock test data so that you can prototype your application as if it were the real thing. When you’re finished testing, contact sales to request production access.

,

Note: Skip this step if you already created an app and have a pair of Client ID and Client Secret.

  1. Sign in to developer.citi.com
  2. Select My Applications tab.
  3. Click Register a New App
     

a. Fill out the required details

b. Upload an icon for your app (optional)

c. Click Submit

d. You will receive a pair of Client ID and Client Secret. Store this information securely. Use the Show button/checkbox to see your Client ID and Client Secret.

Note: Client secret is shown only once, so make sure you save this information. If in any case you lose your credential set, you can use the Regenerate button to get a new set of Client ID & Client Secret.

,

An access token is required to call all functional APIs. To retrieve your access token, visit your market’s Authorize guide.

,

Returns an array of credit card numbers, credit limits, statuses and types for the customer who authorized your app.

Sample Request:

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

cardFunction

ALL

 

,

Activates or deactivates a specified card's ability to be used overseas. Cards can be activated for overseas usage permanently or for a set period of time.

Sample Request:

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

cardFunction

ALL

Content-Type

application/json

cardId

4565666277647878436c505774504c504a594261686a4c676f2f2b2b67334e32747967676f4c7341794e553d

OverseasCardUsageRequest

{"overseasCardUsageOption":"ACTIVATE","ActivationRequest":{"perpetualActivationIndicator":"N","overseasCardActivationStartDate":"2017-08-09","overseasCardActivationEndDate":"2017-12-30"}}

 

,

Reports a specified card as lost or stolen and returns a reference number to track the request.

Sample Request:

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

cardFunction

ALL

Content-Type

application/json

cardId

4565666277647878436c505774504c504a594261686a4c676f2f2b2b67334e32747967676f4c7341794e553d

ReportLostStolencardRequest

{"replacementIndicator":"BLOCK_AND_REPLACE"}

 

,

Activates or deactivates  the specified card's ability to be used locally.

Sample Request:

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

cardFunction

ALL

Content-Type

application/json

cardId

3565666277647878436c505774504c504a594261686a4c676f2f2b2b67334e32747967676f4c7341794e553d

cardActivationCode

ACTIVATE

CardUsageRequest

{"cvv":"1855613852316f2b4d4d796c344e38756339654972776f66"}

 

,

Requests a permanent or temporary credit limit increase. For a temporary credit limit increase, the request must indicate that the type of request is temporary and include Card ID, requested limit and duration. For permanent increases, the Card ID and requested limit are the only required parameters.

Sample Request:

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

cardFunction

ALL

Content-Type

application/json

CreditLimitIncreaseRequest

{"temporaryCreditLimitIncrease":{"cardId":"4565666277647878436c505774504c504a594261686a4c676f2f2b2b67334e32747967676f4c7341794e553d","requestedCreditLimitAmount":9000,"creditLimitIncreaseStartDate":"2016-10-01","creditLimitIncreaseEndDate":"2016-12-01","reasonCode":"TRAVEL_RELATED"}}