--- schema_version: "1" id: d9e8442dd55d1f6a697fde27a026ff96c901b070b0ab7de623ac0d9f3f3e6e14 title: FSC Integrations collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/financial_services/references/generated-api-specs/fsc_api.md canonical_url: https://developer.salesforce.com/docs/industries/fsc/references/fsc_api source_site: developer.salesforce.com content_type: documentation content_hash: 433cf26938160756e4388b2f551e2e5f86c5e0f59ed91f70baeffdeafabdf1d3 products: - Agentforce Financial Services - Industries Integrations --- FSC Integrations # FSC Integrations Use the Financial Services Cloud Integrations API to access core banking functions that are provided by external banking systems. With the Integrations API, you can retrieve account balances, retrieve account transactions, update address, and reverse a fee applied to financial accounts. **Version:** v1 Protocols: HTTPS. ## Operations ### PUT Replace cards for current account `PUT /CurrentAccount/IssuedDevice/Request` Replaces cards for current account. #### Parameters * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `ReplaceIssuedDeviceRequest`. #### Responses * **200** Replace cards for current account. Media type: `application/json`. Schema: `ReplaceIssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "406" errorMessage: The requested resource cannot generate acceptable content according to the Accept headers sent in the request. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "415" errorMessage: The server denied the request because it is not in a format supported by the target resource. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve current account balance `GET /CurrentAccount/{accountId}` Retrieves the account balance of current account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved current account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `CurrentAccount`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: CurrentPostedBalance BalanceAmount: 222 - BalanceType: Balance BalanceAmount: 787 - BalanceType: PendingWithdrawals BalanceAmount: 90 - BalanceType: PendingDeposits BalanceAmount: 9008 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of current account `PATCH /CurrentAccount/{accountId}` Updates the address of current account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of current account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Add beneficiary `POST /CurrentAccount/{accountId}/Initiate` Adds a beneficiary. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `BeneficiariesRequest`. #### Responses * **201** Beneficiary added. Media type: `application/json`. Schema: `BeneficiariesResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### DELETE Delete beneficiary `DELETE /CurrentAccount/{accountId}/Delete` Deletes a beneficiary. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `DeleteBeneficiariesRequest`. #### Responses * **200** Deleted the beneficiary. Media type: `application/json`. Schema: `DeleteBeneficiariesResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Reverse fee on current account `POST /CurrentAccount/{accountId}/ReverseFee` Reverses the fee that's applied on a customer's current account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `object`. * `request` (_object_, required) * `FeeReversalTransactions` (_array of object_, required) Specifies the list of transactions that the customer has requested to reverse. * `ReversalAmount` (_number_, required) Specifies the amount that's approved for the reversal. Example: `50.00`. * `ReversalAmountCurrency` (_string_, required) Specifies the currency of the amount to be reversed. Example: `USD`. * `ReversalReason` (_string_, required) Specifies the reason for requesting the reversal. Example: `Reversal requested by the VIP customer.`. * `OriginalTransaction` (_object_, required) Specifies the details of the original transaction. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_, required) Specifies additional attributes that must be sent in the request. #### Responses * **200** Reversed fee on current account. Media type: `application/json`. Schema: `object`. * `FeeReversalTransactionResponse` (_array of object_, required) * `OriginalTransactionId` (_string_, required) Example: `someTransactionId`. * `FeeReversalErrorDetail` (_object_) Response object for an error. * `ErrorCode` (_string_) Example: `E-002`. * `ErrorMessage` (_string_, required) Example: `Specifies the error while retrieving the account information.`. * `MaintenanceResponse` (_object_) * `timestamp` (_datetime (rfc3339)_) Example: `2022-02-28T16:41:41.090Z`. * `FeeReversalTransaction` (_object_) Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve current account transactions `GET /CurrentAccount/{accountId}/transactions` Retrieves an current account to get its transactions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved current account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `CurrentAccount`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve standing instruction `GET /CurrentAccount/{accountId}/Payments/Retrieve` Retrieves standing instruction #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (query, string) The paymentId property is a unique and unambiguous identification of a payment order or standing order. Example: `SOT00010000`. * `payeeName` (query, string) Specifies the beneficiary account holder name. Example: `Amazon`. * `amount` (query, string) Specifies the payment order amount. Example: `1000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved standing instruction. Media type: `application/json`. Schema: `GetPaymentInstructionsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Add standing instruction `POST /CurrentAccount/{accountId}/Payments/Initiate` Adds standing instructions / Transfers money between customer's own accounts. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `PaymentInstrcutionsRequest`. #### Responses * **201** Added Standing Instruction / Transfered money between customer's own accounts. Media type: `application/json`. Schema: `PaymentInstrcutionsResponse`. Specifies the payment instructions request. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Modify standing instructions `PUT /CurrentAccount/{accountId}/Payments/{paymentId}/Update` Modify standing instructions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (path, string, required) The paymentId property is a unique and unambiguous identification of a payment order. Example: `SOT00010000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `PaymentInstrcutionsRequest`. #### Responses * **200** Modified standing instruction. Media type: `application/json`. Schema: `UpdatePaymentInstructionsResponse`. Specifies the payment instructions request. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Cancel standing instruction `PATCH /CurrentAccount/{accountId}/Payments/{paymentId}/Update` Cancels standing instruction. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (path, string, required) The paymentId property is a unique and unambiguous identification of a payment order. Example: `SOT00010000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `CancelPaymentInstructionsRequest`. #### Responses * **200** Canceled standing instruction. Media type: `application/json`. Schema: `CancelPaymentInstructionsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Request current account statement `POST /CurrentAccount/{accountId}/Statement/Request` Requests current account statement. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `OrderStatementsRequest`. #### Responses * **201** Requested current account statement. Media type: `application/json`. Schema: `OrderStatementsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Order checkbook for current account `POST /CurrentAccount/{accountId}/IssuedDevice/Initiate` Orders checkbook for current account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `IssuedDeviceRequest`. #### Responses * **201** Ordered checkbook for current account. Media type: `application/json`. Schema: `IssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Stop check of current account `PUT /CurrentAccount/{accountId}/IssuedDevice/Update` Stops checks of current account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `UpdateIssuedDeviceRequest`. #### Responses * **200** Stopped check of current account. Media type: `application/json`. Schema: `UpdateIssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Replace cards for savings account `PUT /SavingsAccount/IssuedDevice/Request` Replaces cards for savings account. #### Parameters * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `ReplaceIssuedDeviceRequest`. #### Responses * **200** Replace cards for savings account. Media type: `application/json`. Schema: `ReplaceIssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve savings account balance `GET /SavingsAccount/{accountId}` Retrieves the account balance of savings account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved savings account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `SavingsAccount`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: CurrentPostedBalance BalanceAmount: 500 - BalanceType: Balance BalanceAmount: 490 - BalanceType: PendingWithdrawals BalanceAmount: 25 - BalanceType: PendingDeposits BalanceAmount: 3000 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of savings account `PATCH /SavingsAccount/{accountId}` Updates the address of savings account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of savings account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Add beneficiary `POST /SavingsAccount/{accountId}/Initiate` Adds a beneficiary. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `BeneficiariesRequest`. #### Responses * **201** Beneficiary added. Media type: `application/json`. Schema: `BeneficiariesResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### DELETE Delete beneficiary `DELETE /SavingsAccount/{accountId}/Delete` Deletes a beneficiary. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `DeleteBeneficiariesRequest`. #### Responses * **200** Deleted the beneficiary. Media type: `application/json`. Schema: `DeleteBeneficiariesResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Reverse fee on savings account `POST /SavingsAccount/{accountId}/ReverseFee` Reverses the fee that's applied on a customer's savings account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `object`. * `request` (_object_, required) * `FeeReversalTransactions` (_array of object_, required) Specifies the list of transactions that the customer has requested to reverse. * `ReversalAmount` (_number_, required) Specifies the amount that's approved for the reversal. Example: `50.00`. * `ReversalAmountCurrency` (_string_, required) Specifies the currency of the amount to be reversed. Example: `USD`. * `ReversalReason` (_string_, required) Specifies the reason for requesting the reversal. Example: `Reversal requested by the VIP customer.`. * `OriginalTransaction` (_object_, required) Specifies the details of the original transaction. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_, required) Specifies additional attributes that must be sent in the request. #### Responses * **200** Reversed fee on savings account. Media type: `application/json`. Schema: `object`. * `FeeReversalTransactionResponse` (_array of object_, required) * `OriginalTransactionId` (_string_, required) Example: `someTransactionId`. * `FeeReversalErrorDetail` (_object_) Response object for an error. * `ErrorCode` (_string_) Example: `E-002`. * `ErrorMessage` (_string_, required) Example: `Specifies the error while retrieving the account information.`. * `MaintenanceResponse` (_object_) * `timestamp` (_datetime (rfc3339)_) Example: `2022-02-28T16:41:41.090Z`. * `FeeReversalTransaction` (_object_) Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve savings account transactions `GET /SavingsAccount/{accountId}/transactions` Retrieves an savings account to get its transactions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved savings account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `SavingsAccount`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve standing instruction `GET /SavingsAccount/{accountId}/Payments/Retrieve` Retrieves standing instruction #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (query, string) The paymentId property is a unique and unambiguous identification of a payment order or standing order. Example: `SOT00010000`. * `payeeName` (query, string) Specifies the beneficiary account holder name. Example: `Amazon`. * `amount` (query, string) Specifies the payment order amount. Example: `1000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved standing instruction. Media type: `application/json`. Schema: `GetPaymentInstructionsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Add standing instruction `POST /SavingsAccount/{accountId}/Payments/Initiate` Adds standing instructions / Transfers money between customer's own accounts. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `PaymentInstrcutionsRequest`. #### Responses * **201** Added Standing Instruction / Transfered money between customer's own accounts. Media type: `application/json`. Schema: `PaymentInstrcutionsResponse`. Specifies the payment instructions request. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Modify standing instructions `PUT /SavingsAccount/{accountId}/Payments/{paymentId}/Update` Modify standing instructions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (path, string, required) The paymentId property is a unique and unambiguous identification of a payment order. Example: `SOT00010000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `PaymentInstrcutionsRequest`. #### Responses * **200** Modified standing instruction. Media type: `application/json`. Schema: `UpdatePaymentInstructionsResponse`. Specifies the payment instructions request. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Cancel standing instruction `PATCH /SavingsAccount/{accountId}/Payments/{paymentId}/Update` Cancels standing instruction. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `paymentId` (path, string, required) The paymentId property is a unique and unambiguous identification of a payment order. Example: `SOT00010000`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `CancelPaymentInstructionsRequest`. #### Responses * **200** Canceled standing instruction. Media type: `application/json`. Schema: `CancelPaymentInstructionsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Request savings account statement `POST /SavingsAccount/{accountId}/Statement/Request` Requests savings account statement. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `OrderStatementsRequest`. #### Responses * **201** Requested savings account statement. Media type: `application/json`. Schema: `OrderStatementsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Order checkbook for savings account `POST /SavingsAccount/{accountId}/IssuedDevice/Initiate` Orders checkbook for savings account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `IssuedDeviceRequest`. #### Responses * **201** Ordered checkbook for savings account. Media type: `application/json`. Schema: `IssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Stop check of savings account `PUT /SavingsAccount/{accountId}/IssuedDevice/Update` Stops checks of savings account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `UpdateIssuedDeviceRequest`. #### Responses * **200** Stopped check of savings account. Media type: `application/json`. Schema: `UpdateIssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PUT Replace cards for credit card `PUT /CreditCard/IssuedDevice/Request` Replaces cards for credit card. #### Parameters * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `ReplaceIssuedDeviceRequest`. #### Responses * **200** Replace cards for credit card. Media type: `application/json`. Schema: `ReplaceIssuedDeviceResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve credit card account balance `GET /CreditCard/{creditCardId}` Retrieves the account balance of credit card account. #### Parameters * `creditCardId` (path, string, required) Specifies the unique ID of the credit card. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved credit card account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `CreditCard`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: MinimumPayment BalanceAmount: 234 - BalanceType: Balance BalanceAmount: 78 - BalanceType: AvailableCredit BalanceAmount: 9000 - BalanceType: TotalCreditLimit BalanceAmount: 10000 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of credit card account `PATCH /CreditCard/{creditCardId}` Updates the address of credit card account. #### Parameters * `creditCardId` (path, string, required) Specifies the unique ID of the credit card. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of credit card account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Reverse fee on credit card account `POST /CreditCard/{creditCardId}/ReverseFee` Reverses the fee that's applied on a customer's credit card account. #### Parameters * `creditCardId` (path, string, required) Specifies the unique ID of the credit card. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `object`. * `request` (_object_, required) * `FeeReversalTransactions` (_array of object_, required) Specifies the list of transactions that the customer has requested to reverse. * `ReversalAmount` (_number_, required) Specifies the amount that's approved for the reversal. Example: `50.00`. * `ReversalAmountCurrency` (_string_, required) Specifies the currency of the amount to be reversed. Example: `USD`. * `ReversalReason` (_string_, required) Specifies the reason for requesting the reversal. Example: `Reversal requested by the VIP customer.`. * `OriginalTransaction` (_object_, required) Specifies the details of the original transaction. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_, required) Specifies additional attributes that must be sent in the request. #### Responses * **200** Reversed fee on credit card account. Media type: `application/json`. Schema: `object`. * `FeeReversalTransactionResponse` (_array of object_, required) * `OriginalTransactionId` (_string_, required) Example: `someTransactionId`. * `FeeReversalErrorDetail` (_object_) Response object for an error. * `ErrorCode` (_string_) Example: `E-002`. * `ErrorMessage` (_string_, required) Example: `Specifies the error while retrieving the account information.`. * `MaintenanceResponse` (_object_) * `timestamp` (_datetime (rfc3339)_) Example: `2022-02-28T16:41:41.090Z`. * `FeeReversalTransaction` (_object_) Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve credit card account transactions `GET /CreditCard/{creditCardId}/transactions` Retrieves an credit card account to get its transactions. #### Parameters * `creditCardId` (path, string, required) Specifies the unique ID of the credit card. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved credit card account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `CreditCard`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Loan account balance `GET /Loan/{loanId}` Retrieves the account balance of Loan account. #### Parameters * `loanId` (path, string, required) Specifies the ID of a loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Loan account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `Loan`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: PrincipalBalance BalanceAmount: 1007 - BalanceType: Balance BalanceAmount: 787 - BalanceType: MinimumPayment BalanceAmount: 95 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of Loan account `PATCH /Loan/{loanId}` Updates the address of Loan account. #### Parameters * `loanId` (path, string, required) Specifies the ID of a loan account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of Loan account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Loan payoff details `GET /Loan/{loanId}/Payoff/Details` Retrieves Loan payoff details. #### Parameters * `loanId` (path, string, required) Specifies the ID of a loan account. Example: `01axx000003MLytAAG`. * `payoffDate` (query, string, required) Specifies the date until which the amounts due for pay off must be calculated. Example: `06/08/2025`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Loan payoff details. Media type: `application/json`. Schema: `LoanPayoffResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Loan account transactions `GET /Loan/{loanId}/transactions` Retrieves an Loan account to get its transactions. #### Parameters * `loanId` (path, string, required) Specifies the ID of a loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Loan account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `Loan`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Request Loan account statement `POST /Loan/{loanId}/Statement/Request` Requests Loan account statement. #### Parameters * `loanId` (path, string, required) Specifies the ID of a loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `OrderStatementsRequest`. #### Responses * **201** Requested Loan account statement. Media type: `application/json`. Schema: `OrderStatementsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Auto loan account balance `GET /AutoLoan/{autoLoanId}` Retrieves the account balance of Auto loan account. #### Parameters * `autoLoanId` (path, string, required) Specifies the ID of an auto loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Auto loan account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `AutoLoan`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: PrincipalBalance BalanceAmount: 3312 - BalanceType: Balance BalanceAmount: 321 - BalanceType: MinimumPayment BalanceAmount: 123 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of Auto loan account `PATCH /AutoLoan/{autoLoanId}` Updates the address of Auto loan account. #### Parameters * `autoLoanId` (path, string, required) Specifies the ID of an auto loan account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of Auto loan account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve AutoLoan payoff details `GET /AutoLoan/{autoLoanId}/Payoff/Details` Retrieves AutoLoan payoff details. #### Parameters * `autoLoanId` (path, string, required) Specifies the ID of an auto loan account. Example: `01axx000003MLytAAG`. * `payoffDate` (query, string, required) Specifies the date until which the amounts due for pay off must be calculated. Example: `06/08/2025`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved AutoLoan payoff details. Media type: `application/json`. Schema: `LoanPayoffResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Auto loan account transactions `GET /AutoLoan/{autoLoanId}/transactions` Retrieves an Auto loan account to get its transactions. #### Parameters * `autoLoanId` (path, string, required) Specifies the ID of an auto loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Auto loan account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `AutoLoan`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Request auto loan account statement `POST /AutoLoan/{autoLoanId}/Statement/Request` Requests auto loan account statement. #### Parameters * `autoLoanId` (path, string, required) Specifies the ID of an auto loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `OrderStatementsRequest`. #### Responses * **201** Requested auto loan account statement. Media type: `application/json`. Schema: `OrderStatementsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Mortgage account balance `GET /Mortgage/{mortgageLoanId}` Retrieves the account balance of Mortgage account. #### Parameters * `mortgageLoanId` (path, string, required) Specifies the ID of a mortgage account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Mortgage account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `Mortgage`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: PrincipalBalance BalanceAmount: 1007 - BalanceType: Balance BalanceAmount: 787 - BalanceType: MinimumPayment BalanceAmount: 95 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of Mortgage account `PATCH /Mortgage/{mortgageLoanId}` Updates the address of Mortgage account. #### Parameters * `mortgageLoanId` (path, string, required) Specifies the ID of a mortgage account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of Mortgage account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Mortgage payoff details `GET /Mortgage/{mortgageLoanId}/Payoff/Details` Retrieves Mortgage payoff details. #### Parameters * `mortgageLoanId` (path, string, required) Specifies the ID of a mortgage account. Example: `01axx000003MLytAAG`. * `payoffDate` (query, string, required) Specifies the date until which the amounts due for pay off must be calculated. Example: `06/08/2025`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Mortgage payoff details. Media type: `application/json`. Schema: `LoanPayoffResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve Mortgage account transactions `GET /Mortgage/{mortgageLoanId}/transactions` Retrieves an Mortgage account to get its transactions. #### Parameters * `mortgageLoanId` (path, string, required) Specifies the ID of a mortgage account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved Mortgage account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `Mortgage`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Request Mortgage account statement `POST /Mortgage/{mortgageLoanId}/Statement/Request` Requests Mortgage account statement. #### Parameters * `mortgageLoanId` (path, string, required) Specifies the ID of a mortgage account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `OrderStatementsRequest`. #### Responses * **201** Requested Mortgage account statement. Media type: `application/json`. Schema: `OrderStatementsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve home equity loan account balance `GET /HomeEquityLoan/{accountId}` Retrieves the account balance of home equity loan account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved home equity loan account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `HomeEquityLoan`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: MinimumPayment BalanceAmount: 225 - BalanceType: Balance BalanceAmount: 783 - BalanceType: AvailableCredit BalanceAmount: 7000 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of home equity loan account `PATCH /HomeEquityLoan/{accountId}` Updates the address of home equity loan account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of home equity loan account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve home equity loan account transactions `GET /HomeEquityLoan/{accountId}/transactions` Retrieves an home equity loan account to get its transactions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved home equity loan account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `HomeEquityLoan`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Add standing instruction `POST /HomeEquityLoan/{accountId}/Payments/Initiate` Adds standing instructions / Transfers money between customer's own accounts. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `PaymentInstrcutionsRequest`. #### Responses * **201** Added Standing Instruction / Transfered money between customer's own accounts. Media type: `application/json`. Schema: `PaymentInstrcutionsResponse`. Specifies the payment instructions request. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve investment account balance `GET /InvestmentAccount/{accountId}` Retrieves the account balance of investment account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved investment account balance. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_, required) Example: `InvestmentAccount`. * `Balances` (_array of object_, required) Each item: Balance object for an account. _Example_ ``` - BalanceType: CashBalance BalanceAmount: 544 - BalanceType: Balance BalanceAmount: 777 - BalanceType: BalanceLastStatement BalanceAmount: 2000 ``` * `BalanceType` (_string_, required) Example: `AvailableBalance`. * `BalanceAmount` (_number_, required) Example: `5000`. * `AdditionalAttributes` (_object_) * `PaymentDueDate` (_string_, required) Example: `2025-06-08`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the address of investment account `PATCH /InvestmentAccount/{accountId}` Updates the address of investment account. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. #### Request body Media type: `application/json`. Schema: `AddressUpdateRequest`. #### Responses * **200** Updated the address of investment account Media type: `application/json`. Schema: `SuccessResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve investment account transactions `GET /InvestmentAccount/{accountId}/transactions` Retrieves an investment account to get its transactions. #### Parameters * `accountId` (path, string, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `startDate` (query, string) Returns the transactions that occurred on or after the start date. * `endDate` (query, string) Returns the transactions that occurred on or before the end date. * `minAmount` (query, number) Returns the transactions having an amount that's higher than the minimum transaction amount. * `maxAmount` (query, number) Returns the transactions having an amount that's lower than the maximum transaction amount. * `description` (query, string) Returns the transactions having a description that contains the provided string. * `transactionType` (query, string) Returns the transactions where the transaction type matches the transactionType parameter. * `offset` (query, number) Specifies the number of transactions to be skipped before returning the first transaction. Default: `0`. * `limit` (query, number) Specifies the maximum number of records to return. Default: `10`. * `sortBy` (query, string) Specifies the fields that can be used to sort the records. Default: `TransactionId`. * `fields` (query, string) Specifies the fields to be returned in the response. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved investment account transactions. Media type: `application/json`. Schema: `object`. Financial account info returned by the GET method. * `AccountId` (_string_) Example: `01axx000003MLytAAG`. * `AccountName` (_string_) Example: `Salesforce.com`. * `AccountCurrency` (_string_, required) Example: `USD`. * `AccountType` (_string_) Example: `InvestmentAccount`. * `Transactions` (_array of object_, required) Each item: Specifies a transaction object for an account. * `TransactionId` (_string_, required) Example: `123456`. * `TransactionType` (_string_) Example: `Fee`. * `TransactionDescription` (_string_) Example: `Annual Credit Card Fee`. * `TransactionAmount` (_number_, required) Example: `5000`. * `TransactionPostedDate` (_string_, required) Example: `2000-01-01`. * `TransactionAmountCurrency` (_string_, required) Specifies the currency of the original transaction amount. Example: `USD`. * `TransactionCode` (_string_) * `AdditionalAttributes` (_object_) _Example_ ``` "Subtype": Overdraft Fee ``` * `AdditionalAttributes` (_object_) * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Update the customer details `PATCH /customers/{customerId}` Updates the customer details. #### Parameters * `customerId` (path, string, required) Specifies the customer ID. Example: `CID776623`. #### Request body Media type: `application/json`. Schema: `CustomersRequest`. #### Responses * **200** Updated the customer details. Media type: `application/json`. Schema: `CustomersResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Create travel Notification `POST /customers/{customerId}/travel-notifications` Creates a travel notification. #### Parameters * `customerId` (path, string, required) Specifies the customer ID. Example: `CID776623`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `TravelNotificationsRequest (extended)`. Includes all fields of `TravelNotificationsRequest`. * `CommunicationPreferences` (_object_, required) Requires email, phone, mobile, or alternate phone details. * `Email` (_string | any_) Specifies the email address of the customer as a communication preference while traveling. _Example_ ``` bob@gmail.com ``` One of: `string`, `any`. _Example_ ``` bob@gmail.com ``` * `Phone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `Mobile` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `AlternatePhone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `Cards` (_array of object_, required) Specifies the list of cards. Minimum items: 1. * `Id` (_string_, required) Specifies the unique card ID. Example: `46451`. * `Type` (_string | any_) Specifies the type of card, such as debit. _Example_ ``` Debit ``` One of: `string`, `any`. _Example_ ``` Debit ``` * `Name` (_string_, required) Specifies the name of card. Example: `New Master Card`. * `Role` (_string | any_) Specifies the role. _Example_ ``` Primary Owner ``` One of: `string`, `any`. _Example_ ``` Primary Owner ``` * `ExpiryDate` (_string_, required) Specifies the expiry date of the card. Example: `05/2024`. #### Responses * **201** Created travel notification. Media type: `application/json`. Schema: `TravelNotificationsResponse (extended)`. Includes all fields of `TravelNotificationsResponse`. * `Cards` (_array of object_, required) Specifies the list of cards. Minimum items: 1. * `Id` (_string_, required) Specifies the unique card ID. Example: `46451`. * `Type` (_string | any_) Specifies the type of card, such as debit. _Example_ ``` Debit ``` One of: `string`, `any`. _Example_ ``` Debit ``` * `Name` (_string_, required) Specifies the name of card. Example: `New Master Card`. * `Role` (_string | any_) Specifies the role. _Example_ ``` Primary Owner ``` One of: `string`, `any`. _Example_ ``` Primary Owner ``` * `ExpiryDate` (_string_, required) Specifies the expiry date of the card. Example: `05/2024`. * `CommunicationPreferences` (_object_, required) Requires email, phone, mobile, or alternate phone details. * `Email` (_string | any_) Specifies the email address of the customer as a communication preference while traveling. _Example_ ``` bob@gmail.com ``` One of: `string`, `any`. _Example_ ``` bob@gmail.com ``` * `Phone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `Mobile` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `AlternatePhone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve account restraints `GET /customers/{customerId}/account-restraints` Retrieves account restraints for a customer. #### Parameters * `customerId` (path, string, required) Specifies the customer ID. Example: `CID776623`. * `accountId` (query, string) Filter restraints by specific account ID. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved account restraints for the customer. Media type: `application/json`. Schema: `AccountRestraintsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve customer cards `GET /IssuedDeviceAdministration/Retrieve` Retrieves customer card information. #### Parameters * `CustomerReference` (query, string, required) Customer ID to retrieve cards for. Example: `CID776623`. * `IssuedDeviceType` (query, string, required) Type of issued device. This is always "Card" for this endpoint. Allowed values: `Card`. Example: `Card`. * `requestId` (query, string) Specifies unique trackingId of the request Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies unique flowRefId from source system of the request Example: `006E0077774TquXIAS`. #### Responses * **200** Retrieved customer card information. Media type: `application/json`. Schema: `RetrieveCustomerCardsResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** Found no valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as PUT /CurrentAccount/IssuedDevice/Request 415 response._ * **429** Exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeded rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ## Schemas ### ReplaceIssuedDeviceRequest Issued Device Replace Request. * `IssuedDevice` (_object_, required) Handles the issuance and tracking of issued devices or inventory, such as checkbooks and pay-in slips associated with the account. * `IssuedInventoryType` (_string_, required) A property of the issued device or inventory, such as card, checkbook, and pay-in slip. Example: `debit card`. * `IssuedInventoryDescription` (_string_, required) Definition of the inventory item, including processing and handling guidelines and rules. Example: `replace debit card`. * `IssuedInventoryStatus` (_string_, required) The tracked status of the device or inventory item, such as active, suspended, and cancelled. Example: `REPLACE`. * `IssuedInventoryOptionDefinition` (_object_, required) Definition of the processing option and impact. Includes all fields of `ReplaceCards`. ### ReplaceIssuedDeviceResponse * `Accounts` (_array of object_, required) Specifies accounts details. * `AccountId` (_string_, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `Cards` (_array of object_, required) Specifies the list of cards. * `CardId` (_string_, required) Specifies the unique ID of the card. Example: `3489`. * `Status` (_string_, required) Specifies the status of the card, such as Reissued or Blocked. Example: `Reissued`. ### ErrorResponse Represents a standard message body to be returned with the error responses. * `errorCode` (_string_, required) Specifies the short code to identify the error. Example: `INVALID_PARAMETER`. * `errorMessage` (_string_, required) Specifies the verbose human-readable error message. Example: `The value you entered is out of bounds`. * `transactionId` (_string_, required) Specifies the request identifier. Example: `dd960082-abbf-47c2-8c65-f18eeb35848b`. * `timeStamp` (_datetime_, required) Specifies the event date time. Example: `2019-09-23T11:46:44.256-05:00`. ### AddressUpdateRequest * `request` (_object_, required) * `requestId` (_string_, required) Example: `006E0000004TquXIAS`. * `addresses` (_array of object_, required) * `addressType` (_string_, required) Specifies the type of address, such as home. Example: `Mailing Address`. * `addressLine1` (_string_, required) Specifes the address line 1 of the customer address. Example: `415 Mission St`. * `addressLine2` (_string_) Specifes the address line 2 of the customer address. Example: `Floor 61`. * `city` (_string_, required) Specifes the city name of the customer address. Example: `San Francisco`. * `state` (_string_, required) Specifes the state of the customer address. Example: `CA`. * `postalCode` (_string_, required) Specifes the postal code of the customer address. Example: `94105`. * `countryCode` (_string_, required) Specifes the country of the customer address. Example: `USA`. ### SuccessResponse * `maintenanceResponse` (_object_) * `timestamp` (_datetime (rfc3339)_) Example: `2022-02-28T16:41:41.090Z`. ### BeneficiariesRequest * `Beneficiaries` (_array of Adult | Minor_, required) ### BeneficiariesResponse * `Beneficiaries` (_array of AdultResponse | MinorResponse_, required) ### DeleteBeneficiariesRequest * `Beneficiaries` (_array of object_, required) * `BeneficiaryId` (_string_, required) Specifies the unique code to identify a beneficiary. Example: `BFR-6065225`. * `BeneficiaryName` (_string_) Name of a beneficiary. Example: `Gabriel Basso`. ### DeleteBeneficiariesResponse * `Beneficiaries` (_array of object_, required) * `BeneficiaryId` (_string_, required) Specifies the unique code to identify a beneficiary. Example: `BFR-6065225`. * `Status` (_string_, required) Specifies the status of beneficiary. Example: `DELETED`. ### GetPaymentInstructionsResponse * `PaymentOrders` (_array of PaymentInstrcutionsResponseType_, required) ### PaymentInstrcutionsRequest Specifies the payment instructions request. * `Payments` (_object_, required) * `PaymentType` (_string_, required) Specifies the type of payment transaction, such as customer payment, standing order, direct debit, and bill pay. Example: `standing order`. * `PaymentDefinition` (_AutoPay | PaymentAmount_, required) One of: `AutoPay`, `PaymentAmount`. * `PaymentSchedule` (_object_, required) * `PaymentStartDate` (_string_, required) Specifies the start date (transfer date) of the payment. The accepted format is MM/dd/yyyy. Example: `10/25/2023`. * `PaymentEndDate` (_string_) Specifies the end date of the payment. The accepted format is MM/dd/yyyy. Example: `10/25/2024`. * `PaymentFrequency` (_string_) Specifies the frequency of the payment, which is the calendar period, such as DAILY, MONTHLY, HALF-YEARLY, or YEARLY. Example: `MONTHLY`. * `NumberOfPayments` (_string_) Specifies the number of payments to be made. The NumberOfPayments property can't be used when the endDate property is specified. Example: `12`. * `PaymentMechanism` (_string_) Specifies the type of payment, such as one-time or recurring. Example: `recurring`. * `PaymentPurpose` (_string_) Specifies the purpose of the standing order. Example: `Standing instruction for phone bill 1000 USD`. * `PayeeReference` (_object_) * `PayeeName` (_string_, required) Specifies the beneficiary account holder's name. Example: `Amazon`. * `PayeeBankReference` (_object_) * `RoutingNumber` (_string_, required) Specifies the routing number of the bank. Example: `2000123008`. * `PayeeAccountReference` (_object_, required) * `PayeeAccountNumber` (_string_, required) Specifies the beneficiary account identifier. Example: `AMZ10012`. * `PayeeAccountType` (_string_) Specifies the account type. Example: `savings`. ### PaymentInstrcutionsResponse Includes all fields of `PaymentInstrcutionsRequestType`. * `PaymentId` (_string_, required) Specifies the unique identifier of the payment. An update to a payment uses this key to identify the payment. Example: `SOT00010000`. * `CreationDateTime` (_string_, required) Specifies the date and time when the payment order was created. Example: `2023-06-27T11:56:59.001502Z`. ### UpdatePaymentInstructionsResponse Includes all fields of `PaymentInstrcutionsRequestType`. * `PaymentId` (_string_, required) Specifies the unique identifier of the payment order. An update to a payment order uses this key to identify the standing order. Example: `SOT00010000`. * `UpdateDateTime` (_string_, required) Specifies the date and time when the payment order was updated. Example: `2023-06-27T11:56:59.001502Z`. ### CancelPaymentInstructionsRequest * `PaymentCancelPurpose` (_string_) Specifies the purpose of cancelling the payment order. Example: `Cancel Standing instruction for phone bill 1000 USD`. ### CancelPaymentInstructionsResponse * `PaymentId` (_string_, required) Specifies the unique identifier of the payment order. An update to the payment order uses this key to identify the standing order. Example: `SOT00010000`. * `CancelDateTime` (_string_, required) Specifies the date and time when the payment order was cancelled. Example: `2023-06-27T11:56:59.001502Z`. ### OrderStatementsRequest * `Statement` (_Both | ByEmail | ByPost_, required) One of: `Both`, `ByEmail`, `ByPost`. ### OrderStatementsResponse Includes all fields of `StatementsRequestType`. * `Status` (_string_, required) Specifies the status of the statements request. Example: `ORDERED`. ### IssuedDeviceRequest Issued Device Request. * `IssuedDevice` (_object_, required) Handles the issuance and tracking of issued devices or inventory, such as checkbooks and pay-in slips associated with the account. * `IssuedInventoryType` (_string_, required) A property of the issued device or inventory, such as card, checkbook, and pay-in slip. Example: `checkbook`. * `IssuedInventoryDescription` (_string_, required) Definition of the inventory item, including processing and handling guidelines and rules. Example: `order checkbook`. * `IssuedInventoryOptionDefinition` (_object_, required) Definition of the processing option and impact. Includes all fields of `OrderCheckbook`. ### IssuedDeviceResponse Issued Device Response. * `IssuedDevice` (_object_, required) Handles the issuance and tracking of issued devices or inventory, such as checkbooks and pay-in slips associated with the account. * `IssuedInventoryType` (_string_, required) A property of the issued device or inventory, such as card, checkbook, and pay-in slip. Example: `checkbook`. * `IssuedInventoryDescription` (_string_, required) Definition of the inventory item, including processing and handling guidelines and rules. Example: `order checkbook`. * `IssuedInventoryOptionDefinition` (_object_, required) Definition of the processing option and impact. Includes all fields of `OrderCheckbook`. * `IssuedInventoryStatus` (_string_, required) The tracked status of the device or inventory item, such as active, suspended, and cancelled. Example: `INPROGRESS`. ### UpdateIssuedDeviceRequest Issued Device Update Request. * `IssuedDevice` (_object_, required) Handles the issuance and tracking of issued devices or inventory, such as checkbooks and pay-in slips associated with the account. * `IssuedInventoryType` (_string_, required) A property of the issued device or inventory, such as card, checkbook, and pay-in slip. Example: `check`. * `IssuedInventoryDescription` (_string_, required) Definition of the inventory item, including processing and handling guidelines and rules. Example: `stop check`. * `IssuedInventoryStatus` (_string_, required) The tracked status of the device or inventory item, such as active, suspended, and cancelled. Example: `STOP`. * `IssuedInventoryOptionDefinition` (_object_, required) Definition of the processing option and impact. Includes all fields of `StopChecks`. ### UpdateIssuedDeviceResponse Issued Device Update Response. * `IssuedDevice` (_object_, required) Handles the issuance and tracking of issued devices or inventory, such as checkbooks and pay-in slips associated with the account. * `IssuedInventoryType` (_string_, required) A property of the issued device or inventory, such as card, checkbook, and pay-in slip. Example: `check`. * `IssuedInventoryDescription` (_string_, required) Definition of the inventory item, including processing and handling guidelines and rules. Example: `stop check`. * `IssuedInventoryOptionDefinition` (_object_, required) Definition of the processing option and impact. Includes all fields of `StopChecks`. * `IssuedInventoryStatus` (_string_, required) The tracked status of the device or inventory item, such as active, suspended, and cancelled. Example: `STOPPED`. ### LoanPayoffResponse * `FeeBalance` (_string_, required) Specifies the fee balance due when the pay off of the account is in a future date. Example: `10`. * `InterestBalance` (_string_, required) Specifies the interest balance due when the pay off of the account is in a future date. Example: `100`. * `PenaltyBalance` (_string_, required) Specifies the penalty balance due when the pay off of the account is in a future date. Example: `50`. * `PrincipalBalance` (_string_, required) Specifies the principal balance due when the pay off of the account is in a future date. Example: `1000`. * `TotalBalance` (_string_, required) Specifies the total balance due when the pay off of the account is in a future date. Example: `1160`. * `Currency` (_string_, required) Specifies the currency. Example: `USD`. ### CustomersRequest * `request` (_object_, required) * `requestId` (_string_, required) Example: `006E0000004TquXIAS`. * `flowRefId` (_string_) Specifies the unique flowRefId from the source system of the request. Example: `006E0077774TquXIAS`. * `contactInformation` (_object_, required) * `addresses` (_array of object_) * `addressType` (_string_, required) Specifies the type of address, such as home. Example: `Mailing Address`. * `addressLine1` (_string_, required) Specifes the address line 1 of the customer address. Example: `415 Mission St`. * `addressLine2` (_string_) Specifes the address line 2 of the customer address. Example: `Floor 61`. * `city` (_string_, required) Specifes the city name of the customer address. Example: `San Francisco`. * `state` (_string_, required) Specifes the state of the customer address. Example: `CA`. * `postalCode` (_string_, required) Specifes the postal code of the customer address. Example: `94105`. * `countryCode` (_string_, required) Specifes the country of the customer address. Example: `USA`. * `phone` (_string_) Specifies the phone number. Example: `+919876543210`. * `mobile` (_string_) Specifies the mobile number. Example: `+919876543210`. * `email` (_string_) Specifies the email address. Example: `bob.martin@salesforce.com`. ### CustomersResponse * `Status` (_string_, required) Specifies the status of the request. Example: `INPROGRESS`. ### TravelNotificationsRequest * `TravelDetail` (_object_, required) Requires the usDestinations or internationalDestinations property along with the departureDate and returnDate properties. Includes all fields of `TravelDetails`. * `CommunicationPreferences` (_object_, required) Includes all fields of `CommunicationPreferences`. * `Cards` (_Cards_, required) ### TravelNotificationsResponse Includes all fields of `TravelType`. * `CustomerId` (_string_, required) Specifies the unique ID of the customer. Example: `CID-12345`. ### AccountRestraintsResponse * `customerId` (_string_, required) Unique identifier of the customer. Example: `CUST123456`. * `accountRestraints` (_array of AccountRestraintType_, required) List of account restraints for the customer. ### RetrieveCustomerCardsResponse Response for retrieving customer cards. * `accountId` (_string_, required) Customer account ID. Example: `CUST123456`. * `financialCards` (_array of FinancialCardType_, required) List of financial cards for the customer. ### ReplaceCards One of: `BlockCards`, `ReissueCards`. ### Adult Add Beneficiaries * `IsMinor` (_string_, required) Is beneficiary minor ?. Example: `No`. * `RelationshipType` (_string_, required) Specifies relationship with account holder. Example: `Son`. ### Minor Add Beneficiaries * `IsMinor` (_string_, required) Indicates if the beneficiary is minor. Example: `Yes`. * `GuardianDetails` (_object_, required) * `Name` (_string_, required) Specifies the name of the guardian. Example: `Luciane Buchanan`. * `MobileNumber` (_string_, required) Specifies the mobile number of the guardian. Example: `9876541235`. * `RelationshipType` (_string_, required) Specifies relationship with the beneficiary. Example: `Father`. * `SSN` (_string_) Specifies the social security number. Example: `569-94-7726`. * `Address` (_object_) * `AddressType` (_string_) Specifies the type of address, such as home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) Specifies the address line 1 of the customer address. Example: `415 Mission St`. * `AddressLine2` (_string_) Specifies the address line 2 of the customer address. Example: `Floor 61`. * `City` (_string_, required) Specifies the city name of the customer address. Example: `San Francisco`. * `State` (_string_, required) Specifies the state of the customer address. Example: `CA`. * `PostalCode` (_string_, required) Specifies the postal code of the customer address. Example: `94105`. * `CountryCode` (_string_, required) Specifies the country of the customer address. Example: `USA`. ### AdultResponse Includes all fields of `Adult`. * `BeneficiaryId` (_string_, required) Specifies the unique code to identify a beneficiary. Example: `BFR-6065225`. ### MinorResponse Includes all fields of `Minor`. * `BeneficiaryId` (_string_, required) Specifies the unique code to identify a beneficiary. Example: `BFR-6065225`. ### PaymentInstrcutionsResponseType Includes all fields of `PaymentInstrcutionsRequestType`. * `PaymentId` (_string_, required) Specifies the unique identifier of the payment. An update to a payment uses this key to identify the payment. Example: `SOT00010000`. * `CreationDateTime` (_string_, required) Specifies the date and time when the payment order was created. Example: `2023-06-27T11:56:59.001502Z`. ### AutoPay * `AutoPay` (_object_, required) * `AutoPayAmount` (_string_, required) Specifies the autopay type (Pay Total Due, Pay Minimum Due). Example: `Pay Total Due`. ### PaymentAmount * `PaymentAmount` (_object_, required) * `Amount` (_string_, required) Specifies the payment amount. Example: `1000`. * `Currency` (_string_, required) Specifies the ISO 4217 - currency code, which is the identifier of the currency. Example: `USD`. ### PaymentInstrcutionsRequestType Specifies the payment instructions request. * `Payments` (_object_, required) * `PaymentType` (_string_, required) Specifies the type of payment transaction, such as customer payment, standing order, direct debit, and bill pay. Example: `standing order`. * `PaymentDefinition` (_AutoPay | PaymentAmount_, required) One of: `AutoPay`, `PaymentAmount`. * `PaymentSchedule` (_object_, required) * `PaymentStartDate` (_string_, required) Specifies the start date (transfer date) of the payment. The accepted format is MM/dd/yyyy. Example: `10/25/2023`. * `PaymentEndDate` (_string_) Specifies the end date of the payment. The accepted format is MM/dd/yyyy. Example: `10/25/2024`. * `PaymentFrequency` (_string_) Specifies the frequency of the payment, which is the calendar period, such as DAILY, MONTHLY, HALF-YEARLY, or YEARLY. Example: `MONTHLY`. * `NumberOfPayments` (_string_) Specifies the number of payments to be made. The NumberOfPayments property can't be used when the endDate property is specified. Example: `12`. * `PaymentMechanism` (_string_) Specifies the type of payment, such as one-time or recurring. Example: `recurring`. * `PaymentPurpose` (_string_) Specifies the purpose of the standing order. Example: `Standing instruction for phone bill 1000 USD`. * `PayeeReference` (_object_) * `PayeeName` (_string_, required) Specifies the beneficiary account holder's name. Example: `Amazon`. * `PayeeBankReference` (_object_) * `RoutingNumber` (_string_, required) Specifies the routing number of the bank. Example: `2000123008`. * `PayeeAccountReference` (_object_, required) * `PayeeAccountNumber` (_string_, required) Specifies the beneficiary account identifier. Example: `AMZ10012`. * `PayeeAccountType` (_string_) Specifies the account type. Example: `savings`. ### Both Specifies the details of the address and email address to send the statements. * `StartDate` (_string_, required) Specifies the start date for the order statements. Example: `2023-05-08`. * `EndDate` (_string_, required) Specifies the end date for the order statements. Example: `2023-06-08`. * `SendVia` (_object_, required) * `EmailId` (_string_, required) Specifies the email address to send the statements. Example: `bob@gmail.com`. * `ShippingPreference` (_string_, required) Specifies the shipment preference, such as standard. Example: `Standard`. * `ShippingAddress` (_object_, required) Specifies the shipping address to send the statements. * `AddressType` (_string_) Specifies the type of address, such as home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) Specifies the address line 1 of the customer address. Example: `415 Mission St`. * `AddressLine2` (_string_) Specifies the address line 2 of the customer address. Example: `Floor 61`. * `City` (_string_, required) Specifies the city name of the customer address. Example: `San Francisco`. * `State` (_string_, required) Specifies the state of the customer address. Example: `CA`. * `PostalCode` (_string_, required) Specifies the postal code of the customer address. Example: `94105`. * `CountryCode` (_string_, required) Specifies the country of the customer address. Example: `USA`. ### ByEmail Specifies details of the email address to send the statements. Requires the emailId property. * `StartDate` (_string_, required) Specifies the start date for the order statements. Example: `2023-05-08`. * `EndDate` (_string_, required) Specifies the end date for the order statements. Example: `2023-06-08`. * `SendVia` (_object_, required) * `EmailId` (_string_, required) Specifies the email address to send statements. Example: `bob@gmail.com`. ### ByPost Specifies details of the address to send the statements. * `StartDate` (_string_, required) Specifies the start date for the order statements. Example: `2023-05-08`. * `EndDate` (_string_, required) Specifies the end date for the order statements. Example: `2023-06-08`. * `SendVia` (_object_, required) * `ShippingPreference` (_string_, required) Specifies the shipment preference, such as standard. Example: `Standard`. * `ShippingAddress` (_object_, required) Specifies the shipping address to send the statements. * `AddressType` (_string_) Specifies the type of address, such as home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) Specifies the address line 1 of the customer address. Example: `415 Mission St`. * `AddressLine2` (_string_) Specifies the address line 2 of the customer address. Example: `Floor 61`. * `City` (_string_, required) Specifies the city name of the customer address. Example: `San Francisco`. * `State` (_string_, required) Specifies the state of the customer address. Example: `CA`. * `PostalCode` (_string_, required) Specifies the postal code of the customer address. Example: `94105`. * `CountryCode` (_string_, required) Specifies the country of the customer address. Example: `USA`. ### StatementsRequestType * `Statement` (_Both | ByEmail | ByPost_, required) One of: `Both`, `ByEmail`, `ByPost`. ### OrderCheckbook Checkbook Request. * `NumberOfLeaves` (_string_, required) Defines the size of the checkbook. Example: `50`. * `ShippingAddress` (_object_, required) Specifies the address where the checkbook is to be delivered. * `AddressType` (_string_) Specifies the type of address, such as home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) Specifies the address line 1 of the customer address. Example: `415 Mission St`. * `AddressLine2` (_string_) Specifies the address line 2 of the customer address. Example: `Floor 61`. * `City` (_string_, required) Specifies the city name of the customer address. Example: `San Francisco`. * `State` (_string_, required) Specifies the state of the customer address. Example: `CA`. * `PostalCode` (_string_, required) Specifies the postal code of the customer address. Example: `94105`. * `CountryCode` (_string_, required) Specifies the country of the customer address. Example: `USA`. * `ShippingPreference` (_string_, required) Specifies the shipment preference, such as standard. Example: `Standard`. ### StopChecks One of: `SingleCheck`, `MultipleChecks`. ### TravelDetails * `UsDestinations` (_array of string_) Specifies the state code. Minimum items: 1. _Example_ ``` - CA - AZ ``` * `InternationalDestinations` (_array of string_) Specifies the two-letter ISO 3166-1 (Alpha-2) country code. Minimum items: 1. _Example_ ``` - US ``` * `DepartureDate` (_string_, required) Specifies the start date \[MM/dd/yyyy\] for the travel notifications. Example: `05/08/2023`. * `ReturnDate` (_string_, required) Specifies the end date \[MM/dd/yyyy\] for the travel notifications. Example: `06/08/2023`. ### CommunicationPreferences Requires email, phone, mobile, or alternate phone details. * `Email` (_string | any_) Specifies the email address of the customer as a communication preference while traveling. _Example_ ``` bob@gmail.com ``` One of: `string`, `any`. _Example_ ``` bob@gmail.com ``` * `Phone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `Mobile` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. * `AlternatePhone` (_object_) Includes country code (optional) and phone number. * `CountryCode` (_string | any_) Specifies the country code. _Example_ ``` +91 ``` One of: `string`, `any`. _Example_ ``` +91 ``` * `PhoneNumber` (_string_, required) Specifies the phone number. Example: `9876541234`. ### Cards Specifies the list of cards. Array of `object`. Minimum items: 1. * `Id` (_string_, required) Specifies the unique card ID. Example: `46451`. * `Type` (_string | any_) Specifies the type of card, such as debit. _Example_ ``` Debit ``` One of: `string`, `any`. _Example_ ``` Debit ``` * `Name` (_string_, required) Specifies the name of card. Example: `New Master Card`. * `Role` (_string | any_) Specifies the role. _Example_ ``` Primary Owner ``` One of: `string`, `any`. _Example_ ``` Primary Owner ``` * `ExpiryDate` (_string_, required) Specifies the expiry date of the card. Example: `05/2024`. ### TravelType * `TravelDetail` (_object_, required) Requires the usDestinations or internationalDestinations property along with the departureDate and returnDate properties. Includes all fields of `TravelDetails`. * `CommunicationPreferences` (_object_, required) Includes all fields of `CommunicationPreferences`. * `Cards` (_Cards_, required) ### AccountRestraintType * `accountId` (_string_, required) Identifier of the financial account under restraint. Example: `ACCT10001`. * `accountType` (_string_, required) Type of financial account (for example, Checking, Savings) Example: `Checking`. * `restraintId` (_string_, required) Unique identifier of the restraint. Example: `RST111`. * `restraintType` (_string_, required) Type of restraint (for example, Freeze, LegalHold). Example: `Freeze`. * `status` (_string_, required) Status of the restraint (for example, Active, Closed). Example: `Active`. * `effectiveDate` (_date-only_, required) Restraint start date in ISO 8601 format. Example: `2025-06-01`. * `expiryDate` (_date-only_, required) Restraint end date in ISO 8601 format. Example: `2025-12-01`. * `reason` (_string_, required) Business or legal reason for restraint. Example: `Suspicious transaction flagged`. * `amountLimit` (_object_, required) Maximum allowed limit under the restraint. Includes all fields of `AmountLimitType`. * `initiatedBy` (_string_, required) Department or system that initiated the restraint. Example: `FraudOps`. ### FinancialCardType Represents a financial card for a customer * `Role` (_string_, required) Role of the card holder. Example: `Owner`. * `CardNumber` (_string_, required) Card number. Example: `9800`. * `Reissue` (_boolean_, required) Whether the card is a reissue. Example: `false`. * `CardName` (_string_, required) Full name on the card. Example: `Shubham Jain`. * `RecordTypeName` (_string_, required) Type of account record. Example: `Checking`. * `CardActive` (_boolean_, required) Whether the card is active. Example: `true`. * `CardType` (_string_, required) Type of the card. Example: `Debit Card`. * `CardNumberLast4` (_string_, required) Last 4 digits of the card number. Example: `9800`. * `CardValidDate` (_string_, required) Card expiration date. Example: `11/2031`. * `SourceSystemId` (_string_, required) Source system identifier. Example: `2133312`. * `IsLocked` (_boolean_, required) Lock/unlock status of the card. Example: `true`. ### BlockCards * `Accounts` (_array of object_, required) Specifies accounts details. Minimum items: 1. * `AccountId` (_string_, required) Specifies the account ID of the financial account. Example: `01axx000003MLytAAG`. * `Cards` (_array of object_, required) Specifies the list of cards. Minimum items: 1. * `CardId` (_string_, required) Specifies unique ID of the card. Example: `3489`. * `ToBeReissued` (_string_, required) Specifies Yes if the request is to reissue the card or to block the card. Example: `Yes`. * `Reason` (_string_, required) Specifies the reason to reissue the card. Example: `Damaged`. * `Remarks` (_string_) Specifies remarks, if any. Example: `Damaged`. ### ReissueCards Includes all fields of `BlockCards`. * `ShippingPreference` (_string_, required) Specifies the shipment preference, such as standard. Example: `Standard`. * `ShippingAddress` (_object_, required) Specifies the address to deliver the card to. * `AddressType` (_string_) Specifies the type of address, such as home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) Specifies the address line 1 of the customer address. Example: `415 Mission St`. * `AddressLine2` (_string_) Specifies the address line 2 of the customer address. Example: `Floor 61`. * `City` (_string_, required) Specifies the city name of the customer address. Example: `San Francisco`. * `State` (_string_, required) Specifies the state of the customer address. Example: `CA`. * `PostalCode` (_string_, required) Specifies the postal code of the customer address. Example: `94105`. * `CountryCode` (_string_, required) Specifies the country of the customer address. Example: `USA`. ### SingleCheck Request to stop a single check payment. * `CheckNumber` (_string_, required) Specifies the check number. Example: `00124509`. * `CheckDate` (_string_) Specifies the check date \[MM/dd/yyyy\]. Example: `06/08/2025`. * `Amount` (_string_) Specifies the amount. Example: `23000`. * `Payee` (_string_) Specifies the payee name. Example: `Josephine Arrington`. * `Reason` (_string_, required) Specifies the reason to stop the check. Example: `checkbook stolen`. ### MultipleChecks Request to stop multiple check payments. * `LowestCheckNumber` (_string_, required) Specifies the lowest check number. Example: `00124509`. * `HighestCheckNumber` (_string_, required) Specifies the highest check number. Example: `00124522`. * `Reason` (_string_, required) Specifies the reason to stop the checks. Example: `checkbook stolen`. ### AmountLimitType * `currency` (_string_, required) ISO currency code (for example, USD, INR). Example: `USD`. * `amount` (_number_, required) Numeric amount of the account limit. Example: `10000.00`.