Create Dynamic Immediate Charge with PSP-generated txid (COB-4)

​

Creates a dynamic immediate charge (cob) with a txid automatically generated by the PSP. The PSP generates a unique 26-35 character lowercase alphanumeric txid. Requires Idempotency-Key header.

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
  • application/json
  • application/json
Request Example for post/api/cob
curl http://localhost:8080/api/cob \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "calendario": {
    "expiracao": 1
  },
  "valor": {
    "original": "",
    "modalidadeAlteracao": 0,
    "retirada": {
      "saque": {
        "valor": "",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": ""
      },
      "troco": {
        "valor": "",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": ""
      }
    }
  },
  "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-09-16T19:14:18.660Z",
    "expiracao": 1
  },
  "valor": {
    "original": "string",
    "modalidadeAlteracao": 1,
    "retirada": {
      "saque": {
        "valor": "string",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "string"
      },
      "troco": {
        "valor": "string",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "string"
      }
    }
  },
  "chave": "string",
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "loc": {
    "id": "string",
    "location": "string",
    "tipoCob": "cob",
    "criacao": "2026-09-16T19:14:18.660Z"
  },
  "location": "string",
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "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"
}