openapi: 3.2.0
info:
description: Subscription API allows Commercial application events and to receive notifications based on those subscriptions
version: 2.0.0
title: vca events subscriptions Subscription API
x-ibm-name: vca-events-subscriptions
contact:
name: GLOBAL Commercial Cards API Production support
email: dl.icg.global.commercial.cards.digital.production.support@imcap.ap.ssmb.com
servers:
- url: https://tts.apib2b.citi.com/tts/cards
tags:
- name: Subscription
description: Operations related to event subscriptions
paths:
/vca/v2/events/subscriptions:
post:
summary: Create Subscription
description: Create a subscription that will cause notifications to be generated for the specified events.
operationId: createSubscription
tags:
- Subscription
parameters:
- name: Authorization
in: header
description: Bearer token obtained from the OAuth2 Client Credentials flow
required: true
schema:
type: string
- name: Region
in: header
description: region of the client(Apac/EMEA/NAM)
required: true
schema:
type: string
- name: Country
in: header
description: country of the Client
required: true
schema:
type: string
- name: Req-Sys-Id
in: header
description: Client Tracking ID
required: true
schema:
type: string
requestBody:
description: SubscriptionRequest
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionRequest'
responses:
'201':
description:
| errorCode | errorDescription |
| EVB0700 | subscriptionName is Mandatory |
| EVB0701 | subscriptionName length should contain a min of 1 character and a max of 50 characters |
| EVB0702 | subscriptionName field is invalid and can only have letters, numbers, dashes and underscores |
| EVB0703 | active is Mandatory |
| EVB0704 | operator field is Mandatory |
| EVB0705 | WHERE operator can only be used in the first subscription.operator field, other subscription.operator fields should use only OR operator |
| EVB0706 | fieldName is Mandatory |
| EVB0707 | subscription.fieldName must have a value of programId for the first condition in the specifications in conjunction with the WHERE operator and the EQUALS fieldOperator |
| EVB0708 | subscription.fieldName that is after the first subscription can only have a value of programId in conjunction with an operator value of OR and a fieldOperator value of EQUALS |
| EVB0709 | fieldName should contain a min of 1 character and a max of 30 characters |
| EVB0710 | fieldOperator is Mandatory |
| EVB0711 | subscription.expectedContent.contentType must have a value of INTEGER when subscription.fieldName value equal 'programId' |
| EVB0712 | expectedContent.contentType is Mandatory |
| EVB0713 | expectedContent.contentType length should contain a min of 1 character and a max of 7 characters |
| EVB0714 | subscription.expectedContent.contentType is invalid and can only have a value of INTEGER for the EQUALS operator |
| EVB0715 | expectedContent.value is Mandatory |
| EVB0716 | expectedContent.value must only contain letters, digits, spaces, hyphens, slashes, commas, periods and underscores |
| EVB0717 | children.operator is invalid and can only have a value of AND, OR |
| EVB0718 | Invalid value for the field children.fieldName |
| EVB0719 | Invalid value for the field children.fieldName. children.fieldName cannot contain a value of programId |
| EVB0720 | children.fieldOperator is invalid and can only have a value of EQUALS |
| EVB0721 | children.expectedContent.contentType can only have a value of TEXT when the children.fieldOperator field is EQUALS |
| EVB0722 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'fundingSourceName' |
| EVB0723 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'messageTypeIndicator' |
| EVB0724 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'authorizationResponseDetail' |
| EVB0725 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'vcaAuthorizationResponseDetail' |
| EVB0357 | ProgramId must be numeric |
| EVB0201 | We were unable to process your request. Please try again, or contact Citi support if you have any further questions or comments. |
| EVB0066 | ClientId and programId combination is not valid |
| EVB0726 | subscriptionId length should contain a min of 1 character and a max of 255 characters |
| EVB0727 | No subscription found for the specified subscription ID |
| EVB0728 | This subscription name is already registered for this subscriber |
| EVB0729 | subscriptionEventType field is invalid and can only have one of the following values:'PAYMENT_AUTHORIZATION','CLEARING' |
| GRC0005 | Client Tracking ID is missing in the request header |
| GRC0010 | Client Tracking ID length should contain a min of 1 character and a max of 36 characters |
| GRC0003 | Invalid JSON input |
| GRC0016 | Country code is not available in the request |
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: | errorCode | errorDescription |
| EVB0700 | subscriptionName is Mandatory |
| EVB0701 | subscriptionName length should contain a min of 1 character and a max of 50 characters |
| EVB0702 | subscriptionName field is invalid and can only have letters, numbers, dashes and underscores |
| EVB0703 | active is Mandatory |
| EVB0704 | operator field is Mandatory |
| EVB0705 | WHERE operator can only be used in the first subscription.operator field, other subscription.operator fields should use only OR operator |
| EVB0706 | fieldName is Mandatory |
| EVB0707 | subscription.fieldName must have a value of programId for the first condition in the specifications in conjunction with the WHERE operator and the EQUALS fieldOperator |
| EVB0708 | subscription.fieldName that is after the first subscription can only have a value of programId in conjunction with an operator value of OR and a fieldOperator value of EQUALS |
| EVB0709 | fieldName should contain a min of 1 character and a max of 30 characters |
| EVB0710 | fieldOperator is Mandatory |
| EVB0711 | subscription.expectedContent.contentType must have a value of INTEGER when subscription.fieldName value equal 'programId' |
| EVB0712 | expectedContent.contentType is Mandatory |
| EVB0713 | expectedContent.contentType length should contain a min of 1 character and a max of 7 characters |
| EVB0714 | subscription.expectedContent.contentType is invalid and can only have a value of INTEGER for the EQUALS operator |
| EVB0715 | expectedContent.value is Mandatory |
| EVB0716 | expectedContent.value must only contain letters, digits, spaces, hyphens, slashes, commas, periods and underscores |
| EVB0717 | children.operator is invalid and can only have a value of AND, OR |
| EVB0718 | Invalid value for the field children.fieldName |
| EVB0719 | Invalid value for the field children.fieldName. children.fieldName cannot contain a value of programId |
| EVB0720 | children.fieldOperator is invalid and can only have a value of EQUALS |
| EVB0721 | children.expectedContent.contentType can only have a value of TEXT when the children.fieldOperator field is EQUALS |
| EVB0722 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'fundingSourceName' |
| EVB0723 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'messageTypeIndicator' |
| EVB0724 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'authorizationResponseDetail' |
| EVB0725 | children.expectedContent.contentType must have a value of TEXT when children.fieldName value is 'vcaAuthorizationResponseDetail' |
| GRC0005 | Client Tracking ID is missing in the request header |
| GRC0010 | Client Tracking ID length should contain a min of 1 character and a max of 36 characters |
| GRC0003 | Invalid JSON input |
| GRC0016 | Country code is not available in the request |
| EVB0357 | ProgramId must be numeric |
| EVB0201 | We were unable to process your request. Please try again, or contact Citi support if you have any further questions or comments. |
| EVB0066 | ClientId and programId combination is not valid |
| EVB0726 | subscriptionId length should contain a min of 1 character and a max of 255 characters |
| EVB0727 | No subscription found for the specified subscription ID |
| EVB0729 | eventType field is invalid and can only have one of the following values:'PAYMENT_AUTHORIZATION','CLEARING' |
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: