Citi API

Notifications

notifications

Methods

Credit Debit Notifications ->
Subscription
post/v1/crdr/subscription

CitiConnect Credit Debit Notification Subscription allows users to receive PUSH notifications for debit and credit transactions, allowing for real-time data and instant reconciliation.
Authorization : header : The OAuth Token prefixed with ?Bearer? and space in between.
Request Type : body : The subscription type for which this request is raised. Valid values are CREATE, MODIFY, DELETE. Notification Format : body : The format in which notifications will be received in the form of JSON or XML. Valid values are JSON or XML.

Security
Parameters
client_id: string

unique identifier which created during onboarding process

Body parameters
accountIdentification?: unknown

account number in which subscription to be maintained

branchIdentification?: string

CITI branch id where the account is associated

creditDebitIndicator?: "DBIT" | "CRDT" | "BOTH"

direction of the transaction which needs notification

format?: "XML" | "JSON"

format in which notification message expected

fromAmount?: string

lower limit for notification to be send. Notification will not be send if transaction amount lesser than this amount

requestType?: "CREATE" | "MODIFY" | "DELETE"

prefered operation of subscription maintenance create/modify/delete

toAmount?: string

upper limit for notification to be send. Notification will not be send if transaction amount greater than this amount

Response fields
Subscription
Request example
200Example

Domain types

Subscription = { accountNumber, clientId, format, 6 more... }