Global Wallet

Cards

Global Wallet

Take advantage of Citibank's Global Wallet feature to create foreign currency accounts which are linked to your Citibank Debit Mastercard instantly. Use it to shop on international websites using your Citibank Debit Mastercard, and pay zero foreign transaction or currency conversion fees.

Australia

Singapore

Api's Called

Cards

Citi Global Wallet benefit displayed in Partner app

Benefits about Citibank's Global Wallet are displayed with a link to learn more.

(There can be multiple entry points. This is just an example to illustrate how the journey could begin.)

Zoom In

Find out more about Global Wallet feature

In Partner App, details of the Global Wallet feature are displayed and an option for customers to apply for a Citibank Debit Mastercard if they don't already have one.
Zoom In

Customers apply to open account

Customers can open an account with Citibank or apply for an account.

Customers provide minimal details to Citibank that include their basic information like title, first name, last name, phone number, and email address.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

LiabilitiesApplicationAdd

This API is used to capture customers interest to open an Account with Citibank or to apply for an account.

Endpoint

Australia: POST /v1/onboarding/products/liabilities/applications

Singapore: POST /v1/onboarding/products/liabilities/applications

 

Parameters

PATH

NA

Confirmation message displayed to customers

A confirmation message is displayed to customers along with a link to complete their application on Citibank Online.

 

An email notification will also be sent as a reminder to complete the application.

Zoom In

Customer notification upon account opening

Once the account is open, customers will be notified via email and SMS.

Start using Global Wallet in Partner app

Citibank can send an event to partner upon account creation so that customers will be able to use the Global Wallet feature in Partner app.

 

 

Zoom In

Secure identification

In order to enable the connection of customers' Citi accounts to the third-party application, customers will be prompted with a modal window (triggered by the OAuth API) where they will be 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

Hong Kong:  GET /authCode/oauth2/authorize

India:  GET /authCode/oauth2/authorize

Indonesia:  GET /authCode/oauth2/authorize

Malaysia:  GET /authCode/oauth2/authorize

Philippines:  GET /authCode/oauth2/authorize

Singapore:  GET /authCode/oauth2/authorize

Thailand:  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 sent to their registered mobile number

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

Customer consent

Customers will be presented with Citi’s consent page where they can read the terms and conditions of what account information will and will not be shared with the third-party application. If they agree, customers can click ‘Authorize' to proceed.

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 expire, and 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 the 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>

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

Parameters

PATH

countryCode

businessCode

FormData

grant_type

code

redirect_uri

Refresh access token

If the access token has expired and the partner still has a valid refresh token, the access token can be refreshed by calling the Refresh Token API and exchanging it for a new set of valid access and refresh tokens. 

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Refresh 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 /authCode/oauth2/refresh

Singapore: POST /authCode/oauth2/refresh

 

Parameters

PATH

NA

FormData

grant_type

refresh_token

Turn on Global Wallet

If customers do not yet have the Global Wallet turned on, they will be given the option to do so.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Global Wallet Eligible and Enrolled Accounts and Available Currencies

This API is used to check for Eligibility for Global Wallet as well as to retrieve the list of Eligible and Enrolled accounts from host systems.

This will also return a list of currencies which are available for the customer to choose for addition.

 

Endpoint

Australia: GET /v1/cards/multiCurrencyAccounts/enrollment/eligibility

Singapore: GET /v2/cards/multiCurrencyAccounts/enrollment/eligibility

Parameters

PATH

NA

View Api Callout 2 >
×

Use Case Callout

Turn on Global Wallet

This API is used to Enroll the Customers debit card to Global Wallet.

 

Endpoint

Australia: POST /v1/cards/{cardId}/multiCurrencyAccounts

Singapore: POST /v2/cards/{cardId}/multiCurrencyAccounts

Parameters

PATH

NA

View Global Wallet

Customers can view all accounts they currently have created and in what currencies.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Global Wallet Eligible and Enrolled Accounts and Available Currencies

This API is used to check for Eligibility for Global Wallet as well as to retrieve the list of Eligible and Enrolled accounts from host systems.

This will also return a list of currencies which are available for the customer to choose for addition.

 

Endpoint

Australia: GET /v1/cards/multiCurrencyAccounts/enrollment/eligibility

Singapore: GET /v2/cards/multiCurrencyAccounts/enrollment/eligibility

Parameters

PATH

NA

Choose currency

Customer can view list of available currencies that they can convert their money into.

 

As soon as the customer chooses a currency, a new currency account will be created and linked to the wallet in the background.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Global Wallet Eligible and Enrolled Accounts and Available Currencies

This API is used to check for Eligibility for Global Wallet as well as to retrieve the list of Eligible and Enrolled accounts from host systems.

This will also return a list of currencies which are available for the customer to choose for addition.

 

Endpoint

Australia: GET /v1/cards/multiCurrencyAccounts/enrollment/eligibility

Singapore: GET /v2/cards/multiCurrencyAccounts/enrollment/eligibility

Parameters

PATH

NA

View Api Callout 2 >
×

Use Case Callout

Global Wallet Eligible and Enrolled Accounts and Available Currencies

This API will create a new Currency Account and link it to Customer's Global Wallet.

Endpoint

Australia: POST /v1/cards/{cardId}/multiCurrencyAccounts/Currency

Singapore: POST /v2/cards/{cardId}/multiCurrencyAccounts/Currency

Parameters

PATH

NA

Top up Global Wallet

Customers can choose the source account from which they wish to take money to convert into their chosen currency.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve summary of source accounts for personal domestic transfer

This API returns the valid combinations of personal domestic transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa.

Endpoint

Australia: GET /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts

Singapore: GET /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts

 

Parameters

PATH

NA

Review and confirmation

Customers can review the transaction details before confirming.

(Customers might be requested to enter OTP upon confirmation.)

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Preprocess Personal Domestic Transfer

This API is used to Create a new personal domestic transfer and verify that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming.

Endpoint

Australia: POST /v1/moneyMovement/personalDomesticTransfers/preprocess

Singapore: POST /v1/moneyMovement/personalDomesticTransfers/preprocess

 

Parameters

PATH

NA

View Api Callout 2 >
×

Use Case Callout

Personal Domestic Transfer

This API is used to Confirm the personal transfer. It should be called after successfully creating the personal transfer. If successful, it will return a confirmation number that should be displayed and stored.

Endpoint

Australia: POST /v1/moneyMovement/personalDomesticTransfers

Singapore: POST /v1/moneyMovement/personalDomesticTransfers

 

Parameters

PATH

NA

OTP validation

Customers may receive an OTP from Citi on their registered mobile number.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

MFA 

The third-party calls Citi's MFA page, whereby the customer enters their OTP code, sent to their registered mobile number. Citi then validates the OTP. After successful authentication, Citi will respond back with a success or error (in case validation failed) on the redirect URL registered by the third-party.  The MFA API is not available on the sandbox.

Endpoint

Hong Kong: /oauth2/mfa

India: /oauth2/mfa

Malaysia: /oauth2/mfa

Singapore: /oauth2/mfa

Parameters

PATH

Query

client_id

mfaCode

redirect_uri

Body

Response - 
<<Partner Redirect URI>>?mfaStatus=success&state=<<echo back whatever is sent in request>>

Final Confirmation of successful transaction

Confirmation of transaction is displayed to customer.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Personal Domestic Transfer Confirmation

This API is to confirm personal domestic transfers post Multi Factor Authentication.

Endpoint

Australia: POST /v1/moneyMovement/personalDomesticTransfers/confirmation

Singapore: POST /v1/moneyMovement/personalDomesticTransfers/confirmation

 

Parameters

PATH

NA