Create due-date charge batch

Prerequisite: create the batch charges before generating their QR/payloads (see generateBRCode and resolveCobVPayload). Creates a due-date charge batch identified by the path id. Items are processed synchronously: each results in CRIADA or NEGADA. Pix API PUT /lotecobv/.

PUT /api/v1/brcode/lotecobv/{id}

Create due-date charge batch

cURL

curl --request PUT \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/lotecobv/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cobsv": [
    {
      "calendario": {
        "dataDeVencimento": "<string>",
        "validadeAposVencimento": 1
      },
      "chave": "<string>",
      "devedor": {
        "cep": "<string>",
        "cidade": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>",
        "email": "<string>",
        "logradouro": "<string>",
        "nome": "<string>",
        "uf": "<string>"
      },
      "txid": "<string>",
      "valor": {
        "original": "<string>"
      },
      "infoAdicionais": [
        {
          "nome": "<string>",
          "valor": "<string>"
        }
      ],
      "loc": {
        "id": 123
      },
      "solicitacaoPagador": "<string>"
    }
  ],
  "descricao": "<string>"
}
'

default

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key · string

Idempotency key, max 255 characters.

Path Parameters

id · string · required

Identificador do lote (texto).

Pattern: ^[A-Za-z0-9-]{1,35}$

Body

application/json

cobsv · object[] | null · required

Solicitações de criação de cobranças com vencimento.

Show child attributes

descricao · string · required

Descrição do lote.

Maximum string length: 200

Response

202

Accepted