Customers

Select the following:
Home

>

API Products

>

Hong Kong - Customers API Documentation

Customers

Summary

The Customers API allows you to retrieve basic Citi customer information like name, mailing address, email address and phone numbers.

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /partner/v1/customers/profiles Retrieve Customer Personal Details from Partner
get /v1/sales/customers/offers/details Retrieve Offer Details
get /v1/cards/accounts/{accountId}/addresses This API is used s for card to get the Card to , Bill to , Pin to address

Retrieve Customer Personal Details from Partner

get /partner/v1/customers/profiles
Description

This API is used to retrieve customer details including personal particulars, address, phone number and email details from the partner's site.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit UUID that you generate for every request
Accept
string required
Content-Type that are acceptable for the response
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Query Parameters
addressType
string Optional
Type of the address. This is a reference data field. Please use /v1/utilities/referenceData/{addressType} resource to get valid value of this field with description.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • emails
      • emailAddress
        • Updated email address of the customer
        • type : string
      • preferredEmailFlag
        • Flag to indicate the preferred email
        • type : boolean
      • emailKey
        • Unique identifier of the email address
        • type : integer
  • customerType
    • Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerType} resource to get valid value of this field with description. You can use customerType as the referenceCode parameter to retrieve the values.
    • type : string
  • customerParticulars
      • names
        • properties : Array
      • prefix
        • The prefix of the customer s name.
        • type : string
      • suffix
        • The suffix of the customer s name.
        • type : string
  • customerSegment
    • Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerSegment} resource to get valid value of this field with description. You can use customerSegment as the referenceCode parameter to retrieve the values.
    • type : string
  • partnerCustomerSegment
    • Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description.
    • type : string
  • addressList
      • addressKey
        • Unique identifier of the address and it is mandatory in update customer address details
        • type : integer
      • city
        • City
        • type : string
      • addressType
        • Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions.
        • type : string
      • postalCode
        • Postal code the mailing address
        • type : string
      • addressline3
        • Address line3 of the mailing address
        • type : string
      • addressline2
        • Address line2 of the mailing address
        • type : string
      • addressline1
        • Address line1 of the mailing address
        • type : string
      • state
        • State. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description.
        • type : string
      • countryName
        • Country Name.This is a reference data field. Please use /v1/apac/utilities/referenceData/{countryName} resource to get valid value of this field with description.
        • type : string
      • addressline4
        • Address line3 of the mailing address
        • type : string
  • phones
      • phoneType
        • The type of phone.This is a reference data field. Please use /utilities/referenceData/{phoneType} resource to get valid values of this field with descriptions
        • type : string
      • areaCode
        • Area code of telephone number
        • type : string
      • extension
        • Extension of telephone number
        • type : string
      • phoneKey
        • Unique identifier of the phone number
        • type : integer
      • phoneNumber
        • The phone number of a customer
        • type : string
      • phoneCountryCode
        • Country calling code. This is a reference data field. Please use /utilities/referenceData/{phoneCountryCode} resource to get valid values of this field with descriptions
        • type : string
Example Response for get /partner/v1/customers/profiles
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/customers/profiles
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/customers/profiles
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/customers/profiles
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/customers/profiles
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /partner/v1/customers/profiles
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Offer Details

get /v1/sales/customers/offers/details
Description

This API allows to retrieve the details for an offer.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Query Parameters
campaignId
string Optional
Unique identifier for a specific campaign being offered to the channel
waveId
string Optional
Unique identifier for the promotion under specific campaign being offered to the channel
accountId
string Optional
The account number in encrypted format
cardId
string Optional
Unique Id of the card in encrypted format
offerId
string Optional
Unique offer ID associated with the offer
offerSegmentCategory
string Optional
This field is used to Classify the Offers into appropriate segments to allow usage managers to target offers to a specific group of customers. This is a reference data field. Please use /v1/utilities/referenceData/{offerSegmentCategory} resource to get valid value of this field with description
virtualOfferFlag
boolean Optional
Indicates if offer is virtual
productCode
string Optional
A unique code that identifies the product
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • offerType
    • Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description
    • type : string
  • campaignId
    • Unique identifier for a specific campaign being offered to the channel
    • type : string
  • waveId
    • Unique identifier for the promotion under specific campaign being offered to the channel
    • type : string
  • waveDescription
    • Description of the benefits of taking the product under the given offer
    • type : string
  • offerStartDate
    • Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
    • type : string
    • format : date
  • offerExpiryDate
    • Expiry Date of the promotion in ISO 8601 date format YYYY-MM-DD
    • type : string
    • format : date
  • offerPriority
    • Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
    • type : string
  • offerProductCode
    • A unique code that identifies the offered product to applicant
    • type : string
  • offerProductDescription
    • Description of the Product for the offer
    • type : string
  • yearsWithCitiRelationship
      • languageCode
        • Preferred language of communication
        • type : string
      • relationshipWithCitiInYears
        • Customer relationship in years with Citi
        • type : integer
        • format : int32
      • lastUpgradedCustomerSegment
        • Customer segment decides each applicants interest rate, Different customer target will be subjected to different interest rate. This is a reference data field. Please use /v1/utilities/referenceData/{customerSegment} resource to get possible value of this field with description
        • type : string
      • returnsNetSavingsAmount
        • Net saving money and amount is rounded off to nearest lower 10s
        • type : integer
        • format : int32
      • returnsNewInvestmentAmount
        • New investment brought in and amount is rounded off to nearest lower 10s.
        • type : integer
        • format : int32
      • returnsDividendsEarnedAmount
        • Dividends earned and amount is rounded off to nearest lower 10s.
        • type : integer
        • format : int32
      • returnsTotalGainAmount
        • Total realised and unrealised gain including fees.Amount is rounded off to nearest lower 10s
        • type : integer
        • format : int32
      • currentCustomerSegment
        • Customer segment decides each applicants interest rate, Different customer target will be subjected to different interest rate. This is a reference data field. Please use /v1utilities/referenceData/{customerSegment} resource to get possible value of this field with description
        • type : string
      • goalSubmissionFlag
        • If customer has previosuly submitted the Goals for next financial year
        • type : boolean
  • ecdOffer
      • productSecurityCode
        • This field is used to stored Product security code if any for ECD (Electronic Certificate of Deposit) offers
        • type : string
  • offerStatus
    • Offer Status. This is a reference data field. Please use /v1/utilities/referenceData/{offerStatus} resource to get possible value of this field with description
    • type : string
  • merchantRecommendationOffer
      • offerSegmentCategory
        • This field is used to Classify the Offers into appropriate segments to allow usage managers to target offers to a specific group of customers. This is a reference data field. Please use /v1/utilities/referenceData/{offerSegmentCategory} resource to get valid value of this field with description
        • type : string
      • offerSegmentScore
        • This is a score that is determined by Offer system in the range of 1 to 100.
        • type : string
      • offerRank
        • The rank is determined/derived by Offer system. It is derived based on the segment and ranking.
        • type : string
      • offerMode
        • Each offer is classified as either Geo, Non-Geo or Batch. This is a reference data field. Please use /v1/utilities/referenceData/{offerMode} resource to get valid value of this field with description.
        • type : string
      • localOverseasIndicator
        • This is to indicate to specify whether a given offer is local or overseas. This is a reference data field. Please use /v1/utilities/referenceData/{localOverseasIndicator} resource to get valid value of this field with description.
        • type : string
      • merchantCatagory
        • Each of the Merchants in the repository is tagged to a category. Please use /v1/utilities/referenceData/{merchantCategory} resource to get valid value of this field with description.
        • type : string
  • customerActionGroup
      • customerAction
        • This is to indicate to specify whether a given offer is liked or disliked This is a reference data field. Please use /v1/utilities/referenceData/{customerAction} resource to get valid value of this field with description.
        • type : string
      • customerActionDateTime
        • Customer action date-time in ISO 8601 date format YYYY-MM-DDTHH:MM:SS
        • type : string
  • templateFields
      • templateFieldKey
        • Template variable key
        • type : string
      • templateFieldValue
        • Template variable value
        • type : string
  • easyPaymentPlan
      • promotionId
        • Unique identifier for a specific promotion being offered for a specific campaign/offer
        • type : string
      • merchantOrganizationNumber
        • Merchant organization number for the perticular merchant
        • type : string
      • merchantNumber
        • Unique identifier associated with the merchant
        • type : string
      • offerIndicator
        • This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description
        • type : string
      • creditLimitPercentage
        • percentages of that perticular credit limit
        • type : number
        • format : double
      • eppMinimumEligibleAmount
        • minimum Amount which eligible for that customer
        • type : number
        • format : double
      • eppMaximumEligibleAmount
        • maximum Amount which eligible for that customer
        • type : number
        • format : double
  • loanOverPhoneOffer
      • offerType
        • Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description.
        • type : string
      • campaignId
        • Unique identifier for a specific campaign being offered to the channel
        • type : string
      • waveId
        • Unique identifier for the promotion under specific campaign being offered to the channel
        • type : string
      • waveDescription
        • Description of the benefits of taking the product under the given offer
        • type : string
      • offerStartDate
        • Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerExpiryDate
        • End date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerPriority
        • Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
        • type : string
      • productCode
        • type : string
        • A unique code that identifies the product
      • productDescription
        • type : string
        • Detailed information about offered product
      • promotionId
        • type : string
        • Unique identifier for a specific promotion being offered for a specific campaign/offer.
      • offerIndicator
        • This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description.
        • type : string
      • tenorAndInterestDetails
        • properties : Array
      • creditLimitPercentage
        • This field is used to specify the percentage of credit limit to be eligible for EPP Booking.
        • type : number
        • format : double
      • monthlyFlatRate
        • This field is used to specify maximum monthly flat rate.
        • type : number
        • format : double
      • lopMinimumEligibleAmount
        • Minimum eligible amount for which loan over phone can be booked.
        • type : number
        • format : double
      • lopMaximumEligibleAmount
        • Maximum eligible amount for which loan over phone Plan can be booked.
        • type : number
        • format : double
      • lopIndicator
        • This field is used to indicate whether it is LOP/Advance LOP. This is a reference data field. Please use /v1/utilities/referenceData/{lopIndicator} resource to get valid value of this field with description.
        • type : string
  • balanceTransferOffer
      • offerType
        • Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description.
        • type : string
      • campaignId
        • Unique identifier for a specific campaign being offered to the channel
        • type : string
      • waveId
        • Unique identifier for the promotion under specific campaign being offered to the channel
        • type : string
      • waveDescription
        • Description of the benefits of taking the product under the given offer
        • type : string
      • offerStartDate
        • Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerExpiryDate
        • End date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerPriority
        • Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
        • type : string
      • productCode
        • type : string
        • A unique code that identifies the product
      • productDescription
        • type : string
        • Detailed information about offered product
      • promotionId
        • type : string
        • Unique identifier for a specific promotion being offered for a specific campaign/offer.
      • offerIndicator
        • This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description.
        • type : string
      • eligbleLoanAmount
        • This field is used to specify the eligible loan amount for balance transfer.
        • type : number
        • format : double
      • tenorAndInterestDetails
        • properties : Array
      • creditLimitPercentage
        • This field is used to specify the percentage of credit limit to be eligible for EPP Booking.
        • type : number
        • format : double
      • btMinimumEligibleAmount
        • Minimum eligible amount for which balance transfer can be booked.
        • type : number
        • format : double
      • btMaximumEligibleAmount
        • Maximum eligible amount for which balance transfer can be booked.
        • type : number
        • format : double
  • genericOffer
      • offerType
        • Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description.
        • type : string
      • campaignId
        • Unique identifier for a specific campaign being offered to the channel
        • type : string
      • waveId
        • Unique identifier for the promotion under specific campaign being offered to the channel
        • type : string
      • waveDescription
        • Description of the benefits of taking the product under the given offer
        • type : string
      • offerStartDate
        • Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerExpiryDate
        • End date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerPriority
        • Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
        • type : string
      • productCode
        • type : string
        • A unique code that identifies the product
      • productDescription
        • type : string
        • Detailed information about offered product
  • customerSegmentChangeOffer
      • offerType
        • Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description.
        • type : string
      • campaignId
        • Unique identifier for a specific campaign being offered to the channel
        • type : string
      • waveId
        • Unique identifier for the promotion under specific campaign being offered to the channel
        • type : string
      • waveDescription
        • Description of the benefits of taking the product under the given offer
        • type : string
      • offerStartDate
        • Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerExpiryDate
        • End date of the promotion in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • offerPriority
        • Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
        • type : string
      • productCode
        • type : string
        • A unique code that identifies the product
      • productDescription
        • type : string
        • Detailed information about offered product
      • currentCustomerSegment
        • type : string
        • Current customer segment.
      • previousCustomerSegment
        • type : string
        • Previous customer segment.
      • customerSegmentChangeDate
        • type : string
        • format : date
        • Customer segment change date in ISO 8601 date format YYYY-MM-DD.
      • targetTrbDifferenceAmount
        • type : number
        • format : double
        • Difference in amount in current TRB(Total Releationship Balance amount) to next segment threshold amount.
      • segmentChangeOfferCode
        • type : string
        • Based on customer's current segment, customer is categoried in scenarios based on his/her current TRB(Total Relationship Balance amount) & duration for maintaing that balance. Based on this scenario customer will be given different offer.
Example Response for get /v1/sales/customers/offers/details
204

No content
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/sales/customers/offers/details
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/sales/customers/offers/details
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/sales/customers/offers/details
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : error, warn, invalid, fatal
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/sales/customers/offers/details
{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

This API is used s for card to get the Card to , Bill to , Pin to address

get /v1/cards/accounts/{accountId}/addresses
Description

This API is used s for card to get the Card to , Bill to , Pin to address

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Path Parameters
accountId
string required
The account identifier in encrypted format.Typically, this is not displayed to the customer
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • addressList
      • addressIdentifierType
        • Type of the address identifier type. This is a reference data field. Please use /utilities/referenceData/{addressIndentifierType} resource to get valid values of this field with descriptions. Possible values : CARD_TO , BILL_TO , PIN_TO
        • type : string
      • addressType
        • Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions.
        • type : string
      • addressline1
        • Address line1 of the mailing address
        • type : string
      • addressline2
        • Address line2 of the mailing address
        • type : string
      • addressline3
        • Address line3 of the mailing address