Citi PaySmart

Cards

Citi PaySmart

Enhance customers' shopping experience with Citi PaySmart. Customers can pay for their merchandise and services using their preferred credit card and can also earn great rewards.

Hong Kong

Api's Called

Money Movement

Shop smartly with Citi PaySmart

Customers can use their Citi credit card and enjoy a great shopping experience along with rewards from top online retailers.
Zoom In

Secure identification

Customers register their preferred Citi credit card to use it for their purchases. This allows them to verify their identity without compromising on security. Refer to the below API callout for information about retrieving an authorization code.

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.

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

Endpoint

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

Parameters

PATH

countryCode

businessCode

Body

lastFourDigitsCardNumber
citiCardHolderPhoneNumber
merchantCustomerReferenceId
grant_type

Validation of the one-time password

Customers complete their registration by validating the one-time password sent to their registered mobile number. They also receive a notification from bank after successful registration. Refer to the below API callout for activating card access token.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Activate Card Access Token 

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

Endpoint

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

Parameters

PATH

countryCode

businessCode

Body

controlFlowId
linkageConfirmationCode

Registration confirmation

Customers receive a confirmation message after successful registration. They can click on 'Shop Now' to begin their purchase.

 

Zoom In

Customers select the product to purchase

Customers can select the product of their choice and click on 'Checkout' to proceed with the purchase. Refer to the below API callout to authorize customer's purchase using his registered credit card.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

CardPurchaseAuthorization

This API is used to authorize a purchase done using card.

Endpoint

POST /partner/v1/moneyMovement/cards/purchases/authorization

Parameters

PATH

NA

Validate the one-time password based on additional authentication

Customers need to validate the one-time password sent to their registered mobile number. This password is based on additional authentication setup by the partner.

Refer to the below API callouts -

  • API callout1 for retrieving the public key used for encryption.
  • API callout2 to validate the one time password.
  • API callout3 to confirm the authorization of a purchase done using card.
  • API callout4 for resending the one time password.

 

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

E2EKeyExchange

This API is used by browser based applications for retrieving the public key used for encryption. It returns the modulus and exponent for setting up a business public key. This is a post login API.

Endpoint

GET /v1/security/e2eKey

Parameters

PATH

NA

 

View Api Callout 2 >
×

Use Case Callout

swagger-ccp-ValidateOTP

This API allows to validate the one time password sent to the customer.

Endpoint

PUT /v1/mfa/otp

Parameters

PATH

NA

View Api Callout 3 >
×

Use Case Callout

CardPurchaseAuthorizationConfirmation
This API is used to confirm the authorization of a purchase done using card.

Endpoint

 

POST /partner/v1/moneyMovement/cards/purchases/authorization/confirmation

Parameters

PATH

NA

 

View Api Callout 4 >
×

Use Case Callout

swagger-ccp-GenerateOTP

This API allows you to generate the one time password and deliver to the customer.

Endpoint

POST /v1/mfa/otp

Parameters

PATH

NA

Transaction is being processed

Customers need to wait till the time their transaction is being processed.

Zoom In

Order confirmation

After the successful order placement, customers receive a confirmation message that shows the order number along with the date and time of order placement. They also receive a notification from their bank shortly after. Customers also have the provision to check the status of their order by clicking on the provided link.

Zoom In