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]

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

  • 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

  • loc
    Type: object ·

    Location reference for binding to a charge

  • locationId
    Type: string Format: uuid
    deprecated

    DEPRECADO — use loc: { "id": ... }. A API Pix 2.9.0 define loc para a cobv, como ja faz a cob, e e loc que a resposta desta cobranca devolve. Aceito apenas para nao quebrar quem ja integrou; sera removido.

  • recebedor
    Type: object ·

    Receiver (recebedor) information for a cobv

  • 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
  • application/json
  • application/json
Request Example for put/api/cobv/{txid}
curl http://localhost:8080/api/cobv/txid12345678901234567890123456 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "chave": "",
  "calendario": {
    "dataDeVencimento": "",
    "validadeAposVencimento": 0
  },
  "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": "",
    "email": "",
    "logradouro": "",
    "cidade": "",
    "uf": "",
    "cep": ""
  },
  "recebedor": {
    "nome": "",
    "cidade": "",
    "taxId": "",
    "logradouro": "",
    "uf": "",
    "cep": ""
  },
  "solicitacaoPagador": "",
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "loc": {
    "id": ""
  },
  "emitImage": true
}'
{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "chave": "string",
  "calendario": {
    "criacao": "2026-09-16T19:14:18.660Z",
    "dataDeVencimento": "2026-09-16",
    "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-09-16",
          "valorPerc": "string"
        }
      ],
      "valorPerc": "string"
    }
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string",
    "email": "string",
    "logradouro": "string",
    "cidade": "string",
    "uf": "string",
    "cep": "string"
  },
  "recebedor": {
    "nome": "string",
    "cidade": "string",
    "taxId": "string",
    "logradouro": "string",
    "uf": "string",
    "cep": "string"
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "loc": {
    "id": "string",
    "location": "string",
    "tipoCob": "cob",
    "criacao": "2026-09-16T19:14:18.660Z"
  },
  "location": "string",
  "pix": [
    {
      "endToEndId": "E1234567820260713123456789012345",
      "txid": "string",
      "valor": "100.0",
      "componentesValor": {
        "original": {
          "valor": "100.0"
        },
        "saque": {
          "valor": "20.0",
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "string"
        },
        "troco": {
          "valor": "20.0",
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "string"
        },
        "juros": {
          "valor": "100.0"
        },
        "multa": {
          "valor": "100.0"
        },
        "abatimento": {
          "valor": "100.0"
        },
        "desconto": {
          "valor": "100.0"
        }
      },
      "chave": "string",
      "horario": "2026-09-16T19:14:18.660Z",
      "infoPagador": "string",
      "devolucoes": [
        {
          "id": "devolucao001",
          "rtrId": "D1234567820260713123456789012345",
          "valor": "10.0",
          "natureza": "ORIGINAL",
          "descricao": "string",
          "horario": {
            "solicitacao": "2026-09-16T19:14:18.660Z",
            "liquidacao": "2026-09-16T19:14:18.660Z"
          },
          "status": "EM_PROCESSAMENTO",
          "motivo": "string"
        }
      ]
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-09-16T19:14:18.660Z"
}