API Reference

Criar cobrança imediata

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

Atributos comuns a todas entidades de Cobrança

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.

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.
.

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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 years ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 2 years ago

Did this page help you?