Criar cobrança imediata

post https://api.pix.voluti.com.br/cob

Use este endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.

Body Params

Dados para geração da cobrança imediata.

calendario

object

required

Os campos contidos sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

devedor

Os campos contidos sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento.

cpf ou cnpj: A cobrança pode ter um CPF ou um CNPJ como devedor. Não é permitido preencher ambos ao mesmo tempo.
nome: Se o nome do devedor estiver preenchido, deve existir um CPF ou CNPJ preenchido.

valor

object

required

valores monetários referentes à cobrança.

chave

string

length ≤ 77

Formato da Chave Pix na qual a conta receberá o valor.

Conforme especificado na PACS.008. Os tipos de chave permitidos são:

Telefone
E-mail
CPF/CNPJ
O Endereço Virtual de Pagamento (EVP)

O formato detalhado das chaves está na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para Iniciação do Pix.
.

solicitacaoPagador

string

length ≤ 140

Permite que o pagador inclua um texto livre relacionado ao recebedor.

Preenchimento: O PSP do pagador insere esse texto no campo RemittanceInformation da pacs.008.

Limite de caracteres: Restrito a 140 caracteres.

infoAdicionais

array of objects

Apresentação das informações adicionais ao pagador:

Cada informação adicional contida nos campos nome e valor deve ser exibida ao pagador.

Informações adicionais

Responses

Response body

object

calendario

object

required

Os campos contidos sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

criacao

date-time

required

Timestamp que indica o momento em que foi criada a cobrança. Respeita o formato definido na RFC 3339.

expiracao

int32

Defaults to 86400

Tempo de vida da cobrança, especificado em segundos a partir da data do campo criação.

txid

string

required

Identificador da transação (txid):

O campo txid determina o identificador da transação, sendo crucial para o processo de conciliação de pagamentos, pois determina a transação de forma única. Na pacs.008, é mencionado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Funcionalidade:

O txid é gerado pelo usuário recebedor e enviado ao PSP do pagador.
Após a confirmação do pagamento, é transmitido para o SPI via pacs.008 e também para o PSP do recebedor.
Ao detectar um pagamento com txid, o PSP do recebedor pode informar ao usuário recebedor sobre a liquidação específica desse pagamento.

Responsabilidades:

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
Cada txid é único por CPF/CNPJ do usuário recebedor, com a validação dessa regra realizada pelo PSP recebedor na API Pix.

revisao

int32

required

Indica a revisão da cobrança, começando sempre em zero e aumentando em incrementos de 1.

Incremento: A revisão é incrementada sempre que um objeto da cobrança é alterado, exceto pelo campo loc.
Exceção: Se a única alteração em uma cobrança for no campo loc, a revisão não é incrementada, pois o loc não altera a cobrança em si.
Armazenamento: Não é necessário manter histórico das alterações do campo loc, mas é necessário para outros campos da cobrança.

devedor

cpf ou cnpj: A cobrança pode ter um CPF ou um CNPJ como devedor. Não é permitido preencher ambos ao mesmo tempo.
nome: Se o nome do devedor estiver preenchido, deve existir um CPF ou CNPJ preenchido.

loc

object

Identificador da localização do payload.

int64

required

Identificador da localização a ser informada na criação da cobrança.

location

uri

required

length ≤ 77

Localização do payload a ser informada na criação da cobrança.

tipoCob

string

required

Tipo de cobrança.

cob cobv

criacao

date-time

required

Data e hora em que a localização foi criada. Respeita RFC 3339.

location

uri

length ≤ 77

Localização do Payload a ser informada na criação da cobrança.

status

string

required

Estado do registro da cobrança.

Os status:

ATIVA: Indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida;
CONCLUIDA: Indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento;
REMOVIDO_PELO_USUARIO_RECEBEDOR: Indica que o usuário recebedor solicitou a remoção do registro da cobrança;
REMOVIDO_PELO_PSP: Indica que o PSP recebedor solicitou a remoção do registro da cobrança.

ATIVA CONCLUIDA REMOVIDA_PELO_USUARIO_RECEBEDOR REMOVIDA_PELO_PSP

valor

object

required

valores monetários referentes à cobrança.

original

string

Valor original da cobrança.

modalidadeAlteracao

int32

0 to 1

Indica se o valor final do documento pode ser alterado pelo pagador. Se ausente, assume-se que o valor é fixo (0). Se presente e definido como 1, o valor pode ser alterado pelo pagador.

retirada

object

É uma estrutura opcional relacionada ao conceito de recebimento de numerário. Apenas um agrupamento por vez é permitido, quando há saque não há troco e vice-versa.

Quando uma cobrança imediata tem uma estrutura de retirada ela deixa de ser considerada Pix comum e passa à categoria de Pix Saque ou Pix Troco.

Para que o preenchimento do objeto retirada seja considerado válido as seguintes regras se aplicam:

os campos modalidadeAgente e prestadorDoServicoDeSaque são de preenchimento obrigatório;
quando o saque estiver presente a cobrança deve respeitar as seguintes condições:
- O campo valor.original deve ser preenchido com valor igual a 0.00 (zero);
- O campo valor.modalidadeAlteracao deve possuir o valor 0 (zero) explicitamente, ou implicitamente (pelo não preenchimento).
quando o troco estiver presente a cobrança deve respeitar as seguintes condições:
- O campo valor.original deve ser preenchido com valor maior que 0.00 (zero);
- O campo valor.modalidadeAlteracao deve possuir o valor 0 (zero) explicitamente, ou implicitamente (pelo não preenchimento).

IMPORTANTE: Quando usados o saque ou troco não será permitida a alteração do valor.original recebido. Na presença de saque ou troco o recebimento do campo valor.modalidadeAlteracao com valor 1 (um) é considerado erro.

Exemplos válidos:

Considerando os campos da estrutura valor e o predicado 'presente' cujo resultado é verdade quando a estrutura apontada é encontrada temos:

uma cobrança com valor fixo (condições: valor.original > 0 && valor.modalidadeAlteração = 0 && !presente(valor.retirada))
```
...
"valor": {
  "original": "10.00"
},
...
```
uma cobrança com valor alterável (condições: valor.original >= 0.00 && modalidadeAlteração = 1 && !presente(valor.retirada))
```
...
"valor": {
  "original": "10.00",
  "modalidadeAlteracao": 1
},
```
saque com valor fixo (condições: valor.original = 0.00 && valor.modalidadeAlteração = 0 && presente(valor.retirada.saque) && valor.retirada.saque.valor > 0 && valor.retirada.saque.modalidadeAlteracao = 0)
```
...
"valor": {
  "original": "0.00",
  "retirada": {
    "saque": {
      "valor": "5.00",
      "modalidadeAgente": "AGPSS",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...
```

saque com valor alterável (condições: valor.original = 0.00 && valor.modalidadeAlteração = 0 && presente(valor.retirada.saque) && valor.retirada.saque.valor >= 0 && valor.retirada.saque.modalidadeAlteracao = 1)

...
"valor": {
  "original": "0.00",
  "retirada": {
    "saque": {
      "valor": "5.00",
      "modalidadeAlteracao": 1,
      "modalidadeAgente": "AGPSS",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

cobrança com troco fixo (condições: valor.original > 0.00 && valor.modalidadeAlteração = 0 && presente(valor.retirada.troco) && valor.retirada.troco.valor > 0 && valor.retirada.troco.modalidadeAlteracao = 0)
```
...
"valor": {
  "original": "10.00",
  "retirada": {
    "troco": {
      "valor": "5.00",
      "modalidadeAgente": "AGTEC",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...
```

cobrança com troco alterável (condições: valor.original > 0.00 && valor.modalidadeAlteração = 0 && presente(valor.retirada.troco) && valor.retirada.troco.valor >= 0 && valor.retirada.troco.modalidadeAlteracao = 1)

...
  "valor": {
    "original": "10.00",
    "retirada": {
      "troco": {
        "valor": "0.00",
        "modalidadeAlteracao": 1,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "12345678"
      }
    }
  },
...

Exemplos inválidos:

Abaixo alguns exemplos que não são válidos. Convém observar que esta listagem não tem pretensão de ser completa, sendo tão somente uma referência para alguns erros possíveis.

saque sem modalidadeAgente e prestadorDoServicoDeSaque

...
"valor": {
  "original": "0.00",
  "retirada": {
    "saque": {
      "valor": "5.00"
    }
  }
},
...

cobrança com saque e troco juntos (não pode ter os dois ao mesmo tempo)

...
"valor": {
  "original": "100.00",
  "retirada": {
    "saque": {
      "valor": "50.00",
      "modalidadeAgente": "AGPSS",
      "prestadorDoServicoDeSaque": "12345678"
    },
    "troco": {
      "valor": "30.00",
      "modalidadeAgente": "AGTEC",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

saque com valor.original maior que 0.00 (zero) (saque requer valor.original = 0.00)

...
"valor": {
  "original": "10.00",
  "retirada": {
    "saque": {
      "valor": "5.00",
      "modalidadeAgente": "AGPSS",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

troco com valor.original igual a 0.00 (zero) (para haver troco tem que haver valor.original > 0.00)

...
"valor": {
  "original": "0.00",
  "retirada": {
    "troco": {
      "valor": "5.00",
      "modalidadeAgente": "AGTEC",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

saque com valor.original alterável (não se pode alterar o valor.original na presença do saque)

...
"valor": {
  "original": "0.00",
  "modalidadeAlteracao": 1,
  "retirada": {
    "saque": {
      "valor": "5.00",
      "modalidadeAlteracao": 1,
      "modalidadeAgente": "AGPSS",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

troco com valor.original alterável (não se pode alterar o valor.original na presença do troco)

...
"valor": {
  "original": "0.01",
  "modalidadeAlteracao": 1,
  "retirada": {
    "troco": {
      "valor": "5.00",
      "modalidadeAlteracao": 1,
      "modalidadeAgente": "AGTOT",
      "prestadorDoServicoDeSaque": "12345678"
    }
  }
},
...

pixCopiaECola

string

length ≤ 512

Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.

chave

string

length ≤ 77

Formato da Chave Pix na qual a conta receberá o valor.

Conforme especificado na PACS.008. Os tipos de chave permitidos são:

Telefone
E-mail
CPF/CNPJ
O Endereço Virtual de Pagamento (EVP)

O formato detalhado das chaves está na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para Iniciação do Pix.
.

solicitacaoPagador

string

length ≤ 140

Permite que o pagador inclua um texto livre relacionado ao recebedor.

Preenchimento: O PSP do pagador insere esse texto no campo RemittanceInformation da pacs.008.

Limite de caracteres: Restrito a 140 caracteres.

infoAdicionais

array of objects

Apresentação das informações adicionais ao pagador:

Cada informação adicional contida nos campos nome e valor deve ser exibida ao pagador.

Informações adicionais

object

nome

string

required

length ≤ 50

Nome do pagador.

valor

string

required

length ≤ 200

Valor de cobrança.

Language

Credentials

OAuth2


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://api.pix.voluti.com.br/cob \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "calendario": {
8
    "expiracao": 86400
9
  },
10
  "valor": {
11
    "retirada": {
12
      "saque": {
13
        "modalidadeAlteracao": 0,
14
        "modalidadeAgente": "AGTEC"
15
      }
16
    }
17
  }
18
}
19
'


xxxxxxxxxx
35
}
1
{
2
  "calendario": {
3
    "criacao": "2020-09-09T20:15:00.358Z",
4
    "expiracao": 3600
5
  },
6
  "txid": "7978c0c97ea847e78e8849634473c1f1",
7
  "revisao": 0,
8
  "loc": {
9
    "id": 789,
10
    "location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
11
    "tipoCob": "cob"
12
  },
13
  "location": "pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25",
14
  "status": "ATIVA",
15
  "devedor": {
16
    "cnpj": "12345678000195",
17
    "nome": "Empresa de Serviços SA"
18
  },
19
  "valor": {
20
    "original": "37.00",
21
    "modalidadeAlteracao": 1
22
  },
23
  "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
24
  "solicitacaoPagador": "Serviço realizado.",
25
  "infoAdicionais": [

201Cobrança imediata criada

Exemplos válidos:

Exemplos inválidos:

400Requisição com formato inválido.

403Requisição de participante autenticado que viola alguma regra de autorização.

503Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.