---
swagger: "2.0"
info:
  title: crds-ccc-d-recurring-charge-retrieve
  description: This microservice is used to retrieve instructions of recurring charges
    and scheduled payments.
  version: 1.0.0
  x-ibm-name: crds-ccc-d-recurring-charge-retrieve
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/cards/recurring-charges/retrieve:
    post:
      tags:
      - retrieve-recurring-charges
      operationId: retrieve-recurring-charges
      summary: 'LOB:Credit&Cards; Feature: Recurring charges; Functionality: Retrieve.'
      description: This API is used to retrieve 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: retrieveRecurringChargesRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveRecurringChargesRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveRecurringChargesResponse'
        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:
  RetrieveRecurringChargesRequest:
    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"
      payment:
        $ref: '#/definitions/Payment'
    required:
    - languageCode
    - companyCode
  RetrieveRecurringChargesResponse:
    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"
      aliasName:
        description: Description added by user to identify the operation.
        type: string
        maxLength: 20
        example: Home Electricity
      lastUpdateDate:
        description: Date when last updated.Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: 22/06/2022
      cancelReason:
        description: Reason for Case Cancellation, Only in the scenario in which an
          inoperable instruction is activated again in the registration.
        type: string
        maxLength: 4
        example: "12"
      account:
        $ref: '#/definitions/Account'
  Payment:
    type: object
    properties:
      paymentInstructionId:
        description: Number generated by the backend system to identify the recurring
          charge.
        type: string
        maxLength: 8
        example: "12345678"
      accountNumber:
        description: Customer's Account Number with the Bank.
        type: string
        maxLength: 20
        example: "4152313655668879"
      paymentReferenceNumber:
        description: This attribute holds a reference number for payments. Eg RPU
          number.
        type: string
        maxLength: 20
        example: "12345678901"
    required:
    - paymentInstructionId
  Account:
    type: object
    properties:
      customerId:
        description: Customer ID is a key associated with a specific entity or person
          Citi does business or has some relationship with.
        type: string
        maxLength: 12
        example: "123456789"
      autoDebitAccountNumber:
        description: Account number or destination account related with the service
          to be paid.
        type: string
        maxLength: 20
        example: "4152313645671594"
      paymentFrequencyType:
        description: 'Periodicity of instruction. Eg: 4 = Daily, 5 = Weekly, 6 = Fortnightly,
          7 = Monthly, 8 = Bimonthly, 9 = Quarterly, 10 = Four-monthly, 11 = Semester,
          12 = Annual.'
        type: string
        maxLength: 2
        example: "4"
      accountingTellerId:
        description: It is the accounting box that is affected. Register the accounting
          movements of an account.
        type: string
        maxLength: 2
        example: "12"
      contractNumber:
        description: Contract number used to represent an account contract uniquely
        type: string
        maxLength: 20
        example: "123456789"
      transaction:
        $ref: '#/definitions/Transaction'
      partyAndOrganization:
        $ref: '#/definitions/PartyAndOrganization'
  Transaction:
    type: object
    properties:
      statementCycleCode:
        description: This date indicates the plastic cutoff day.
        type: string
        maxLength: 2
        example: "12"
      transactionId:
        description: Refers to the unique identifier associated with the operation
          made by  the operator.
        type: string
        maxLength: 4
        example: "1234"
      paymentMode:
        description: 'Payment option. Eg: Minimum = M, Total = T, 1 = Pesos, 3 = UDIS.'
        type: string
        maxLength: 1
        example: "1"
      requestReceiptFlag:
        description: It indicates if a voucher should be sent to the customer.
        type: boolean
        example: true
      transactionStatus:
        description: Refers to the status of the transaction.
        type: string
        maxLength: 2
        example: "40"
      billingCurrencyCode:
        description: Refers to currency in which billing is to be done.
        type: string
        maxLength: 2
        example: "1"
      transactionDescription:
        description: Refers to the detailed description of the transaction.
        type: string
        maxLength: 20
        example: REGISTER
      localTransactionTime:
        description: Local time when the transaction takes place at the acceptor location.This
          is also printed on the credit card receipt.
        type: string
        example: "17:32:28"
      paymentDetails:
        $ref: '#/definitions/PaymentDetails'
  PaymentDetails:
    type: object
    properties:
      accountType:
        description: This specify the account type. Eg. 1 = Check, 3 = Card, 40 =
          CLABE
        type: string
        maxLength: 2
        example: "3"
      paymentReferenceNumber:
        description: This attribute holds a reference number for payments. Eg RPU
          number.
        type: string
        maxLength: 20
        example: "12345678901"
      paymentFrequency:
        description: 'Periodicity of instruction. Eg: 4 Daily, 5 Weekly, 6 Fortnightly,
          7 Monthly, 8 Bimonthly, 9 Quarterly, 10 Four-monthly, 11 Semester, 12 Annual.'
        type: string
        maxLength: 2
        example: "8"
      paymentReferenceDescription:
        description: Description of the unique reference number for individual options
          for market linked deposits.
        type: string
        maxLength: 20
        example: "123456789"
      paymentReferenceName:
        description: Unique reference for customer request
        type: string
        maxLength: 20
        example: "123485689"
      nextExecutionDate:
        description: Date of the next payment or transfer within a recurring payment
          or transfer.
        type: string
        format: date
        example: 22/06/2022
      paymentCycleDay:
        description: Payment Day for the autopay scheduled.
        type: string
        maxLength: 2
        example: "12"
      alertAndNotification:
        $ref: '#/definitions/AlertAndNotification'
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
      recurringPayment:
        $ref: '#/definitions/RecurringPayment'
  AlertAndNotification:
    type: object
    properties:
      paymentAlertFlag:
        description: Indicator to notify to the customer previous to load the charge.
        type: boolean
        example: true
      paymentNotificationFlag:
        description: Indicator to notify to the customer after to load the charge.
        type: boolean
        example: true
      channelType:
        description: 'Via to notify to the customer about the charge. Eg: 0 without
          warning, 1 Email, 2 Fax, 3 pager.'
        type: string
        maxLength: 2
        example: "3"
      notificationChannelId:
        description: Number used in case of modification or deletion.
        type: string
        maxLength: 4
        example: "1234"
  PartyAndOrganization:
    type: object
    properties:
      branchId:
        description: Unique identifier for the branch
        type: string
        maxLength: 4
        example: "100"
      branchCode:
        description: Branch Code of the branch which the pre-registration was made.
        type: string
        maxLength: 4
        example: "102"
      employeeId:
        description: Unique indentity number that identifies the employee of an organization
          uniquely.
        type: string
        maxLength: 8
        example: "48039"
  CardPlastic:
    type: object
    properties:
      paymentInstructionId:
        description: Number generated by the backend system to identify the recurring
          charge.
        type: string
        maxLength: 8
        example: "12345678"
      accountNumber:
        description: Customer's Account Number with the Bank.
        type: string
        maxLength: 20
        example: "4152313655668879"
  RecurringPayment:
    type: object
    properties:
      totalPaymentAmount:
        description: Total amount to be paid for a recurring transfer or payment.
        type: number
        format: double
        example: 1275.500000
      paymentScheduleId:
        description: This attribute holds the unique identifier for the scheduled
          payments. Payment indicator 1,2,3 o 4. If the value is null, 0 is assigned.
          If the type is 4, the paymentDueDate and transferStartTime are mandatory.
        type: string
        maxLength: 1
        example: "4"
      terminationDate:
        description: The last payment of a standing order or installment loan, or
          the last transfer of a recurring transfer, is to be made on this date.
        type: string
        format: date
        example: 22/06/2023
  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
...