Create Dynamic Immediate Charge (COB)

​

Creates a dynamic immediate charge (cob) and binds it to the specified location. The txid must be 26-35 lowercase alphanumeric characters as per Bacen specification. This operation is idempotent — using the same txid returns the existing charge. 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 immediate charge with location binding

  • calendario
    Type: object ·
    required

    Calendar settings for the charge expiration

  • chave
    Type: string
    min length:  
    1
    required

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

  • valor
    Type: object ·
    required

    Amount information for the charge

  • devedor
    Type: object ·

    Debtor information (payer)

  • emitImage
    Type: boolean

    If true, also returns the PNG image (base64).

  • 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

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Optional message/request from the payer.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/cob/{txid}
curl http://localhost/cob/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 '{
  "calendario": {
    "expiracao": 1
  },
  "valor": {
    "original": "",
    "modalidadeAlteracao": 0
  },
  "chave": "",
  "devedor": {
    "cpf": "",
    "cnpj": "",
    "nome": ""
  },
  "loc": {
    "id": ""
  },
  "solicitacaoPagador": "",
  "emitImage": true,
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ]
}'

{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "calendario": {
    "criacao": "2026-07-31T12:59:10.424Z",
    "expiracao": 1
  },
  "valor": {
    "original": "string",
    "modalidadeAlteracao": 1
  },
  "chave": "string",
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "loc": {
    "id": "string",
    "url": "string"
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-07-31T12:59:10.424Z"
}

Charge already exists — idempotent response