Account Notification

Account Notification Subscription Request

Changed on Nov 6, 2026

Using this endpoint you can create, modify, or delete a subscription request and set parameters such as frequency and number of notifications.

post/v1/crdr/subscription

Request

Base URL
https://tts.apib2b.citi.com/citiconnect/prod/accountstatementservices
Auth
OAuth 2
Client credentials
Token URL/authenticationservices/v3/oauth/token
TypeScript
https://skmtc.dev/citi/apis/account-notifications/docs/v1/crdr/subscription/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

client_idstring required

Your unique client identifier, assigned as part of your onboarding with your Citi representative.

Headers

Content-Typestring required

Supports "application/xml" and "application/json".

Authorizationstring required

The OAuth Token prefixed with "Bearer" and space in between.

Request body

requestType'CREATE' | 'MODIFY' | 'DELETE' required

Specifies the action to perform on the specified subscription. You can create, modify, or delete subscriptions, based on the request type.

format'XML' | 'JSON' required

Specifies the format to use for notifications - XML or JSON.

creditDebitIndicator'DBIT' | 'CRDT' | 'BOTH' required

The type of transaction for which you want notifications:

Credit
Debit
Both

accountIdentificationstring required

The account number associated with the subscription.

branchIdentificationstring required

Citi branch ID associated with the account.

fromAmountstring

The minimum amount of a transaction to trigger a notification. Notifications will not be sent for transaction amounts below this threshold.

toAmountstring

The maximium amount of a transaction to trigger a notification. Notifications will not be sent for transaction amounts above this limit.

Example request

{
  "requestType": "CREATE",
  "format": "JSON",
  "creditDebitIndicator": "BOTH",
  "accountIdentification": "1730173616",
  "branchIdentification": "713",
  "fromAmount": "0",
  "toAmount": "99999999999"
}

Response

OK.

Infostring

Information for your request

Example response

{
  "Info": "Request successfully submitted; please wait for the final confirmation"
}

Changes

Nov 6, 202679414b28970e Revision changes
- breaking
  the request's body type changed from object to no type (media type: application/json)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/xml)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/xml)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/xml)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/xml)
- breaking
  the request property became required (media type: application/json)
- breaking
  the request property became required (media type: application/xml)
- info
  api operation id Account notification subscription request removed and replaced with AccountNotificationSubscriptionRequest
- info
  the endpoint scheme security clientCredentials was added to the API
- info
  the endpoint scheme security Client Credentials was removed from the API
- info
  api tag Account Notification added
- info
  the request's body type was generalized from object to no type (media type: application/xml)
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the media type application/xml for the response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)

Operation history