I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

India - Accounts API Documentation

Accounts

Summary

The Accounts API allows you to retrieve account and transaction data for Citi Customers who have authorized your app. In most cases, you'll want to request a summary of all accounts first, which will return basic account information and accountIds. Once you have this information, you can request additional account details and/or transactions.

The Accounts API uses the authorization_code grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/accounts Retrieve summary of all accounts
get /v1/accounts/{accountId} Retrieve account details
get /v1/accounts/{accountId}/transactions Retrieve transactions
get /v1/accounts/{accountId}/statements/{statementId} Retrieve statements summary & transaction
get /v1/accounts/{accountId}/consents Retrieve consents based on account Number

Retrieve summary of all accounts

get /v1/accounts
Description

Returns a summary of all accounts held by a Citi customer who has authorized your application. If a customer has multiple but similar accounts, e.g. two savings accounts, the accounts will be returned in the array accountGroupSummary.

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 consumer onboarding
Query Parameters
nextStartIndex
string Optional
In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data.
  • 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
  • accountGroupSummary
      • accountGroup
        • type : string
        • Account group is a classification of accounts according to their common characteristics. This is a reference data field. Please use /v1/apac/utilities/referenceData/{accountGroup} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • insurancePolicies
        • properties : Array
      • totalCurrentBalance
        • properties : Array
      • totalAvailableBalance
        • properties : Array
      • totalOutstandingBalance
        • properties : Array
  • nextStartIndex
    • type : string
    • In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data.
Example Response for get /v1/accounts
{
    "accountGroupSummary": {
        "accountGroup": "SAVINGS",
        "accounts": {
            "checkingAccountSummary": null,
            "savingsAccountSummary": null,
            "creditCardAccountSummary": null,
            "readyCreditAccountSummary": null,
            "loanAccountSummary": null,
            "mutualFundAccountSummary": null,
            "securitiesBrokerageAccountSummary": null,
            "callDepositAccountSummary": null,
            "premiumDepositAccountSummary": null,
            "timeDepositAccountSummary": null
        },
        "insurancePolicies": {
            "productName": "Personal Life Insurance Policy",
            "productCode": "IN_PLI",
            "displayAccountNumber": "XXXXXX2391",
            "currencyCode": "AUD",
            "accountClassification": "ASSET",
            "accountStatus": "ACTIVE",
            "displayPolicyNumber": "XXXXXXXX0368",
            "insuranceApplicationId": "1100000125",
            "insuranceSumAssuredAmount": 100000.25,
            "totalPremiumPaidAmount": 6171.53
        },
        "totalCurrentBalance": {
            "localCurrencyCode": "AUD",
            "localCurrencyBalanceAmount": 8900.12,
            "foreignCurrencyCode": "SGD",
            "foreignCurrencyBalanceAmount": 8880.25
        },
        "totalAvailableBalance": {
            "localCurrencyCode": "AUD",
            "localCurrencyBalanceAmount": 8900.12,
            "foreignCurrencyCode": "SGD",
            "foreignCurrencyBalanceAmount": 8880.25
        },
        "totalOutstandingBalance": {
            "localCurrencyCode": "AUD",
            "localCurrencyBalanceAmount": 8900.12,
            "foreignCurrencyCode": "SGD",
            "foreignCurrencyBalanceAmount": 8880.25
        }
    },
    "nextStartIndex": "11"
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "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
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve account details

get /v1/accounts/{accountId}
Description

Returns additional account details than what is provided in the summary of all accounts. To retrieve the details, simply pass the accountId returned to you from the account summary.

Path Parameters
accountId
string required
The account identifier in encrypted format.Typically, this is not displayed to the customer
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 consumer onboarding
  • 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
  • creditCardAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • outstandingBalance
        • The amount of money owed.
        • type : number
        • format : double
      • lastStatementBalance
        • The balance on last statement date
        • type : number
        • format : double
      • lastStatementDate
        • type : string
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD
      • creditUsed
        • type : number
        • format : double
        • The part of the credit limit already used
      • creditLimit
        • type : number
        • format : double
        • The maximum amount of credit that extend to a customer
      • availableCredit
        • type : number
        • format : double
        • The available credit
      • cashAdvanceLimit
        • type : number
        • format : double
        • Some percentage of credit limit to withdraw cash
      • cashAdvanceAvailableAmount
        • type : number
        • format : double
        • Cash advance amount available. This will be same as the cash limit if there is no cash advance done. Otherwise, this will be the amount from the cashLimit minus the cash advance amount already used
      • lastPaymentAmount
        • type : number
        • format : double
        • The amount of the last payment made
      • lastPaymentDate
        • type : string
        • format : date
        • The date of the last payment in ISO 8601 date format YYYY-MM-DD
      • minimumDueAmount
        • type : number
        • format : double
        • Minimum due amount for a payment cycle
      • paymentDueDate
        • type : string
        • format : date
        • The date of the next payment/payment due date in ISO 8601 date format YYYY-MM-DD
      • availablePointBalance
        • type : number
        • Available reward points on the credit card
  • readyCreditAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • outstandingBalance
        • The amount of money owed
        • type : number
        • format : double
      • lastStatementBalance
        • The balance on last statement date
        • type : number
        • format : double
      • lastStatementDate
        • type : string
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD
      • minimumDueAmount
        • type : number
        • format : double
        • Minimum due amount for a payment cycle
      • creditLimit
        • type : number
        • format : double
        • The maximum amount of credit that extend to a customer
      • availableCredit
        • type : number
        • format : double
        • Available credit limit of ready credit account
      • cashAdvanceLimit
        • type : number
        • format : double
        • Some percentage of credit limit to withdraw cash
      • cashAdvanceAvailableAmount
        • type : number
        • format : double
        • The amount available under cash advance limit
      • lastPaymentAmount
        • type : number
        • format : double
        • The amount of the last payment made
      • lastPaymentDate
        • type : string
        • format : date
        • The date of the last payment in ISO 8601 date format YYYY-MM-DD
      • nextPaymentAmount
        • type : number
        • format : double
        • The next payment amount due
      • nextPaymentDate
        • type : string
        • format : date
        • The date of the next payment in ISO 8601 date format YYYY-MM-DD
  • checkingAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currentBalance
        • The current balance including any pending or in progress deposits and withdrawals
        • type : number
        • format : double
      • availableBalance
        • The amount available to withdraw or transfer immediately
        • type : number
        • format : double
      • overdraftLimit
        • type : number
        • format : double
        • This allows a customer to overdraw their account up to a specific amount
      • availableOverdraftLimit
        • type : number
        • format : double
        • The amount available under over draft Limit amount
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • lastStatementDate
        • type : string
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD
      • holdAmount
        • type : number
        • format : double
        • The amount of funds that were previously available but are now blocked. It represents funds authorized for withdrawal but not yet withdrawn. The hold amount is included in the ledger/book balance but not in the available balance. It is included in interest
      • floatAmount
        • type : number
        • format : double
        • The total amount of funds that have not yet been cleared through the collection process for cheque and other instruments deposited to a checking account. These funds are unavailable for withdrawal until they are paid by the drawee bank.
      • totalInterestAmount
        • type : number
        • format : double
        • Total interest amount on checking account.
      • openingDate
        • type : string
        • format : date
        • Checking account opening date in ISO 8601 date format YYYY-MM-DD
  • savingsAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currentBalance
        • The current balance including any pending or in progress deposits and withdrawals
        • type : number
        • format : double
      • availableBalance
        • The amount available to withdraw or transfer immediately
        • type : number
        • format : double
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • lastStatementDate
        • type : string
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD
      • holdAmount
        • type : number
        • format : double
        • A portion of account balance unavailable for use for a set period
      • openingDate
        • type : string
        • format : date
        • Saving account opening date in ISO 8601 date format YYYY-MM-DD
      • floatAmount
        • type : number
        • format : double
        • The total amount of funds that have not yet been cleared through the collection process for cheque and other instruments deposited to a savings account. These funds are unavailable for withdrawal until they are paid by the drawee bank.
      • totalInterestAmount
        • type : number
        • format : double
        • Total interest amount on the saving account
  • timeDepositAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • originalPrincipalAmount
        • type : number
        • format : double
        • The original principal amount when account opened.
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • interestRate
        • type : number
        • format : double
        • The rate of interest applicable for the time deposit
      • openingDate
        • type : string
        • format : date
        • The opening date of the time deposit, in ISO 8601 format YYYY-MM-DD
      • maturityDate
        • type : string
        • format : date
        • The date when the time deposit will mature, in ISO 8601 format YYYY-MM-DD
      • nextInterestPaymentDate
        • type : string
        • format : date
        • The date when interest will be paid by Citibank, in ISO8601 format YYYY-MM-DD
      • interestAmountDue
        • type : number
        • format : double
        • The accrued interest amount which has not yet been paid by Citibank
      • renewalInstructions
        • type : string
        • The instructions for time deposit renewal. This is a reference data field. Please use /v1/apac/utilities/referenceData/{renewalInstructions} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • tenorTerm
        • type : integer
        • The tenor term for the deposit, expressed as a whole number
      • tenorPeriod
        • type : string
        • The unit of the tenor term. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenorPeriod} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • baseCurrencyMaturityAmount
        • type : number
        • format : double
        • The investment amount and accrued interest in base currency
      • maturityInterestAmount
        • type : number
        • format : double
        • The accrued interest in base currency.
      • lastInterestPaymentAmount
        • type : number
        • format : double
        • Last interest amount for the time deposit account
  • loanAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • originalPrincipalAmount
        • type : number
        • format : double
        • The amount borrowed
      • currentPrincipalAmount
        • type : number
        • format : double
        • The remaining principal amount
      • outstandingBalance
        • type : number
        • format : double
        • The amount of money owed.
      • currencyCode
        • type : string
        • The currency code in ISO 4217 format
      • maturityDate
        • type : string
        • format : date
        • Loan maturity date in ISO 8601 date format YYYY-MM-DD
      • openingDate
        • type : string
        • format : date
        • Loan account opening date in ISO 8601 date format YYYY-MM-DD
      • lastPaymentDate
        • type : string
        • format : date
        • The date of the last payment in ISO 8601 format YYYY-MM-DD
      • lastPaymentAmount
        • type : number
        • format : double
        • The amount of the last payment made
      • interestAmount
        • type : number
        • format : double
        • Interest amount paid for the mentioned period
      • interestAccumulationPeriod
        • type : string
        • The period of interest accumulation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{interestAccumulationPeriod} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • nextPaymentAmount
        • type : number
        • format : double
        • The next payment amount due
      • nextPaymentDate
        • type : string
        • format : date
        • The date of the next payment in ISO 8601 date format YYYY-MM-DD
      • paymentFrequency
        • type : string
        • The payment frequency
      • interestType
        • type : string
        • The interest type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{interestType} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • interestRate
        • type : number
        • format : double
        • Loan interest rate.
      • effectiveInterestRate
        • type : number
        • format : double
        • Loan effective interest rate
      • installmentAmount
        • type : number
        • format : double
        • Installment loan payment amount
      • remainingTermNumber
        • type : number
        • Term remaining.
      • pastDueAmount
        • type : number
        • format : double
        • Past due is a loan payment that has not been made as of its due date
      • paidPrincipalAmount
        • type : number
        • format : double
        • The amount of principal returned to the bank
      • lateChargeAmount
        • type : number
        • format : double
        • Late charge amount applicable when amount is not paid by the due date
  • mutualFundAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • totalNetAssetValueAmount
        • type : number
        • format : double
        • Total of net asset value of mutual funds
      • totalTransactionAmount
        • type : number
        • format : double
        • Total transaction amount in local currency
      • totalUnrealizedGains
        • type : number
        • format : double
        • Total unrealized gains amount, profitable position that has yet to be cashed in
      • mutualFund
        • properties : Array
  • securitiesBrokerageAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • totalSecuritiesValueAmount
        • type : number
        • format : double
        • The total market worth of securities
      • totalTransactionAmount
        • type : number
        • format : double
        • Total transaction amount in local currency
      • totalUnrealizedGains
        • type : number
        • format : double
        • Total unrealized gains amount, profitable position that has yet to be cashed in
      • security
        • properties : Array
  • callDepositAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • currencyCode
        • type : string
        • The currency code of the account in ISO 4217 format
      • availableBalance
        • type : number
        • format : double
        • The amount available to withdraw or transfer immediately
      • currentBalance
        • type : number
        • format : double
        • The current balance including any pending or in progress deposits and withdrawals
      • interestRate
        • type : number
        • format : double
        • The rate of interest applicable for the call deposit account
      • openingDate
        • type : string
        • format : date
        • Call deposit account opening date in ISO 8601 date format YYYY-MM-DD
      • baseCurrencyMaturityAmount
        • type : number
        • format : double
        • Maturity amount on the call deposit account.
      • lastInterestPaymentAmount
        • type : number
        • format : double
        • Last interest payment amount on the call deposit account.
      • lastInterestPaymentDate
        • type : string
        • format : date
        • Last interest payment date in ISO 8601 date format YYYY-MM-DD
  • premiumDepositAccount
      • productName
        • type : string
        • The name of the product
      • productCode
        • type : string
        • A unique code that identifies the product
      • displayAccountNumber
        • type : string
        • A masked account number that can be displayed to the customer
      • baseCurrencyPrincipalAmount
        • type : number
        • format : double
        • The investment amount in base currency
      • baseCurrencyCode
        • type : string
        • The base currency code in ISO 4217 format
      • alternateCurrencyPrincipalAmount
        • type : number
        • format : double
        • The investment amount in alternate currency
      • openingDate
        • type : string
        • format : date
        • Premium deposit open date in ISO 8601 date format YYYY-MM-DD
      • alternateCurrencyCode
        • type : string
        • The alternate currency code in ISO 4217 format
      • baseCurrencyDisposalAccount
        • type : string
        • The account number to deposit returns of base currency, upon maturity
      • alternateCurrencyDisposalAccount
        • type : string
        • The account number to deposit returns of alternate currency, upon maturity
      • baseCurrencyInterestAmount
        • type : number
        • format : double
        • The accrued interest amount in base currency
      • alternateCurrencyInterestAmount
        • type : number
        • format : double
        • The accrued interest amount in alternate currency
      • baseCurrencyMaturityAmount
        • type : number
        • format : double
        • The investment amount and accrued interest in base currency
      • alternateCurrencyMaturityAmount
        • type : number
        • format : double
        • The investment amount and accrued interest in alternate currency
      • baseCurrencyPremiumAmount
        • type : number
        • format : double
        • A part or all of the interest the customer earns on the Premium Account represents the premium that the bank pays the customer for the currency option
      • maturityDate
        • type : string
        • format : date
        • The date when the premium deposit will mature, in ISO8601 date format YYYY-MM-DD
      • strikePrice
        • type : number
        • format : double
        • The Pre-agreed exchange rate
      • customerInterestRate
        • type : number
        • format : double
        • The customer interest rate applicable for the premium deposit
      • accruedInterestRate
        • type : number
        • format : double
        • The accrued interest rate applicable for the premium deposit
      • benchmarkInterestRate
        • type : number
        • format : double
        • The benchmark interest rate applicable for the premium deposit
      • dealStatus
        • type : string
        • The deal status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{dealStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
      • expiryDate
        • type : string
        • format : date
        • The date when the premium deposit deal will expire, in ISO8601 date format YYYY-MM-DD
      • tenorTerm
        • type : integer
        • The tenor term for deposit
      • tenorPeriod
        • type : string
        • This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenorPeriod} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values.
Example Response for get /v1/accounts/{accountId}
{
    "creditCardAccount": {
        "productName": "Credit Card Account",
        "productCode": "0500_VC901",
        "displayAccountNumber": "XXXXXXXXXXXX2391",
        "currencyCode": "EUR",
        "outstandingBalance": 10000.25,
        "lastStatementBalance": 15000.25,
        "lastStatementDate": "2015-06-25",
        "creditUsed": 3750.25,
        "creditLimit": 50000.25,
        "availableCredit": 3750.25,
        "cashAdvanceLimit": 15000.25,
        "cashAdvanceAvailableAmount": 15000.25,
        "lastPaymentAmount": 1500.25,
        "lastPaymentDate": "2015-06-12",
        "minimumDueAmount": 1500.25,
        "paymentDueDate": "2015-06-12",
        "availablePointBalance": 1500.25
    },
    "readyCreditAccount": {
        "productName": "Ready Credit Account",
        "productCode": "0900_VC301",
        "displayAccountNumber": "XXXXXX2364",
        "currencyCode": "EUR",
        "outstandingBalance": 10000.25,
        "lastStatementBalance": 15000.25,
        "lastStatementDate": "2015-06-25",
        "minimumDueAmount": 1500.25,
        "creditLimit": 50000.25,
        "availableCredit": 3750.5,
        "cashAdvanceLimit": 15000.25,
        "cashAdvanceAvailableAmount": 15000.25,
        "lastPaymentAmount": 1500.25,
        "lastPaymentDate": "2015-06-12",
        "nextPaymentAmount": 1500.25,
        "nextPaymentDate": "2015-06-12"
    },
    "checkingAccount": {
        "productName": "Checking Account",
        "productCode": "0100_VC300",
        "displayAccountNumber": "XXXXXX2391",
        "currentBalance": 10000.25,
        "availableBalance": 11000.25,
        "overdraftLimit": 15000.25,
        "availableOverdraftLimit": 13200.25,
        "currencyCode": "EUR",
        "lastStatementDate": "2015-06-25",
        "holdAmount": 12900.12,
        "floatAmount": 250000.25,
        "totalInterestAmount": 1212.12,
        "openingDate": "2007-12-01"
    },
    "savingsAccount": {
        "productName": "Personal Saving Account",
        "productCode": "0200_VC400",
        "displayAccountNumber": "XXXXXX2391",
        "currentBalance": 10000.25,
        "availableBalance": 15000.25,
        "currencyCode": "EUR",
        "lastStatementDate": "2015-06-25",
        "holdAmount": 12900.12,
        "openingDate": "2007-12-01",
        "floatAmount": 250000.25,
        "totalInterestAmount": 1250.25
    },
    "timeDepositAccount": {
        "productName": "Time Deposit Account",
        "productCode": "0600_VC101",
        "displayAccountNumber": "XXXXXX2391",
        "originalPrincipalAmount": 10000.25,
        "currencyCode": "EUR",
        "interestRate": 0.0525,
        "openingDate": "2015-12-01",
        "maturityDate": "2016-12-13",
        "nextInterestPaymentDate": "2017-01-01",
        "interestAmountDue": 100.25,
        "renewalInstructions": "RENEW_PRINCIPAL_ONLY",
        "tenorTerm": 12,
        "tenorPeriod": "MONTHS",
        "baseCurrencyMaturityAmount": 145071.25,
        "maturityInterestAmount": 5071.25,
        "lastInterestPaymentAmount": 107.25
    },
    "loanAccount": {
        "productName": "Loan Account",
        "productCode": "0800_VC601",
        "displayAccountNumber": "XXXXXX2391",
        "originalPrincipalAmount": 200000.25,
        "currentPrincipalAmount": 18000.25,
        "outstandingBalance": 20000.25,
        "currencyCode": "EUR",
        "maturityDate": "2037-12-31",
        "openingDate": "2007-12-01",
        "lastPaymentDate": "2014-01-14",
        "lastPaymentAmount": 8463.25,
        "interestAmount": 91504.81,
        "interestAccumulationPeriod": "YEAR_TO_DATE",
        "nextPaymentAmount": 9230.67,
        "nextPaymentDate": "2018-06-13",
        "paymentFrequency": "MONTHLY",
        "interestType": "VARIABLE",
        "interestRate": 10.08,
        "effectiveInterestRate": 10.1,
        "installmentAmount": 1200.25,
        "remainingTermNumber": 1200.25,
        "pastDueAmount": 20000.25,
        "paidPrincipalAmount": 200000.25,
        "lateChargeAmount": 20000.25
    },
    "mutualFundAccount": {
        "productName": "Mutual Fund Account",
        "productCode": "0201_VC890",
        "displayAccountNumber": "XXXXXX2391",
        "currencyCode": "EUR",
        "totalNetAssetValueAmount": "5000.25",
        "totalTransactionAmount": "4500.25",
        "totalUnrealizedGains": "500.25",
        "mutualFund": {
            "netAssetValueAmount": 166171.53,
            "fundCode": "AFZ03",
            "fundName": "AXA - Australian Property Fund",
            "investmentAmount": 166000.25,
            "currencyCode": "EUR",
            "maturityDate": "2018-12-31",
            "availableUnits": 1000.25,
            "settledUnits": 800.25,
            "assignedUnits": 1000.25,
            "confirmedUnits": 800.25,
            "pendingUnits": 200.25,
            "blockUnits": 0,
            "unrealizedGains": 10.25,
            "unrealizedPercentageGain": 12.5,
            "latestPrice": 15.25
        }
    },
    "securitiesBrokerageAccount": {
        "productName": "Securities Brokerage Account",
        "productCode": "0101_VC801",
        "displayAccountNumber": "XXXXXX2391",
        "currencyCode": "EUR",
        "totalSecuritiesValueAmount": "5000.25",
        "totalTransactionAmount": "4500.25",
        "totalUnrealizedGains": "500.25",
        "security": {
            "securityName": "UBS CALLABLE RANGE ACCRUAL UNIT - SERIES 2 AUD",
            "stockCode": "TIB",
            "stockMarketCode": "SGX",
            "marketValueAmount": 166171.53,
            "investmentAmount": 166000.25,
            "currencyCode": "EUR",
            "averageUnitCost": 12.58,
            "maturityDate": "2018-12-31",
            "availableUnits": 1000.25,
            "settledUnits": 100,
            "assignedUnits": 95,
            "confirmedUnits": 95,
            "pendingUnits": 5,
            "blockUnits": 0,
            "unrealizedGains": 2500.25,
            "unrealizedPercentageGain": 1500.25,
            "latestPrice": 50.25
        }
    },
    "callDepositAccount": {
        "productName": "Call Deposit Account",
        "productCode": "0051_VC201",
        "displayAccountNumber": "XXXXXX2391",
        "currencyCode": "EUR",
        "availableBalance": 15000.25,
        "currentBalance": 15000.25,
        "interestRate": 0.0125,
        "openingDate": "2007-12-01",
        "baseCurrencyMaturityAmount": 15000.25,
        "lastInterestPaymentAmount": 500.25,
        "lastInterestPaymentDate": "2016-12-02"
    },
    "premiumDepositAccount": {
        "productName": "Premium Deposit Account",
        "productCode": "0061_VC401",
        "displayAccountNumber": "XXXXXX2391",
        "baseCurrencyPrincipalAmount": 100000.25,
        "baseCurrencyCode": "AUD",
        "alternateCurrencyPrincipalAmount": 145000.25,
        "openingDate": "2016-12-02",
        "alternateCurrencyCode": "EUR",
        "baseCurrencyDisposalAccount": "C036",
        "alternateCurrencyDisposalAccount": "C978",
        "baseCurrencyInterestAmount": 1000.25,
        "alternateCurrencyInterestAmount": 1050.25,
        "baseCurrencyMaturityAmount": 145071.25,
        "alternateCurrencyMaturityAmount": 90867.25,
        "baseCurrencyPremiumAmount": 145000.25,
        "maturityDate": "2018-12-31",
        "strikePrice": 145.25,
        "customerInterestRate": 4.01,
        "accruedInterestRate": 5.01,
        "benchmarkInterestRate": 4.01,
        "dealStatus": "ACTIVE",
        "expiryDate": "2018-12-31",
        "tenorTerm": 12,
        "tenorPeriod": "MONTHS"
    }
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts/{accountId}
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/accounts/{accountId}
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "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"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem