# Atualiza um contrato de cartão

Atualiza um contrato de cartão.

Endpoint: PUT /api/v3/cards/contracts/{cardContractId}
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de Empresas: GET /api/v3/companies.
    Example: 12

## Path parameters:

  - `cardContractId` (integer, required)
    ID do contrato do cartão.

## Request fields (application/json):

  - `title` (string, required)
    Título do contrato.
    Example: "Cielo"

  - `code` (string)
    Código do contrato.
    Example: "CIE"

  - `bank_account_id` (integer, required)
    ID da conta bancária.
    Example: 123

  - `status` (string, required)
    Status do contrato.
    Enum: "active", "inactive"

  - `provider` (object)
    Dados do provedor de cartão.

  - `provider.id` (integer)
    ID do provedor do cartão.
    Example: 123

  - `provider.qr_code` (object)
    Dados de configuração do QRCode

  - `provider.qr_code.access_token` (string)
    Access token do QRCode.
    Example: "access-token-123"

  - `provider.qr_code.store_id` (string)
    Identificador da loja à qual o caixa pertence.
    Example: "access-token-123"

  - `provider.qr_code.fixed_amount` (boolean)
    Determine se o cliente pode inserir o valor a ser pago.
    Example: true

  - `provider.qr_code.merchant_category_code` (string)
    Código MCC que indica a categoria do ponto de venda.
    Example: "5611203"

  - `settings` (object, required)
    Configurações do contrato.

  - `settings.holidays_to_consider_as_working_days` (array)
    Feriados que são considerados dias úteis.

Valores:
  - municipal feriados municipais
  - state feriados estaduais
  - national feriados nacionais
  - international feriados internacionais
    Example: ["municipal","state"]

  - `settings.mark_all_entries_as_paid` (boolean, required)
    Definir como pago todas as entradas nesse contrato.
    Example: true

  - `settings.deposit_fee` (object)
    Tarifa de deposito.

  - `settings.deposit_fee.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `settings.deposit_fee.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `settings.receivable_anticipation_periods` (array)
    Lista de taxas de antecipação.

  - `settings.receivable_anticipation_periods.fee` (number)
    Taxa(%) da antecipação.
    Example: 4.32

  - `settings.grouping` (object)
    Configurações de agrupamento.

  - `settings.grouping.type` (string)
    Define qual a maneira na qual os pagamentos serão agrupados:
  - by_transaction: os pagamentos serão agrupados por transação.
  - by_payment_method: os pagamentos serão agrupados por método de pagamento.
  - by_card_brand: os pagamentos serão agrupados por método de pagamento e pela bandeira de cartão.
    Enum: "by_transaction", "by_payment_method", "by_card_brand"

  - `settings.payout_schedule` (object, required)
    Define o cronograma de repasse de recebíveis efetuado pela provedora associada a este contrato de cartão.

Cada repasse irá incluir todos os recebíveis que foram pagos desde o fechamento do último repasse.
A _frequência_ determina as datas nas quais ocorrerá o fechamento dos repasses, junto a configurações específicas para
cada frequência de repasse.

A _data de depósito do repasse_ será calculada considerando a data de fechamento do repasse, somado a
quantidade de dias days_to_deposit. Caso a data calculada não seja um dia útil e a opção deposit_only_in_working_days
esteja ativa, a data calculada será movida para o próximo dia útil.

  - `settings.payout_schedule.frequency` (string, required)
    Indica a frequência na qual ocorrerá o fechamento dos repasses.
    Enum: "daily", "weekly"

  - `settings.payout_schedule.days_to_deposit` (integer)
    A quantidade de dias que irá levar para que o repasse seja depositado na conta bancária.
    Example: 1

  - `settings.payout_schedule.deposit_only_in_working_days` (boolean)
    Se o depósito do repasse somente ocorrerá em dias úteis.

Caso true, o cálculo da data de deposíto do repasse sempre irá jogar para o próximo dia útil.

  - `payment_methods` (array, required)
    Representa a lista de meios de pagamento do contrato de cartão

  - `payment_methods.payment_method_id` (integer)
    ID do método de pagamento.
    Example: 123

  - `payment_methods.type_days_first_payment` (string)
    Em quais dias irão cair os primeiros pagamentos.

Exemplo:

- calendar_days: dias corridos
- working_days: dias úteis
    Enum: "calendar_days", "working_days"

  - `payment_methods.type_days_between_installments` (string)
    Dias entre parcelas.

Exemplo:

- calendar_days: dias corrigos
- single_payment: pagamento único
- working_days: dias úteis
    Enum: "calendar_days", "single_payment", "working_days"

  - `payment_methods.due_date_only_in_working_days` (boolean)
    Vencimento apenas em dias úteis.
    Example: true

  - `payment_methods.rules` (array)
    Regras de cálculo utilizadas por esse método de pagamento.

  - `payment_methods.rules.installment` (object, required)
    Representa uma configuração de parcelamento do método de pagamento.

  - `payment_methods.rules.installment.min` (integer, required)
    Quantidade mínima de parcelas.
    Example: 1

  - `payment_methods.rules.installment.max` (integer, required)
    Quantidade máxima de parcelas.
    Example: 5

  - `payment_methods.rules.installment.days_between` (integer)
    Dias entre as parcelas. Deve estar presente se e somente se o max seja maior que 1.
    Example: 30

  - `payment_methods.rules.card_brand_id` (integer,null)
    ID da bandeira do cartão.

Caso null, significa que essa regra de cálculo se aplica a todos as outras bandeiras aceitas
pelo método de pagamento, ou que o método de pagamento não aceita bandeiras.
    Example: 123

  - `payment_methods.rules.rate` (number, required)
    Taxa(%) da parcela.
    Example: 0.85

  - `payment_methods.rules.fare` (object, required)
    Tarifa da parcela.

  - `payment_methods.rules.days_first_payment` (integer, required)
    Dias para o 1º pagamento.
    Example: 15

## Response 200 fields (application/json):

  - `id` (integer)
    Identificador único do contrato.
    Example: 123

  - `title` (string)
    Título do contrato.
    Example: "Cielo"

  - `code` (string)
    Código do contrato.
    Example: "CIE"

  - `bank_account` (object)
    Conta bancária que este contrato está associado.

  - `bank_account.id` (integer)
    Identificador único da conta bancária.
    Example: 123

  - `bank_account.name` (string)
    Nome da conta bancária
    Example: "ConnectPlug Bank"

  - `bank_account.initial_date` (string)
    Data.
    Example: "2025-01-30"

  - `bank_account.initial_value` (object)
    Valor inicial da conta bancária

  - `bank_account.initial_value.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `bank_account.initial_value.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `bank_account.bank` (object)
    Representa um banco.

  - `bank_account.bank.id` (integer)
    Identificador único do banco.
    Example: 123

  - `bank_account.bank.code` (integer)
    Código do banco
    Example: 10

  - `bank_account.bank.image` (string)
    URL da imagem do banco
    Example: "https://connectplug.com.br/images/banks/10.png"

  - `bank_account.deleted` (boolean)
    Indica se está apagado ou não.

  - `bank_account.companies` (array)
    Lista de empresas que permite visualizar.

  - `bank_account.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `bank_account.companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `bank_account.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `bank_account.first_transaction_date` (string)
    Data da primeira transação na conta bancária.
    Example: "2025-01-30"

  - `bank_account.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `bank_account.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `status` (string)
    Status do contrato.
    Enum: "active", "inactive"

  - `settings` (object)
    Conta bancária que este contrato está associado.

  - `settings.holidays_to_consider_as_working_days` (array)
    Feriados que são considerados dias úteis.

Valores:
  - municipal feriados municipais
  - state feriados estaduais
  - national feriados nacionais
  - international feriados internacionais
    Example: ["municipal","state"]

  - `settings.mark_all_entries_as_paid` (boolean, required)
    Definir como pago todas as entradas nesse contrato.
    Example: true

  - `settings.deposit_fee` (object)
    Tarifa de deposito.

  - `settings.receivable_anticipation_periods` (array)
    Lista de taxas de antecipação.

  - `settings.receivable_anticipation_periods.id` (integer)
    Identificador único do período de antecipação.
    Example: 123

  - `settings.receivable_anticipation_periods.days` (integer)
    quantidade de dias de antecipação.
    Example: 14

  - `settings.receivable_anticipation_periods.fee` (number)
    Taxa(%) da antecipação.
    Example: 4.32

  - `settings.grouping` (object)
    Configurações de agrupamento.

  - `settings.grouping.type` (string)
    Define qual a maneira na qual os pagamentos serão agrupados:
  - by_transaction: os pagamentos serão agrupados por transação.
  - by_payment_method: os pagamentos serão agrupados por método de pagamento.
  - by_card_brand: os pagamentos serão agrupados por método de pagamento e pela bandeira de cartão.
    Enum: "by_transaction", "by_payment_method", "by_card_brand"

  - `settings.payout_schedule` (object, required)
    Define o cronograma de repasse de recebíveis efetuado pela provedora associada a este contrato de cartão.

Cada repasse irá incluir todos os recebíveis que foram pagos desde o fechamento do último repasse.
A _frequência_ determina as datas nas quais ocorrerá o fechamento dos repasses, junto a configurações específicas para
cada frequência de repasse.

A _data de depósito do repasse_ será calculada considerando a data de fechamento do repasse, somado a
quantidade de dias days_to_deposit. Caso a data calculada não seja um dia útil e a opção deposit_only_in_working_days
esteja ativa, a data calculada será movida para o próximo dia útil.

  - `settings.payout_schedule.frequency` (string, required)
    Indica a frequência na qual ocorrerá o fechamento dos repasses.
    Enum: "daily", "weekly"

  - `settings.payout_schedule.days_to_deposit` (integer)
    A quantidade de dias que irá levar para que o repasse seja depositado na conta bancária.
    Example: 1

  - `settings.payout_schedule.deposit_only_in_working_days` (boolean)
    Se o depósito do repasse somente ocorrerá em dias úteis.

Caso true, o cálculo da data de deposíto do repasse sempre irá jogar para o próximo dia útil.

  - `provider` (object)
    Dados do provedor de cartão.

  - `provider.id` (integer)
    Identificador único do provedor.
    Example: 123

  - `provider.name` (string)
    Nome do provedor.
    Example: "Mercado Pago"

  - `provider.key` (string)
    identificar alpha numérico do provedor.
    Example: "MERCADOPAGO"

  - `provider.qr_code` (object)
    Dados de configuração do QRCode

  - `provider.qr_code.access_token` (string)
    Access token do QRCode.
    Example: "access-token-123"

  - `provider.qr_code.store_id` (string)
    Identificador da loja à qual o caixa pertence.
    Example: "access-token-123"

  - `provider.qr_code.fixed_amount` (boolean)
    Determine se o cliente pode inserir o valor a ser pago.
    Example: true

  - `provider.qr_code.merchant_category_code` (string)
    Código MCC que indica a categoria do ponto de venda.
    Example: "5611203"

  - `supplier` (object)
    Dados do fornecedor.

  - `supplier.id` (integer)
    Identificador único do fornecedor.
    Example: 123

  - `supplier.name` (string)
    Nome fantasia do fornecedor.
    Example: "Fornecedor padrão"

  - `supplier.company_name` (string)
    Razão social do fornecedor.
    Example: "Fornecedor padrão LTDA"

  - `payment_methods` (array)
    Representa a lista de meios de pagamento do contrato de cartão

  - `payment_methods.payment_method` (object)
    Método de pagamento da parcela.

  - `payment_methods.payment_method.id` (integer, required)
    Identificador único da um método de pagamento.
    Example: 123

  - `payment_methods.payment_method.name` (string, required)
    Nome do método de pagamento.
    Example: "Dinheiro"

  - `payment_methods.payment_method.fiscal_code` (string, required)
    Código fiscal a ser informado na nota fiscal.

Exemplo:

- 01: Dinheiro
- 02: Cheque
- 03: Cartão de Crédito
- 04: Cartão de Débito
- 05: Crédito de Loja
- 10: Vale Alimentação
- 11: Vale Refeição
- 12: Vale Presente
- 13: Vale Combustível
- 14: Duplicata Mercantil
- 15: Boleto Bancário
- 16: Depósito Bancário
- 17: Pagamento Instantâneo (PIX)
- 18: Transferência bancária, Carteira Digital
- 19: Programa de fidelidade, Cashback, Crédito Virtual
- 90: Sem Pagamento
- 99: Outros
    Enum: "01", "02", "03", "04", "05", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "90", "99"

  - `payment_methods.payment_method.is_editable` (boolean)
    Indica se o método de pagamento pode ser editável ou não.
    Example: true

  - `payment_methods.payment_method.allow_installment` (boolean)
    Indica se o método de pagamento permite ou não o parcelamento.
    Example: true

  - `payment_methods.type_days_first_payment` (string)
    Em quais dias irão cair os primeiros pagamentos.

Exemplo:

- calendar_days: dias corridos
- working_days: dias úteis
    Enum: "calendar_days", "working_days"

  - `payment_methods.type_days_between_installments` (string)
    Dias entre parcelas.

Exemplo:

- calendar_days: dias corrigos
- single_payment: pagamento único
- working_days: dias úteis
    Enum: "calendar_days", "single_payment", "working_days"

  - `payment_methods.due_date_only_in_working_days` (boolean)
    Vencimento apenas em dias úteis.
    Example: true

  - `payment_methods.rules` (array)
    Regras de cálculo utilizadas por esse método de pagamento.

  - `payment_methods.rules.installment` (object, required)
    Representa uma configuração de parcelamento do método de pagamento.

  - `payment_methods.rules.installment.min` (integer, required)
    Quantidade mínima de parcelas.
    Example: 1

  - `payment_methods.rules.installment.max` (integer, required)
    Quantidade máxima de parcelas.
    Example: 5

  - `payment_methods.rules.installment.days_between` (integer)
    Dias entre as parcelas. Deve estar presente se e somente se o max seja maior que 1.
    Example: 30

  - `payment_methods.rules.card_brand` (object)
    Bandeira do cartão.

Caso null, significa que essa regra de cálculo se aplica a todos as outras bandeiras aceitas
pelo método de pagamento, ou que o método de pagamento não aceita bandeiras.

  - `payment_methods.rules.card_brand.id` (integer)
    Identificador único da bandeira.
    Example: 123

  - `payment_methods.rules.card_brand.name` (string)
    Nome da bandeira.
    Example: "Master"

  - `payment_methods.rules.card_brand.icon` (string)
    ícone da bandeira.
    Example: "mastercard.png"

  - `payment_methods.rules.card_brand.nfe_code` (string)
    Código da NFe da bandeira.
    Example: "02"

  - `payment_methods.rules.rate` (number, required)
    Taxa(%) da parcela.
    Example: 0.85

  - `payment_methods.rules.fare` (object, required)
    Tarifa da parcela.

  - `payment_methods.rules.days_first_payment` (integer, required)
    Dias para o 1º pagamento.
    Example: 15

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields