swagger.json

swagger: '2.0'
info:
  description: 'Comunicação da autorização de disponibilização ou suspensão de agendas.'
  version: '1.0'
  title: RCC-Opt
schemes:
  - https
basePath: /api/rcc-opt/
host: Caminho_backend
tags:
  - name: OptIn
paths:
  /v1.0/optin:
    post:
      tags:
        - OptIn
      summary: >-
        Disponibilização de agendas de recebíveis de cartão (Opt-In) pela
        Credenciadora ou Financiador no sistema de registro de Recebíveis de
        Cartão de Crédito
      operationId: OptinPost
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: OptinPost
          description: ''
          schema:
            $ref: '#/definitions/OptinPostReq'
      responses:
        '201':
          description: OK
          schema:
            $ref: '#/definitions/OptinPostRsp'
        '400':
          description: Erro no objeto de requisição.
        '422':
          description: Erro de Negócio
          schema:
            $ref: '#/definitions/Erros'
        '500':
          description: Erro não mapeado.
  /v1.0/optout:
    put:
      tags:
        - Optout
      summary: ' Revogação da autorização (Opt-out) do Estabelecimento Comercial para envio da Agenda de Recebíveis para determinado Financiador ou Não Financeira.'
      operationId: OptoutPut
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: OptoutPost
          description: ''
          schema:
            $ref: '#/definitions/OptoutPutReq'
      responses:
        '200':
          description: No Content
          schema:
            $ref: '#/definitions/OptoutPutRsp'
        '400':
          description: Erro no objeto de requisição.
        '422':
          description: Erro de Negócio.
          schema:
            $ref: '#/definitions/Erros'
        '500':
          description: Erro não mapeado.
definitions:
  Optin:
    type: object
    properties:
      codigoExterno:
        type: string
        description: Código único de referência de controle do participante.
        example: null
      cnpjSolicitante:
        type: string
        description: CNPJ do solicitante.
        example: null
      cnpjFinanciador:
        type: string
        description: CNPJ da financeira/não-financeira
        example: null
      cnpjCredenciadora:
        type: string
        description: CNPJ da credenciadora/subcredenciadora.
        example: null
      documentoUsuarioFinalRecebedor:
        type: string
        description: ''
        example: null
      arranjoPagamento:
        type: string
        description: Identificadores do usuário final recebedor na bandeira
        example: null
      dataAssinatura:
        type: string
        format: date
        description: Data de assinatura do opt-in.
        example: null
      dataEfetivacao:
        type: string
        format: date
        description: Data do início da vigência.
        example: null
      dataExpiracao:
        type: string
        format: date
        description: Data do fim da vigência.
        example: null
      documentoTitular:
        type: string
        description: CPF ou CNPJ do titular.
        example: null
    required:
      - codigoExterno
      - cnpjSolicitante
      - cnpjFinanciador
      - documentoUsuarioFinalRecebedor
      - dataAssinatura
      - dataEfetivacao
      - documentoTitular
  RetornoRequisicao:
    type: object
    properties:
      codigoExterno:
        type: string
        description: Código único de referência de controle do participante.
        example: null
      protocoloProcessamento:
        type: string
        description: Protocolo de processamento gerado no recebimento da requisição
        example: null
      protocolo:
        type: string
        description: Protocolo de processamento do Opt-In.
        example: null
      dataHoraProcessamento:
        type: string
        format: datetime
        description: Data e hora do final do processamento
        example: null
    required:
      - codigoExterno
      - protocoloProcessamento
      - protocolo
      - dataHoraProcessamento
  Meta:
    type: object
    properties:
      codigoExterno:
        type: string
        description: >-
          Código de referência externa utilizado pelo participante para
          identificar as operações.
        example: null
      dataHoraProcessamento:
        type: string
        format: datetime
        description: Data e hora de processamento da requisição.
        example: null
    required:
      - codigoExterno
      - dataHoraProcessamento
  Erros:
    type: object
    properties:
      Erros:
        type: array
        items:
          $ref: '#/definitions/Erro'
      Meta:
        $ref: '#/definitions/Meta'
  Erro:
    type: object
    properties:
      codigo:
        type: string
        description: Cófigo de erro técnico.
        example: null
      mensagem:
        type: string
        description: 'Mensagem de retorno do erro. '
        example: null
    required:
      - codigo
      - mensagem
  OptinPostReq:
    type: object
    properties:
      Optin:
        $ref: '#/definitions/Optin'
  OptinPostRsp:
    type: object
    properties:
      RetornoRequisicao:
        $ref: '#/definitions/RetornoRequisicao'
  Optout:
    type: object
    properties:
      codigoExterno:
        type: string
        description: Código único de referência de controle do participante.
        example: null
      cnpjSolicitante:
        type: string
        description: CNPJ do solicitante.
        example: null
      protocolo:
        type: string
        description: Protocolo do Opt-In cadastrado na ação de post.
        example: null
    required:
      - codigoExterno
      - cnpjSolicitante
      - protocolo
  OptoutPutReq:
    type: object
    properties:
      Optout:
        $ref: '#/definitions/Optout'
  OptoutPutRsp:
    type: object
    properties:
      RetornoRequisicao:
        $ref: '#/definitions/RetornoRequisicao'