---
swagger: "2.0"
info:
  title: crds-ccc-d-recurring-charge-cancellation
  description: This microservice is used to cancel instructions of recurring charges
    and scheduled payments.
  version: 1.0.0
  x-ibm-name: crds-ccc-d-recurring-charge-cancellation
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/cards/credit-cards/recurring-charges/cancellation:
    post:
      tags:
      - cancellation-recurring-charges
      operationId: cancellation-recurring-charges
      summary: 'LOB:Credit&Cards; Feature: Recurring charges; Functionality: Cancellation.'
      description: This API is used to cancel a recurring charge instruction registered
        in backend.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: false
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: false
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: cancellationRecurringChargesRequest
        in: body
        schema:
          $ref: '#/definitions/CancellationRecurringChargesRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CancellationRecurringChargeResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  CancellationRecurringChargesRequest:
    type: object
    properties:
      languageCode:
        description: 'Agent''s language code. For Eg: 1 = Spanish, 2 = English.'
        type: string
        maxLength: 1
        example: "1"
      bankCode:
        description: Name of the issuing bank where the branch is associated. Eg 2
          = Banamex.
        type: string
        maxLength: 4
        example: "2"
      companyCode:
        description: Code associated to a service provider. Eg. 201 = CFE, 115 = TELMEX.
        type: string
        maxLength: 6
        example: "115"
      paymentInstructionId:
        description: Number generated by the backend system to identify the recurring
          charge.
        type: string
        maxLength: 8
        example: "32145698"
      paymentAuthorizationCode:
        description: Authorization number generated by the backend system to identify
          the transaction.
        type: string
        maxLength: 8
        example: "12345678"
    required:
    - languageCode
    - bankCode
    - companyCode
    - paymentInstructionId
    - paymentAuthorizationCode
  CancellationRecurringChargeResponse:
    type: object
    properties:
      languageCode:
        description: 'Agent''s language code. For Eg: 1 = Spanish, 2 = English.'
        type: string
        maxLength: 1
        example: "1"
      paymentAuthorizationCode:
        description: Authorization number generated by the backend system to identify
          the transaction.
        type: string
        maxLength: 8
        example: "87654321"
      transaction:
        $ref: '#/definitions/Transaction'
  Transaction:
    type: object
    properties:
      transactionDescription:
        description: Refers to the detailed description of the transaction.
        type: string
        maxLength: 248
        example: Transaction Canceled
      transactionStatus:
        description: Refers to the status of the transaction.
        type: string
        maxLength: 2
        example: "90"
      productCode:
        description: Product code associated with the order
        type: string
        maxLength: 4
        example: "4321"
      transactionInstrumentId:
        description: This attribute holds the unique identifier for different payment
          instrument.
        type: string
        maxLength: 4
        example: "4321"
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: More Info can be used to pass any additional details
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...