Create Dynamic Charge with Due Date (COBV)

Creates a dynamic charge with due date (cobv) and binds it to the specified location. Supports due date with optional rules for abatement, discount, interest, and fine. The txid must be 26-35 lowercase alphanumeric characters as per Bacen specification. Note: DPP (Intended Payment Date) is not supported in V1. Requires Idempotency-Key header.

Path Parameters
  • txid
    Type: string
    required

    Transaction identifier (txid). Must be 26-35 lowercase alphanumeric characters [a-z0-9]

Headers
  • x-branch
    Type: string
    required

    Branch of the charge owner account

  • x-account-number
    Type: string
    required

    Number of the charge owner account

  • Idempotency-Key
    Type: string
    required

    Unique idempotency key

Body·
required
application/json

Request to create a dynamic charge with due date (COBV)

  • calendario
    Type: object ·
    required

    Calendar settings for charge with due date (COBV)

  • chave
    Type: string
    min length:  
    1
    required

    Pix key of the receiver. EVP, email, CPF/CNPJ or phone in E.164 format (+55...).

  • devedor
    Type: object ·
    required

    Debtor (payer) information

  • locationId
    Type: string Format: uuid
    required

    Location ID to bind to this charge

  • valor
    Type: object ·
    required

    Amount configuration for charge with due date (COBV)

  • emitImage
    Type: boolean

    If true, returns the PNG image (base64) in the response

  • infoAdicionais
    Type: array object[] · …50

    Additional information list for the payer

    Additional information for the payer

  • recebedor
    Type: object ·

    Merchant (receiver) information for EMV payload composition

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Optional message/request for the payer

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/cobv/{txid}
curl http://localhost/cobv/txid12345678901234567890123456 \
  --request PUT \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "chave": "",
  "calendario": {
    "dataDeVencimento": "",
    "validadeAposVencimento": 0,
    "validAfterDueDaysOrDefault": 1
  },
  "valor": {
    "original": "",
    "multa": {
      "modalidade": "1",
      "valorPerc": ""
    },
    "juros": {
      "modalidade": "1",
      "valorPerc": ""
    },
    "abatimento": {
      "modalidade": "1",
      "valorPerc": ""
    },
    "desconto": {
      "modalidade": "1",
      "descontoDataFixa": [
        {
          "data": "",
          "valorPerc": ""
        }
      ],
      "valorPerc": ""
    }
  },
  "devedor": {
    "cpf": "",
    "cnpj": "",
    "nome": ""
  },
  "recebedor": {
    "nome": "",
    "cidade": "",
    "taxId": "",
    "endereco": {
      "logradouro": "",
      "cidade": "",
      "uf": "",
      "cep": ""
    }
  },
  "solicitacaoPagador": "",
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "locationId": "",
  "emitImage": true
}'
{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "chave": "string",
  "calendario": {
    "criacao": "2026-07-31T17:52:48.662Z",
    "dataDeVencimento": "2026-07-31",
    "validadeAposVencimento": 1
  },
  "valor": {
    "original": "string",
    "multa": {
      "modalidade": "1",
      "valorPerc": "string"
    },
    "juros": {
      "modalidade": "1",
      "valorPerc": "string"
    },
    "abatimento": {
      "modalidade": "1",
      "valorPerc": "string"
    },
    "desconto": {
      "modalidade": "1",
      "descontoDataFixa": [
        {
          "data": "2026-07-31",
          "valorPerc": "string"
        }
      ],
      "valorPerc": "string"
    }
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "recebedor": {
    "nome": "string",
    "cidade": "string",
    "taxId": "string",
    "endereco": {
      "logradouro": "string",
      "cidade": "string",
      "uf": "string",
      "cep": "string"
    }
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "loc": {
    "id": "string",
    "url": "string"
  },
  "pix": [
    {
      "endToEndId": "string",
      "txid": "string",
      "valor": "string",
      "horario": "2026-07-31T17:52:48.662Z",
      "infoPagador": "string"
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-07-31T17:52:48.662Z"
}