openapi: 3.2.0
info:
  title: Citi Vca API
  x-refined-note:
  - x-ibm-name differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Vca across 5 of this provider''s published API definitions: citi-id-provisioning-openapi.yaml, citi-purchase-openapi.yaml, citi-virtual-cards-notifications-openapi.yaml, citi-virtual-cards-pi-openapi.yaml, citi-virtual-cards-reporting-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://tts.apib2b.citi.com/tts/cards/
  description: production gateway URL
- url: https://tts.sandbox.apib2b.citi.com/tts/cards/
  description: sandbox URL
- url: https://tts.apib2b.citi.com/tts/cards
  description: production gateway URL
- url: https://tts.sandbox.apib2b.citi.com/tts/cards
  description: sandbox URL
- url: https://grace-engine-service-uat-icg-tts-grace-173707.namicgswd12u.nam.nsroot.net/tts/cards
  description: production gateway URL
- url: https://tts.apib2b.citi.com/tts/cards/pi/
  description: production gateway URL
- url: https://tts.sandbox.apib2b.citi.com/tts/cards/pi/
  description: sandbox URL
tags:
- name: Vca
paths:
  /vca/programdtls/v1/idprov:
    post:
      tags:
      - Vca
      summary: ID Provisioning
      description: ''
      operationId: generateAuthReport_2
      parameters:
      - name: Content-Type
        in: header
        description: Supports application/json
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: Country
        in: header
        description: Three-character length country code used during onboarding into Citi.
        required: true
        schema:
          type: string
      - name: Region
        in: header
        description: This value will be used by APIm to route to the respective Citi backend instance.
        required: true
        schema:
          type: string
      requestBody:
        description: GenerateIdProvisioningRequest
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdProvRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdProvResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnAuthorizedResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TechIssueResponse'
      security:
      - clientCredentials: []
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards/
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards/
      description: sandbox URL
  /vca/v1/purchasetemplate/details:
    post:
      tags:
      - Vca
      summary: Purchase Template Details
      description: ''
      operationId: getPurchaseTemplateDetails
      parameters:
      - name: Content-Type
        in: header
        description: Supports application/json
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: sample
        required: true
        schema:
          type: string
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for oauth token generation
        schema:
          type: string
      - name: Country
        in: header
        description: sample
        required: true
        schema:
          type: string
      - name: Region
        in: header
        description: sample
        required: true
        schema:
          type: string
      - name: Req-Sys-Id
        in: header
        description: sample
        required: true
        schema:
          type: string
      responses:
        '200':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>PurchaseTemplateInboundSuccessResponse</td><td></td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseTemplateInboundSuccessResponse'
        '206':
          description: <table><tr><td>PurchaseTemplateInboundPartialResponse</td><td></td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseTemplateInboundPartialResponse'
        '400':
          description: '<table><tr><td>ResponseCodes400</td><td><table><tr><th>Error Code</th><th>Error Description</th></tr>

            <tr><td>ERS0060</td><td>Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>

            <tr><td>MS0007</td><td>There was a problem retrieving the purchase template details for Purchase Template ID: {templateId}</td></tr>

            <tr><td>GRC0002</td><td>Client ID is missing in the request header</td></tr>

            <tr><td>GRC0003</td><td>Invalid JSON Input</td></tr>

            <tr><td>GRC0004</td><td>Region ID is not available in the request</td></tr>

            <tr><td>GRC0005</td><td>Client Tracking ID is missing in the request header</td></tr>

            <tr><td>GRC0010</td><td>Client Tracking ID length should contain a min of 1 character and a max of 36 characters</td></tr>

            <tr><td>GRC0011</td><td>Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>

            <tr><td>GRC0012</td><td>Necessary header value is missing</td></tr>

            <tr><td>GRC0016</td><td>Country code is not available in the request</td></tr>

            <tr><td>ERS0064</td><td>No ID Provisioning data was found for the given Program Name: {programName}</td></tr>

            <tr><td>ERS0065</td><td>The required Program Name Field was empty</td></tr>

            <tr><td>ERS0073</td><td>Size of the programName exceeds max length</td></tr>

            <tr><td>ERS0074</td><td>Size of the templateId exceeds max length</td></tr>

            <tr><td>ERS0075</td><td>templateId should be a valid long value</td></tr></table></td></tr></table>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCodes400'
        '500':
          description: '<table><tr><td>ResponseCode500</td><td><table><tr><th>Error Code</th><th>Error Description</th></tr>

            <tr><td>GRC0001</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments</td></tr><tr><td>GRC0014</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments</td></tr>

            <tr><td>MS0003</td><td>There was a problem retrieving the funding source data for Program Name: {programName}</td></tr>

            <tr><td>MS0004</td><td>There was a problem retrieving ID provisioning data for Program Name: {programName}</td></tr>

            <tr><td>MS0006</td><td> There was a problem retrieving the purchase template list for Program Name: {programName}</td></tr></table></td></tr></table>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseTemplateInboundRequest'
        description: PurchaseTemplateInboundRequest
        required: true
      security:
      - clientCredentials: []
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards
      description: sandbox URL
  /vca/v1/authorizations/subscriptions:
    post:
      summary: Create Subscription
      description: Create a notification subscription for a Virtual Card program.
      operationId: createSubscription
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for oauth token generation
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Supports application/json.
        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
      responses:
        '201':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>SubscriptionResponse</td><td>Created</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '400':
          description: <table><tr><td>Error-400</td><td>Bad Request</td></tr><tr><td>SubscriptionFailureResponse</td><td>Bad Request</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionFailureResponse'
        '500':
          description: <table><tr><td>Error-403</td><td>Internal Server Error</td></tr><tr><td>Error-401</td><td>Internal Server Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d401'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        description: SubscriptionRequest
        required: true
      tags:
      - Vca
      security:
      - clientCredentials: []
    servers:
    - url: https://grace-engine-service-uat-icg-tts-grace-173707.namicgswd12u.nam.nsroot.net/tts/cards
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards
      description: sandbox URL
  /vca/v1/authorizations/subscriptions/{subscriptionId}:
    get:
      summary: Retrieve Subscription
      description: Retrieve the details that were set on the subscription.
      operationId: getSubscription
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for oauth token generation
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        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
      responses:
        '200':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>SubscriptionResponse</td><td>OK</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '404':
          description: <table><tr><td>Error-404</td><td>Bad Request</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d404'
        '500':
          description: <table><tr><td>Error-403</td><td>Internal Server Error</td></tr><tr><td>Error-401</td><td>Internal Server Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d401'
      tags:
      - Vca
      security:
      - clientCredentials: []
    put:
      summary: Update an Existing Subscription
      description: Update an existing Virtual Cards notification subscription.
      operationId: updateSubscription
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for oauth token generation
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Supports application/json.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        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
      responses:
        '200':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>SubscriptionResponse</td><td>OK</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '400':
          description: <table><tr><td>SubscriptionFailureResponse</td><td>Bad Request</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionFailureResponse'
        '404':
          description: <table><tr><td>Error-404</td><td></td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d404'
        '500':
          description: <table><tr><td>Error-403</td><td>Internal Server Error</td></tr><tr><td>Error-401</td><td>Internal Server Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d401'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        description: SubscriptionRequest
        required: true
      tags:
      - Vca
      security:
      - clientCredentials: []
    delete:
      summary: Delete Subscription
      description: Delete a Virtual Cards Notification subscription.
      operationId: deleteSubscription
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for oauth token generation
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Subscription ID
        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
      responses:
        '204':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td></td><td>DELETED</td></tr></table>
        '404':
          description: <table><tr><td>Error-404</td><td>Not Found</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d404'
        '500':
          description: <table><tr><td>Error-403</td><td>Internal Server Error</td></tr><tr><td>Error-401</td><td>Internal Server Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error%2d401'
      tags:
      - Vca
      security:
      - clientCredentials: []
    servers:
    - url: https://grace-engine-service-uat-icg-tts-grace-173707.namicgswd12u.nam.nsroot.net/tts/cards
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards
      description: sandbox URL
  /vca/v1/create:
    post:
      summary: Create Virtual Card Accounts
      operationId: create
      description: Create a virtual card and set its associated spending controls, custom reference data and payment beneficiaries.
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for OAuth token generation
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Supports \"application/xml\" and \"application/json\".
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and a space in between.
        required: true
        schema:
          type: string
      - name: country
        in: header
        description: Country of the client.
        required: true
        schema:
          type: string
      - name: region
        in: header
        description: region of the client(APAC/EMEA/NAM)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Create virtual card acknowledgement response
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              example: 0123456789012345678901234567
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImmediateAckResponse'
        '400':
          description: Invalid virtual card request
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualCardFailureResponse'
        '401':
          description: Unauthorized Modify Virtual Card request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnAuthorizedResponse'
        '405':
          description: Method Not Allowed
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualCardFailureResponse'
        '500':
          description: Internal Server Error
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualCardFailureResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualCardRequest'
        required: true
      tags:
      - Vca
      security:
      - clientCredentials: []
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards/pi/
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards/pi/
      description: sandbox URL
  /vca/v1/modify:
    post:
      summary: Modify Virtual Card Accounts
      operationId: update
      description: Modify a virtual card and set its associated spending controls, custom reference data, and payment beneficiaries.
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for OAuth token generation
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Supports \"application/xml\" and \"application/json\".
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and a space in between.
        required: true
        schema:
          type: string
      - name: country
        in: header
        description: Country of the client.
        required: true
        schema:
          type: string
      - name: region
        in: header
        description: region of the client(APAC/EMEA/NAM)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Modify Virtual Card response
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyVirtualCardResponse'
        '400':
          description: Invalid Modify Virtual Card request
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyVirtualCardFailureResponse'
        '401':
          description: Unauthorized Modify Virtual Card request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnAuthorizedResponse'
        '405':
          description: Method Not Allowed
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyVirtualCardFailureResponse'
        '500':
          description: Internal Server Error
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyVirtualCardFailureResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyVirtualCardRequest'
        required: true
      tags:
      - Vca
      security:
      - clientCredentials: []
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards/pi/
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards/pi/
      description: sandbox URL
  /vca/v1/cancel:
    post:
      summary: Cancel Virtual Card Accounts
      operationId: cancel
      description: Cancel a virtual card when it is no longer needed.
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for OAuth token generation
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Supports \"application/xml\" and \"application/json\".
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and a space in between.
        required: true
        schema:
          type: string
      - name: country
        in: header
        description: Country of the client.
        required: true
        schema:
          type: string
      - name: region
        in: header
        description: region of the client(APAC/EMEA/NAM)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cancel Virtual Card response
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelVirtualCardResponse'
        '400':
          description: Invalid Cancel Virtual Card request
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelVirtualCardFailureResponse'
        '401':
          description: Unauthorized Virtual Card request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnAuthorizedResponse'
        '405':
          description: Method Not Allowed
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelVirtualCardFailureResponse'
        '500':
          description: Internal Server Error
          headers:
            api-transactionId:
              description: Citi commercial cards API tracking ID.
              schema:
                type: string
            messageId:
              description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelVirtualCardFailureResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelVirtualCardRequest'
        required: true
      tags:
      - Vca
      security:
      - clientCredentials: []
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards/pi/
      description: production gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards/pi/
      description: sandbox URL
  /vca/v2/reports/authorization:
    post:
      summary: Obtain Authorized Transaction Details
      description: Obtain authorized transaction details on a VCA for reporting & payment reconciliation
      operationId: AuthorizationReport
      parameters:
      - name: Content-Type
        in: header
        description: Supports application/json
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Oauth token included by the external client to APIm. APIm will external the client ID and pass it to GRACE
        required: true
        schema:
          type: string
      - name: Country
        in: header
        description: Three character length country code used during onboarding into GRACE
        schema:
          type: string
        required: true
      - name: Region
        in: header
        description: This value will be used by APIm to route to the respective GRACE backend instance
        schema:
          type: string
        required: true
      - name: Req-Sys-Id
        in: header
        description: Unique ID of the API message sent. This ID will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
        schema:
          type: string
        required: false
      requestBody:
        description: AuthReportInboundRequest
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthReportInboundRequest'
            examples:
              Mastercard-Request-Required-Fields:
                summary: Mastercard Sample Request with Required Fields
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00000AuthReport00020260521195320
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
              Visa-Request-Required-Fields:
                summary: Visa Sample Request with Required Fields
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00000AuthReport00020260521195321
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
              Mastercard-Request-All-Fields:
                summary: Mastercard Sample Request with All Fields
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00000AuthReport00020260521195322
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  startTime: 00:00
                  endTime: '23:00'
                  timeZone: UTC-04:00
                  transactionType: All
              Visa-Request-All-Fields:
                summary: Visa Sample Request with All Fields
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00000AuthReport00020260521195323
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  startTime: 00:00
                  endTime: '23:00'
              Mastercard-Pagination-Request:
                summary: Mastercard Sample Request with Pagination
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00000AuthReport00020260521195324
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
                  transactionType: All
                  reportIds:
                  - '1234567'
                  - '2345678'
                  filters:
                    paginationRequired: 'true'
                    sortOrder: DESCENDING
                    startIndex: '101'
                    endIndex: '200'
              Visa-Pagination-Request:
                summary: Visa Sample Request with Pagination
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00000AuthReport00020260521195325
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  filters:
                    paginationRequired: 'true'
                    startIndex: '150'
                    endIndex: '300'
              Mastercard-Retry-Request:
                summary: Mastercard Sample Retry Request for Pending/Active Status
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00000AuthReport00020260521195326
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
                  transactionType: All
                  reportIds:
                  - '1234567'
      responses:
        '200':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>AuthReportInboundResponse</td><td>success</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthReportInboundResponse'
              examples:
                Mastercard-Response-All-Transaction-Type:
                  summary: Mastercard Sample Response for All Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2026-02-27'
                    endDate: '2026-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2026-02-27'
                      toDate: '2026-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2026-03-30'
                      toDate: '2026-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '122026'
                      billingCurrencyAmount: '123'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '123'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:52:11'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Refer to card issuer
                      vcaAuthorizationResponseDetail: Iss/Netwk decline
                    - expiryDate: '012026'
                      billingCurrencyAmount: '-143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '-143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:26:26'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '012026'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:24:56'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '012026'
                      billingCurrencyAmount: '141'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '141'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:23:33'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '122026'
                      billingCurrencyAmount: '0'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '0'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:34:03'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Do not honor
                      vcaAuthorizationResponseDetail: No Auth for Revl
                    - expiryDate: '122026'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:32:47'
                      transactionType: Auth Purchase Return
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '122026'
                      billingCurrencyAmount: '141'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '141'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:29:20'
                      transactionType: Auth Purchase Return
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON        MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                Mastercard-Response-Approved-Transaction-Type:
                  summary: Mastercard Sample Response for Approved Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: Approved
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '012023'
                      billingCurrencyAmount: '-143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '-143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:26:26'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '012023'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:24:56'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '012023'
                      billingCurrencyAmount: '141'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '141'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:23:33'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '122023'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:32:47'
                      transactionType: Auth Purchase Return
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '122023'
                      billingCurrencyAmount: '141'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '141'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:29:20'
                      transactionType: Auth Purchase Return
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                Mastercard-Response-Declined-Transaction-Type:
                  summary: Mastercard Sample Response for Declined Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: Declined
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '122021'
                      billingCurrencyAmount: '123'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '123'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:52:11'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Refer to card issuer
                      vcaAuthorizationResponseDetail: Iss/Netwk decline
                    - expiryDate: '122023'
                      billingCurrencyAmount: '0'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '0'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:34:03'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Do not honor
                      vcaAuthorizationResponseDetail: No Auth for Revl
                Mastercard-Response-Issuer-Declined-Transaction-Type:
                  summary: Mastercard Sample Response for Issuer-Declined Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: Issuer-Declined
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '122021'
                      billingCurrencyAmount: '123'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '123'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:52:11'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Refer to card issuer
                      vcaAuthorizationResponseDetail: Iss/Netwk decline
                Mastercard-Response-Reversal-Response-Transaction-Type:
                  summary: Mastercard Sample Response for Reversal-Response Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: Reversal-Response
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '012023'
                      billingCurrencyAmount: '-143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '-143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:26:26'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON  MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '122023'
                      billingCurrencyAmount: '0'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '0'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:34:03'
                      transactionType: Reversal
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON  MO
                      acquirerIdentifier: '999080'
                      authorizationResponseDetail: Do not honor
                      vcaAuthorizationResponseDetail: No Auth for Revl
                Mastercard-Response-Request-Response-Transaction-Type:
                  summary: Mastercard Sample Response for Request-Response Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: Request-Response
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '122021'
                      billingCurrencyAmount: '123'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '123'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:52:11'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Refer to card issuer
                      vcaAuthorizationResponseDetail: Iss/Netwk decline
                    - expiryDate: '012023'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:24:56'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                    - expiryDate: '012023'
                      billingCurrencyAmount: '141'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '141'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '19:23:33'
                      transactionType: Authorization
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      transactionEnvironment: POS
                      authorizationResponseDetail: Approved or completed successfully
                      vcaAuthorizationResponseDetail: Approval
                Mastercard-Response-Purchase-Return:
                  summary: Mastercard Sample Response for Purchase-Return
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - expiryDate: '122023'
                      billingCurrencyAmount: '143'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-15
                      transactionTime: '17:32:47'
                      transactionType: Purchase Return
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5999'
                      mccDescription: MISCELLANEOUS AND SPECIALTY RETAIL STORES
                      merchantId: 00000R-5411-USA
                      merchantName: GROCERY STORES SUPERM OFALLON      MO
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: '999080'
                      terminalId: '33248931'
                      transactionEnvironment: UNKNOWN
                      vcaAuthorizationResponseDetail: Approval
                Mastercard-Response-Forced-Post:
                  summary: Mastercard Sample Response for Forced-Post
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    authorizationRecords:
                    - billingCurrencyAmount: '127.00'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '127.00'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '14:41:52'
                      transactionType: Forced Post
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: 00000999080
                      transactionEnvironment: POS
                      vcaAuthorizationResponseDetail: Approval
                    - billingCurrencyAmount: '143.00'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '143.00'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '14:37:13'
                      transactionType: Forced Post
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: 00000999080
                      transactionEnvironment: POS
                      vcaAuthorizationResponseDetail: Approval
                    - billingCurrencyAmount: '125.00'
                      billingCurrencyCode: USD
                      billingCurrencyCodeDescription: US Dollar
                      transactionCurrencyCode: USD
                      transactionCurrencyAmount: '125.00'
                      transactionCurrencyCodeDescription: US Dollar
                      transactionDate: 04-20
                      transactionTime: '14:36:25'
                      transactionType: Forced Post
                      preAuthorizationFlag: 'No'
                      addressVerificationServiceFlag: 'No'
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCountryCode: USA
                      merchantCountryName: United States (the)
                      acquirerIdentifier: 00000999080
                      transactionEnvironment: POS
                      vcaAuthorizationResponseDetail: Approval
                Mastercard-Pending-Response:
                  summary: Mastercard Sample Response for Pending Response
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: PARTIALLY COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: PENDING
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: PENDING
                Mastercard-Active-Response:
                  summary: Mastercard Sample Response for Active Response
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: PARTIALLY COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: ACTIVE
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: ACTIVE
        '400':
          description: '<table><tr><td>ErrorResponseForAuthReport</td><td><table><tr><th>Error Code</th><th>Error Description</th></tr>\n<tr><td>ERS0001</td><td>Invalid Virtual Card Account Number format</td></tr>\n<tr><td>ERS0002</td><td>Invalid Transaction Type</td></tr>\n<tr><td>ERS0003</td><td>timeZone field is empty or has an invalid UTC offset time zone format</td></tr>\n<tr><td>ERC0004</td><td>Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.</td></tr>\n<tr><td>ERS0007</td><td>Invalid Message ID format</td></tr>\n<tr><td>ERS0009</td><td>Client Onboard Configuration setup is missing. Contact Citi support.</td></tr>\n<tr><td>ERS0010</td><td>Invalid Report ID format. Report ID must include numeric values</td></tr>\n<tr><td>ERS0053</td><td>Start Date is Mandatory.</td></tr>\n<tr><td>ERS0054</td><td>End Date is Mandatory.</td></tr>\n<tr><td>ERS0055</td><td>Requested report date cannot exceed 180 days in the past from today''s date</td></tr>\n<tr><td>ERS0057</td><td>startDate value exceeds requested endDate value</td></tr>\n<tr><td>ERS0060</td><td>Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>\n<tr><td>ERS0061</td><td>VCA ID is not present in our system</td></tr>\n<tr><td>ERS0063</td><td>Requested Time Zone is not supported</td></tr>\n<tr><td>ERS0068</td><td>Program Id is Mandatory.</td></tr>\n<tr><td>ERS0069</td><td>Vca Id is Mandatory.</td></tr>\n<tr><td>ERS0070</td><td>Message Id is Mandatory.</td></tr>\n<tr><td>ERS0071</td><td>Virtual Card Account Number is Mandatory.</td></tr>\n<tr><td>ERS0072</td><td>Requested report date cannot exceed 36 months in the past from todays date</td></tr>\n<tr><td>ERS0079</td><td>The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).</td></tr>\n<tr><td>ERS0080</td><td>The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).</td></tr>\n<tr><td>ERS0081</td><td>The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).</td></tr>\n<tr><td>ERS0082</td><td>The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.</td></tr>\n<tr><td>ERS0083</td><td>The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.</td></tr>\n<tr><td>ERS0084</td><td>The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.</td></tr>\n<tr><td>ERS0091</td><td>startDate value must have valid format: YYYY-MM-DD</td></tr>\n<tr><td>ERS0092</td><td>endDate value must have valid format: YYYY-MM-DD</td></tr>\n<tr><td>ERS0093</td><td>The date specified in startDate does not exist</td></tr>\n<tr><td>ERS0094</td><td>The date specified in endDate does not exist</td></tr>\n<tr><td>ERS0095</td><td>Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID</td></tr>\n<tr><td>ERS0097</td><td>startTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)</td></tr>\n<tr><td>ERS0098</td><td>endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)</td></tr>\n<tr><td>ERS0099</td><td>startTime value cannot exceed the requested endTime value</td></tr><tr><td>ERS0100</td><td>Invalid sortOrder value</td></tr><tr><td>ERS0101</td><td>startIndex should be numeric</td></tr><tr><td>ERS0102</td><td>endIndex should be numeric</td></tr><tr><td>ERS0103</td><td>startIndex should be less than or equal to endIndex</td></tr><tr><td>ERS0104</td><td>The startIndex & endIndex range cannot be greater than 150</td></tr><tr><td>ERS0105</td><td>The startDate and endDate range cannot be greater than 30 days if paginationRequired is true</td></tr>\n\n<tr><td>MS0001</td><td>Invalid Virtual Card Account Number</td></tr>\n<tr><td>MS0002</td><td>From date should be before to date.</td></tr>\n<tr><td>MS0006</td><td>Invalid vcaId value</td></tr>\n<tr><td>MS0008</td><td>Invalid Report ID</td></tr>\n\n<tr><td>GRC0002</td><td>Client ID is missing in the request header</td></tr>\n<tr><td>GRC0003</td><td>Invalid JSON Input</td></tr>\n<tr><td>GRC0004</td><td>Region ID is not available in the request</td></tr>\n<tr><td>GRC0011</td><td>Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>\n<tr><td>GRC0016</td><td>Country code is not available in the request</td></tr>\n</table></td></tr></table>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseForAuthReport'
        '500':
          description: '<table><tr><td>ServerErrorResponseForAuthReport</td><td><table><tr><th>Error Code</th><th>Error Description</th></tr>

            <tr><td>GRC0001</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments.</td></tr>

            <tr><td>GRC0006</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments.</td></tr>

            <tr><td>GRC0009</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments.</td></tr>

            <tr><td>GRC0014</td><td>We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments</td></tr>

            </table></td></tr></table>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponseForAuthReport'
        '504':
          description: <table><tr><td>ErrorResponseForAuthReport</td><td>Backend Connectivity Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseForAuthReport'
      tags:
      - Vca
      security:
      - clientCredentials:
        - /api
      x-operation-id-source: normalized
      x-operation-id-original: Authorization Report
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards
      description: Production Gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards
      description: Sandbox Gateway URL
  /vca/v2/reports/clearing:
    post:
      summary: Obtain Cleared Transaction Details Reporting
      description: Obtain cleared transaction details on a VCA for reporting and payment reconciliation
      operationId: ClearingReport
      parameters:
      - name: Content-Type
        in: header
        description: Supports application/json
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Oauth token included by the external client to APIm. APIm will external the client ID and pass it to GRACE
        required: true
        schema:
          type: string
      - name: Country
        in: header
        description: Three character length country code used during onboarding into GRACE
        schema:
          type: string
        required: true
      - name: Region
        in: header
        description: This value will be used by APIm to route to the respective GRACE backend instance
        schema:
          type: string
        required: true
      - name: Req-Sys-Id
        in: header
        description: Unique ID of the API message sent. This ID will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
        schema:
          type: string
        required: false
      requestBody:
        description: ClearingReportInboundRequest
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClearingReportInboundRequest'
            examples:
              Mastercard-Request-Required-Fields:
                summary: Mastercard Sample Request with Required Fields
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00ClearingReport0020260521195320
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
              Visa-Request-Required-Fields:
                summary: Visa Sample Request with Required Fields
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00ClearingReport0020260521195321
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
              Mastercard-Request-All-Fields:
                summary: Mastercard Sample Request with All Fields
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00ClearingReport0020260521195322
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  startTime: 00:00
                  endTime: '23:00'
                  timeZone: UTC-04:00
                  transactionType: All
              Visa-Request-All-Fields:
                summary: Visa Sample Request with All Fields
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00ClearingReport0020260521195323
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  startTime: 00:00
                  endTime: '23:00'
              Mastercard-Pagination-Request:
                summary: Mastercard Sample Request with Pagination
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00ClearingReport0020260521195324
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
                  transactionType: All
                  reportIds:
                  - '1234567'
                  - '2345678'
                  filters:
                    paginationRequired: 'true'
                    sortOrder: DESCENDING
                    startIndex: '101'
                    endIndex: '200'
              Visa-Pagination-Request:
                summary: Visa Sample Request with Pagination
                value:
                  vcaId: '2026052113115824204'
                  virtualCardAccountNumber: '9898121243438000'
                  programId: '918'
                  messageId: CITI00ClearingReport0020260521195325
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  filters:
                    paginationRequired: 'true'
                    startIndex: '150'
                    endIndex: '300'
              Mastercard-Retry-Request:
                summary: Mastercard Sample Retry Request for Pending/Active Status
                value:
                  vcaId: '17896177'
                  virtualCardAccountNumber: '9898121243438778'
                  programId: '431341'
                  messageId: CITI00ClearingReport0020260521195326
                  startDate: '2026-04-01'
                  endDate: '2026-04-30'
                  timeZone: UTC-04:00
                  transactionType: All
                  reportIds:
                  - '1234567'
      responses:
        '200':
          description: <table><tr><td>Code</td><td>Details</td></tr><tr><tr><td>ClearingReportInboundResponse</td><td>success</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClearingReportInboundResponse'
              examples:
                Mastercard-Response-All-Transaction-Type:
                  summary: Mastercard Sample Response for All Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    virtualCardAccountNumber: '5281722601926445'
                    programId: '429777'
                    reportStatus: COMPLETED
                    transactionType: All
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    clearingRecords:
                    - transactionCurrencyAmount: '143'
                      transactionCurrencyCode: USD
                      transactionCurrencyCodeDescription: U.S. DOLLAR
                      transactionExchangerate: '1'
                      billingCurrencyCode: USD
                      billingCurrencyAmount: '143'
                      billingCurrencyCodeDescription: U.S. DOLLAR
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000999080R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCity: OFALLON
                      merchantState: MO
                      merchantCountryCode: USA
                      merchantCountryName: UNITED STATES
                      acquirerIdentifier: 00000999080
                      acquirerReferenceData: '25567681110000232050357'
                      messageType: '1240'
                      messageReasonCode: '1400'
                      functionCode: '200'
                      transactionDate: '2021-04-21'
                      transactionTime: '11:06:00'
                      settlementAmount: '189.98'
                      settlementCurrencyCode: SGD
                      settlementCurrencyDescription: Singapore Dollar
                      approvalCode: '802907'
                      transactionPostDate: '2021-04-21'
                      transactionType: First Presentment
                    - transactionCurrencyAmount: '141'
                      transactionCurrencyCode: USD
                      transactionCurrencyCodeDescription: U.S. DOLLAR
                      transactionExchangerate: '1'
                      billingCurrencyCode: USD
                      billingCurrencyAmount: '141'
                      billingCurrencyCodeDescription: U.S. DOLLAR
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000999080R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCity: OFALLON
                      merchantState: MO
                      merchantCountryCode: USA
                      merchantCountryName: UNITED STATES
                      acquirerIdentifier: 00000999080
                      acquirerReferenceData: '25567681110000232050340'
                      messageType: '1240'
                      messageReasonCode: '1400'
                      functionCode: '200'
                      transactionDate: '2021-04-21'
                      transactionTime: '11:06:00'
                      settlementAmount: '187.32'
                      settlementCurrencyCode: SGD
                      settlementCurrencyDescription: Singapore Dollar
                      approvalCode: '802931'
                      transactionPostDate: '2021-04-21'
                      transactionType: First Presentment
                Mastercard-Response-Presentment-Transaction-Type:
                  summary: Mastercard Sample Response for Presentment Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    virtualCardAccountNumber: '5281723603983210'
                    transactionType: Presentment
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                    clearingRecords:
                    - transactionCurrencyAmount: '127'
                      transactionCurrencyCode: USD
                      transactionCurrencyCodeDescription: U.S. DOLLAR
                      transactionExchangerate: '1'
                      billingCurrencyCode: USD
                      billingCurrencyAmount: '127'
                      billingCurrencyCodeDescription: U.S. DOLLAR
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000999080R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCity: OFALLON
                      merchantState: MO
                      merchantCountryCode: USA
                      merchantCountryName: UNITED STATES
                      acquirerIdentifier: 00000999080
                      acquirerReferenceData: '25567681110000232050407'
                      messageType: '1240'
                      messageReasonCode: '1400'
                      functionCode: '200'
                      transactionDate: '2021-04-21'
                      transactionTime: '11:06:00'
                      settlementAmount: '168.72'
                      settlementCurrencyCode: SGD
                      settlementCurrencyDescription: Singapore Dollar
                      approvalCode: '802910'
                      transactionPostDate: '2021-04-21'
                      transactionType: First Presentment
                    - transactionCurrencyAmount: '143'
                      transactionCurrencyCode: USD
                      transactionCurrencyCodeDescription: U.S. DOLLAR
                      transactionExchangerate: '1'
                      billingCurrencyCode: USD
                      billingCurrencyAmount: '143'
                      billingCurrencyCodeDescription: U.S. DOLLAR
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000999080R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCity: OFALLON
                      merchantState: MO
                      merchantCountryCode: USA
                      merchantCountryName: UNITED STATES
                      acquirerIdentifier: 00000999080
                      acquirerReferenceData: '25567681110000232050399'
                      messageType: '1240'
                      messageReasonCode: '1400'
                      functionCode: '200'
                      transactionDate: '2021-04-21'
                      transactionTime: '11:06:00'
                      settlementAmount: '189.98'
                      settlementCurrencyCode: SGD
                      settlementCurrencyDescription: Singapore Dollar
                      approvalCode: '802933'
                      transactionPostDate: '2021-04-21'
                      transactionType: First Presentment
                    - transactionCurrencyAmount: '125'
                      transactionCurrencyCode: USD
                      transactionCurrencyCodeDescription: U.S. DOLLAR
                      transactionExchangerate: '1'
                      billingCurrencyCode: USD
                      billingCurrencyAmount: '125'
                      billingCurrencyCodeDescription: U.S. DOLLAR
                      merchantCategoryCode: '5812'
                      mccDescription: EATING PLACES RESTAURANTS
                      merchantId: 00000999080R-5411-USA
                      merchantName: GROCERY STORES SUPERM
                      merchantCity: OFALLON
                      merchantState: MO
                      merchantCountryCode: USA
                      merchantCountryName: UNITED STATES
                      acquirerIdentifier: 00000999080
                      acquirerReferenceData: '25567681110000232050381'
                      messageType: '1240'
                      messageReasonCode: '1400'
                      functionCode: '200'
                      transactionDate: '2021-04-21'
                      transactionTime: '11:06:00'
                      settlementAmount: '166.06'
                      settlementCurrencyCode: SGD
                      settlementCurrencyDescription: Singapore Dollar
                      approvalCode: '802909'
                      transactionPostDate: '2021-04-21'
                      transactionType: First Presentment
                Mastercard-Response-Second-Presentment-Transaction-Type:
                  summary: Mastercard Sample Response for Second Presentment Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    virtualCardAccountNumber: '5281723603983210'
                    transactionType: Second Presentment
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                Mastercard-Response-Chargeback-Transaction-Type:
                  summary: Mastercard Sample Response for Chargeback Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    virtualCardAccountNumber: '5281723603983210'
                    transactionType: Chargeback
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                Mastercard-Response-Retrieval-Request-Transaction-Type:
                  summary: Mastercard Sample Response for Retrieval Request Transaction Type
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    virtualCardAccountNumber: '5281723603983210'
                    transactionType: Retrieval Request
                    programId: '429777'
                    reportStatus: COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      status: COMPLETED
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      status: COMPLETED
                Mastercard-Pending-Response:
                  summary: Mastercard Sample Response for Pending Response
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: PARTIALLY COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: PENDING
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: PENDING
                Mastercard-Active-Response:
                  summary: Mastercard Sample Response for Active Response
                  value:
                    vcaId: '17896177'
                    startDate: '2021-02-27'
                    endDate: '2021-04-27'
                    messageId: '123456789123456789123456789123450066'
                    timeZone: UTC+05:30
                    transactionType: All
                    virtualCardAccountNumber: '5281723603983210'
                    programId: '429777'
                    reportStatus: PARTIALLY COMPLETED
                    info:
                    - fromDate: '2021-02-27'
                      toDate: '2021-03-29'
                      reportId: '1122330'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: ACTIVE
                    - fromDate: '2021-03-30'
                      toDate: '2021-04-27'
                      reportId: '1122331'
                      errorMessage: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments
                      errorCode: ERC0004
                      status: ACTIVE
        '400':
          description: '<table><tr><td>ErrorResponseForAuthReport</td><td><table><tr><th>Error Code</th><th>Error Description</th></tr>\n<tr><td>ERS0001</td><td>Invalid Virtual Card Account Number format</td></tr>\n<tr><td>ERS0002</td><td>Invalid Transaction Type</td></tr>\n<tr><td>ERS0003</td><td>timeZone field is empty or has an invalid UTC offset time zone format</td></tr>\n<tr><td>ERC0004</td><td>Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.</td></tr>\n<tr><td>ERS0007</td><td>Invalid Message ID format</td></tr>\n<tr><td>ERS0009</td><td>Client Onboard Configuration setup is missing. Contact Citi support.</td></tr>\n<tr><td>ERS0010</td><td>Invalid Report ID format. Report ID must include numeric values</td></tr>\n<tr><td>ERS0053</td><td>Start Date is Mandatory.</td></tr>\n<tr><td>ERS0054</td><td>End Date is Mandatory.</td></tr>\n<tr><td>ERS0055</td><td>Requested report date cannot exceed 180 days in the past from today''s date</td></tr>\n<tr><td>ERS0057</td><td>startDate value exceeds requested endDate value</td></tr>\n<tr><td>ERS0060</td><td>Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>\n<tr><td>ERS0061</td><td>VCA ID is not present in our system</td></tr>\n<tr><td>ERS0063</td><td>Requested Time Zone is not supported</td></tr>\n<tr><td>ERS0068</td><td>Program Id is Mandatory.</td></tr>\n<tr><td>ERS0069</td><td>Vca Id is Mandatory.</td></tr>\n<tr><td>ERS0070</td><td>Message Id is Mandatory.</td></tr>\n<tr><td>ERS0071</td><td>Virtual Card Account Number is Mandatory.</td></tr>\n<tr><td>ERS0072</td><td>Requested report date cannot exceed 36 months in the past from todays date</td></tr>\n<tr><td>ERS0079</td><td>The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).</td></tr>\n<tr><td>ERS0080</td><td>The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).</td></tr>\n<tr><td>ERS0081</td><td>The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).</td></tr>\n<tr><td>ERS0082</td><td>The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.</td></tr>\n<tr><td>ERS0083</td><td>The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.</td></tr>\n<tr><td>ERS0084</td><td>The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.</td></tr>\n<tr><td>ERS0091</td><td>startDate value must have valid format: YYYY-MM-DD</td></tr>\n<tr><td>ERS0092</td><td>endDate value must have valid format: YYYY-MM-DD</td></tr>\n<tr><td>ERS0093</td><td>The date specified in startDate does not exist</td></tr>\n<tr><td>ERS0094</td><td>The date specified in endDate does not exist</td></tr>\n<tr><td>ERS0095</td><td>Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID</td></tr>\n<tr><td>ERS0097</td><td>startTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)</td></tr>\n<tr><td>ERS0098</td><td>endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)</td></tr>\n<tr><td>ERS0099</td><td>startTime value cannot exceed the requested endTime value</td></tr><tr><td>ERS0100</td><td>Invalid sortOrder value</td></tr><tr><td>ERS0101</td><td>startIndex should be numeric</td></tr><tr><td>ERS0102</td><td>endIndex should be numeric</td></tr><tr><td>ERS0103</td><td>startIndex should be less than or equal to endIndex</td></tr><tr><td>ERS0104</td><td>The startIndex & endIndex range cannot be greater than 150</td></tr><tr><td>ERS0105</td><td>The startDate and endDate range cannot be greater than 30 days if paginationRequired is true</td></tr>\n\n<tr><td>MS0001</td><td>Invalid Virtual Card Account Number</td></tr>\n<tr><td>MS0002</td><td>From date should be before to date.</td></tr>\n<tr><td>MS0006</td><td>Invalid vcaId value</td></tr>\n<tr><td>MS0008</td><td>Invalid Report ID</td></tr>\n\n<tr><td>GRC0002</td><td>Client ID is missing in the request header</td></tr>\n<tr><td>GRC0003</td><td>Invalid JSON Input</td></tr>\n<tr><td>GRC0004</td><td>Region ID is not available in the request</td></tr>\n<tr><td>GRC0011</td><td>Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.</td></tr>\n<tr><td>GRC0016</td><td>Country code is not available in the request</td></tr>\n</table></td></tr></table>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponseForClearingReport'
        '504':
          description: <table><tr><td>ErrorResponseForClearingReport</td><td>Backend Connectivity Error</td></tr></table>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseForClearingReport'
      tags:
      - Vca
      security:
      - clientCredentials:
        - /api
      x-operation-id-source: normalized
      x-operation-id-original: Clearing Report
    servers:
    - url: https://tts.apib2b.citi.com/tts/cards
      description: Production Gateway URL
    - url: https://tts.sandbox.apib2b.citi.com/tts/cards
      description: Sandbox Gateway URL
components:
  schemas:
    TechIssueResponse:
      type: object
      properties:
        messageId:
          type: string
          description: The requested `messageId` will be provided back in response. The ID can be `used for investigation and troubleshooting`.
        provisioningStatus:
          type: string
          description: The status of the provisioning made
          enum:
          - FAILED
        errors:
          type: array
          items:
            $ref: '#/components/schemas/TechErrors'
    UnAuthorizedResponse:
      type: object
      properties:
        httpCode:
          type: string
          description: '401'
        httpMessage:
          type: string
          description: Unauthorized
        moreInformation:
          type: string
          description: Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.
    MethodNotAllowedResponse:
      type: object
      properties:
        path:
          type: string
          description: Requested resource path is available
        error:
          type: string
          description: Method Not Allowed
        message:
          type: string
          description: Detail error message with HTTP request operation type
        timestamp:
          type: string
          description: Citi rejected timestamp
        status:
          type: string
          description: '405'
    FundingSourceDetails:
      type: object
      properties:
        fundingSourceId:
          type: integer
          format: int64
          description: Unique identifier of the funding source to which the virtual card rolls up.
          example: 15510
        fundingSourceName:
          type: string
          description: Descriptive name of the real card to which the virtual card rolls up.
          example: APAC UAT GRACE TEST1
    ProgramDetails:
      type: object
      properties:
        programName:
          type: string
          description: Company Name as defined in the virtual cards system.
          example: INDRALOK INFOWAY
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
          example: '433161'
        status:
          type: string
          description: Defines the status of the data that was requested whether the request has been processed or not.
          enum:
          - COMPLETED
          - FAILED
          example: COMPLETED
        fundingSourceDetails:
          type: array
          items:
            $ref: '#/components/schemas/FundingSourceDetails'
        purchaseTemplates:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseTemplates'
        paymentBeneficiaryDetails:
          type: array
          items:
            $ref: '#/components/schemas/PaymentBeneficiaryDetails'
        error:
          $ref: '#/components/schemas/Errors'
    IdProvResponse:
      type: object
      properties:
        messageId:
          type: string
          example: '1234'
          description: Unique ID of the API message sent. The `messageId` will be provided back in the corresponding response. The ID can be `used for investigation and troubleshooting`. The ID must be unique per integration.
        provisioningStatus:
          type: string
          description: " The status of your provisioning request.\n\n **Note:** a response of ``200: OK`` indicates only that your request is properly formed and has been successfully received. It is possible to receive a response of ``200: OK`` without successfully completing the provisioning.\n\n See ``provisioningStatus`` for more information."
          enum:
          - COMPLETED
          - PARTIALLY COMPLETED
          - FAILED
          example: COMPLETED
        warningMessage:
          type: string
          description: "Citi API Platform onboarding was not successful. \nPlease retry once. If you continue to receive this message please\\\ncontact Citi Support for assistance.\n\n**Note:** You will receive this message only if the provisionStatus is ``Partially Completed`` or ``Failed``."
          example: Citi API Platform onboarding was not successful. Please retry once. If you continue to receive this message please contact Citi Support for assistance.
        programDetails:
          type: array
          items:
            $ref: '#/components/schemas/ProgramDetails'
    BadRequestResponse:
      type: object
      properties:
        messageId:
          type: string
          example: '1234'
          description: The requested `messageId` will be provided back in response. The ID can be `used for investigation and troubleshooting`.
        provisioningStatus:
          type: string
          description: The status of the provisioning made
          enum:
          - FAILED
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Errors'
    TechErrors:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code if there is any error occurred while technical issue is occurred in system
          enum:
          - ERC0002
          - ERS0049
          - GRC0001
          - GRC0005
          - GRC0006
          - GRC0009
          - GRC0014
        errorDescription:
          type: string
          description: The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br><br>  * `ERC0002` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  <br>  * `ERS0049` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br><br>  * `GRC0001` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br><br>  * `GRC0005` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  <br>  * `GRC0006`  - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  <br>  * `GRC0009`  - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  <br>  * `GRC0014`  - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>
    Errors:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code displayed while retrieving the transaction.
          enum:
          - ERC0001
          - ERS0007
          - ERS0064
          - ERS0065
          - ERS0066
          - ERS0076
          - ERC0002
          - ERC0003
          - MS0003
          - MS0004
          - MS0005
          - MS0006
          - GRC0002
          - GRC0003
          - GRC0004
          - GRC0007
          - GRC0011
          - GRC0012
          - GRC0013
          example: GRC0003
        errorDescription:
          type: string
          description: 'The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br><br>message:<br>  * `ERC0001` - No ID Provisioning data was found for the given Program Name: `{programName}`<br>  * `ERS0007` - Invalid Message ID format<br>  * `ERS0064` - No ID Provisioning data was found for the given Program Name: `{programName}`<br>  * `ERS0065` - The required Program Name Field was empty<br>  * `ERS0066` - The required Program Name Field count exceeds the maximum limit<br>  * `ERS0076` - Client ID and/or Program names are missing in Client Onboard Configuration setup. Contact Citi support .<br>  * `ERC0002`  - We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  <br>  * `ERC0003`  - We have encountered an error and couldn''t receive your request. Please try again, or contact Citi support if you have any further questions or comments<br>  * `MS0003` - There was a problem retrieving the funding source data for Program Name: `{programName}`<br>  * `MS0004` - There was a problem retrieving ID provisioning data for Program Name: `{programName}`<br>  * `MS0005` - There was a problem retrieving the supplier data for the given Program Name: `{programName}`<br>  * `MS0006` - Invalid vcaId value.<br>  * `GRC0002`  - Client ID is missing in the request header<br>  <br>  * `GRC0003`  - Country code is not available in the request<br>  <br>  * `GRC0004`  - Region ID is not available in the request<br>  <br>  * `GRC0007`  - Client requested MediaType is not supported.<br>  <br><br>  * `GRC0011`  - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.<br>  <br>  * `GRC0012`  - Necessary header value is missing<br>  <br>  * `GRC0013`  - Invalid JSON Input<br>'
          example: Country code is not available in the request
    PurchaseTemplates:
      type: object
      properties:
        templateId:
          type: integer
          format: int64
          description: Identifies the template id that was setup in the VCA system and that should be used for this virtual card.
          example: 24694
        templateName:
          type: string
          description: Identifies the template name that was setup in the VCA system and that should be used for this virtual card.
          example: GRACE Test Template 2
        templateDescription:
          type: string
          description: Identifies the template description that was setup in the VCA system and that should be used for this virtual card.
          example: GRACE Test Template 2
    PaymentBeneficiaryDetails:
      type: object
      properties:
        paymentBeneficiaryId:
          type: integer
          format: int64
          description: Uniquely identifies the payment beneficiary id for which the virtual card is created.
          example: 20122
        paymentBeneficiaryName:
          type: string
          description: Uniquely identifies the payment beneficiary name for which the virtual card is created.
          example: Test Company Supplier 2
    IdProvRequest:
      type: object
      properties:
        programName:
          type: array
          description: '`Company Name` as defined in the virtual cards system'
          items:
            type: string
          maxItems: 5
          minItems: 1
          example:
          - CITIBANK NA SINGAPORE VCN
        messageId:
          type: string
          description: 'Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.<br><br>`Rules:`<br><br>* Position 1- 4: Always "CITI"<br><br>* Position 5-8 : unique identifier for the client. This 4 character to be decided by Citi during client integration<br><br>* Position 9 - 24: Timestamp including milliseconds<br><br>* Position 25 - 28: Randomly generated value from the client<br><br>* Position 29 - 36: To be reserved for future use'
          minLength: 28
          maxLength: 36
          example: KN98420IdProvIDKNAM1647511593723
    CustomReferenceData:
      properties:
        customReferenceLabel:
          type: string
          format: alphanumeric
          example: Invoice Number
          description: Name of the custom field
          maxLength: 50
        customReferenceValue:
          type: string
          format: alphanumeric
          example: '123456'
          description: Value of the custom field
          maxLength: 80
        customReferenceMaxLength:
          type: string
          format: numeric
          example: '64'
          description: Maximum length of the custom field
          maxLength: 5
        customReferenceDisplayType:
          type: string
          format: alphanumeric
          example: Text
          description: Display type of the custom field<br>Possible Values<br>Text<br>List
          maxLength: 4
        customReferenceDataType:
          type: string
          format: alphanumeric
          example: Alphanumeric
          description: Data type of the custom field.
          maxLength: 50
        customReferenceDataRequired:
          type: string
          format: alphanumeric
          example: N
          description: Whether the custom field is required or not.<br>Possible Values<br>"Y" - Yes<br>"N" - No
          maxLength: 1
    PurchaseType:
      required:
      - mcc
      - mccDescription
      properties:
        mcc:
          type: string
          format: alphanumeric
          example: '30001'
          description: Merchant Category Code used in the template
          maxLength: 4
        mccDescription:
          type: string
          format: alphanumeric
          example: AMERICAN AIRLINES
          description: Merchant Category Code description
          maxLength: 200
    PurchaseTemplateInboundPartialResponse:
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/Templates'
    Templates:
      required:
      - mccGrouping
      - mvcaEnabled
      - purchaseType
      - templateDescription
      - templateId
      - templateName
      - templateType
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/RespCodes'
        templateId:
          type: string
          format: alphanumeric
          example: '36091'
          description: Identifies the template that was setup in the VCA system. <br>The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
          maxLength: 19
        templateName:
          type: string
          format: alphanumeric
          example: Airline Purchases
          description: Identifies the template name that was setup in the VCA system and that should be used for this virtual card
          maxLength: 200
        templateDescription:
          type: string
          format: alphanumeric
          example: Template for making arline purchases
          description: Description of the template.
          maxLength: 500
        templateType:
          type: string
          format: alphanumeric
          example: PC
          description: Type of the template
          maxLength: 20
        mvcaEnabled:
          type: string
          format: boolean
          example: 'true'
          description: Template enabled for mvca.
        purchaseType:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseType'
        templateControl:
          type: array
          description: Spending control available in the template to use
          items:
            $ref: '#/components/schemas/TemplateControl'
        mccGrouping:
          type: string
          format: alphanumeric
          example: Airlines
          description: Name of Merchant Category Code grouping set on purchase template
          maxLength: 200
        customReferenceData:
          type: array
          items:
            $ref: '#/components/schemas/CustomReferenceData'
    RespCodes:
      required:
      - errorCode
      - errorDescription
      properties:
        errorCode:
          type: string
          format: alphanumeric
          example: MS0007
          description: which indicates the error code
          maxLength: 30
        errorDescription:
          type: string
          format: alphanumeric
          example: 'There was a problem retrieving the purchase template list for Purchase Template ID: {templateId}'
          description: which indicates the error description
          maxLength: 300
    ResponseCodes:
      required:
      - errorCode
      - errorDescription
      properties:
        errorCode:
          type: string
          format: alphanumeric
          example: ERS0065
          description: which indicates the error code
          maxLength: 30
        errorDescription:
          type: string
          format: alphanumeric
          example: The required Program Name Field was empty
          description: which indicates the error description
          maxLength: 300
    ResponseCode500:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseCode'
    PurchaseTemplateInboundSuccessResponse:
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/Templates2'
    PurchaseTemplateInboundRequest:
      required:
      - programName
      properties:
        programName:
          type: string
          format: alphanumeric
          example: VCA Program NAM
          description: Company Name as defined in the virtual cards system
          maxLength: 200
        templateId:
          type: array
          example: '["36091"]'
          description: Identifies the template that was setup in the VCA system. <br>The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.<br><br>If templateId is included in the request, then purchase template details will be returned only for that purchase template. If templateId is not included in the request, then purchase template details will be returned for all that purchase templates under the VCA program
          items:
            type: string
    Templates2:
      required:
      - mccGrouping
      - mvcaEnabled
      - purchaseType
      - templateDescription
      - templateId
      - templateName
      - templateType
      properties:
        templateId:
          type: string
          format: alphanumeric
          example: '36091'
          description: Identifies the template that was setup in the VCA system. <br>The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
          maxLength: 19
        templateName:
          type: string
          format: alphanumeric
          example: Airline Purchases
          description: Identifies the template name that was setup in the VCA system and that should be used for this virtual card
          maxLength: 200
        templateDescription:
          type: string
          format: alphanumeric
          example: Template for making arline purchases
          description: Description of the template.
          maxLength: 500
        templateType:
          type: string
          format: alphanumeric
          example: PC
          description: Type of the template
          maxLength: 20
        mvcaEnabled:
          type: string
          format: boolean
          example: 'true'
          description: Template enabled for mvca.
        purchaseType:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseType'
        templateControl:
          type: array
          description: Spending control available in the template to use
          items:
            $ref: '#/components/schemas/TemplateControl'
        mccGrouping:
          type: string
          format: alphanumeric
          example: Airlines
          description: Name of Merchant Category Code grouping set on purchase template
          maxLength: 200
        customReferenceData:
          type: array
          items:
            $ref: '#/components/schemas/CustomReferenceData'
    ResponseCodes400:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseCodes'
    TemplateControl:
      required:
      - controlCode
      - controlDescription
      properties:
        controlCode:
          type: string
          format: alphanumeric
          example: VL
          description: 2-character code of the template control name. Decides the type of control to use to create a purchase request.<br><br>Possible Values<br>AR (Amount range control)<br>CU (Curfew control)<br>GE (Geography control)<br>MA (Merchant amount control)<br>MI Merchant ID control)<br>TD (Time of day control)<br>TL (Transaction limit control)<br>VA (Validity period control)<br>VG (Aging velocity control)<br>VL (Velocity control)
          maxLength: 2
        controlDescription:
          type: string
          format: alphanumeric
          example: Velocity
          description: Template control description
          maxLength: 50
    ResponseCode:
      properties:
        errorCode:
          type: string
          example: GRC0014
          description: which indicates the error code
        errorDescription:
          type: string
          example: We have encountered an error and couldnot receive your request. Please try again, or contact Citi support if you have any further questions or comments
          description: which indicates the error description
    ErrorMessage:
      required:
      - errorCode
      - errorDescription
      properties:
        errorCode:
          type: string
          enum:
          - EVB0700
          - EVB0701
          - EVB0702
          - EVB0703
          - EVB0704
          - EVB0705
          - EVB0706
          - EVB0707
          - EVB0708
          - EVB0709
          - EVB0710
          - EVB0711
          - EVB0712
          - EVB0713
          - EVB0714
          - EVB0715
          - EVB0716
          - EVB0717
          - EVB0718
          - EVB0719
          - EVB0720
          - EVB0721
          - EVB0722
          - EVB0723
          - EVB0724
          - EVB0725
          - GRC0005
          - GRC0010
          - GRC0003
          - GRC0016
          - EVB0357
          - EVB0201
          - EVB0066
          - EVB0726
          - EVB0727
          - EVB0728
        errorDescription:
          type: string
          description: "The error description that corresponds to error code when there is any<br>               error occurred while retrieving the trsansaction.            <br>            <br>              * `EVB0700` - subscriptionName is Mandatory<br>              * `EVB0701` - subscriptionName length should contain a min of 1 character and a max of 50 characters<br>              * `EVB0702` - subscriptionName field is invalid and can only have letters, numbers, dashes and underscores<br>              * `EVB0703` - active is Mandatory<br>              * `EVB0704` - operator field is Mandatory<br>              * `EVB0705` - WHERE operator can only be used in the first subscription.operator field, other subscription.operator fields should use only OR operator<br>              * `EVB0706` - fieldName is Mandatory<br>              * `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<br>              * `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<br>              * `EVB0709` - fieldName should contain a min of 1 character and a max of 30 characters<br>\t\t\t  * `EVB0710` - fieldOperator is Mandatory<br>              * `EVB0711` - subscription.expectedContent.contentType must have a value of INTEGER when subscription.fieldName value equal \"programId\"<br>              * `EVB0712` - expectedContent.contentType is Mandatory<br>              * `EVB0713` - expectedContent.contentType length should contain a min of 1 character and a max of 7 characters<br>              * `EVB0714` - subscription.expectedContent.contentType is invalid and can only have a value of INTEGER for the EQUALS operator<br>\t\t\t  * `EVB0715` - expectedContent.value is Mandatory<br>              * `EVB0716` - expectedContent.value must only contain letters, digits, spaces, hyphens, slashes, commas, periods and underscores<br>              * `EVB0717` - children.operator is invalid and can only have a value of AND, OR<br>\t\t\t  * `EVB0718` - Invalid value for the field children.fieldName<br>              * `EVB0719` - Invalid value for the field children.fieldName. children.fieldName cannot contain a value of programId<br>\t\t\t  * `EVB0720` - children.fieldOperator is invalid and can only have a value of EQUALS<br>              * `EVB0721` - children.expectedContent.contentType can only have a value of TEXT when the children.fieldOperator field is EQUALS<br>              * `EVB0722` - children.expectedContent.contentType must have a value of TEXT when children.fieldName value is \"fundingSourceName\"<br>              * `EVB0723` - children.expectedContent.contentType must have a value of TEXT when children.fieldName value is \"messageTypeIndicator\"<br>\t\t\t  * `EVB0724` - children.expectedContent.contentType must have a value of TEXT  when children.fieldName value is \"authorizationResponseDetail\"<br>\t\t\t  * `EVB0725` - children.expectedContent.contentType must have a value of TEXT when children.fieldName value is \"vcaAuthorizationResponseDetail\"<br>\t\t\t  * `GRC0005` - Client Tracking ID is missing in the request header<br>\t\t\t  * `GRC0010` - Client Tracking ID length should contain a min of 1 character and a max of 36 characters<br>\t\t\t  * `GRC0003` - Invalid JSON input<br>\t\t\t  * `GRC0016` - Country code is not available in the request<br>\t\t\t  * `EVB0357` - ProgramId must be numeric<br>\t\t\t  * `EVB0201` - We were unable to process your request. Please try again, or contact Citi support if you have any further questions or comments.<br>\t\t\t  * `EVB0066` - ClientId and programId combination is not valid<br>\t\t\t  * `EVB0726` - subscriptionId length should contain a min of 1 character and a max of 255 characters<br>\t\t\t  * `EVB0727` - No subscription found for the specified subscription ID<br>\t\t\t  * `EVB0728` - This subscription name is already registered for this subscriber"
    Children:
      required:
      - expectedContent
      - fieldName
      - fieldOperator
      - operator
      properties:
        operator:
          type: string
          format: alpha
          example: WHERE
          description: 'Specify an operator to combine multiple conditions in the specifications.<br>* WHERE: By default, the first condition in the specifications should always have this value to represent the WHERE clause.<br>* AND: Use this in the second condition onwards to create notifications only if all specifications conditions are true.<br>* OR: Use this in the second condition onwards to create notifications if one of the specifications conditions is true.'
          maxLength: 5
        fieldName:
          type: string
          format: alpha
          example: purchaseRequest.rcnAlias
          description: Specifies the field name for the condition to check. This is used in conjunction with the fieldOperator.programId is a required field in order to create a subscription<br><br> Possible values:<br>"fundingSourceName" - Funding source name<br>"messageTypeIndicator" - Message type indicator<br>"authorizationResponseDetail" - Response code<br>"vcaAuthorizationResponseDetail" - In Control VCN service result code
          maxLength: 30
        fieldOperator:
          type: string
          format: alpha
          example: EQUALS
          description: 'Specify the relational operator to use in the condition for the fieldName. This is used in conjunction with the expectedContent.<br> <br> Possible values:<br>"EQUALS": This applies to contentType "TEXT" and "INTEGER". Create notifications for the exact fieldName value specified in the condition.'
          maxLength: 12
        expectedContent:
          $ref: '#/components/schemas/FieldContent'
        children:
          type: array
          description: Used to define specifications with nested conditions for a subscription.
          items:
            $ref: '#/components/schemas/Children'
    SubscriptionResponse:
      properties:
        subscriptionId:
          type: string
          format: alphanumeric
          example: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724070
          description: System generated unique identifier for a subscription, which is returned in the create subscription call. Access the individual subscription using its id to update, get details or delete a subscription permanently.
          minLength: 1
          maxLength: 255
        subscriptionName:
          type: string
          format: alphanumeric
          example: Enter_unique_subscription_name_here
          description: Unique name for the subscription. It can include upper and lowercase alphabets, numbers, dashes and underscores.
          minLength: 1
          maxLength: 50
        active:
          type: boolean
          format: alpha
          example: true
          description: Specify whether the subscription should be active (true ) or inactive (false) for the API to create notifications only if the subscription is active.
        subscription:
          type: array
          description: Alert subscription conditions to filter the payment authorization messages.
          items:
            $ref: '#/components/schemas/Subscription'
    SubscriptionRequest:
      required:
      - active
      - subscription
      - subscriptionName
      properties:
        subscriptionName:
          type: string
          format: alphanumeric
          example: Subscription_test-1654530803985
          description: Unique name for the subscription. It can include upper and lowercase alphabets, numbers, dashes and underscores.
          maxLength: 50
        active:
          type: boolean
          format: alpha
          example: true
          description: Specify whether the subscription should be active (true ) or inactive (false) for the API to create notifications only if the subscription is active.
        subscription:
          type: array
          description: Alert subscription conditions to filter the payment authorization messages
          items:
            $ref: '#/components/schemas/Subscription'
    FieldContent:
      required:
      - contentType
      - value
      properties:
        contentType:
          type: string
          format: alphanumeric
          description: Specify the type of the fields value - TEXT or INTEGER for the EQUALS operator and INTEGER for the rest.
        value:
          type: string
          format: alphanumeric
          example: Travel Expense RCN
          description: Specify a value for a fieldName
    SubscriptionFailureResponse:
      properties:
        errorMessage:
          type: array
          items:
            $ref: '#/components/schemas/ErrorMessage'
    Subscription:
      required:
      - expectedContent
      - fieldName
      - fieldOperator
      - operator
      properties:
        operator:
          type: string
          format: alpha
          example: WHERE
          description: 'Specify an operator to combine multiple conditions in the specifications.<br>* WHERE: By default, the first condition in the specifications should always have this value to represent the WHERE clause.<br>* AND: Use this in the second condition onwards to create notifications only if all specifications conditions are true.<br>* OR: Use this in the second condition onwards to create notifications if one of the specifications conditions is true.'
          maxLength: 5
        fieldName:
          type: string
          format: alpha
          example: purchaseRequest.rcnAlias
          description: Specifies the field name for the condition to check. This is used in conjunction with the fieldOperator.programId is a required field in order to create a subscription<br><br> Possible values:<br>"programId" - VCA program ID. By default, the first condition in the specifications should always have this value in conjunction with the WHERE operator.
          maxLength: 30
        fieldOperator:
          type: string
          format: alpha
          example: EQUALS
          description: 'Specify the relational operator to use in the condition for the fieldName. This is used in conjunction with the expectedContent.<br> <br> Possible values:<br>"EQUALS": This applies to contentType "TEXT" and "INTEGER". Create notifications for the exact fieldName value specified in the condition.'
          maxLength: 12
        expectedContent:
          $ref: '#/components/schemas/FieldContent'
        children:
          type: array
          description: Used to define specifications with nested conditions for a subscription.
          items:
            $ref: '#/components/schemas/Children'
    VcaFailureResponse:
      type: object
      properties:
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        vcaId:
          type: number
          description: A reference number that uniquely identifies the virtual card account.
        errorMessage:
          type: array
          items:
            $ref: '#/components/schemas/ErrorMessage_2'
    CreateVirtualCardRequest:
      type: object
      properties:
        fundingSourceId:
          type: string
          description: Unique identifier of the funding source to which the virtual card rolls up
          example: 8675309,
        fundingSourceName:
          type: string
          description: Descriptive name of the real card to which the virtual card rolls up
          example: CITIBANK NA SINGAPORE VCN 2
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system
          example: 211212,
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration
          example: '1234567890123456789012345678'
        mccGrouping:
          type: string
          description: Limits authorizations to defined Merchant Category Codes.
          example: All MCCs
        getCardImage:
          type: boolean
          description: '* Specifies whether cardImage field needs to be included in the response or not.


            * True = cardImage field will be sent in the response

            * False = cardImage field will not be sent in the response.

            * `Optional field` if not included, cardImage will be sent in the response.'
        currencyCode:
          type: string
          description: Currency Code in which VCA amounts are expressed
          example: 008
        currencyType:
          type: string
          description: Defines the type of the VCA currency. - Value B stands for Billing Currency which indicates that the VCA currency is equal to the billing currency of the underlying funding source. - Value M stands for Merchant Currency which indicates that the VCA currency is expressed in merchant currency and not in billing currency.
          example: B
        timeZone:
          type: string
          description: Defines the time zone applicable for any date or time parameters within controls set for a VCA.If any of the following controls are used, timeZone is required:Validity Period Control,Aging Velocity Control (Mastercard only), Curfew Control and Time of Day Control.It sets the specific timeframe when the account and its controls will become active.
          example: UTC+02:00
        paymentBeneficiaryId:
          type: number
          description: Uniquely identifies the payment beneficiary for which the virtual card is created
          example: 18690,
        paymentBeneficiaryEmails:
          type: string
          description: Lists the email addresses to which the virtual card details should be sent to.In order for emails to get delivered, the following two settings must be enabled in the VCA system:1. Allow VCN details to be emailed to this supplier2. Allow VCN requestor to manually enter a new email address when requesting a VCN
          example: nagara.harikrishnareddy@citi.com
        customReference:
          type: array
          items:
            $ref: '#/components/schemas/CustomReference'
        templateId:
          type: number
          description: Identifies the template that was setup in the VCA system and that should be used for this virtual card.The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
          example: 337561,
        expiryDate:
          type: string
          description: 'Expiry Date of the virtual card account. '
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: Limits the overall amount spend on the virtual card account.
        enableSpendVelocity:
          type: boolean
          description: 'Limits the frequency and total cumulative amount of authorizations performed on the VCA within a specified period. Mastercard: The control is mandatory unless Aging Velcotiy Control is used. This control cannot be used in combination with the Aging Velocity Control.Visa: Spend Velocity Control is mandatory.'
          example: true,
        spendVelocity:
          type: array
          items:
            $ref: '#/components/schemas/SpendVelocityRequest'
          example: maxAuth
        enableValidityPeriodControl:
          type: boolean
          description: 'Limits authorization activity to a specific time period. '
          example: true,
        validityStartDate:
          type: string
          description: Identifies the date from which the virtual card account can be used for transactions.
          example: '2020-09-18'
        validityEndDate:
          type: string
          description: Identifies the date until which the virtual card account can be used for transactions.
          example: '2020-09-23'
        enableAmountRangeControl:
          type: boolean
          description: Approves a transaction only if the requested amount for authorization is equal to or greater than the Minimum Amount and less than or equal to the Maximum Amount.
          example: true,
        maxAmount:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        minAmount:
          type: number
          format: bigdecimal
          description: Identifies the minimum allowed transaction amount.
        enableTransactionLimitControl:
          type: boolean
          description: Limits individual transactions to a maximum amount.
        amountLimit:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        enableCurfewControl:
          type: boolean
          description: Limits authorization activity to a single time period for each day selected.
        curfewTime:
          $ref: '#/components/schemas/CurfewTime'
        enableTimeOfDayControl:
          type: boolean
          description: Limits authorization request to defined time periods each day
        timeOfDay:
          type: array
          items:
            $ref: '#/components/schemas/TimeOfDay'
        enableAgingVelocityControl:
          type: boolean
          description: Sets a cumulative amount and keeps track of the current remaining balance. Allows the requester to 'age off' approved authorization requests that have not been cleared by the merchant after a defined number of days.
        authorizationHoldDays:
          type: number
          format: long
          description: Identifies the number of days after which an authorization gets aged off if no matching clearing record was received.
        enableGeographyControl:
          type: boolean
          description: Limits authorization requests to a defined geographic location.
        countryCodes:
          type: array
          description: Defines the merchant country in which the VCA can be used.
          items:
            type: string
        allowed:
          type: boolean
          description: Indicate whether the values in countryCode are allowed or disallowed
        enableMerchantIdControl:
          type: boolean
          description: Limits authorizations to a particular merchant using the Merchant ID and Acquirer ID (Mastercard) or Card Acceptor ID (Visa).
        merchantId:
          $ref: '#/components/schemas/MerchantIdRequest'
    CurfewTime:
      type: object
      properties:
        startTime:
          type: string
          description: 'Specifies the start time from when the card can be used each of the specified days.<br>`Visa`: 24-hour format of HH:MM and the minutes digit must be populated with zero only'
          example: '12:30'
        endTime:
          type: string
          description: 'Specifies the end time until which the card can be used each of the specified days.<br>`Visa`: 24-hour format of HH:MM and the minutes digit must be populated with zero only'
          example: '13:30'
        weekdaysEffective:
          type: array
          description: Specifies the day applicable to the start and end times defined.
          items:
            type: string
          example:
          - MON
          - TUE
          - FRI
    ModifyVirtualCardResponse:
      type: object
      properties:
        vcaId:
          type: string
          description: A reference number that uniquely identifies the virtual card account.
        cardImage:
          type: string
          description: A visual representation of the virtual card account front and back.
        currencyCode:
          type: string
          description: Currency Code in which VCA amounts are expressed.
        timeZone:
          type: string
          description: Defines the time zone applicable for any date or time parameters within controls set for a VCA.
        virtualCardAccountNumber:
          type: string
          description: The virtual card account number to use for transactions.
        expiryDate:
          type: string
          description: 'Expiry Date of the virtual card account. '
        securityCode:
          type: string
          description: The security code (i.e. cvv) corresponding to the virtual card accunt.
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
        mccGrouping:
          type: string
          description: Limits authorizations to defined Merchant Category Codes.
        currencyType:
          type: string
          description: Defines the type of the VCA currency. - Value B stands for Billing Currency which indicates that the VCA currency is equal to the billing currency of the underlying funding source. - Value M stands for Merchant Currency which indicates that the VCA currency is expressed in merchant currency and not in billing currency.
        paymentBeneficiaryId:
          type: number
          description: Uniquely identifies the payment beneficiary for which the virtual card is created.
        paymentBeneficiaryEmails:
          type: string
          description: Specifies up to five email addresses to which the virtual card account details should be delivered. Email addresses specified in the request will not override any default email addresses specified in the virtual card application.
        customReference:
          type: array
          items:
            $ref: '#/components/schemas/CustomReference'
        templateId:
          type: number
          description: Identifies the template that was setup in the VCA system and that should be used for this virtual card.The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: 'Limits the overall amount spend on the virtual card account. '
        modifySpendVelocity:
          type: boolean
          description: Limits the frequency and total cumulative amount of authorizations performed on the VCA within a specified period.
        spendVelocity:
          type: array
          items:
            $ref: '#/components/schemas/SpendVelocityResponse'
        modifyValidityPeriodControl:
          type: boolean
          description: 'Limits authorization activity to a specific time period. '
        validityStartDate:
          type: string
          description: Identifies the date from which the virtual card account can be used for transactions.
        validityEndDate:
          type: string
          description: Identifies the date until which the virtual card account can be used for transactions.
        modifyAmountRangeControl:
          type: boolean
          description: Approves a transaction only if the requested amount for authorization is equal to or greater than the Minimum Amount and less than or equal to the Maximum Amount.
        maxAmount:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        minAmount:
          type: number
          format: bigdecimal
          description: Identifies the minimum allowed transaction amount.
        modifyTransactionLimitControl:
          type: boolean
          description: Limits individual transactions to a maximum amount.
        amountLimit:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        modifyCurfewControl:
          type: boolean
          description: Limits authorization activity to a single time period for each day selected.
        curfewTime:
          $ref: '#/components/schemas/CurfewTime'
        modifyTimeOfDayControl:
          type: boolean
          description: 'Limits authorization request to defined time periods each day. '
        timeOfDay:
          type: array
          items:
            $ref: '#/components/schemas/TimeOfDay'
        modifyAgingVelocityControl:
          type: boolean
          description: Sets a cumulative amount and keeps track of the current remaining balance. Allows the requester to age off approved authorization requests that have not been cleared by the merchant after a defined number of days.
        authorizationHoldDays:
          type: number
          format: long
          description: Identifies the number of days after which an authorization gets aged off if no matching clearing record was received.
        modifyGeographyControl:
          type: boolean
          description: 'Limits authorization requests to a defined geographic location. '
        countryCodes:
          type: array
          description: Defines the merchant country in which the VCA can be used.
          items:
            type: string
        allowed:
          type: boolean
          description: Indicate whether the values in countryCode are allowed or disallowed
        modifyMerchantIdControl:
          type: boolean
          description: Limits authorizations to a particular merchant using the Merchant ID and Acquirer ID (Mastercard) or Card Acceptor ID (Visa).
        merchantInfo:
          type: array
          items:
            $ref: '#/components/schemas/MerchantIdResponse'
    MerchantIdResponse:
      type: object
      properties:
        allowed:
          type: boolean
          description: Indicate whether the values in merchantId and acquirerId are allowed or disallowed.True = values provided in merchantId and acquirerId are allowed,False = values provided in merchantId and acquirerId are not allowed
        cardAcceptorId:
          type: string
          description: Specifies the Card Acceptor ID that should be allowed / disallowed when transacting with the virtual card
        merchantIds:
          type: array
          items:
            $ref: '#/components/schemas/MerchantId'
    MerchantId:
      type: object
      properties:
        merchantId:
          type: string
          description: Specifies the Merchant ID that should be allowed / disallowed when transacting with the virtual card. Must always be provided in combination with a Acquirer ID.
        acquirerId:
          type: integer
          format: int64
          description: Specifies the Acquirer ID that should be allowed / disallowed when transacting with the virtual card. Must always be provided in combination with a Merchant ID.
    CustomReference:
      type: object
      properties:
        customReferenceValue:
          type: string
          description: 'Specifies the label of a custom reference field.Mastercard: All field labels included in the template used for this virtual card account request should be included.'
        customReferenceLabel:
          type: string
          description: "Specifies the value of a custom reference field. Mastercard: If the template used for this VCA request identifies a given custom reference field as required, then the value provided in this field cannot be blank.\n`For Entity Customer:` </br>\n\n* `VCA PI Identifier` - `Optional`: Defulted as  'MC_VCAPI'.  \n* `Entity Type` - `Mandatory`: Indicates whether the VCA is being created for an Entity or an Individual. </br></br>Possible values: 'E' - Entity.\n* `Last Name` - `Mandatory`: Entity Name and the length should not exceed 80 characters.\n* `Primary Address Line 1` - `Mandatory`:  Individual /Business street address line 1 of the applicant. Length should not exceed 35 characters.\n* `Primary Address Line 2` - `Optional`: Individual /Business street address line 2 of the applicant. The length should not exceed 35 characters.\n* `ZIP code` -`Mandatory`: \tIndividual /business address post code of the applicant. The length should not exceed 35 characters.\n* `City` - `Mandatory`: Individual /business address City of the applicant. The length should not exceed 35 characters.\n* `State Or Province` - `Mandatory`: Individual /business address State or Province  of the applicant. The length should not exceed 35 characters.\n* `Address Country` - `Mandatory`: 3-byte ISO country code. The length should not exceed 3 characters.\n* `Country of Incorporation or Nationality` - `Mandatory`: 3-byte ISO country code. The length should not exceed 3 characters.\n* `PI Client Name` - `Mandatory`: \t Payment Intermediatory Client Name and the length should not exceed 2 characters.\n\n\n`For Individual/Personal Customer:` </br>\n* `VCA PI Identifier` - `Optional`: Defulted as  'MC_VCAPI'.  \n* `Entity Type` - `Mandatory`: Indicates whether the VCA is being created for an Entity or an Individual. <br><br>Possible values: 'E' - Entity.\n* `Last Name` - `Mandatory`: Entity Name and the length should not exceed 80 characters.\n* `Primary Address Line 1` - `Mandatory`:  Individual /Business street address line 1 of the applicant. Length should not exceed 35 characters.\n* `Primary Address Line 2` - `Optional`: Individual /Business street address line 2 of the applicant. The length should not exceed 35 characters.\n* `ZIP code` -`Mandatory`: \tIndividual /business address post code of the applicant. The length should not exceed 35 characters.\n* `City` - `Mandatory`: Individual /business address City of the applicant. The length should not exceed 35 characters.\n* `State Or Province` - `Mandatory`: Individual /business address State or Province  of the applicant. The length should not exceed 35 characters.\n* `Address Country` - `Mandatory`: 3-byte ISO country code. The length should not exceed 3 characters.\n* `Country of Incorporation or Nationality` - `Mandatory`: 3-byte ISO country code. The length should not exceed 3 characters.\n* `PI Client Name` - `Mandatory`: \t Payment Intermediatory Client Name and the length should not exceed 2 characters.\n\n* `First Name` - `Mandatory` :  First name of Individual and the length should not exceed 80 characters.\n* `ID Number` - `Mandatory` :  Value of ID - The length should not exceed 80 characters.\n\n `For Example`: Drivers License Number, SSN, TIN, Alien Registration Number, National Id, etc.\n\n* `Passport Number` - `Mandatory` :  Passport ID. The length should not exceed 80 characters.\n* `Date of Birth` - `Mandatory` :  `Format`: YYYY-MM-DD. </br>The length should not exceed 80 characters.\n* `Place of Birth` - `Mandatory` :  The length should not exceed 80 characters."
    SpendVelocityRequest:
      type: object
      properties:
        maxAuth:
          type: number
          format: long
          description: Limits the number of authorizations that can be made with a VCA. Should be set to 1, if a single-use VCA is created. Specify any value larger than one for a multi-use VCA. Set to 0, if unlimited authorizations should be allowed.
          example: 5,
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: Limits the overall amount spend on the virtual card account.
          example: 2000,
        periodType:
          type: string
          description: Period for which the control values are valid before they reset
          example: C
    MerchantIdRequest:
      type: object
      properties:
        allowed:
          type: boolean
          description: Indicate whether the values in merchantId and acquirerId are allowed or disallowed.True = values provided in merchantId and acquirerId are allowed,False = values provided in merchantId and acquirerId are not allowed
        cardAcceptorId:
          type: string
          description: Specifies the Card Acceptor ID that should be allowed / disallowed when transacting with the virtual card
    VcaResponse:
      type: object
      properties:
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        vcaId:
          type: number
          description: A reference number that uniquely identifies the virtual card account.
          example: 5070616
    ModifyVirtualCardRequest:
      type: object
      properties:
        vcaId:
          type: number
          description: 'A reference number that uniquely identifies the virtual card account. '
        fundingSourceId:
          type: string
          description: Unique identifier of the funding source to which the virtual card rolls up
        fundingSourceName:
          type: string
          description: Descriptive name of the real card to which the virtual card rolls up
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration
        mccGrouping:
          type: string
          description: Limits authorizations to defined Merchant Category Codes.
        getCardImage:
          type: boolean
          description: '* Specifies whether cardImage field needs to be included in the response or not.


            * True = cardImage field will be sent in the response

            * False = cardImage field will not be sent in the response.

            * `Optional field` if not included, cardImage will be sent in the response.'
        currencyCode:
          type: string
          description: Currency Code in which VCA amounts are expressed
        currencyType:
          type: string
          description: Defines the type of the VCA currency. - Value B stands for Billing Currency which indicates that the VCA currency is equal to the billing currency of the underlying funding source. - Value M stands for Merchant Currency which indicates that the VCA currency is expressed in merchant currency and not in billing currency.
        timeZone:
          type: string
          description: Defines the time zone applicable for any date or time parameters within controls set for a VCA.If any of the following controls are used, timeZone is required:Validity Period Control,Aging Velocity Control (Mastercard only), Curfew Control and Time of Day Control.It sets the specific timeframe when the account and its controls will become active.
        paymentBeneficiaryId:
          type: number
          description: Uniquely identifies the payment beneficiary for which the virtual card is created
        paymentBeneficiaryEmails:
          type: string
          description: Lists the email addresses to which the virtual card details should be sent to.In order for emails to get delivered, the following two settings must be enabled in the VCA system:1. Allow VCN details to be emailed to this supplier2. Allow VCN requestor to manually enter a new email address when requesting a VCN
        customReference:
          type: array
          items:
            $ref: '#/components/schemas/CustomReference'
        templateId:
          type: number
          description: Identifies the template that was setup in the VCA system and that should be used for this virtual card.The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
        expiryDate:
          type: string
          description: 'Expiry Date of the virtual card account. '
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: Limits the overall amount spend on the virtual card account.
        maxAuth:
          type: number
          format: long
          description: 'Limits the number of authorizations that can be made with a VCA. Should be set to 1, if a single-use VCA is created.Specify any value larger than one for a multi-use VCA. Mastercard: Set to 0, if unlimited authorizations should be allowed. (0 is not applicable for Visa)'
        modifySpendVelocity:
          type: boolean
          description: 'Limits the frequency and total cumulative amount of authorizations performed on the VCA within a specified period. Mastercard: The control is mandatory unless Aging Velcotiy Control is used. This control cannot be used in combination with the Aging Velocity Control.Visa: Spend Velocity Control is mandatory.'
        spendVelocity:
          type: array
          items:
            $ref: '#/components/schemas/SpendVelocityRequest'
        modifyValidityPeriodControl:
          type: boolean
          description: 'Limits authorization activity to a specific time period. '
        validityStartDate:
          type: string
          description: Identifies the date from which the virtual card account can be used for transactions.
        validityEndDate:
          type: string
          description: Identifies the date until which the virtual card account can be used for transactions.
        modifyAmountRangeControl:
          type: boolean
          description: Approves a transaction only if the requested amount for authorization is equal to or greater than the Minimum Amount and less than or equal to the Maximum Amount.
        maxAmount:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        minAmount:
          type: number
          format: bigdecimal
          description: Identifies the minimum allowed transaction amount.
        modifyTransactionLimitControl:
          type: boolean
          description: Limits individual transactions to a maximum amount.
        amountLimit:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        modifyCurfewControl:
          type: boolean
          description: Limits authorization activity to a single time period for each day selected.
        curfewTime:
          $ref: '#/components/schemas/CurfewTime'
        modifyTimeOfDayControl:
          type: boolean
          description: Limits authorization request to defined time periods each day
        timeOfDay:
          type: array
          items:
            $ref: '#/components/schemas/TimeOfDay'
        modifyAgingVelocityControl:
          type: boolean
          description: Sets a cumulative amount and keeps track of the current remaining balance. Allows the requester to 'age off' approved authorization requests that have not been cleared by the merchant after a defined number of days.
        authorizationHoldDays:
          type: number
          format: long
          description: Identifies the number of days after which an authorization gets aged off if no matching clearing record was received.
        modifyGeographyControl:
          type: boolean
          description: Limits authorization requests to a defined geographic location.
        countryCodes:
          type: array
          description: Defines the merchant country in which the VCA can be used.
          items:
            type: string
        allowed:
          type: boolean
          description: Indicate whether the values in countryCode are allowed or disallowed
        modifyMerchantIdControl:
          type: boolean
          description: Limits authorizations to a particular merchant using the Merchant ID and Acquirer ID (Mastercard) or Card Acceptor ID (Visa).
        merchantId:
          $ref: '#/components/schemas/MerchantIdRequest'
    CancelVirtualCardRequest:
      type: object
      properties:
        vcaIds:
          type: array
          description: Unique Identifier for each Virtual card request.
          example:
          - 6143447
          items:
            type: number
        virtualCardAccountNumber:
          type: string
          description: The virtual card account number for which the modifications are requested.
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
          example: '429777'
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          example: '123456789012345678901234567890'
    TimeOfDay:
      type: object
      properties:
        startTime:
          type: string
          description: Specifies the start time from which the virtual card account can be used on the particular day specified in weekDaysEffective.
        endTime:
          type: string
          description: Specifies the end time until which the virtual card account can be used on the particular day specified in weekDaysEffective.
        weekdayEffective:
          type: string
          description: Specifies the day applicable to the start and end times defined.
    ModifyVirtualCardFailureResponse:
      type: object
      properties:
        vcaId:
          type: string
          description: A reference number that uniquely identifies the virtual card account.
        cardImage:
          type: string
          description: A visual representation of the virtual card account front and back.
        currencyCode:
          type: string
          description: Currency Code in which VCA amounts are expressed.
        timeZone:
          type: string
          description: Defines the time zone applicable for any date or time parameters within controls set for a VCA.
        virtualCardAccountNumber:
          type: string
          description: The virtual card account number to use for transactions.
        expiryDate:
          type: string
          description: 'Expiry Date of the virtual card account. '
        securityCode:
          type: string
          description: The security code (i.e. cvv) corresponding to the virtual card accunt.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorMessage_2'
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
        mccGrouping:
          type: string
          description: Limits authorizations to defined Merchant Category Codes.
        currencyType:
          type: string
          description: Defines the type of the VCA currency. - Value B stands for Billing Currency which indicates that the VCA currency is equal to the billing currency of the underlying funding source. - Value M stands for Merchant Currency which indicates that the VCA currency is expressed in merchant currency and not in billing currency.
        paymentBeneficiaryId:
          type: number
          description: Uniquely identifies the payment beneficiary for which the virtual card is created.
        paymentBeneficiaryEmails:
          type: string
          description: Specifies up to five email addresses to which the virtual card account details should be delivered. Email addresses specified in the request will not override any default email addresses specified in the virtual card application.
        customReference:
          type: array
          items:
            $ref: '#/components/schemas/CustomReference'
        templateId:
          type: number
          description: Identifies the template that was setup in the VCA system and that should be used for this virtual card.The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: 'Limits the overall amount spend on the virtual card account. '
        modifySpendVelocity:
          type: boolean
          description: Limits the frequency and total cumulative amount of authorizations performed on the VCA within a specified period.
        spendVelocity:
          type: array
          items:
            $ref: '#/components/schemas/SpendVelocityResponse'
        modifyValidityPeriodControl:
          type: boolean
          description: 'Limits authorization activity to a specific time period. '
        validityStartDate:
          type: string
          description: Identifies the date from which the virtual card account can be used for transactions.
        validityEndDate:
          type: string
          description: Identifies the date until which the virtual card account can be used for transactions.
        modifyAmountRangeControl:
          type: boolean
          description: Approves a transaction only if the requested amount for authorization is equal to or greater than the Minimum Amount and less than or equal to the Maximum Amount.
        maxAmount:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        minAmount:
          type: number
          format: bigdecimal
          description: Identifies the minimum allowed transaction amount.
        modifyTransactionLimitControl:
          type: boolean
          description: Limits individual transactions to a maximum amount.
        amountLimit:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        modifyCurfewControl:
          type: boolean
          description: Limits authorization activity to a single time period for each day selected.
        curfewTime:
          $ref: '#/components/schemas/CurfewTime'
        modifyTimeOfDayControl:
          type: boolean
          description: 'Limits authorization request to defined time periods each day. '
        timeOfDay:
          type: array
          items:
            $ref: '#/components/schemas/TimeOfDay'
        modifyAgingVelocityControl:
          type: boolean
          description: Sets a cumulative amount and keeps track of the current remaining balance. Allows the requester to age off approved authorization requests that have not been cleared by the merchant after a defined number of days.
        authorizationHoldDays:
          type: number
          format: long
          description: Identifies the number of days after which an authorization gets aged off if no matching clearing record was received.
        modifyGeographyControl:
          type: boolean
          description: 'Limits authorization requests to a defined geographic location. '
        countryCodes:
          type: array
          description: Defines the merchant country in which the VCA can be used.
          items:
            type: string
        allowed:
          type: boolean
          description: Indicate whether the values in countryCode are allowed or disallowed
        modifyMerchantIdControl:
          type: boolean
          description: Limits authorizations to a particular merchant using the Merchant ID and Acquirer ID (Mastercard) or Card Acceptor ID (Visa).
        merchantId:
          type: array
          items:
            $ref: '#/components/schemas/MerchantIdRequest'
    ErrorMessage_2:
      type: object
      properties:
        errorCode:
          type: string
          enum:
          - EVB0014
          - EVB0010
          - EVB0017
          - EVB0018
          - EVB0020
          - EVB0030
          - EVB0033
          - EVB0042
          - EVB0044
          - EVB0032
          - EVB0046
          - EVB0050
          - EVB0053
          - EVB0061
          - EVB0062
          - EVB0063
          - EVB0065
          - EVB0066
          - EVB0070
          - EVB0071
          - EVB0099
          - EVB0106
          - EVB0107
          - EVB0110
          - EVB0113
          - EVB0114
          - EVB0112
          - EVB0120
          - EVB0121
          - EVB0125
          - EVB0126
          - EVB0133
          - EVB0136
          - EVB0137
          - EVB0138
          - EVB0140
          - EVB0143
          - EVB0151
          - EVB0163
          - EVB0170
          - EVB0201
          - EVB0202
          - EVB0213
          - EVB0214
          - EVB0215
          - EVB0217
          - EVB0222
          - EVB0224
          - EVB0241
          - EVB0243
          - EVB0245
          - EVB0251
          - EVB0252
          - EVB0244
          - EVB0246
          - EVB0248
          - EVB0250
          - EVB0041
          - EVB0255
          - EVB0256
          - EVB0257
          - EVB0258
          - EVB0025
          - EVB0260
          - EVB0261
          - EVB0262
          - EVB0264
          - EVB0265
          - EVB0267
          - EVB0270
          - EVB0271
          - EVB0272
          - EVB0273
          - EVB0290
          - EVB0350
          - EVB0351
          - EVB0352
          - EVB0353
          - EVB0354
          - EVB0355
          - EVB0356
          - EVB0359
          - EVB0360
          - EVB0361
          - EVB0362
          - EVB0363
          - EVB0364
          - EVB0365
          - EVB0366
          - EVB0367
          - EVB0368
          - EVB0369
          - EVB0370
          - EVB0371
          - EVB0378
          - EVB0381
          - EVB0401
          - EVB0404
          - EVB0430
          - EVB0431
          - EVB0432
          - EVB0435
          - EVB0436
          - EVB0437
          - EVB0438
          - EVB0406
          - EVB0440
          - EVB0441
          - EVB0530
          - EVB0607
          - EVB0211
          - EVB0212
          - EVB0218
          - EVB0219
          - EVB0230
          - EVB0231
          - EVB0281
          - EVB0232
          - EVB0233
          - EVB0234
          - EVB0235
          - EVB0547
          - EVB0600
          - EVB0601
          - EVB0602
          - EVB0609
          - EVB0610
          - EVB0611
          - EVB0612
          - EVB0613
          - EVB0614
          - EVB0615
          - EVB0616
          - EVB0618
          - EVB0619
          - EVB0620
          - EVB0621
          - EVB0604
          - EVB0605
          - EVB0606
          - EVB502
          - EVB0254
          - EVB0236
          - EVB0237
          - EVB0238
          - EVB0903
          - EVB1300
          - EVB1301
          - EVB1302
          - EVB1303
          - EVB1304
          - EVB1305
          - EVB1306
          - EVB1307
          - EVB1308
          - EVB1309
          - GRC0001
          - GRC0002
          - GRC0003
          - GRC0004
          - GRC0005
          - GRC0006
          - GRC0007
          - GRC0009
          - GRC0011
          - GRC0012
          - GRC0014
          - VCCE0001
          - VCCV0002
          - VCCV0003
          - VCCV0004
          - VCCV0005
          - VCCV0006
          - VCCV0007
          - VCCV0008
          - VCCV0009
          - VCCV0010
          - VCCV0011
          - VCCV0012
          - VCCV0013
          - VCCV0014
          - VCCV0015
          - VCCV0016
          - VCCV0017
          - VCCV0018
          - VCCV0019
          - VCCV0020
          - VCCV0021
          - VCCV0022
          - VCCV0023
          - VCCV0024
          - VCCV0025
          - VCCV0026
          - VCCV0027
          - VCCV0028
          - VCCV0029
          - VCCV0030
          - VCCV0031
          - VCCV0032
          - VCCV0033
          - VCCV0034
          - VCCV0035
          - VCCV0036
          - VCCV0037
          - VCCV0038
        errorDescription:
          type: string
          description: "The error description that corresponds to error code when there is any error occurred while retrieving the trsansaction.\n\n\n  * `EVB0010` - vcaId size must be between 1 and 19 digits\n  \n  * `EVB0014` - vcaId value must be a numeric\n  * `EVB0017` - vcaID is empty or null\n  * `EVB0018` - No previously approved vcaID is present\n  * `EVB0020` - vcaID and programId combination is not present\n  * `EVB0030` - FundingSourceId cannot be modified\n  * `EVB0033` - FundingSourceId is mandatory\n  * `EVB0042` - fundingSourceName is mandatory\n  * `EVB0044` - Funding source Id|Funding source Name|Template Id is not required for cancel request\n  * `EVB0032` - fundingSourceId value must be a numeric\n  * `EVB0046` - FundingSourceName cannot be modified\n  * `EVB0050` - paymentBeneficiaryId cannot be modified\n  * `EVB0053` - paymentBeneficiaryEmails must be alphanumeric and have value with proper email format: '.' and '@'\n  * `EVB0061` - expiryDate length exceeds max length allowed of: 6 characters\n  * `EVB0062` - TimeZone is mandatory if any of the following controls are set to true: Validity Period, Aging Velocity (MasterCard only), Curfew Control, Time of Day Control\n  * `EVB0063` - timeZone field has an invalid UTC offset time zone format\n  * `EVB0065` - currencyCode is mandatory\n  * `EVB0066` - ClientId and programId combination is not valid\n  * `EVB0070` - templateId cannot be modified\n  * `EVB0071` - templateId cannot be null\n  * `EVB0099` - currencyCode length allowed is:  3 digits\n  * `EVB0106` - minAmount is mandatory if enableAmountRangeControl is true\n  * `EVB0107` - maxAmount is mandatory if enableAmountRangeControl is true\n  * `EVB0110` - startTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)\n  * `EVB0113` - startTime is mandatory if CurfewControl is true\n  * `EVB0114` - endTime is mandatory if CurfewControl is true\n  * `EVB0112` - endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)\n  * `EVB0120` - validityEndDate value must have valid format: YYYY-MM-DD\n  * `EVB0121` - validityStartDate value must have valid format: YYYY-MM-DD\n  * `EVB0125` - validityStartDate is mandatory if ValidityPeriodControl is true\n  * `EVB0126` - validityEndDate is mandatory if ValidityPeriodControl is true\n  * `EVB0133` - VelocityControlType-periodType is mandatory.\n  * `EVB0136` - currencyType is mandatory\n  * `EVB0137` - spendVelocityControl-cumulativeSpendLimit is mandatory\n  * `EVB0138` - spendVelocityControl-maxAuth is mandatory\n  * `EVB0140` - periodType length exceeds max length allowed of: 1 character\n  * `EVB0143` - periodType is mandatory \n  * `EVB0151` - Cannot add any new controls to a previosuly created VCA\n  * `EVB0163` - authorizationHoldDays is mandatory if agingVelocityControl is true\n  * `EVB0170` - amountLimit is mandatory if TransactionLimitControl is true\n  * `EVB0201` - We were unable to process your request. Please try again, or contact Citi support if you have any further questions or comments.\n  * `EVB0202` - We were unable to process your request. Please try again, or contact Citi support if you have any further questions or comments\n  * `EVB0213` - virtualCardAccountNumber is Invalid\n  * `EVB0214` - Validity Period Control must be set to true and validityStartDate and validityEndDate are mandatory if periodType = 3\n  * `EVB0215` - Validity Period Control must be set to true and validityStartDate and  validityEndDate are mandatory if periodType = C\n  * `EVB0217` -validityStartDate cannot be a past date\n  * `EVB0222` - messageId cannot be null\n  * `EVB0224` - messageId size must be between 28 and 36 characters\n  * `EVB0241` - Transaction Not Found for the respective client id and message id on grace.\n  * `EVB0243` - Program Id is not present\n  * `EVB0245` - currencyCode value must be numeric [0-9]\n  * `EVB0251` - ExpiryDate is not required\n  * `EVB0252` - messageId should be alphanumeric without special characters\n  * `EVB0041` - FundingSourceName size must be between 1 and 100 characters\n  * `EVB0244` - TemplateId Should be a Valid Long Value\n  * `EVB0246` - paymentBeneficiaryId is mandatory\n  * `EVB0248` - paymentBeneficiaryId Should be a Valid Long Value\n  * `EVB0250` - FundingSourceName is not required\n  * `EVB0255` - customReference size should be between 1 and 29\n  * `EVB0256` - customReferenceValue should be between 1 and 100 characters\n  * `EVB0257` - vcaId should not be null or empty\n  * `EVB0258` - customReferenceLabel should be between 1 and 50 characters\n  * `EVB00259`- expiryDate must have format: MMYYYY\n  * `EVB0260` - cardAcceptorId is mandatory if Merchant Control ID is true\n  * `EVB0261` - cardAcceptorId length exceeds max length allowed of 15 character\n  * `EVB0262` - weekdaysEffective is mandatory if enableCurfewControl is true\n  * `EVB0264` - spendVelocityControl is Mandatory \n  * `EVB0265` - mccGrouping cannot be null or empty\n  * `EVB0267` - ProgramId should be alphanumeric without special characters\n  * `EVB0270` - Not allowed to modify when control indicator is disabled \n  * `EVB0271` - ExpiryDate is mandatory\n  * `EVB0272` - Both Aging and Spend Velocity Control cannot be enabled\n  * `EVB0273` - Either Aging or Spend Velocity Control should be enabled\n  * `EVB0290` - Bulk Cancellation is not Allowed for visa\n  * `EVB0350` - virtualCardAccountNumber length should be 16 characters\n  * `EVB0351` - virtualCardAccountNumber is Mandatory\n  * `EVB0352` - FundingSourceId is Invalid. FundingSourceId value should be a valid long value and size must be between 1 and 19 digits\n  * `EVB0352` - FundingSourceId is Invalid. FundingSourceId value should be alphanumeric and size must be between 1 and 19 digits\n  * `EVB0353` - customReferenceValue should be between 1 and 80 characters\n  * `EVB0354` - AmountRangeControl-minAmount length exceed max length allowed is:  14 characters\n  * `EVB0355` - AmountRangeControl-maxAmount length exceed max length allowed is:  14 characters\n  * `EVB0356` - minAmount & maxAmount values must be a numeric positive value with a maximum of 2 decimals digits\n  * `EVB0359` - programId value must be between 1 and 25 digits\n  * `EVB0360` - Invalid JSON input\n  * `EVB0361` - Invalid JSON input\n  * `EVB0362` - Invalid maxAuth format. maxAuth value cannot exceed 8 digits\n  * `EVB0363` - cumulativeSpendLimit max field length is 12 digits with 10 digits to the left of the decimal and 2 digits to the right of the decimal\n  * `EVB0364` - transactionLimitControl-amount value must be a numeric positive value with a maximum of 2 decimals digits\n  * `EVB0365` - periodType is mandatory if enableSpendVelocity is true\n  * `EVB0366` - resetDay value must an integer between 1-28\n  * `EVB0367` - startTime is mandatory if Time Of Day Control is true\n  * `EVB0368` - \\\"weekdayEffective must have value which matches regex: SUN|MON|TUE|WED|THU|FRI|SAT\\\"\n  * `EVB0369` - cumulativeSpendLimit is mandatory if Aging Velocity Control is set to true\n  * `EVB0370` - countryCodes is required if Geography Control is set to true\n  * `EVB0371` - allowed field is required if Geography Control is set to true\n  * `EVB0378` - allowed field is required if Merchant ID Control is set to true\n  * `EVB0381` - AmountRangeControl-minAmount is greater than maxAmount\n  * `EVB0401` - The value is not present in the predefined list for custom field named field name\n  * `EVB0404` - The value has non numeric characters for custom field named: [field]\n  * `EVB0430` - The Amount must be greater than or equal to the Cumulative Limit\n  * `EVB0431` - The Amount must be less than the max amount range\n  * `EVB0432` - The Amount Range Control was missing from the request\n  * `EVB0435` - There was a problem retrieving the RCN Data with rcnId : [rcnID]\n  * `EVB0436` - There was a problem assigning rules to your VCN Request\n  * `EVB0437` - Invalid date {date given}.[valid date format YYYY-MM-DD] \n  * `EVB0438` - From date should be before to date.\n  * `EVB0406` - The Validity Control was missing from the request\n  * `EVB0440` - There was a problem retrieving the RCN Data with rcnId:\n  * `EVB0441` - An invalid velocity control field exists in the request. field name:\n  * `EVB0442` - There was a problem getting the Card Image Data\n  * `EVB0443` - There was a problem retrieving the RCN Data with rcnId : \n  * `EVB0427` - There was a problem getting the DataSources for the given issuer  \n  * `EVB0445` - There was a problem getting the issuer id for the company id provided.  \n  * `EVB0446` - There was a problem getting RCN details.  \n  * `EVB0447` - There was a problem getting the custom data fields for the given request id \n  * `EVB0448` - There was a problem getting the supplier email address by a supplier id  \n  * `EVB0448` - There was a problem getting the supplier email address by a supplier id \n  * `EVB0449` - There was a problem getting the suppliers for the company ID provided  \n  * `EVB0450` -  The Merchant Amount Control was missing from the request \n  * `EVB0439` - An invalid geography control field exists in the request. field name: \n  * `EVB0452` - Negate is the only supported attribute; Merchant and Acquirer details should be specified in Supplier Setup  \n  * `EVB0453` - The purchase request rules must have unique rule names  \n  * `EVB0454` - Invalid or inactive supplier.  \n  * `EVB0455` - An invalid travel control field exists in the request. field name:  \n  * `EVB0456` - An invalid time of day control field exists in the request. field name:  \n  * `EVB0457` - An invalid transaction limit control field exists in the request. field name:\n  * `EVB0426` - An invalid validity control field exists in the request. field name:  \n  * `EVB0441` - An invalid velocity control field exists in the request. field name: \n  * `EVB0459` - The specified supplier has not been configured to use the Merchant ID control\n  * `EVB0460` - Cannot have multiple velocity controls in the request with the same period.  \n  * `EVB0461` - A request submitter is not valid user  \n  * `EVB0462` - There was not a Purchase Template with the given Id, Id:  \n  * `EVB0444` - The request's Purchase Template is not associated with the active auto approve purchase group \n  * `EVB0464` - There was a problem saving the custom data fields for the allocate vcn request \n  * `EVB0465` - There was a problem getting the Travel Agency Detail for the request \n  * `EVB0466` - There was a problem getting the Tolerances for the given corpId  \n  * `EVB0470` - There was a problem getting the Template CDF to get the order \n  * `EVB0468` - There was a problem getting the Air Detail for the request  \n  * `EVB0469` - There was a problem getting the Vehicle Rental Detail for the request  \n  * `EVB0472` - There was a problem getting the companies for the given issuer id and corp number \n  * `EVB0471` - There was a problem getting the supplier by a supplier name  \n  * `EVB0477` - There was a problem getting the Lodging Summary for the request  \n  * `EVB0473` - There was a problem getting the VCN Request \n  * `EVB0474` - There was a problem getting the Rail Detail for the request  \n  * `EVB0475` - There was a problem getting the CDF to get the order \n  * `EVB0476` - There was a problem getting the real cards for the company entered  \n  * `EVB0524` - Date range should be same month. \n  * `EVB0478` -  There was a problem in deleting a vcn.  \n  * `EVB0479` - The maximum number of records has been exceeded. \n  * `EVB0480` - There was a problem TRYING TO Sync Card Currency  \n  * `EVB0481` -  There was a problem saving the custom data fields for the update request \n  * `EVB0482` - There was a problem saving the vcn request  \n  * `EVB0483` - There was a problem updating the vcn request  \n  * `EVB0484` -  Invalid Expiry Date Requested  \n  * `EVB0485` -  Unable to correctly analyze a purchase request which did not have required controls present: \n  * `EVB0528` - There was a problem allocating the vcn \n  * `EVB0486` - Purchase Request(s) could not be approved  \n  * `EVB0487` - Purchase Request(s) could not be canceled  \n  * `EVB0513` - Message ID is not unique. \n  * `EVB0516` - Request could not be processed successfully. \n  * `EVB0515` - Invalid Buyer \n  * `EVB0516` - Request could not be processed successfully. \n  * `EVB0517` - Invalid Web Service Method \n  * `EVB0518` - Proxy number provided in the request is not active. \n  * `EVB0519` - Invalid visa account number \n  * `EVB0520` - Proxy number length should be between 1 and 19 \n  * `EVB0521` - Proxy number contains invalid characters \n  * `EVB0522` - Start Date should not be more than 10 characters \n  * `EVB0523` - Start Date is invalid. Valid date format is YYYY-MM-DD \n  * `EVB0525` - End Date is mandatory \n  * `EVB0526` - End Date should not be more than 10 characters \n  * `EVB0527` - End Date is invalid. Valid date format is YYYY-MM-DD \n  * `EVB0528` - End Date cannot be a past date \n  * `EVB0529` - Rule Code is not valid \n  * `EVB516`  - cumulativeSpendLimit value must be numeric \n  * `EVB517`  - cumulativeSpendLimit value must be numeric \n  * `EVB0530` - Sequence number should contain only numbers. \n  * `EVB0531` - OverrideCode contains invalid characters \n  * `EVB0532` - OverrideCode should not be more than 33 characters. \n  * `EVB0531` - OverrideValue contains invalid characters \n  * `EVB0533` - OverrideValue should not be more than 10 characters \n  * `EVB0559` - End Date should not be less than Start Date \n  * `EVB0535` - Sequence number should be within 0 to 999 range. \n  * `EVB0536` - Rule Code is mandatory. Please provide valid rule code \n  * `EVB0537` - Rule Code cannot contain special characters. Please provide valid rule code \n  * `EVB0538` - Override code is mandatory \n  * `EVB0539` - Override Value is mandatory \n  * `EVB0540` - Action is mandatory. Action code should be A/U/D. \n  * `EVB0560` - Invalid Action. Action code should be A/U/D. \n  * `EVB0542` - Request could not be processed successfully. Failed to generate Token. \n  * `EVB0543` - Add payment control could not be processed successfully. \n  * `EVB0544` - Account number should be blank.\n  * `EVB0545` - Atlease one requisition rule is mandaotry. \n  * `EVB0546` - Atlease one override rule is mandatory. \n  * `EVB0547` - A cancelled VCA cannot be modified or cancelled again \n  * `EVB0548` - equence number is mandatory \n  * `EVB0549` - Account Number is Mandatory \n  * `EVB0550` - Number of cards count should be 1. \n  * `EVB0551` - Start Date is Mandatory. \n  * `EVB0552` - The number of accounts you have requested exceeds the maximum allowed limit \n  * `EVB0553` - Overrides rule size exceeds maximum Limit \n  * `EVB0554` - The pseudo account type set for the SUA proxy is not matching the pseudo account type set up for the buyer. \n  * `EVB0555` - Currency code passed in the request is not configured as one of the allowed currency for the buyer. \n  * `EVB0556` - The startRange and endRange overrides are mandatory for the Other MCG rule. \n  * `EVB0557` - Rules can have a maximum of 25 override values \n  * `EVB0558` - Atleast one RequisitionDetail is mandatory \n  * `EVB0607` - At least one spend control is mandatory \n  * `EVB0211` - validityStartDate invalid format. MM value must be less than or equal to 12  and DD value must be less than or equal to 31 \n  * `EVB0212` - validityEndDate invalid format. MM value must be less than or equal to 12   and DD value must be less than or equal to 31 \n  * `EVB0218` - validityEndDate cannot be a past date \n  * `EVB0219` - expiryDate month and year cannot be a past or current date \n  * `EVB0230` - Invalid contryCode format. countryCode value cannot exceed 3 characters \n  * `EVB0231` - maxAuth is mandatory if enableSpendVelocityControl is set to True \n  * `EVB0281` - maxAuth must be a valid long value with a maximum of 10 digits \n  * `EVB0232` - weekdayEffective is mandatory if Time Of Day Control is true\n  * `EVB0233` - endTime is mandatory if Time Of Day Control is true\n  * `EVB0234` - endTime and startTime are mandatory if Time Of Day Control is set for a new weekdayEffective\n  * `EVB0235` - startTime value cannot exceed the requested endTime value\n  * `EVB0600` - validityStartDate should be before validityEndDate\n  * `EVB0601` - Allowed is the only supported attribute; Merchant and Acquirer details should be specified in Supplier Setup\n  * `EVB0602` - Invalid or inactive payment beneficiary\n  * `EVB0609` - Geography control-countryCodes cannot be populated if Geography control is true\n  * `EVB0610` - Invalid periodType value. periodType can contain a value of either D, M, W, Q, Y, or C\n  * `EVB0611` - Invalid periodType value. periodType can contain a value of either 1, 2, or 3\n  * `EVB0612` - resetDay is mandatory if periodType = 1\n  * `EVB0613` - Geography control-allowed cannot be populated if Geography control is true\n  * `EVB0614` - Invalid startTime or endTime value for curfew control. startTime and endTime value must have valid format: HH:MM - H (0,1,2) | H (0-9) : M (0) | M (0)\n  * `EVB0615` - No time zone found for UTC value provided in timeZone field\n  * `EVB0616` - validityPeriodControl is Mandatory\n  * `EVB0618` - Amount Range Control minAmount field length is 12 digits with 10 digits to the left of the decimal and 2 digits to the right of the decimal\n  * `EVB0619` - Amount Range Control maxAmount field length is 12 digits with 10 digits to the left of the decimal and 2 digits to the right of the decimal\n  * `EVB0620` - transactionLimitControl-amount value must be a numeric positive whole number with a maximum of 7 digits\n  * `EVB0621` - authorizationHoldDays must be positive long value with a maximum of 4 digits\n  * `EVB0604` - fundingSourceId provided in the request is not active.\n  * `EVB0605` - fundingSourceId length should be between 1 and 19\n  * `EVB0606` - fundingSourceId contains invalid characters\n  * `EVB502` - virtualCardAccountNumber is Invalid\n  * `EVB0254` - mccGrouping should not contain multiple values\n  * `EVB0236` - Invalid contryCode, countryCode doesn't exist\n  * `EVB0237` - The date specified in validityStartDate does not exist\n  * `EVB0238` - The date specified in validityEndDate does not exist\n  * `EVB0903` - Atleast one Spend velocity control is required, When enableSpendVelocity is true\n  * `EVB1300` - Amount range control is included in the request, but this control is not configured within   the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1301` - Curfew control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1302` - Geography control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1303` - Merchant amount control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1304` - Merchant ID control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1305` - Time of day control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1306` - Transaction limit control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1307` - Validity period control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1308` - Aging velocity control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n  * `EVB1309` - Velocity control is included in the request, but this control is not configured within the Virtual Card Purchase Template that is included in the request. Please configure this control in the Purchase Template \n * `GRC0001` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments \n  * `GRC0002` - Client ID is missing in the request header \n  * `GRC0003` - Contry code is not available in the request \n  * `GRC0004` - Region ID is not available in the request \n  * `GRC0005` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments \n  * `GRC0006` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments \n  * `GRC0007` - Client requested MediaType is not supported. \n  * `GRC0009` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments \n  * `GRC0011` - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support. \n  * `GRC0012` - Necessary header value is missing \n  * `GRC0003` - Invalid JSON Input \n  * `GRC0014` - We have encountered an error and couldn't receive your request. Please try again, or contact Citi support if you have any further questions or comments\n  * `VCCE0001` - invalid customReferenceValue for customReferenceLabel Entity Type. It can contain a value of either E or I.\n  * `VCCV0002` - customReferenceValue is required for customReferenceLabel Last Name.\n  * `VCCV0003` - invalid customReferenceValue for customReferenceLabel Last Name.\n  * `VCCV0004` - customReferenceValue is required for customReferenceLabel Primary Address Line 1.\n  * `VCCV0005` - customReferenceValue for customReferenceLabel = Primary Address Line 1 cannot exceed 35 characters.\n  * `VCCV0006` - invalid customReferenceValue for customReferenceLabel Primary Address Line 1.\n  * `VCCV0007` - customReferenceValue for customReferenceLabel = Primary Address Line 2 cannot exceed 35 characters.\n  * `VCCV0008` - invalid customReferenceValue for customReferenceLabel Primary Address Line 2.\n  * `VCCV0009` - customReferenceValue is required for customReferenceLabel ZIP code.\n  * `VCCV0010` - customReferenceValue for customReferenceLabel = ZIP code cannot below 1 characters.\n  * `VCCV0011` - customReferenceValue for customReferenceLabel = ZIP code cannot exceed 35 characters.\n  * `VCCV0012` - invalid customReferenceValue for customReferenceLabel ZIP code.\n  * `VCCV0013` - customReferenceValue is required for customReferenceLabel City.\n  * `VCCV0014` - customReferenceValue for customReferenceLabel = City cannot exceed 35 characters.\n  * `VCCV0015` - invalid customReferenceValue for customReferenceLabel City.\n  * `VCCV0016` - customReferenceValue is required for customReferenceLabel State Or Province.\n  * `VCCV0017` - customReferenceValue for customReferenceLabel = State Or Province cannot exceed 35 characters.\n  * `VCCV0018` - invalid customReferenceValue for customReferenceLabel State Or Province.\n  * `VCCV0019` - customReferenceValue is required for customReferenceLabel Address Country.\n  * `VCCV0020` - customReferenceValue for customReferenceLabel = Address Country cannot below 3 characters.\n  * `VCCV0021` - customReferenceValue for customReferenceLabel = Address Country cannot exceed 3 characters.\n  * `VCCV0022` - invalid customReferenceValue for customReferenceLabel Address Country.\n  * `VCCV0023` - customReferenceValue is required for customReferenceLabel Country of Incorporation or Nationality.\n  * `VCCV0024` - customReferenceValue for customReferenceLabel = Country of Incorporation or Nationality cannot below 3 characters.\n  * `VCCV0025` - customReferenceValue for customReferenceLabel = Country of Incorporation or Nationality cannot exceed 3 characters.\n  * `VCCV0026` - invalid customReferenceValue for customReferenceLabel Country of Incorporation or Nationality.\n  * `VCCV0027` - customReferenceValue is required for customReferenceLabel PI Client Name.\n  * `VCCV0028` - invalid customReferenceValue for customReferenceLabel PI Client Name.\n  * `VCCV0029` - customReferenceValue is required for customReferenceLabel First Name.\n  * `VCCV0030` - invalid customReferenceValue for customReferenceLabel First Name.\n  * `VCCV0031` - customReferenceValue is required for customReferenceLabel ID Number.\n  * `VCCV0032` - invalid customReferenceValue for customReferenceLabel ID Number.\n  * `VCCV0033` - customReferenceValue is required for customReferenceLabel Passport Number.\n  * `VCCV0034` - invalid customReferenceValue for customReferenceLabel Passport Number.\n  * `VCCV0035` - customReferenceValue is required for customReferenceLabel Date of Birth.\n  * `VCCV0036` - customReferenceValue for customReferenceLabel = Date of Birth is not in valid format.\n  * `VCCV0037` - customReferenceValue is required for customReferenceLabel Place of Birth.\n  * `VCCV0038` - invalid customReferenceValue for customReferenceLabel Place of Birth.\n  \n  \n  \n"
    CreateVirtualCardFailureResponse:
      type: object
      properties:
        vcaId:
          type: string
          description: A reference number that uniquely identifies the virtual card account.
          example: '5070616'
        cardImage:
          type: string
          description: A visual representation of the virtual card account front and back.
        currencyCode:
          type: string
          description: Currency Code in which VCA amounts are expressed.
        timeZone:
          type: string
          description: Defines the time zone applicable for any date or time parameters within controls set for a VCA.
        virtualCardAccountNumber:
          type: string
          description: The virtual card account number to use for transactions.
        expiryDate:
          type: string
          description: 'Expiry Date of the virtual card account. '
        securityCode:
          type: string
          description: The security code (i.e. cvv) corresponding to the virtual card accunt.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorMessage_2'
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          example: '12345678901234567890123456789'
        mccGrouping:
          type: string
          description: Limits authorizations to defined Merchant Category Codes.
        currencyType:
          type: string
          description: Defines the type of the VCA currency. - Value B stands for Billing Currency which indicates that the VCA currency is equal to the billing currency of the underlying funding source. - Value M stands for Merchant Currency which indicates that the VCA currency is expressed in merchant currency and not in billing currency.
          example: B
        paymentBeneficiaryId:
          type: number
          description: Uniquely identifies the payment beneficiary for which the virtual card is created.
          example: 41432,
        paymentBeneficiaryEmails:
          type: string
          description: Specifies up to five email addresses to which the virtual card account details should be delivered. Email addresses specified in the request will not override any default email addresses specified in the virtual card application.
          example: siyadh.shafee@citi.com;gangasravanthi.gollamudi@citi.com;nagara.harikrishnareddy@citi.com
        customReference:
          type: array
          items:
            $ref: '#/components/schemas/CustomReference'
        templateId:
          type: number
          description: Identifies the template that was setup in the VCA system and that should be used for this virtual card.The template setup in the VCA system defines which controls, custom data fields and MCC groupings can be used.
          example: 22646,
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: 'Limits the overall amount spend on the virtual card account. '
          example: 2000,
        enableSpendVelocity:
          type: boolean
          description: Limits the frequency and total cumulative amount of authorizations performed on the VCA within a specified period.
        spendVelocity:
          type: array
          items:
            $ref: '#/components/schemas/SpendVelocityResponse'
        enableValidityPeriodControl:
          type: boolean
          description: 'Limits authorization activity to a specific time period. '
        validityStartDate:
          type: string
          description: Identifies the date from which the virtual card account can be used for transactions.
          example: '2020-09-18'
        validityEndDate:
          type: string
          description: Identifies the date until which the virtual card account can be used for transactions.
          example: '2020-09-23'
        enableAmountRangeControl:
          type: boolean
          description: Approves a transaction only if the requested amount for authorization is equal to or greater than the Minimum Amount and less than or equal to the Maximum Amount.
        maxAmount:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        minAmount:
          type: number
          format: bigdecimal
          description: Identifies the minimum allowed transaction amount.
        enableTransactionLimitControl:
          type: boolean
          description: Limits individual transactions to a maximum amount.
        amountLimit:
          type: number
          format: bigdecimal
          description: Identifies the maximum allowed transaction amount.
        enableCurfewControl:
          type: boolean
          description: Limits authorization activity to a single time period for each day selected.
        curfewTime:
          $ref: '#/components/schemas/CurfewTime'
        enableTimeOfDayControl:
          type: boolean
          description: 'Limits authorization request to defined time periods each day. '
        timeOfDay:
          type: array
          items:
            $ref: '#/components/schemas/TimeOfDay'
        enableAgingVelocityControl:
          type: boolean
          description: Sets a cumulative amount and keeps track of the current remaining balance. Allows the requester to age off approved authorization requests that have not been cleared by the merchant after a defined number of days.
        authorizationHoldDays:
          type: number
          format: long
          description: Identifies the number of days after which an authorization gets aged off if no matching clearing record was received.
        enableGeographyControl:
          type: boolean
          description: 'Limits authorization requests to a defined geographic location. '
        countryCodes:
          type: array
          description: Defines the merchant country in which the VCA can be used.
          items:
            type: string
          example:
          - AFG
        allowed:
          type: boolean
          description: Indicate whether the values in countryCode are allowed or disallowed.
        enableMerchantIdControl:
          type: boolean
          description: Limits authorizations to a particular merchant using the Merchant ID and Acquirer ID (Mastercard) or Card Acceptor ID (Visa).
        merchantId:
          type: array
          items:
            $ref: '#/components/schemas/MerchantIdRequest'
    CancelVirtualCardResponse:
      type: object
      properties:
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
          example: '429777'
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          example: 0123456789012345678901234567
        vcaResponse:
          type: array
          items:
            $ref: '#/components/schemas/VcaResponse'
    SpendVelocityResponse:
      type: object
      properties:
        maxAuth:
          type: number
          format: long
          description: Limits the number of authorizations that can be made with a VCA. Should be set to 1, if a single-use VCA is created. Specify any value larger than one for a multi-use VCA. Set to 0, if unlimited authorizations should be allowed.
          example: 5,
        cumulativeSpendLimit:
          type: number
          format: bigdecimal
          description: Limits the overall amount spend on the virtual card account.
          example: 1000,
        periodType:
          type: string
          description: Period for which the control values are valid before they reset
          example: D
        availableBalance:
          type: number
          description: The remaining balance available to spend on the virtual card.
        periodEndDate:
          type: string
          description: End date of the current period based on the periodType selected.
    CancelVirtualCardFailureResponse:
      type: object
      properties:
        programId:
          type: string
          description: Unique ID of the company record defined in the virtual cards system.
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
        vcaResponse:
          type: array
          items:
            $ref: '#/components/schemas/VcaFailureResponse'
    ImmediateAckResponse:
      type: object
      properties:
        messageId:
          type: string
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          example: 0123456789012345678901234567
        status:
          type: string
          description: Immediate Ack response message.
          example: CREATED
    RequestFilters:
      description: Provides variaous filter features which are optional in nature
      type: object
      properties:
        sortOrder:
          description: 'Specifies the oder in which transactions needs to be sorted.<br><br>Applicable for Mastercard only.<br><br>`Possible values`: ASCENDING, DESCENDING'
          type: string
          format: alphanumeric
          example: ASCENDING
          maxLength: 10
        paginationRequired:
          description: Specifies whether pagination is required or not.<br><br>If paginationRequired is true, startDate and endDate cannot be more than 30 days apart.
          type: string
          format: boolean
          example: 'true'
        startIndex:
          description: 'Specifies the start index of the transactions being requested for pagination<br><br>Rules:<ol><li>Positive number greater than or equal to 1</li><li>Visa: <ul><li>startIndex and endIndex range should not be less than 10 or greater than 150</li></ul></li></ol>'
          type: string
          format: alphanumeric
          example: '1'
        endIndex:
          description: 'Specifies the end index of the transactions being requested for pagination<br><br>Rules:<ol><li>Positive number greater than or equal to 1</li><li>Visa: <ul><li>startIndex and endIndex range should not be less than 10 or greater than 150</li></ul></li></ol>'
          type: string
          format: alphanumeric
          example: '100'
    ClearingServerErrors:
      properties:
        errorCode:
          description: The error code if there is any error occurred while retrieving the transaction
          type: string
          format: alphanumeric
          example: GRC0014
        errorDescription:
          description: '"The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br>* `GRC0001` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0006` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0009` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0014` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.'
          type: string
          format: alphanumeric
          example: We have encountered an error and couldn`t receive your request. Please try again, or contact Citi support if you have any further questions or comments
    ErrorResponseForClearingReport:
      properties:
        startDate:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '2023-01-01'
        endDate:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '2023-01-30'
        startTime:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: 00:00
        endTime:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '23:59'
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '123456'
        programId:
          description: Unique ID of the company record defined in the virtual cards system.
          type: string
          format: alphanumeric
          example: '429777'
        messageId:
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          type: string
          format: alphanumeric
          example: CITI0000ClearingReport20230825120311
        timeZone:
          description: Defines the time zone applicable for any date or time
          type: string
          format: alphanumeric
          example: UTC+05:30
        transactionType:
          description: Specifies the nature of the transaction whether it was authorized or returned etc.
          type: string
          format: alphanumeric
          example: All
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.
          type: string
          format: alphanumeric
          example: '5281722601926445'
        reportStatus:
          description: Defines the status of the data that was requested whether the request has been processed or not.
          type: string
          format: alphanumeric
          example: FAILED
          maxLength: 16
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ClearingErrors'
    ServerErrorResponseForAuthReport:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AuthServerErrors'
    AuthErrors:
      properties:
        errorCode:
          description: The error code if there is any error occurred while retrieving the transaction
          type: string
          format: alphanumeric
          example: ERS0001
        errorDescription:
          description: '"The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br>* `ERS0001` - Invalid Virtual Card Account Number format<br>* `ERS0002` - Invalid Transaction Type<br>* `ERS0003` - timeZone field is empty or has an invalid UTC offset time zone format<br>* `ERC0004` - Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.<br>* `ERS0007` - Invalid Message ID format<br>* `ERS0009` - Client Onboard Configuration setup is missing. Contact Citi support.<br>* `ERS0010` - Invalid Report ID format. Report ID must include numeric values<br>* `ERS0053` - Start Date is Mandatory.<br>* `ERS0054` - End Date is Mandatory.<br>* `ERS0055` - Requested report date cannot exceed 180 days in the past from today''s date<br>* `ERS0057` - startDate value exceeds requested endDate value<br>* `ERS0060` - Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.<br>* `ERS0061` - VCA ID is not present in our system<br>* `ERS0063` - Requested Time Zone is not supported<br>* `ERS0068` - Program Id is Mandatory.<br>* `ERS0069` - Vca Id is Mandatory.<br>* `ERS0070` - Message Id is Mandatory.<br>* `ERS0071` - Virtual Card Account Number is Mandatory.<br>* `ERS0072` - Requested report date cannot exceed 36 months in the past from todays date<br>* `ERS0079` - The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).<br>* `ERS0080` - The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).<br>* `ERS0081` - The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).<br>* `ERS0082` - The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.<br>* `ERS0083` - The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.<br>* `ERS0084` - The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.<br>* `ERS0091` - startDate value must have valid format: YYYY-MM-DD<br>* `ERS0092` - endDate value must have valid format: YYYY-MM-DD<br>* `ERS0093` - The date specified in startDate does not exist<br>* `ERS0094` - The date specified in endDate does not exist<br>* `ERS0095` - Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID<br>* `ERS0097` - startTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)<br>* `ERS0098` - endTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)<br>* `ERS0099` - startTime value cannot exceed the requested endTime value<br>* `ERS0100` -  Invalid sortOrder value<br>* `ERS0101` - startIndex should be numeric <br>* `ERS0102` - endIndex should be numeric<br>* `ERS0103` -  startIndex should be less than or equal to endIndex<br>* `ERS0104` -  The startIndex & endIndex range cannot be greater than 150<br> * `ERS0105` - The startDate and endDate range cannot be greater than  30 days if paginationRequired is true<br><br>* `MS0001` - Invalid Virtual Card Account Number<br>* `MS0002` - From date should be before to date.<br>* `MS0006` - Invalid vcaId value<br>* `MS0008` - Invalid Report ID<br><br>* `GRC0002` - Client ID is missing in the request header<br>* `GRC0003` - Invalid JSON Input<br>* `GRC0004` - Region ID is not available in the request<br>* `GRC0011` - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.<br>* `GRC0016` - Country code is not available in the request"'
          type: string
          format: alphanumeric
          example: Invalid Virtual Card Account Number format
    AuthReportInboundRequest:
      properties:
        startDate:
          description: "Specifies the start date upto when the reports can be retrieved<br><br>Format:YYYY-MM-DD<br><br>Rules:<ol><li>Start date should be less than end date.</li><li>Start date should not be earlier than create VCA date</li><li>Mastercard:  <ul><li>startDate and endDate cannot be more than 90 days apart</li><li>startDate and endDate can be up to 36 months\n in the past from the day of report requested and not future date</li></ul></li><li>Visa:<ul><li>startDate and endDate cannot be more than 30 days apart</li><li>startDate and endDate can be up to 6 months\n in the past from the day of report requested and not future date</li></ul></li></ol>"
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        endDate:
          description: "Specifies the end date upto when the reports can be retrieved<br><br>Format:YYYY-MM-DD<br><br>Rules:<ol><li>End date should greater than the start date</li><li>Mastercard:  <ul><li>startDate and endDate cannot be more than 90 days apart.</li><li>If endDate is more than 90 days after startDate, it will be automatically reset to exactly 90 days after startDate</li><li>startDate and endDate can be up to 36 months\n in the past from the day of report requested and not future date</li></ul></li><li>Visa:<ul><li>startDate and endDate cannot be more than 30 days apart</li><li>startDate and endDate can be up to 6 months\n in the past from the day of report requested and not future date</li></ul></li></ol>"
          type: string
          format: alphanumeric
          example: '2023-03-30'
          maxLength: 10
        startTime:
          description: Specifies the start time from when the reports can be retrieved<br><br>Format:HH:MM
          type: string
          format: alphanumeric
          example: 00:00
          maxLength: 10
        endTime:
          description: Specifies the end time upto when the reports can be retrieved<br><br>Format:HH:MM
          type: string
          format: alphanumeric
          example: '23:59'
          maxLength: 10
        transactionType:
          description: 'Specifies the nature of the transaction whether it was authorized or returned etc.<br><br>Visa - Not applicable<br><br>Mastercard - Optional<br><br>Possible Values:<br>"All" - Returns all Authorization transactions associated to a virtual card account for a given time range<br>"Approved" - Authorization requests that have an Approved Authorization status from the issuer or card network<br>"Partial-Approved" - Authorization requests that have a Partial Approval Authorization status from the issuer<br>"Declined" - Authorization requests that have a declined Authorization status from the issuer or card network<br>"Issuer-Declined" - Authorization requests that have an declined Authorization status from the issuer<br>"Request-Response" - Response to an authorization request. It carries the response information required to service (approve or deny) the Authorization Request.<br>"Advice-Response" - Response by an Issuer or System to either an Acquirer-generated, Issuer-generated, or System-generated Authorization Advice message Note: Advices for Issuer declines, that match an earlier Auth, do not generate a record and therefore will not be included in this filter.<br>"Reversal-Response" - Response to a reversal request and denotes the disposition of the Reversal Request'
          type: string
          format: alphanumeric
          example: All
          maxLength: 20
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '67676781'
          maxLength: 19
        programId:
          description: Unique ID of the company record defined in the virtual cards system.<br><br>Mastercard - This value is returned in the ID Provisioning API. This value is generated when the VCA program is onboarded to Mastercard's VCA platform. Data format - Long (Numeric). Max character length - 19<br><br>Visa - This value is generated when the VCA program is onboarded to Visa's VCA platform. Data format - Alphanumeric. Max character length - 25
          type: string
          format: alphanumeric
          example: '233191'
          maxLength: 25
        messageId:
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID must be unique per API request and cannot include special characters
          type: string
          format: alphanumeric
          example: CITI00000000AuthReport20230825120311
          maxLength: 36
          minLength: 28
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.<br><br>Numeric field and no decimals allowed
          type: string
          format: alphanumeric
          example: '5281722601926445'
          maxLength: 16
        timeZone:
          description: Defines the time zone applicable for any date or time<br><br>UTC offset<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: UTC+05:30
          maxLength: 9
        reportIds:
          description: 'An optional reportId array passed by client to fetch the Auth report transactions that previously returned a "PENDING" or "IN-PROGRESS" report status. When calling the API with reportId, pass all other request parameters as orignally passed in the previous request '
          type: array
          items:
            type: string
          format: alphanumeric
          example:
          - '12345'
        filters:
          $ref: '#/components/schemas/RequestFilters'
      required:
      - startDate
      - endDate
      - vcaId
      - programId
      - messageId
      - virtualCardAccountNumber
    ClearingErrors:
      properties:
        errorCode:
          description: The error code if there is any error occurred while retrieving the transaction
          type: string
          format: alphanumeric
          example: ERS0001
        errorDescription:
          description: '"The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br>* `ERS0001` - Invalid Virtual Card Account Number format<br>* `ERS0002` - Invalid Transaction Type<br>* `ERS0003` - timeZone field is empty or has an invalid UTC offset time zone format<br>* `ERC0004` - Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.<br>* `ERS0007` - Invalid Message ID format<br>* `ERS0009` - Client Onboard Configuration setup is missing. Contact Citi support.<br>* `ERS0010` - Invalid Report ID format. Report ID must include numeric values<br>* `ERS0053` - Start Date is Mandatory.<br>* `ERS0054` - End Date is Mandatory.<br>* `ERS0055` - Requested report date cannot exceed 180 days in the past from today''s date.<br>* `ERS0057` - startDate value exceeds requested endDate value<br>* `ERS0060` - Client ID and/or Program Id is missing in Client Onboard Configuration setup. Contact Citi support.<br>* `ERS0061` - VCA ID is not present in our system<br>* `ERS0063` - Requested Time Zone is not supported<br>* `ERS0068` - Program Id is Mandatory.<br>* `ERS0069` - Vca Id is Mandatory.<br>* `ERS0070` - Message Id is Mandatory.<br>* `ERS0071` - Virtual Card Account Number is Mandatory.<br>* `ERS0072` - Requested report date cannot exceed 36 months in the past from todays date<br>* `ERS0079` - The requested report ID(s) is for a VCA that is different than the VCA included in the request. Please include the VCA associated to the report ID(s).<br>* `ERS0080` - The requested report ID(s) is for a programId that is different than the programId included in the request. Please include the programId associated to the report ID(s).<br>* `ERS0081` - The requested report ID(s) is for a timeZone that is different than the timeZone included in the request. Please include the timeZone associated to the report ID(s).<br>* `ERS0082` - The requested report IDs are for different VCAs, Please include report IDs that belong to the same VCA.<br>* `ERS0083` - The requested report IDs are for different program IDs, Please include report IDs that belong to the same program ID.<br>* `ERS0084` - The requested report IDs are for different requested time zones, Please include report IDs that belong to the same requested time zone.<br>* `ERS0091` - startDate value must have valid format: YYYY-MM-DD<br>* `ERS0092` - endDate value must have valid format: YYYY-MM-DD<br>* `ERS0093` - The date specified in startDate does not exist<br>* `ERS0094` - The date specified in endDate does not exist<br>* `ERS0095` - Report ID included in your request is not present for the given ClientID/program ID. Please generate a new report ID for this Reports request by calling the Reports API without a report ID<br>* `ERS0097` - startTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)<br>* `ERS0098` - endTime value must have valid format: HH:MM` - H (0,1,2) | H (0-9) : M (0-5) | M (0-9)<br>* `ERS0099` - startTime value cannot exceed the requested endTime value<br>* `ERS0100` -  Invalid sortOrder value<br>* `ERS0101` - startIndex should be numeric <br>* `ERS0102` - endIndex should be numeric<br>* `ERS0103` -  startIndex should be less than or equal to endIndex<br>* `ERS0104` -  The startIndex & endIndex range cannot be greater than 150<br> * `ERS0105` - The startDate and endDate range cannot be greater than  30 days if paginationRequired is true<br><br>* `MS0001` - Invalid Virtual Card Account Number<br>* `MS0002` - From date should be before to date.<br>* `MS0006` - Invalid vcaId value<br>* `MS0008` - Invalid Report ID<br><br>* `GRC0002` - Client ID is missing in the request header<br>* `GRC0003` - Invalid JSON Input<br>* `GRC0004` - Region ID is not available in the request<br>* `GRC0011` - Client ID and/or Country and/or region id is missing in Client Onboard Configuration setup. Contact Citi support.<br>* `GRC0016` - Country code is not available in the request"'
          type: string
          format: alphanumeric
          example: Invalid Virtual Card Account Number format
    ErrorResponseForAuthReport:
      properties:
        startDate:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '2023-01-01'
        endDate:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '2023-01-30'
        startTime:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: 00:00
        endTime:
          description: Specifies the start date from when the reports can be retrieved
          type: string
          format: alphanumeric
          example: '23:59'
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '123456'
        programId:
          description: Unique ID of the company record defined in the virtual cards system.
          type: string
          format: alphanumeric
          example: '429777'
        messageId:
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
          type: string
          format: alphanumeric
          example: CITI00000000AuthReport20230825120311
        timeZone:
          description: Defines the time zone applicable for any date or time
          type: string
          format: alphanumeric
          example: UTC+05:30
        transactionType:
          description: Specifies the nature of the transaction whether it was authorized or returned etc.
          type: string
          format: alphanumeric
          example: All
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.
          type: string
          format: alphanumeric
          example: '5281722601926445'
        reportStatus:
          description: Defines the status of the data that was requested whether the request has been processed or not.
          type: string
          format: alphanumeric
          example: FAILED
          maxLength: 19
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AuthErrors'
    ClearingRecords:
      properties:
        clearingType:
          description: Specifies the type of clearing, Which it is debit or credit<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: Debit
          maxLength: 6
        billingCurrencyAmount:
          description: 'Specifies the value of transaction amount which is converted to billling currency '
          type: string
          format: alphanumeric
          example: '123.00'
          maxLength: 16
        billingCurrencyCode:
          description: Specifies the ISO currency code of accounts that was initially set up for billing the transactions.
          type: string
          format: alphanumeric
          example: USD
          maxLength: 3
        billingCurrencyCodeDescription:
          description: Specifies the description of currency code of accounts that was initially set up for billing the transactions
          type: string
          format: alphanumeric
          example: US Dollar
          maxLength: 70
        transactionCurrencyAmount:
          description: Specifies the actual transaction amount in transaction currency
          type: string
          format: alphanumeric
          example: '123.00'
          maxLength: 32
        transactionCurrencyCode:
          description: Specifies the ISO currency code on which actual authorization of transaction was done
          type: string
          format: alphanumeric
          example: USD
          maxLength: 10
        transactionCurrencyCodeDescription:
          description: Specifies the currency code description on which actual authorization of transaction was done
          type: string
          format: alphanumeric
          example: US Dollar
          maxLength: 70
        transactionExchangeRate:
          description: Currency exchange in operation during a payment.<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '1'
          maxLength: 7
        transactionDate:
          description: Specifies card transaction date.<br>Format - YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-01-20'
          maxLength: 10
        transactionTime:
          description: Specifies card transaction time. <br>Format - hh:mm:ss
          type: string
          format: alphanumeric
          example: '19:52:11'
          maxLength: 8
        transactionType:
          description: Specifies the type of transaction<br><br>Possible values:<br><br>Mastercard:<br><br>"First Presentment" - Transactions where an acquire has initiated a first presentment to advise the issuer or its agent that a financial transaction was completed on its behalf<br>"Second Presentment (Full)" - Acquirer-initiated transaction to remedy a previous First Chargeback for the full First Presentment amount<br>"Second Presentment (Partial)" - Acquirer-initiated transaction to remedy a previous First Presentment or First Chargeback for part of the First Presentment amount or First Chargeback amount<br>"First Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount<br>"Arbitration Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount<br>"First Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount<br>"Arbitration Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount or Second Presentment amount<br><br>Visa:<br><br>10 = Purchase<br>11 = Credit Voucher<br>20 = Manual Cash Disbursement<br>22 = ATM Cash Disbursement<br>30 = Payment<br>Reversal - NSF Check<br>31 = Payment<br>40 = Finance Charge<br>50 = Annual Fee<br>52 = Miscellaneous Fees<br>54 = NSF Check Fee<br>56 = Report Fee<br>61 = Credit Adjustment<br>62 = Debit Adjustment<br>63 = Finance Charge Credit Adjustment<br>64 = Finance Charge Debit Adjustment<br>65 = Other Credits<br>66 = Other Debits<br>71 = Fuel Discount<br>73 = Non-Fuel Discount<br>80 = Convenience Checks<br>82 = Convenience Checks Fees<br>84 = Travelers Checks Fees<br>86 = ATM Fees<br>88 = Late Fees
          type: string
          format: alphanumeric
          example: First Presentment
          maxLength: 40
        merchantCategoryCode:
          description: The category under which the merchant is been assigned by the network
          type: string
          format: alphanumeric
          example: '5812'
          maxLength: 10
        mccDescription:
          description: The decsription of the category on which merchant has been assigned by the netwrok
          type: string
          format: alphanumeric
          example: EATING PLACES, RESTAURANTS
          maxLength: 200
        merchantId:
          description: The ID created for a specific merchant by the network<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 00000R-5411-USA
          maxLength: 50
        merchantName:
          description: The merchant name that corresponds to merchant id defined by the netwrok
          type: string
          format: alphanumeric
          example: GROCERY STORES, SUPERM
          maxLength: 200
        merchantState:
          description: The state under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: MO
          maxLength: 100
        merchantCity:
          description: The city under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: OFALLON
          maxLength: 100
        merchantCountryCode:
          description: The conutry code defined under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: USA
          maxLength: 3
        merchantCountryName:
          description: The conutry name that corresponds to merchant country code under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: United States (the)
          maxLength: 50
        merchantZipCode:
          description: The ZIP code defined under which the merchant city has been categorised<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '12345'
          maxLength: 10
        acquirerIdentifier:
          description: The identifier under which the acquirer has been categorised
          type: string
          format: alphanumeric
          example: 00000999080
          maxLength: 50
        terminalId:
          description: The ID under which the terminal has been categorised<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '789254'
          maxLength: 50
        transactionId:
          description: Unique identifier of the transaction<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '380198318999999'
          maxLength: 50
        cardAcceptorId:
          description: Specifies card transaction acceptor ID<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '490050000000053'
          maxLength: 26
        transactionSequenceNumber:
          description: Specifies card transaction sequence number<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '4910'
          maxLength: 24
        acquirerReferenceData:
          description: Specifies card transaction acquirer reference number<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '25567681110000232050357'
          maxLength: 23
        messageType:
          description: Four-digit numeric field describing the type of message being interchanged.<br><br>Mastercard - Required<br>Visa - Not applicable<br><br>Possible Values:<br>1240   Presentment<br>1442   Chargeback<br>1644   Administrative<br>1740   Fee Collection
          type: string
          format: alphanumeric
          example: '1740'
          maxLength: 4
        messageReasonCode:
          description: Four-digit data element that indicates the reason for sending a message<br>Mastercard - Required<br>Visa - Not applicbale
          type: string
          format: alphanumeric
          example: '1400'
          maxLength: 4
        functionCode:
          description: Three-digit data element that indicates the specific purpose of a message in a message class.<br>Uniquely identifies all transaction functions the clearing system performs.<br><br>Mastercard - Required<br>Visa - Not applicbale<br><br>Possible values:<br><br>"200" – First Presentment<br>"205" – Second Presentment (Full)<br>"282" – Second Presentment (Partial)<br>"450" – First Chargeback (Full)<br>"451" – Arbitration Chargeback (Full)<br>"603" – Retrieval Request<br>"695" – File Trailer<br>"696" – Financial Detail Addendum<br>"697" – File Header<br>"700" – Fee Collection
          type: string
          format: alphanumeric
          example: '200'
          maxLength: 3
        transactionPostDate:
          description: Specifies card transaction once its posted / settled from network<br>Format - YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-01-20'
          maxLength: 10
        settlementAmount:
          description: Specifies card transaction amount where actual settlement was done<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '189.98'
          maxLength: 32
        settlementCurrencyCode:
          description: Specifies the currency code on which actual settlement of transaction was done<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: SGD
          maxLength: 3
        settlementCurrencyDescription:
          description: Specifies the currency code description on which actual settlement of transaction was done<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: Singapore Dollar
          maxLength: 70
        approvalCode:
          description: Specifies approval code which can be used for reconciliation, advise supplier/ merchants and trouble shoot declines across network
          type: string
          format: alphanumeric
          example: '802907'
          maxLength: 50
    AuthorizationRecords:
      properties:
        expiryDate:
          description: Expiry Date of the virtual card account.<br><br>Format MMYYYY<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '122021'
          maxLength: 6
        billingCurrencyAmount:
          description: Specifies the value of transaction amount which is converted to billling currency
          type: string
          format: alphanumeric
          example: '123.00'
          maxLength: 16
        billingCurrencyCode:
          description: Specifies the ISO currency code of accounts that was initially set up for billing the transactions.
          type: string
          format: alphanumeric
          example: USD
          maxLength: 3
        billingCurrencyCodeDescription:
          description: Specifies the description of currency code of accounts that was initially set up for billing the transactions.
          type: string
          format: alphanumeric
          example: US Dollar
          maxLength: 70
        billingAmountInUSD:
          description: Card Holder billing amount converted to USD currency.<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '123.00'
          maxLength: 16
        transactionCurrencyAmount:
          description: Specifies the actual transaction amount in transaction currency.
          type: string
          format: alphanumeric
          example: '123.00'
          maxLength: 16
        transactionCurrencyCode:
          description: Specifies the ISO currency code on which actual authorization of transaction was done.
          type: string
          format: alphanumeric
          example: USD
          maxLength: 3
        transactionCurrencyCodeDescription:
          description: Specifies the currency code description on which actual authorization of transaction was done.
          type: string
          format: alphanumeric
          example: US Dollar
          maxLength: 70
        transactionExchangerate:
          description: Currency exchange in operation during a payment.<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '1'
          maxLength: 7
        transactionDate:
          description: The date of the transaction that was initiated and amount debited.<br>Format - YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-01-20'
          maxLength: 10
        transactionTime:
          description: The time of the transaction that was initiated and amount debited<br>Format - hh:mm:ss
          type: string
          format: alphanumeric
          example: '19:52:11'
          maxLength: 8
        transactionType:
          description: 'Specifies the type of transaction.<br><br>Possible values - Mastercard:<br><br>"Authorization" - Transactions that have a requested authorization<br>"Auth Purchase Return" - Authorization from issuer on a reversal (refund/credit)<br>"Advice" - Non-posting message generated by either an acquirer, issuer, or system. Acquirer-generated advice message - advises of an authorization that was carried out on the issuer’s behalf. Issuer-generated advice message - sent to the risk scoring system. System-generated advice message - advises of an authorization that was carried out on the issuer’s behalf.<br> "Reversal" - Reversal Request generated by an acquirer when the acquirer is unable to deliver an issuer’s Authorization Request Response to a merchant. Merchants also may initiate a Reversal Request to cancel the full or partial amount of the original authorization amount<br>"Reversal advice" - The Reversal Advice message fully reverses a previous Authorization Request. It advises an issuer of a Reversal Request responded to by the Authorization Platform. Reversal advise is generated by the Authorization Platform on detection of an exception condition while processing a previous Authorization Request Response. The Authorization Platform may generate this message when an issuer is unavailable to respond to a Reversal Request or is delayed in providing a Reversal Request Response message.<br>"Unspecified (Offline Settlements)" - Returned when none of the transactionType values apply: Authorization, Auth Purchase Return, Advise, Reversal, Reversal advice, Purchase Return, Forced Post<br>"Purchase Return" - Clearing only refund/credit<br>"Forced Post" - Forced Posted are records inserted in the authorization journal from clearing records when the clearing record didn’t match to a preceding authorization record<br><br>Possible values - Visa:<br><br>"0" -  NOT APPLICABLE<br>"100" -  AUTHORIZATION REQUEST<br>"101" -  REPEAT AUTHORIZATION REQUEST<br>"102" -  ATM CONFIRMATION<br>"110" -  AUTHORIZATION RESPONSE<br>"120" - AUTHORIZATION ADVICE<br>"130" -  AUTHORIZATION ADVICE<br>"200" -  ORIGINAL FINANCIAL REQUEST<br>"201" -  REPEAT FINANCIAL REQUEST<br>"210" -  ORIGINAL FINANCIAL RESPONSE<br>"220" -  ORIGL/ADVC/ADJMT/RPRSNT REQUEST<br>"221" -  REPEAT FINANCIAL ADVICE<br>"230" -  ORIGL/ADVC/ADJMT/RPRSNT RESPONSE<br>"282" -  REPRESENTMENT STATUS ADVICE<br>"292" -  REPRESENTMENT STATUS ADVICE RESPONSE<br>"300" -  FILE OR INQUIRY UPDATE- ACQUIRER<br>"302" -  FILE OR INQUIRY UPDATE-ISSUER<br>"310" -  FILE UPDATE OR INQUIRY RESPONSE-ACQUIRER<br>"312" -  FILE UPDATE OR INQUIRY RESPONSE-ISSUER<br>"322" -  FILE UPDATE OR DISCREPANCY ADVICE<br>"332" -  FILE UPDATE ADVICE RESPONSE<br>"400" -  REVERSAL REQUEST<br>"401" -  REPEAT REVERSAL REQUEST<br>"410" -  REVERSAL RESPONSE<br>"420" -  REVERSAL ADVICE<br>"422" -  CHARGEBACK REQUEST<br>"430" -  REVERSAL ADVICE RESPONSE<br>"432" -  CHARGEBACK RESPONSE<br>"480" -  CHARGEBACK STATUS ADVICE<br>"490" -  CHARGEBACK STATUS ADVICE RESPONSE<br>"500" -  RECONCILIATION TOTAL REQUEST<br>"510" -  RECONCILIATION TOTAL RESPONSE<br>"520" -  RECONCILIATION ADVICE<br>"530" -  RECONCILIATION RESPONSE<br>"600" -  ADMINISTRATIVE REQUEST<br>"610" -  ADMINISTRATIVE RESPONSE<br>"620" -  ADMINISTRATIVE ADVICE<br>"622" -  ADMINISTRATIVE ADVICE RESPONSE'
          type: string
          format: alphanumeric
          example: Authorization
          maxLength: 107
        preAuthorizationFlag:
          description: Pre-Authorization request indicator with Yes/No
          type: string
          format: alphanumeric
          example: 'No'
          maxLength: 3
        addressVerificationServiceFlag:
          description: Indicates whether merchant requests address verification service. Indicator with Yes/No<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 'No'
          maxLength: 3
        merchantCategoryCode:
          description: The category under which the merchant is been assigned by the network
          type: string
          format: alphanumeric
          example: '5812'
          maxLength: 10
        mccDescription:
          description: The decsription of the category in which merchant has been assigned by the netwrok
          type: string
          format: alphanumeric
          example: EATING PLACES, RESTAURANTS
          maxLength: 200
        merchantId:
          description: The ID created for a specific merchant by the network<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 00000R-5411-USA
          maxLength: 50
        merchantName:
          description: The merchant name that corresponds to merchant id defined by the netwrok
          type: string
          format: alphanumeric
          example: GROCERY STORES, SUPERM
          maxLength: 200
        merchantState:
          description: The state under which the merchant has been categorized<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: MO
          maxLength: 100
        merchantCity:
          description: The city under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: OFALLON
          maxLength: 100
        merchantCountryCode:
          description: The conutry code defined under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: USA
          maxLength: 3
        merchantCountryName:
          description: The conutry name that corresponds to merchant country code under which the merchant has been categorised
          type: string
          format: alphanumeric
          example: United States (the)
          maxLength: 50
        merchantZipCode:
          description: The ZIP code defined under which the merchant city has been categorised<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '12345'
          maxLength: 10
        acquirerIdentifier:
          description: The identifier under which the acquirer has been categorised<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 00000999080
          maxLength: 50
        terminalId:
          description: The id under which the terminal has been categorised
          type: string
          format: alphanumeric
          example: '789254'
          maxLength: 50
        transactionId:
          description: Unique identifier of the transaction<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '380198318999999'
          maxLength: 50
        transactionEnvironment:
          description: The environment where the transaction was initaited either through ATM or POS etc.<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: POS
          maxLength: 7
        partialAuthorizationAmount:
          description: Partial Authorization Amount<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '100.02'
          maxLength: 16
        authorizationResponseDetail:
          description: Authorization Status/Reason Description from Issuer<br><br>Possible values:<br><br>Visa:<br><br>0 - APPROVED<br>1 - REFER TO ISSUER<br>2 - REFER TO ISSUER, SPCL COND<br>3 - INVALID MERCHANT<br>4 - PICK UP CARD<br>5 - DO NOT HONOR - If a transaction declines due to a VPC rule, it will fall under this error code.<br>6 - ERROR<br>7 - PICK UP CARD, SPCL COND<br>10 - APPROVAL FOR PARTIAL AMT<br>11 - APPROVED(VIP)<br>12 - INVALID TRANSACTION<br>13 - INVALID AMOUNT<br>14 - INVALID ACCOUNT NUMBER<br>15 - NO SUCH ISSUER<br>19 - RE-ENTER TRANSACTION<br>21 - NO ACTION TAKEN<br>25 - UNABLE TO LOCATE RECORD<br>28 - FILE TEMP UNAVAILABLE<br>30 - STRUCTURAL MESSAGE ERROR<br>31 - BANK NOT SUPPORTED<br>39 - NO CREDIT ACCOUNT<br>41 - PICK UP CARD-LOST<br>43 - PICK UP CARD-STOLEN<br>51 - NOT SUFFICIENT FUNDS<br>52 - NO CHECKING ACCOUNT<br>53 - NO SAVINGS ACCOUNT<br>54 - EXPIRED CARD/NO EXP DATE<br>55 - INCORRECT OR MISSING PIN<br>56 - UNABLE TO LOCATE RECORD<br>57 - TRANSACTION NOT PERMITTED<br>58 - TRAN INVALID AT TERMINAL<br>59 - SUSPECTED FRAUD<br>61 - OVER ACTIVITY AMT LIMI<br>62 - RESTRICTED CARD<br>63 - SECURITY VIOLATION<br>64 - TRANSACTION DOES NOT MEET<br>65 - OVER ACTIVITY COUNT LIMIT<br>68 - LATE RESPONSE<br>75 - PIN ENTRY TRIES EXCEEDED<br>76 - UNSOLICITED REVERSAL<br>77 - PREV MSG INCONSISTENT<br>78 - NO ACCOUNT<br>79 - ALREADY REVERSED<br>80 - NO FINANCIAL IMPACT<br>81 - CRYPTOGRAPHIC ERROR FOUND<br>82 - INCORRECT CVV/ICVV<br>83 - UNABLE TO VERIFY PIN<br>84 - OVER PREAUTH TIME LIMIT<br>85 - NO REASON TO DECLINE<br>86 - CANNOT VERIFY PIN NO PVV<br>87 - RECONCILIATION TOTALING S<br>88 - CANNOT PROVIDE TOTALS NOW<br>89 - INELIGIBLE TO RECEIVE GIV<br>91 - ISSUER/SWITCH INOPERATIVE<br>92 - ROUTING DEST NOT FOUND<br>93 - ILLEGAL TRAN NOT COMPLETE<br>94 - DUPLICATE TRANSMISSION<br>96 - SYSTEM MALFUNCTION<br>A4 - EXCPTN FILE 6000USD LIMIT<br>A7 - EXCPTN FILE 10K USD LIMIT<br>A8 - EXCPTN FILE 1500USD LIMIT<br>A9 - EXCPTN FILE 2225USD LIMIT<br>B1 - SURCHARGE AMT NOT PERMITT<br>B2 - SURCHARGE AMT NOT SUPPORT<br>N0 - FORCE STIP<br>N3 - CASH SERVICE UNAVAILABLE<br>N4 - CASH REQ > ISSUER LIMIT<br>N5 - INELIGIBLE TO RESUBMIT<br>N6 - INCORRECT CVV<br>N7 - DECLINE CVV2 FAILURE<br>N8 - TRAN AMOUNT > PREAUTH AMT<br>P0 - APPROVED, PVID CD MISSING<br>P1 - DECLINED, PVID CD MISSING<br>P2 - INVALID BILLER INFORMATIO<br>P5 - DECLINE OF REQUEST<br>P6 - UNSAFE PIN<br>Q1 - CARD AUTHENTICATION FAIL<br>R0 - STOP PAYMENT ORDER<br>R1 - REVOCATION OF AUTH ORDER<br>R2 - TRANSACTION DOESN'T QUALI<br>R3 - REVOCATION OF ALL AUTHORI<br>T0 - FIRST-TIME CHECK<br>T1 - CHECK OK CANNOT CONVERT<br>T2 - INVALID ROUTING TRANSIT<br>T3 - AMOUNT > SERVICE LIMIT<br>T4 - UNPAID ITEMS/NEG FILE CHK<br>T5 - DUPLICATE CHECK NUMBER<br>T6 - MICR ERROR<br>T7 - TOO MANY CHECKS > LIMIT<br>XA - FORWARD TO ISSUER<br>XD - FORWARD TO ISSUER <br>Y1 - OFFLINE APPROVED<br>Y3 - APPROVED UNABLE ONLINE <br>Z1 - OFFLINE DECLINED<br>Z3 - DECLINED UNABLE ONLINE<br><br>Mastercard:<br><br>"Approved or completed successfully"<br>"Refer to card issuer"<br>"Invalid merchant"<br>"Capture card"<br>"Do not honor"<br>"Honor with ID"<br>"Partial Approval"<br>"Invalid transaction"<br>"Invalid amount"<br>"Invalid card number"<br>"Invalid issuer"<br>"Format error"<br>"Lost card"<br>"Insufficient funds/over credit limit"<br>"Expired card"<br>"Invalid PIN"<br>"Transaction not permitted to issuer/cardholder"<br>"Transaction not permitted to acquirer/terminal"<br>"Exceeds withdrawal amount limit"<br>"Restricted card"<br>"Security violation"<br>"Exceeds withdrawal count limit"<br>"Contact Card Issuer"<br>"PIN Not Changed"<br>"Allowable number of PIN tries exceeded"<br>"Invalid/nonexistent To Account specified"<br>"Invalid/nonexistent From Account specified"<br>"Invalid/nonexistent account specified (general)"<br>"Domestic Debit Transaction Not Allowed (Regional use only)"<br>"Invalid Authorization Life Cycle"<br>"Not declined"<br>"PIN Validation not possible"<br>"Purchase Amount Only, No Cash Back Allowed"<br>"Cryptographic failure"<br>"Unacceptable PIN - Transaction Declined - Retry"<br>"Authorization Platform or issuer system inoperative"<br>"Unable to route transaction"<br>"Duplicate transmission detected"<br>"System error"
          type: string
          format: alphanumeric
          example: Refer to card issuer
          maxLength: 83
        vcaAuthorizationResponseDetail:
          description: Authorization status/reason description from Networks Payment Control<br><br>Possible values:<br><br>Visa:<br><br>ADT - Adult Themed merchants restriction<br>AIR - Airline merchants restriction<br>ALC - Alcohol merchants restriction<br>ATM - ATM cash disbursement restriction<br>ATML - ATM cash disbursement amount limit<br>AUTO - Auto merchants restriction<br>BUS - Business hours restriction<br>BUSS - Business Services merchants restriction<br>CAID - Card Acceptor Code restriction<br>CLOTH - General retail merchants restriction<br>CNP - Card-not-present restriction<br>CNTR - General Contractor Services merchant restriction<br>DOM - State-level transaction restrictions<br>EAM - E-commerce with transaction amount limit<br>ECOM - E-commerce transaction restriction<br>ELEC - Electronics merchants restriction<br>ENT - Entertainment related merchants restriction<br>FUEL - Fuel merchants restriction<br>GOV - Government Services merchants restriction<br>GROC - Grocery Stores and Pharmacies merchants restriction<br>GTM - Ground Transportation merchants restriction<br>HOT - Hotel merchants restriction<br>JEWL - Jewelery merchants restriction<br>MED - Medical retail merchants restriction<br>MISC - Miscellaneous Retailer restriction<br>NOC - Block all other cash access transaction<br>NOTFUEL - Non fuel merchants restriction<br>OSS - Office Supply merchants restriction<br>PROF - Professional Services and Membership Organizations restriction<br>PUR - Purchase amount limit<br>QSR - Fastfood merchants restriction<br>REST - Restaurant merchants restriction<br>RETL - Retail Outlet Services restriction<br>SPV - Spend Velocity restriction<br>TOLRNC - Tolerance range restriction<br>UTIL - Utilities merchants restriction<br>VPAS - Exact Match restriction<br>XBR - Cross-border transaction restriction<br>XBRA - Cross-border transaction restrictions with amount limits<br>XBRB - Country restriction<br>XBRX - Country restriction<br><br>Mastercard:<br><br>"Approval" - Transaction within the VCN limits.<br>"CPN does not exist" - Invalid VCN, not registered in In Control.<br>"Status bad" - VCN not in an active state. Cannot use forauthorizations.<br>"Expiry match fail" - Expiry provided for the authorization does not match the VCN Expiry.<br>"AVV match fail" - CVC2 provided for the authorization does not match the VCN CVC2.<br>"Valid period fail" - Transaction falls outside the VCN’s defined validity period.<br>"Trans limit fail" - Transaction amount greater than the VCN’s transaction limit.<br>"Cumul limit fail" - Current authorization causes the VCN to breach its cumulative spend limit.<br>"Num usages fail" - Current authorization causes the VCN to breach its usage limit.<br>"Merch Id limit fail" - Merchant Id for authorization does not match the Merchant Id linked to the VCN.<br>"MCC limit fail" - Merchant Category Code for the authorization does not match the MCC linked to this VCN.<br>"Iss/Netwk decline" - Authorization declined by the issuer or card network. Outside of In Control.<br>"Base/CPN conv. Err" - <br>"Crit Field Missing" - Critical field missing from the incoming authorization message.<br>"No Auth for Rev" - In Control cannot map the reversal to an original authorization.<br>"Unmatched Response" - Advice does not match any past requests in the authorization journal<br>"Revl of unsucc auth" - In Control cannot reverse an unsuccessful authorization<br>"Exp. Date of CPN used is expired" - VCN expired.<br>"Repeat message" - Repeat of a previous message. Based on a flag in the message header or on key message fields.<br>"Api fail"<br>"Api System Fail"<br>"Enhanced MID" - Acquirer Id (DE32) and Card Acceptor Id (DE42) in the authorization message do not match the values specified for the control.<br>"Enhanced MCC" - MCC value in the authorization message (D18) does not match the values specified for the control.<br>"Txn Env Control" - VCN breached its transaction environment control.<br>"Err Travel Control" - VCN breached its travel control rule.<br>"Multi Merch ID Assoc Lim" - Merchant Id for the authorization does not match any of those linked to this VCN.<br>"Single Merch Name Assoc Lim" - Merchant Name for the authorization does not match that linked to this VCN.<br>"Geographic Control" - VCN breached its geographic control rule.<br>"Curfew Control" - VCN breached its curfew control rule.<br>"Approve Control" - VCN breached its approve control rule.<br>"RCN Decline" - Transaction failed due to decline by a subsequent service.<br>"No Rules Fail" - Rule set with no rules to evaluate.<br>"No Controls Fail" - Rule with no controls to evaluate.<br>"Unknown Control Type Fail" - Cannot classify the control fail<br>"Svc Not Enabled" - Transaction received for an account with no service enabled<br>"Merch Amount Fail" - Transaction amount breaches the expected merchant currency<br>"Merch Curr Fail" - Transaction amount breaches the amount limit for the merchant currency.<br>"DE Control fail" - Values for DE3.1 – Processing Code and/or DE22.1 – PAN Entry Mode and/or61.11 – POS Term Capability Indicator do not match the values in the authorization.<br>"EVCN Control fail" - EVCN not in an active state. Cannot use for authorization.<br>"Roaming VC Fail" - VCN breaches its roaming velocity control.<br>"Amount Range Control Fail" - Transaction amount falls outside the minimum and maximum amount range set.<br>"CPN State Control Fail" - Account suspended. No authorization activity permitted.<br>"Aging Cumul limit fail" - Control that keeps track of the current remaining Available Credit. Approves transactions only if the requested amount is less than or equal to the remaining Available Credit.
          type: string
          format: alphanumeric
          example: Iss/Netwk decline
          maxLength: 69
        authorizationResponseCategory:
          description: Authorization Category Description from VisaNet<br>Mastercard - Not applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: ADT - Adult Themed merchants restriction
        settled:
          description: 'Indicates whether the transaction is unsettled, or settled with anassociated cleared transaction record.<br><br>Visa - Not Applicable<br><br>Mastercard - Required <br><br>Possible values: <br>Settled<br>Unsettled'
          type: string
          format: alphanumeric
          example: Unsettled
          maxLength: 9
        stipAdviceCode:
          description: Stand In Processing Advance Code<br><br>Mastercard - Not Applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '5'
          maxLength: 4
        stipSwitchReasonCod:
          description: Stand In Processing Switch Reason Code<br><br>Mastercard - Not Applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: '0000'
          maxLength: 10
        stipSwitchReasonDescription:
          description: Stand In Processing Switch Reason Description<br><br>Mastercard - Not Applicable<br>Visa - Required
          type: string
          format: alphanumeric
          example: NOT APPLICABLE
          maxLength: 200
    ClearingReportInboundResponse:
      properties:
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '67676781'
          maxLength: 19
        messageId:
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per API request.
          type: string
          format: alphanumeric
          example: CITI0000000ClearReport20230825120311
          maxLength: 36
          minLength: 28
        programId:
          description: Unique ID of the company record defined in the virtual cards system.
          type: string
          format: alphanumeric
          example: '233191'
          maxLength: 25
        startDate:
          description: Specifies the start date from when the reports can be retrieved<br><br>Format:YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        endDate:
          description: Specifies the end date from when the reports can be retrieved<br><br>Format:YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-03-30'
          maxLength: 10
        startTime:
          description: Specifies the start time from when the reports can be retrieved<br><br>Format:HH:MM<br><br>Mastercard - Optional<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 00:00
          maxLength: 10
        endTime:
          description: Specifies the end time upto when the reports can be retrieved<br><br>Format:HH:MM<br><br>Mastercard - Optional<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '23:59'
          maxLength: 10
        reportStatus:
          description: Status of whether the report request was processed.<br><br>Mastercard - If a report status other than COMPLETED is returned, subsequently call the Reports API with the orginal request parameter previously passed along with the list of reportIds for each 30-day date range that did not return a COMPLETED report status
          type: string
          format: alphanumeric
          example: COMPLETED
          maxLength: 19
          enum:
          - COMPLETED
          - PARTIALLY COMPLETED
          - FAILED
          - PENDING
        warning:
          description: Warning information regarding a non-fatal response condition that may be taken into account, but can be ignored
          type: string
          format: alphanumeric
          example: Warning message
          maxLength: 200
        timeZone:
          description: Defines the time zone applicable for any date or time<br>UTC offset
          type: string
          format: alphanumeric
          example: UTC+05:30
          maxLength: 9
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.
          type: string
          format: alphanumeric
          example: '5281722601926445'
          maxLength: 19
        transactionType:
          description: Specifies the type of  transaction.<br><br>Possible values:<br><br>Mastercard:<br><br>"First Presentment" - Transactions where an acquire has initiated a first presentment to advise the issuer or its agent that a financial transaction was completed on its behalf<br>"Second Presentment (Full)" - Acquirer-initiated transaction to remedy a previous First Chargeback for the full First Presentment amount<br>"Second Presentment (Partial)" - Acquirer-initiated transaction to remedy a previous First Presentment or First Chargeback for part of the First Presentment amount or First Chargeback amount<br>"First Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount<br>"Arbitration Chargeback (Full)" - Issuer-initiated transaction to completely return a previous First Presentment amount<br>"First Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount<br>"Arbitration Chargeback (Partial)" - Issuer-initiated transaction to partially return a previous First Presentment amount or Second Presentment amount<br><br>Visa:<br><br>10 = Purchase<br>11 = Credit Voucher<br>20 = Manual Cash Disbursement<br>22 = ATM Cash Disbursement<br>30 = Payment<br>Reversal - NSF Check<br>31 = Payment<br>40 = Finance Charge<br>50 = Annual Fee<br>52 = Miscellaneous Fees<br>54 = NSF Check Fee<br>56 = Report Fee<br>61 = Credit Adjustment<br>62 = Debit Adjustment<br>63 = Finance Charge Credit Adjustment<br>64 = Finance Charge Debit Adjustment<br>65 = Other Credits<br>66 = Other Debits<br>71 = Fuel Discount<br>73 = Non-Fuel Discount<br>80 = Convenience Checks<br>82 = Convenience Checks Fees<br>84 = Travelers Checks Fees<br>86 = ATM Fees<br>88 = Late Fees
          type: string
          format: alphanumeric
          example: All
        filters:
          $ref: '#/components/schemas/ResponseFilters'
        info:
          type: array
          items:
            $ref: '#/components/schemas/ClearingInfo'
        clearingRecords:
          type: array
          items:
            $ref: '#/components/schemas/ClearingRecords'
      required:
      - vcaId
      - messageId
      - programId
      - startDate
      - endDate
      - reportStatus
      - virtualCardAccountNumber
      - transactionType
    AuthReportInboundResponse:
      properties:
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '67676781'
          maxLength: 19
        messageId:
          description: Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per API request.
          type: string
          format: alphanumeric
          example: CITI00000000AuthReport20230825120311
          maxLength: 36
          minLength: 28
        programId:
          description: Unique ID of the company record defined in the virtual cards system.
          type: string
          format: alphanumeric
          example: '233191'
          maxLength: 25
        startDate:
          description: Specifies the start date from when the reports can be retrieved<br><br>Format:YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        endDate:
          description: Specifies the start date from when the reports can be retrieved<br><br>Format:YYYY-MM-DD
          type: string
          format: alphanumeric
          example: '2023-03-30'
          maxLength: 10
        startTime:
          description: Specifies the start time from when the reports can be retrieved<br><br>Format:HH:MM
          type: string
          format: alphanumeric
          example: 00:00
          maxLength: 10
        endTime:
          description: Specifies the end time upto when the reports can be retrieved<br><br>Format:HH:MM
          type: string
          format: alphanumeric
          example: '23:59'
          maxLength: 10
        reportStatus:
          description: Status of whether the report request was processed.<br><br>Mastercard - If a report status other than COMPLETED is returned, subsequently call the Reports API with the orginal request parameter previously passed along with the list of reportIds for each 30-day date range that did not return a COMPLETED report status
          type: string
          format: alphanumeric
          example: COMPLETED
          maxLength: 19
          enum:
          - COMPLETED
          - PARTIALLY COMPLETED
          - FAILED
          - PENDING
        warning:
          description: Warning information regarding a non-fatal response condition that may be taken into account, but can be ignored
          type: string
          format: alphanumeric
          example: Warning message
          maxLength: 200
        timeZone:
          description: Defines the time zone applicable for any date or time<br>UTC offset
          type: string
          format: alphanumeric
          example: UTC+05:30
          maxLength: 9
        transactionType:
          description: 'Specifies the type of transaction.<br><br>Possible values - Mastercard:<br><br>"Authorization" - Transactions that have a requested authorization<br>"Auth Purchase Return" - Authorization from issuer on a reversal (refund/credit)<br>"Advice" - Non-posting message generated by either an acquirer, issuer, or system. Acquirer-generated advice message - advises of an authorization that was carried out on the issuer’s behalf. Issuer-generated advice message - sent to the risk scoring system. System-generated advice message - advises of an authorization that was carried out on the issuer’s behalf.<br> "Reversal" - Reversal Request generated by an acquirer when the acquirer is unable to deliver an issuer’s Authorization Request Response to a merchant. Merchants also may initiate a Reversal Request to cancel the full or partial amount of the original authorization amount<br>"Reversal advice" - The Reversal Advice message fully reverses a previous Authorization Request. It advises an issuer of a Reversal Request responded to by the Authorization Platform. Reversal advise is generated by the Authorization Platform on detection of an exception condition while processing a previous Authorization Request Response. The Authorization Platform may generate this message when an issuer is unavailable to respond to a Reversal Request or is delayed in providing a Reversal Request Response message.<br>"Unspecified (Offline Settlements)" - Returned when none of the transactionType values apply: Authorization, Auth Purchase Return, Advise, Reversal, Reversal advice, Purchase Return, Forced Post<br>"Purchase Return" - Clearing only refund/credit<br>"Forced Post" - Forced Posted are records inserted in the authorization journal from clearing records when the clearing record didn’t match to a preceding authorization record<br><br>Possible values - Visa:<br><br>"0" -  NOT APPLICABLE<br>"100" -  AUTHORIZATION REQUEST<br>"101" -  REPEAT AUTHORIZATION REQUEST<br>"102" -  ATM CONFIRMATION<br>"110" -  AUTHORIZATION RESPONSE<br>"120" - AUTHORIZATION ADVICE<br>"130" -  AUTHORIZATION ADVICE<br>"200" -  ORIGINAL FINANCIAL REQUEST<br>"201" -  REPEAT FINANCIAL REQUEST<br>"210" -  ORIGINAL FINANCIAL RESPONSE<br>"220" -  ORIGL/ADVC/ADJMT/RPRSNT REQUEST<br>"221" -  REPEAT FINANCIAL ADVICE<br>"230" -  ORIGL/ADVC/ADJMT/RPRSNT RESPONSE<br>"282" -  REPRESENTMENT STATUS ADVICE<br>"292" -  REPRESENTMENT STATUS ADVICE RESPONSE<br>"300" -  FILE OR INQUIRY UPDATE- ACQUIRER<br>"302" -  FILE OR INQUIRY UPDATE-ISSUER<br>"310" -  FILE UPDATE OR INQUIRY RESPONSE-ACQUIRER<br>"312" -  FILE UPDATE OR INQUIRY RESPONSE-ISSUER<br>"322" -  FILE UPDATE OR DISCREPANCY ADVICE<br>"332" -  FILE UPDATE ADVICE RESPONSE<br>"400" -  REVERSAL REQUEST<br>"401" -  REPEAT REVERSAL REQUEST<br>"410" -  REVERSAL RESPONSE<br>"420" -  REVERSAL ADVICE<br>"422" -  CHARGEBACK REQUEST<br>"430" -  REVERSAL ADVICE RESPONSE<br>"432" -  CHARGEBACK RESPONSE<br>"480" -  CHARGEBACK STATUS ADVICE<br>"490" -  CHARGEBACK STATUS ADVICE RESPONSE<br>"500" -  RECONCILIATION TOTAL REQUEST<br>"510" -  RECONCILIATION TOTAL RESPONSE<br>"520" -  RECONCILIATION ADVICE<br>"530" -  RECONCILIATION RESPONSE<br>"600" -  ADMINISTRATIVE REQUEST<br>"610" -  ADMINISTRATIVE RESPONSE<br>"620" -  ADMINISTRATIVE ADVICE<br>"622" -  ADMINISTRATIVE ADVICE RESPONSE'
          type: string
          format: alphanumeric
          example: All
          maxLength: 20
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.
          type: string
          format: alphanumeric
          example: '5281722601926445'
          maxLength: 19
        filters:
          $ref: '#/components/schemas/ResponseFilters'
        info:
          type: array
          items:
            $ref: '#/components/schemas/AuthInfo'
        authorizationRecords:
          type: array
          items:
            $ref: '#/components/schemas/AuthorizationRecords'
      required:
      - vcaId
      - messageId
      - programId
      - startDate
      - endDate
      - reportStatus
      - transactionType
      - virtualCardAccountNumber
    ClearingInfo:
      properties:
        fromDate:
          description: Specifies the start date from when the reports can be retrieved<br>Format - YYYY-MM-DD<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        toDate:
          description: Specifies the end date upto when the reports can be retrieved<br><br>Format - YYYY-MM-DD<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '2023-02-01'
          maxLength: 10
        reportId:
          description: The report Id generated for a given 30-day date range<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '12345'
        errorCode:
          description: The error code if there is any error occurred while retrieving the trsansaction
          type: string
          format: alphanumeric
          example: MS0006
        errorMessage:
          description: The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
          type: string
          format: alphanumeric
          example: Invalid vcaId value
          maxLength: 200
        status:
          description: Defines the status of the data that was requested whether the request has been processed or not.<br>Visa - Not applicable<br>Mastercard - Required<br><br>Possible values:<br>COMPLETED<br>FAILED<br>PENDING<br>IN PROGRESS
          type: string
          format: alphanumeric
          example: COMPLETED
          maxLength: 10
    ServerErrorResponseForClearingReport:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ClearingServerErrors'
    ClearingReportInboundRequest:
      properties:
        startDate:
          description: "Specifies the end date upto when the reports can be retrieved<br><br>Format:YYYY-MM-DD<br><br>Rules:<ol><li>End date should greater than the start date</li><li>Mastercard:  <ul><li>startDate and endDate cannot be more than 90 days apart</li><li>startDate and endDate can be up to 36 months\n in the past from the day of report requested and not future date</li></ul></li><li>Visa:<ul><li>startDate and endDate cannot be more than 90 days apart</li><li>startDate and endDate can be up to 6 months\n in the past from the day of report requested and not future date</li></ul></li></ol>"
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        endDate:
          description: "Specifies the end date upto when the reports can be retrieved<br><br>Format:YYYY-MM-DD<br><br>Rules:<ol><li>End date should greater than the start date</li><li>Mastercard:  <ul><li>startDate and endDate cannot be more than 90 days apart</li><li>If endDate is more than 90 days after startDate, it will be automatically reset to exactly 90 days after startDate</li><li>startDate and endDate can be up to 36 months\n in the past from the day of report requested and not future date</li></ul></li><li>Visa:<ul><li>startDate and endDate cannot be more than 90 days apart</li><li>If endDate is more than 90 days after startDate, it will be automatically reset to exactly 90 days after startDate</li><li>startDate and endDate can be up to 6 months\n in the past from the day of report requested and not future date</li></ul></li></ol>"
          type: string
          format: alphanumeric
          example: '2023-01-30'
          maxLength: 10
        startTime:
          description: Specifies the start time from when the reports can be retrieved<br><br>Format:HH:MM<br><br>Mastercard - Optional<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: 00:00
          maxLength: 10
        endTime:
          description: Specifies the end time upto when the reports can be retrieved<br><br>Format:HH:MM<br><br>Mastercard - Optional<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '23:59'
          maxLength: 10
        transactionType:
          description: 'Specifies the nature of the transaction whether it was authorized or returned etc.<br><br>Visa - Not applicable<br><br>Mastercard - Optional<br><br>Possible Values:<br><br>"All" - Returns all Clearing transactions associated to a virtual card account for a given time range<br>"Presentment" - First Presentment transactions<br>"Second Presentment" - Second Presentment transactions in response to a Chargeback initaited from Issuer<br>"Chargeback" - First Chargeback transactions (Full & Partial)<br>"Arbitration Chargeback" - Arbitration chargeback transactions (Full & Partial)<br>"Retrieval Request" - Transactions where an issuer sent a Retrieval Request to an acquirer when it is determined that thetransaction information document needs to be examined for issuer or cardholder needs.<br>"Fee collection" - Transactions related to the collection or disbursement of fees that require funds settlement between various clearing system participants. Fee Collection messages may include fees generated between pairs of customers, and fees generated between the Corporation and customers. Following are some examples of Fee Collection messages: • Collection or disbursement from customer to customer of fees that brand, program, and service rules permit<br> • Collection or disbursement from Mastercard to customer of fees related to processing services that the clearing system provides<br> • Collection or disbursement from Mastercard to customer of such fees as administrative fees, membership fees, and penalties, according to brand, program, and service<br> • Collection or disbursement from customer to customer of summary settlement positions between customers that participate in bilateral clearing arrangements with clearing system summary settlement'
          type: string
          format: alphanumeric
          example: All
          maxLength: 20
        vcaId:
          description: A reference number that uniquely identifies the virtual card account.
          type: string
          format: alphanumeric
          example: '67676781'
          maxLength: 19
        programId:
          description: Unique ID of the company record defined in the virtual cards system.<br><br>Mastercard - This value is returned in the ID Provisioning API. This value is generated when the VCA program is onboarded to Mastercard's VCA platform. Data format - Long (Numeric). Max character length - 19<br><br>Visa - This value is generated when the VCA program is onboarded to Visa's VCA platform. Data format - Alphanumeric. Max character length - 25
          type: string
          format: alphanumeric
          example: '233191'
          maxLength: 25
        messageId:
          description: nique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID must be unique per API request and cannot include special characters
          type: string
          format: alphanumeric
          example: CITI0000000ClearReport20230825120311
          maxLength: 36
          minLength: 28
        virtualCardAccountNumber:
          description: The virtual card account number to use for transactions.<br><br>Numeric field and no decimals allowed
          type: string
          format: alphanumeric
          example: '5281722601926445'
          maxLength: 16
        timeZone:
          description: Defines the time zone applicable for any date or time<br><br>UTC offset<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: UTC+05:30
          maxLength: 9
        reportIds:
          description: An optional reportId array passed by client to fetch the Clearing report transactions that previously returned a "PENDING" or "IN-PROGRESS" report status. When calling the API with reportId, pass all other request parameters as orignally passed in the previous request<br><br>Mastercard - Optional<br>Visa - Not applicable
          type: array
          items:
            type: string
          format: alphanumeric
          example:
          - '12345'
        filters:
          $ref: '#/components/schemas/RequestFilters'
      required:
      - startDate
      - endDate
      - vcaId
      - programId
      - messageId
      - virtualCardAccountNumber
    AuthServerErrors:
      properties:
        errorCode:
          description: The error code if there is any error occurred while retrieving the transaction
          type: string
          format: alphanumeric
          example: GRC0014
        errorDescription:
          description: '"The error description that corresponds to error code when there is any error occurred while retrieving the transaction.<br>* `GRC0001` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0006` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0009` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.<br>* `GRC0014` - We have encountered an error and couldnt receive your request. Please try again, or contact Citi support if you have any further questions or comments.'
          type: string
          format: alphanumeric
          example: We have encountered an error and couldn`t receive your request. Please try again, or contact Citi support if you have any further questions or comments
    AuthInfo:
      properties:
        fromDate:
          description: Specifies the start date from when the reports can be retrieved<br>Format - YYYY-MM-DD<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '2023-01-01'
          maxLength: 10
        toDate:
          description: Specifies the end date upto when the reports can be retrieved<br><br>Format - YYYY-MM-DD<br><br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
          example: '2023-02-01'
          maxLength: 10
        reportId:
          description: The report Id generated for a given 30-day date range<br>Mastercard - Required<br>Visa - Not applicable
          type: string
          format: alphanumeric
        errorCode:
          description: The error code if there is any error occurred while retrieving the transaction
          type: string
          format: alphanumeric
          example: ERC0004
        errorMessage:
          description: The error description that corresponds to error code when there is any error occurred while retrieving the transaction.
          type: string
          format: alphanumeric
          example: Transactions were unable to be returned for the requested data range. Please try again, or contact Citi support if you have any further questions or comments.
          maxLength: 200
        status:
          description: Defines the status of the data that was requested whether the request has been processed or not.<br>Visa - Not applicable<br>Mastercard - Required<br><br>Possible values:<br>COMPLETED<br>FAILED<br>PENDING<br>IN PROGRESS
          type: string
          format: alphanumeric
          example: PENDING
          maxLength: 10
    ResponseFilters:
      description: Provides variaous filter features which are optional in nature
      type: object
      properties:
        sortOrder:
          description: 'Specifies the oder in which transactions are sorted.<br><br>Applicable for Mastercard only<br><br>`Possible values`: ASCENDING, DESCENDING'
          type: string
          format: alphanumeric
          example: ASCENDING
          maxLength: 10
        paginationApplied:
          description: Specifies whether pagination has been requested or not
          type: string
          format: boolean
          example: 'true'
        startIndex:
          description: Specifies the start index of the transactions being requested for pagination
          type: string
          format: alphanumeric
          example: '1'
        endIndex:
          description: Specifies the end index of the transactions being requested for pagination.
          type: string
          format: alphanumeric
          example: '100'
        lastIndex:
          description: Specifies the index of the last available transaction.<br><br>Applicable for Mastercard only
          type: string
          format: alphanumeric
          example: '250'
        hasMore:
          description: Specifie if there further transactions after the endIndex.
          type: string
          format: boolean
          example: 'true'
  securitySchemes:
    clientCredentials:
      description: 'All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See <a href="../../authentication/authentication-api-reference/" target="_blank">the Citi Authentication API reference</a> for information on requesting a token.<br><br>Sandbox Token URL: https://tts.sandbox.apib2b.citi.com/tts/api/oauth2/token<br>


        '
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            /api: ''
          tokenUrl: https://tts.apib2b.citi.com/tts/cards/api/oauth2/token
x-refined-from:
- citi-id-provisioning-openapi.yaml
- citi-purchase-openapi.yaml
- citi-virtual-cards-notifications-openapi.yaml
- citi-virtual-cards-pi-openapi.yaml
- citi-virtual-cards-reporting-openapi.yaml