Home  ›  Your Request Has Failed Due to an Internal Error or Server Unavailability. Please Try Again Later.

Your Request Has Failed Due to an Internal Error or Server Unavailability. Please Try Again Later.

Written By Wednesday, 23 March 2022 Add Comment Edit

Accounts and Transactions

Summary

The Accounts API lets you lot call up business relationship and transaction data for Citi Customers who accept authorized your app. In most cases, you'll desire to request a summary of all accounts first, which volition return basic account information and account IDs. In one case you have this information, you tin request additional account details and/or transactions. The API can return data for cards, checking, savings, loans, line of credit and brokerage accounts. The API can also provide encrypted PII information such every bit Account Routing Number (decryption guide can be plant hither). We are working hard to extend this API to return additional types of accounts. Stay tuned for more!

Want to effort this API out on our Playground?

Become play now

Endpoints on this page
get /v2/accounts/details Retrieve details of all accounts
get /v2/accounts/{accountId}/encrypt/accountRoutingNumber Retrieve routing number(clear text) and encrypted account number of a specific business relationship
get /v2/accounts/{accountId}/transactions Recall transactions

Retrieve details of all accounts

become /v2/accounts/details

  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Responses

Successful operation

Definitions

  • accountGroupDetails
      • accountGroup
        • type : string
        • Business relationship grouping is a nomenclature of accounts according to their mutual characteristics. Values include: CHECKING, SAVINGS, CREDITCARD, LOAN, LINEOFCREDIT, BROKERAGE AND RETIREMENT
        • enum : CHECKING, SAVINGS, CREDITCARD, LOAN, LINEOFCREDIT, BROKERAGE, RETIREMENT
      • checkingAccountsDetails
        • properties : Array
      • savingsAccountsDetails
        • properties : Array
      • creditCardAccountsDetails
        • properties : Assortment
      • loanAccountsDetails
        • properties : Array
      • lineOfCreditAccountsDetails
        • properties : Array
      • brokerageAccountsDetails
        • properties : Array
      • retirementAccountsDetails
        • properties : Array
      • totalCurrentBalance
        • backdrop : Array
      • totalAvailableBalance
        • properties : Assortment
  • client
      • customerId
        • type : string
        • Unique Citi Customer ID number used to identify the end customer and aggregate the end customer'due south different accounts, bringing those multiple accounts into one value. Note - The Client ID is a randomly generated number and is created ane time only. The Customer ID should not be displayed to the stop customer. The customer must take successfully authenticated for this field to pass. This field is unique to the third party aggregator and is persistent, i.eastward. a new customer ID field will be generated for each 3rd party'south customer.

Example Response for get /v2/accounts/details

Type Lawmaking Details
invalid invalidRequest Missing or invalid parameters
fault noAccounts No agile accounts or No accounts linked for customer

Response Schema for go /v2/accounts/details 

                      {     "properties": {         "errors": {             "type": "array",             "clarification": "List of ane or more errors",             "items": {                 "properties": {                     "blazon": {                         "type": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please ready the value and effort once more<\/br>                        
warn - Request was partially processed.  East.chiliad. some of the fields are missing in response to the system bug,  asking was accepted successfully but volition be processed asynchronously<\/br>                        
mistake - The request was accepted but could not be candy successfully<\/br>                        
fatal - At that place was an internal system error while processing the request. These are technical errors and will exist resolved by Citi, and the consumer should retry after some time. Business organisation errors volition not exist categorized as fatal <\/br>"                     },                     "code": {                         "type": "string",                         "description": "Error code which qualifies the error"                     },                     "details": {                         "blazon": "cord",                         "description": "Man readable explanation specific to the occurrence of the trouble"                     },                     "location": {                         "type": "cord",                         "description": "The name of the field that resulted in the mistake"                     },                     "moreInfo": {                         "blazon": "string",                         "clarification": "URI to human being readable documentation of the error"                     }                 },                 "required": [                     "blazon",                     "lawmaking"                 ]             }         }     } }
Type Code Details
error unAuthorized Authorization credentials are missing or invalid

Response Schema for get /v2/accounts/details 

                      {     "properties": {         "errors": {             "type": "array",             "description": "List of one or more errors",             "items": {                 "backdrop": {                     "type": {                         "blazon": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "clarification": "
invalid - Asking did not confirm to the specification and was unprocessed & rejected. Please ready the value and try once more<\/br>                        
warn - Request was partially processed.  E.g. some of the fields are missing in response to the arrangement issues,  request was accepted successfully simply will exist processed asynchronously<\/br>                        
error - The request was accepted but could not be processed successfully<\/br>                        
fatal - At that place was an internal organisation mistake while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry afterwards some time. Business errors volition not be categorized as fatal <\/br>"                     },                     "lawmaking": {                         "blazon": "string",                         "clarification": "Mistake code which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human being readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "blazon": "string",                         "description": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "type": "string",                         "description": "URI to human readable documentation of the fault"                     }                 },                 "required": [                     "blazon",                     "code"                 ]             }         }     } }
Type Code Details More than Info
error accessNotConfigured The asking functioning is not configured to access this resource Channel/Country/Business provided in the asking is not supported currently

Response Schema for get /v2/accounts/details 

                      {     "properties": {         "errors": {             "blazon": "array",             "clarification": "List of ane or more errors",             "items": {                 "backdrop": {                     "type": {                         "blazon": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Delight fix the value and try once again<\/br>                        
warn - Asking was partially processed.  Eastward.grand. some of the fields are missing in response to the system problems,  asking was accepted successfully but volition be processed asynchronously<\/br>                        
error - The asking was accepted simply could not exist processed successfully<\/br>                        
fatal - There was an internal system error while processing the request. These are technical errors and volition be resolved past Citi, and the consumer should retry afterward some time. Business errors will non be categorized as fatal <\/br>"                     },                     "lawmaking": {                         "type": "string",                         "description": "Error code which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human readable caption specific to the occurrence of the problem"                     },                     "location": {                         "type": "cord",                         "description": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "type": "string",                         "description": "URI to human readable documentation of the mistake"                     }                 },                 "required": [                     "type",                     "code"                 ]             }         }     } }
Type Code Details
fatal serverUnavailable The asking failed due to an internal fault/server unavailability

Response Schema for get /v2/accounts/details 

                      {     "backdrop": {         "errors": {             "type": "array",             "description": "List of i or more errors",             "items": {                 "properties": {                     "type": {                         "type": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did non confirm to the specification and was unprocessed & rejected. Please prepare the value and try again<\/br>                        
warn - Request was partially candy.  E.g. some of the fields are missing in response to the organisation issues,  asking was accepted successfully but volition be processed asynchronously<\/br>                        
error - The asking was accepted just could not be processed successfully<\/br>                        
fatal - At that place was an internal system fault while processing the asking. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not exist categorized as fatal <\/br>"                     },                     "code": {                         "blazon": "cord",                         "clarification": "Mistake code which qualifies the mistake"                     },                     "details": {                         "type": "string",                         "description": "Human readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "type": "string",                         "description": "The proper noun of the field that resulted in the mistake"                     },                     "moreInfo": {                         "blazon": "string",                         "description": "URI to human readable documentation of the error"                     }                 },                 "required": [                     "type",                     "code"                 ]             }         }     } }
Blazon Code Details
fatal serverUnavailable The asking failed due to an internal mistake

Response Schema for get /v2/accounts/details 

                      {     "properties": {         "errors": {             "type": "array",             "description": "Listing of one or more errors",             "items": {                 "properties": {                     "type": {                         "type": "cord",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please set the value and try again<\/br>                        
warn - Request was partially processed.  E.g. some of the fields are missing in response to the system problems,  asking was accepted successfully but will exist processed asynchronously<\/br>                        
mistake - The request was accepted but could not exist processed successfully<\/br>                        
fatal - There was an internal arrangement error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry later on some time. Concern errors will not be categorized as fatal <\/br>"                     },                     "code": {                         "type": "string",                         "clarification": "Error code which qualifies the error"                     },                     "details": {                         "blazon": "string",                         "description": "Man readable caption specific to the occurrence of the problem"                     },                     "location": {                         "type": "string",                         "description": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "blazon": "string",                         "description": "URI to human readable documentation of the mistake"                     }                 },                 "required": [                     "type",                     "code"                 ]             }         }     } }

Call up routing number(clear text) and encrypted account number of a specific account

get /v2/accounts/{accountId}/encrypt/accountRoutingNumber

  • whorl
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Responses

Successful operation.

Definitions

  • encryptedAccountNumber
      • encryptedPayload
        • type : object
        • Encrypted Account number object with details to decrypt in header
        • required : Assortment
        • backdrop : Array
  • routingNumber
    • type : string
    • ABA routing number. Conditional on Checking & Savings Accounts only; will not be returned otherwise.

Instance Response for get /v2/accounts/{accountId}/encrypt/accountRoutingNumber

Type Code Details
error invalidRequest Missing or invalid Parameters

Definitions

  • code
    • blazon : cord
  • type
    • type : string
  • moreInformation
    • type : string

Response Schema for go /v2/accounts/{accountId}/encrypt/accountRoutingNumber 

                      {     "properties": {         "code": {             "type": "string",             "instance": "invalidRequest"         },         "type": {             "blazon": "string",             "example": "invalid"         },         "moreInformation": {             "type": "cord",             "case": "Missing or invalid parameters"         }     } }
Blazon Lawmaking Details
error unAuthorized Authorization credentials are missing or invalid

Definitions

  • code
    • type : string
  • type
    • type : string
  • moreInformation
    • type : string

Response Schema for get /v2/accounts/{accountId}/encrypt/accountRoutingNumber 

                      {     "properties": {         "code": {             "type": "string",             "example": "401"         },         "type": {             "type": "string",             "example": "unAuthorized"         },         "moreInformation": {             "blazon": "string",             "example": "Authorization credentials are missing or invalid"         }     } }
Type Code Details More than Info
error accessNotConfigured The request operation is not configured to access this resource Aqueduct/Land/Business provided in the request is not supported currently

Response Schema for get /v2/accounts/{accountId}/encrypt/accountRoutingNumber 

                      {     "properties": {         "errors": {             "type": "array",             "description": "List of one or more errors",             "items": {                 "backdrop": {                     "type": {                         "blazon": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Asking did not confirm to the specification and was unprocessed & rejected. Please set the value and try again<\/br>                        
warn - Asking was partially processed.  East.chiliad. some of the fields are missing in response to the organisation bug,  request was accepted successfully but will be processed asynchronously<\/br>                        
error - The request was accustomed but could not be processed successfully<\/br>                        
fatal - There was an internal system error while processing the asking. These are technical errors and will be resolved by Citi, and the consumer should retry after some fourth dimension. Business errors volition not be categorized every bit fatal <\/br>"                     },                     "code": {                         "type": "string",                         "description": "Fault code which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human readable explanation specific to the occurrence of the trouble"                     },                     "location": {                         "type": "string",                         "description": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "type": "cord",                         "description": "URI to human readable documentation of the error"                     }                 },                 "required": [                     "blazon",                     "code"                 ]             }         }     } }
Type Code Details
mistake resourceNotFound The requested resource was not found

Definitions

  • httpCode
    • blazon : string
  • httpMessage
    • type : string
  • moreInformation
    • type : string

Response Schema for get /v2/accounts/{accountId}/encrypt/accountRoutingNumber 

                      {     "backdrop": {         "httpCode": {             "type": "string",             "instance": "404"         },         "httpMessage": {             "type": "string",             "case": "Not Institute"         },         "moreInformation": {             "type": "string",             "example": "No resources match requested URI"         }     } }
Blazon Code Details
fatal serverUnavailable The asking failed due to an internal error/server unavailability

Response Schema for get /v2/accounts/{accountId}/encrypt/accountRoutingNumber 

                      {     "properties": {         "errors": {             "type": "array",             "description": "List of 1 or more errors",             "items": {                 "properties": {                     "type": {                         "type": "cord",                         "enum": [                             "mistake",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did non confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>                        
warn - Request was partially processed.  Due east.thou. some of the fields are missing in response to the system issues,  request was accepted successfully just will be processed asynchronously<\/br>                        
error - The request was accepted just could not be candy successfully<\/br>                        
fatal - There was an internal system error while processing the asking. These are technical errors and will be resolved by Citi, and the consumer should retry afterwards some time. Business errors will not be categorized as fatal <\/br>"                     },                     "code": {                         "type": "cord",                         "description": "Error code which qualifies the error"                     },                     "details": {                         "type": "string",                         "clarification": "Human being readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "type": "string",                         "description": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "blazon": "string",                         "description": "URI to human readable documentation of the mistake"                     }                 },                 "required": [                     "type",                     "code"                 ]             }         }     } }

Retrieve transactions

go /v2/accounts/{accountId}/transactions

  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Responses

Successful performance

Definitions

  • checkingAccountTransactions
      • accountId
        • type : string
        • Long-term persistent identity of the business relationship. Not an business relationship number.
      • checkNumber
        • blazon : integer
        • This field volition be populated if the transaction is a check deposit or withrawal.
      • currencyCode
        • type : cord
        • The currency code of the transaction in ISO 4217 format
      • debitCreditMemo
        • blazon : string
        • Transaction feed indicator showing whether the transaction amount is coming into account or going out of account. Valid values include - DEBIT, CREDIT.
        • enum : DEBIT, CREDIT
      • displayAccountNumber
        • blazon : string
        • A masked account number that can be displayed to the customer
      • transactionAmount
        • type : number
        • format : double
        • The transaction amount, in the principal currency of the account.
      • transactionDate
        • type : string
        • format : engagement
        • Date merchant did the sale to the customer in ISO 8601 YYYY-MM-DD format.
      • transactionDescription
        • blazon : string
        • Description explaining the details of the transaction.
      • transactionDescriptionExtension
        • type : string
        • Additional transaction clarification,
      • transactionId
        • blazon : string
        • transaction Id to uniquely identify the transaction inside an account. Conditional on transaction blazon and status; not available for pending and organization-generated transactions
      • transactionStatus
        • blazon : string
        • The condition of the transaction. Valid values are either PENDING or POSTED
        • enum : Awaiting, POSTED
      • transactionType
        • type : cord
        • The type of transaction which indicates type of debit or credit transaction. Valid Values for checking and saving transactions include - Deposit, PAYMENT, TRANSFER, WITHDRAWAL_OR_DEPOSIT, WITHDRAWAL, DIVIDEND_AND_INTEREST, FEES, ADJUSTMENTS, TRANSACTION_VOID and FEE_WAIVED.
        • enum : Deposit, PAYMENT, TRANSFER, WITHDRAWAL_OR_DEPOSIT, WITHDRAWAL, DIVIDEND_AND_INTEREST, FEES, ADJUSTMENTS, TRANSACTION_VOID, FEE_WAIVED, OTHER
  • savingsAccountTransactions
      • accountId
        • type : string
        • Long-term persistent identity of the account. Not an account number.
      • checkNumber
        • type : integer
        • This field will be populated if the transaction is a check deposit or withrawal.
      • currencyCode
        • type : string
        • The 3-graphic symbol currency lawmaking in ISO 4217 format that identifies the currency type for the transaction.
      • debitCreditMemo
        • type : string
        • Transaction feed indicator showing whether the transaction amount is coming into business relationship or going out of account. Valid values include - DEBIT, CREDIT.
        • enum : DEBIT, CREDIT
      • displayAccountNumber
        • type : cord
        • A masked account number that tin can exist displayed to the finish customer to identity the account. Notation - Should only show the last 4 digits of the business relationship number, with the remaining numbers masked every bit "X".
      • transactionAmount
        • type : number
        • format : double
        • The transaction amount, in the master currency of the business relationship.
      • transactionDate
        • blazon : string
        • format : engagement
        • Appointment merchant did the sale to the customer in ISO 8601 YYYY-MM-DD format.
      • transactionDescription
        • blazon : cord
        • Description explaining the details of the transaction.
      • transactionDescriptionExtension
        • type : string
        • Additional transaction description,
      • transactionId
        • type : cord
        • transaction Id to uniquely identify the transaction within an account. Conditional on transaction type and condition; not bachelor for pending and arrangement-generated transactions
      • transactionStatus
        • type : string
        • The status of the transaction. Valid values are either Pending or POSTED
        • enum : PENDING, POSTED
      • transactionType
        • type : string
        • The blazon of transaction which indicates type of debit or credit transaction. Valid Values for checking and saving transactions include - Deposit, PAYMENT, TRANSFER, WITHDRAWAL_OR_DEPOSIT, WITHDRAWAL, DIVIDEND_AND_INTEREST, FEES, ADJUSTMENTS, TRANSACTION_VOID and FEE_WAIVED.
        • enum : DEPOSIT, PAYMENT, TRANSFER, WITHDRAWAL_OR_DEPOSIT, WITHDRAWAL, DIVIDEND_AND_INTEREST, FEES, ADJUSTMENTS, TRANSACTION_VOID, FEE_WAIVED, OTHER
  • creditCardAccountTransactions
      • accountId
        • type : string
        • Long-term persistent identity of the account. Not an account number.
      • currencyCode
        • blazon : cord
        • The three-graphic symbol currency code in ISO 4217 format that identifies the currency type for the transaction.
      • debitCreditMemo
        • type : string
        • Transaction feed indicator showing whether the transaction corporeality is coming into account or going out of account. Valid values include - DEBIT, CREDIT.
        • enum : DEBIT, CREDIT
      • displayAccountNumber
        • blazon : string
        • A masked account number that can be displayed to the end customer to identity the business relationship. Note - Should only show the last iv digits of the account number, with the remaining numbers masked as "X".
      • foreignCurrency
        • type : number
        • format : double
        • The transaction corporeality and desciption in the strange currency
      • merchantCategory
        • type : cord
        • A merchant category (MCC or SIC) code is a four-digit number assigned to a business by credit carte du jour companies (for example, American Express, MasterCard, VISA) when the business first starts accepting ane of these cards as a form of payment.
      • merchantDescription
        • type : string
        • The description of the standard merchant category.
      • transactionDate
        • blazon : string
        • format : engagement
        • Date merchant did the sale to the client in ISO 8601 YYYY-MM-DD format.
      • transactionPostingDate
        • type : string
        • format : date
        • The date that the transaction was posted to the account and into Citi'due south system in YYYY-MM-DD format. Conditional on transaction blazon and condition; not available for PENDING and UNPROCESSED_PAYMENTS transactionStatus
      • transactionId
        • type : string
        • transaction Id to uniquely place the transaction within an account. Conditional on transaction type and status; non bachelor for pending and system-generated transactions
      • transactionAmount
        • type : number
        • format : double
        • The transaction amount, in the master currency of the account
      • transactionDescription
        • type : cord
        • Transaction description
      • transactionStatus
        • blazon : string
        • The status of the transaction. Valid values are either Pending, BILLED, UNBILLED, UNPROCESSED_PAYMENTS.
        • enum : PENDING, BILLED, UNBILLED, UNPROCESSED_PAYMENTS
      • transactionType
        • blazon : string
        • The type of transaction which indicates type of debit or credit transaction. Valid values for credit card transactions include PAYMENT, Purchase, CASH_ADVANCES, FEES, INTEREST_CHARGES, ADJUSTMENT and CREDIT.
        • enum : PAYMENT, Buy, CASH_ADVANCES, FEES, INTEREST_CHARGES, Aligning, CREDIT
      • memberName
        • type : string
        • name of the authorized user who made the transaction in instance of authorized users. Provisional on certain Production Type; Optional and may non be returned otherwise
  • loanAccountTransactions
      • accountId
        • blazon : string
        • Long-term persistent identity of the account. Not an business relationship number.
      • displayAccountNumber
        • type : cord
        • A masked account number that can be displayed to the terminate client
      • transactionDate
        • type : string
        • format : date
        • Transaction timestamp in ISO 8601 YYYY-MM-DD format
      • transactionType
        • type : cord
        • The type of transaction. Valid values are PAYMENT, PURCHASE, CASH_ADVANCE, FEE, INTEREST_CHARGED, PURCHASE_CREDIT and CREDIT
        • enum : PAYMENT, Purchase, CASH_ADVANCE, FEE, INTEREST_CHARGED, PURCHASE_CREDIT, CREDIT
      • transactionAmount
        • type : number
        • format : double
        • The transaction amount, in the primary currency of the account
      • debitCreditMemo
        • blazon : string
        • Transaction feed indicator showing whether the transaction amount is coming into account or going out of business relationship. Valid values include - DEBIT, CREDIT.
        • enum : DEBIT, CREDIT
      • transactionId
        • blazon : string
        • Transaction Id to uniquely identify the transaction. 'Conditional on transaction type and condition; not available for pending and arrangement-generated transactions
      • transactionDescription
        • blazon : cord
        • Clarification explaining the details of the transaction.
      • transactionDescriptionExtension
        • type : string
        • Additional transaction clarification,
      • transactionStatus
        • type : cord
        • The status of the transaction. Valid values are either Pending or POSTED
        • enum : Awaiting, POSTED
      • transactionPostingDate
        • type : string
        • format : date
        • The appointment that the transaction was posted to the account and into Citi'due south system in YYYY-MM-DD format (EST).
      • currencyCode
        • type : string
        • The currency code is a 3-character code (ISO 4217 format) that identifies the currency type for the customer'southward account and transaction.
      • checkNumber
        • type : string
        • Bank check number for loan transactions.
  • lineOfCreditAccountTransactions
      • accountId
        • type : cord
        • Long-term persistent identity of the account. Not an business relationship number.
      • displayAccountNumber
        • type : string
        • A masked account number that tin be displayed to the stop customer
      • transactionDate
        • type : string
        • format : date
        • Transaction timestamp in ISO 8601 YYYY-MM-DD format
      • transactionType
        • type : string
        • The blazon of transaction. Valid values are PAYMENT, PURCHASE, CASH_ADVANCE, FEE, INTEREST_CHARGED, PURCHASE_CREDIT and CREDIT
        • enum : PAYMENT, Buy, CASH_ADVANCE, FEE, INTEREST_CHARGED, PURCHASE_CREDIT, CREDIT
      • transactionAmount
        • type : number
        • format : double
        • The transaction amount, in the primary currency of the account
      • debitCreditMemo
        • blazon : string
        • Transaction feed indicator showing whether the transaction corporeality is coming into account or going out of business relationship. Valid values include - DEBIT, CREDIT.
        • enum : DEBIT, CREDIT
      • transactionId
        • type : string
        • Transaction Id to uniquely identify the transaction. Conditional on transaction type and status; not bachelor for pending and arrangement-generated transactions
      • transactionDescription
        • type : string
        • Description explaining the details of the transaction.
      • transactionDescriptionExtension
        • type : string
        • Boosted transaction description,
      • transactionStatus
        • type : string
        • The status of the transaction. Valid values are either PENDING or POSTED
        • enum : Awaiting, POSTED
      • transactionPostingDate
        • type : string
        • format : appointment
        • The appointment that the transaction was posted to the account and into Citi'south system in YYYY-MM-DD format (EST).
      • currencyCode
        • type : string
        • The currency code is a iii-character code (ISO 4217 format) that identifies the currency type for the customer'due south account and transaction.
      • checkNumber
        • type : string
        • Check number for line of credit transactions.
  • brokerageAccountTransactions
      • accountId
        • type : string
        • Long-term persistent identity of the account. Not an account number.
      • displayAccountNumber
        • type : string
        • A masked business relationship number that can be displayed to the client
      • currencyCode
        • type : cord
        • The currency code of the transaction in ISO 4217 format
      • securityIdentifier
        • properties : Array
      • assetClass
        • blazon : string
        • Asset form value displayed on the application for asset allotment nautical chart. Possible values: CORPDEBT, CURRENCY, Equity, ASSTBACK etc.
      • assetType
        • blazon : string
        • Asset type assigned to a holding. Possible values: CORPDEBT, CURRENCY, Disinterestedness, ASSTBACK etc.
      • buySellIndicator
        • type : string
        • Buy sell indicator type
        • enum : BUY, SELL, NONE
      • longActivityDescription
        • type : string
        • Long activeness description.
      • netAmount
        • type : number
        • format : double
        • Net amount of transaction.
      • priceAmount
        • blazon : number
        • format : double
        • Toll amount of the security.
      • principalAmount
        • type : number
        • format : double
        • Principal corporeality of trade. The amount of payment practical to the main. Just present for historical transactions, non intra-day
      • quantity
        • type : number
        • format : double
        • Quantity of security at the time of trade.
      • settlementDate
        • type : cord
        • format : date
        • Settlement data of merchandise transaction.
      • shortActivityDescription
        • type : cord
        • Short activity description.
      • tradeNumber
        • type : string
        • Trade reference number of trade transactions.
      • tradeTransactionFlag
        • type : cord
        • Flag to indicate trade related transaction.
      • transactionDateTime
        • type : string
        • format : appointment
        • Transaction timestamp.
      • transactionId
        • type : string
        • TradeNumber is the identifier used to chronicle a transaction with merchandise orders.
      • transactionType
        • type : string
        • PAYMENT, Buy, CASH_ADVANCES, FEES,INTEREST_CHARGES, PURCHASE_CREDIT, CREDIT, WITHDRAWAL_OR_DEPOSIT, SECURITY_TRANSACTION, DIVIDEND_AND_INTEREST, OTHER, COMMON_STOCK_TRANSACTION, PREFERRED_STOCK_TRANSACTION, OPTIONS_TRANSACTION, MUTUAL_FUND_TRANSACTION, BOND_TRANSACTION, CERTIFICATE_OF_DEPOSIT_TRANSACTION, ADJUSTMENTS
        • enum : PAYMENT, Buy, CASH_ADVANCES, FEES, INTEREST_CHARGES, PURCHASE_CREDIT, CREDIT, WITHDRAWAL_OR_DEPOSIT, SECURITY_TRANSACTION, DIVIDEND_AND_INTEREST, OTHER, COMMON_STOCK_TRANSACTION, PREFERRED_STOCK_TRANSACTION, OPTIONS_TRANSACTION, MUTUAL_FUND_TRANSACTION, BOND_TRANSACTION, CERTIFICATE_OF_DEPOSIT_TRANSACTION, ADJUSTMENTS

Example Response for get /v2/accounts/{accountId}/transactions

No Content

This operation returns no content.

error invalidRequest Missing or invalid request parameters
error invalidTransactionFromDate The transactionFromDate provided is invalid. The date format is YYYYMMDD.
error invalidTransactionToDate The transactionToDate provided is invalid. The engagement format is YYYYMMDD.
fault transactionFromToDateComboInvalid The transactionFromDate value is greater (afterwards) than the transactionToDate value.
fault tranxFromDate2YrsPriorToCurrDate Transaction from date should non be 24 months prior to current engagement.
fault tranxToDateAfterCurrDate Transaction to appointment should non be after current date.

Response Schema for go /v2/accounts/{accountId}/transactions 

                      {     "properties": {         "errors": {             "type": "assortment",             "description": "List of i or more errors",             "items": {                 "backdrop": {                     "blazon": {                         "type": "cord",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "clarification": "
invalid - Asking did not confirm to the specification and was unprocessed & rejected. Please fix the value and attempt again<\/br>                        
warn - Asking was partially processed.  Due east.thousand. some of the fields are missing in response to the system issues,  asking was accepted successfully but volition be processed asynchronously<\/br>                        
fault - The asking was accepted only could not be processed successfully<\/br>                        
fatal - There was an internal organization error while processing the request. These are technical errors and will exist resolved past Citi, and the consumer should retry after some time. Business concern errors will not exist categorized equally fatal <\/br>"                     },                     "lawmaking": {                         "type": "string",                         "clarification": "Error code which qualifies the mistake"                     },                     "details": {                         "type": "string",                         "description": "Human readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "type": "string",                         "clarification": "The proper name of the field that resulted in the error"                     },                     "moreInfo": {                         "type": "string",                         "clarification": "URI to human readable documentation of the error"                     }                 },                 "required": [                     "type",                     "lawmaking"                 ]             }         }     } }
Type Code Details
error unAuthorized Authorization credentials are missing or invalid

Response Schema for go /v2/accounts/{accountId}/transactions 

                      {     "backdrop": {         "errors": {             "type": "array",             "description": "Listing of one or more than errors",             "items": {                 "properties": {                     "type": {                         "type": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try over again<\/br>                        
warn - Asking was partially processed.  E.grand. some of the fields are missing in response to the arrangement issues,  request was accustomed successfully but volition exist processed asynchronously<\/br>                        
mistake - The request was accustomed but could non be processed successfully<\/br>                        
fatal - At that place was an internal organization error while processing the asking. These are technical errors and will exist resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>"                     },                     "code": {                         "type": "string",                         "description": "Error code which qualifies the fault"                     },                     "details": {                         "blazon": "string",                         "clarification": "Human readable explanation specific to the occurrence of the trouble"                     },                     "location": {                         "type": "string",                         "clarification": "The name of the field that resulted in the error"                     },                     "moreInfo": {                         "blazon": "string",                         "description": "URI to man readable documentation of the error"                     }                 },                 "required": [                     "type",                     "code"                 ]             }         }     } }
Type Lawmaking Details More Info
error accessNotConfigured The asking performance is not configured to access this resource Channel/Country/Business provided in the request is not supported currently

Response Schema for get /v2/accounts/{accountId}/transactions 

                      {     "properties": {         "errors": {             "type": "assortment",             "description": "List of i or more than errors",             "items": {                 "properties": {                     "blazon": {                         "type": "cord",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not ostend to the specification and was unprocessed & rejected. Delight fix the value and endeavor again<\/br>                        
warn - Request was partially processed.  Due east.k. some of the fields are missing in response to the system issues,  request was accepted successfully only will be processed asynchronously<\/br>                        
error - The asking was accustomed merely could not be processed successfully<\/br>                        
fatal - At that place was an internal organisation error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry subsequently some time. Business errors volition non exist categorized equally fatal <\/br>"                     },                     "code": {                         "type": "string",                         "clarification": "Error code which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human being readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "type": "cord",                         "description": "The name of the field that resulted in the fault"                     },                     "moreInfo": {                         "type": "string",                         "description": "URI to human readable documentation of the error"                     }                 },                 "required": [                     "blazon",                     "code"                 ]             }         }     } }
Type Lawmaking Details
error resourceNotFound Resources non found

Response Schema for become /v2/accounts/{accountId}/transactions 

                      {     "backdrop": {         "errors": {             "type": "assortment",             "description": "List of ane or more than errors",             "items": {                 "properties": {                     "type": {                         "type": "string",                         "enum": [                             "error",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Asking did not confirm to the specification and was unprocessed & rejected. Please fix the value and attempt again<\/br>                        
warn - Request was partially processed.  E.g. some of the fields are missing in response to the arrangement issues,  request was accepted successfully but volition be processed asynchronously<\/br>                        
error - The request was accepted just could not be processed successfully<\/br>                        
fatal - At that place was an internal organization fault while processing the asking. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not exist categorized as fatal <\/br>"                     },                     "code": {                         "type": "cord",                         "description": "Error lawmaking which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human readable explanation specific to the occurrence of the trouble"                     },                     "location": {                         "type": "cord",                         "description": "The name of the field that resulted in the fault"                     },                     "moreInfo": {                         "blazon": "cord",                         "description": "URI to man readable documentation of the error"                     }                 },                 "required": [                     "blazon",                     "code"                 ]             }         }     } }
Blazon Code Details
fatal serverUnavailable The asking failed due to an internal mistake

Response Schema for become /v2/accounts/{accountId}/transactions 

                      {     "properties": {         "errors": {             "type": "array",             "description": "List of ane or more than errors",             "items": {                 "properties": {                     "type": {                         "type": "string",                         "enum": [                             "fault",                             "warn",                             "invalid",                             "fatal"                         ],                         "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and endeavor once more<\/br>                        
warn - Request was partially candy.  E.grand. some of the fields are missing in response to the organisation issues,  request was accepted successfully simply will be processed asynchronously<\/br>                        
error - The asking was accepted but could non be processed successfully<\/br>                        
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry subsequently some time. Business organization errors will non be categorized equally fatal <\/br>"                     },                     "code": {                         "type": "string",                         "clarification": "Error code which qualifies the error"                     },                     "details": {                         "type": "string",                         "description": "Human readable explanation specific to the occurrence of the problem"                     },                     "location": {                         "blazon": "cord",                         "description": "The proper name of the field that resulted in the fault"                     },                     "moreInfo": {                         "type": "string",                         "description": "URI to man readable documentation of the error"                     }                 },                 "required": [                     "blazon",                     "code"                 ]             }         }     } }

kimouteriesself.blogspot.com

Source: https://sandbox.developerhub.citi.com/api/united-states/retail-bank/accounts/accounts-and-transactions/documentation

0 Response to "Your Request Has Failed Due to an Internal Error or Server Unavailability. Please Try Again Later."

Post a Comment

Subscribe to: Post Comments (Atom)

Iklan Atas Artikel

Iklan Tengah Artikel 1

Iklan Tengah Artikel 2

Iklan Bawah Artikel