Cobrança de pagamento imediato

Uma solicitação de pagamento Pix para pagamento imediato normalmente funciona:

Criação da Solicitação: O parceiro da Onz Finance gera uma solicitação de pagamento Pix usando nossa API de cobrança. Eles especificam o valor a ser pago e frequentemente incluem informações adicionais, como uma descrição do pagamento.
Envio da Solicitação: A solicitação de pagamento é enviada ao pagador (cliente) por meio de um aplicativo de mensagens, e-mail, SMS ou qualquer outro canal de comunicação acordado entre as partes.
Ação do Pagador: Ao receber a solicitação de pagamento, o pagador abre seu aplicativo bancário ou acessa sua plataforma de banco online. Em seguida, eles autorizam o pagamento confirmando os detalhes da transação.
Pagamento Imediato: Assim que o pagador confirma a transação, os fundos são transferidos imediatamente de sua conta bancária para a conta especificada pelo parceiro. O pagamento é processado instantaneamente e os fundos ficam disponíveis para o destinatário sem demora.
Notificação da Onz Finance: A Onz Finance notificará o parceiro sobre o pagamento via o webhook configurado.

Caso de uso
Um cenário de exemplo poderia ser um cliente comprando produtos de uma loja online. Após selecionar os itens para compra, eles escolhem a opção de pagamento Pix no checkout. A loja online gera uma solicitação de pagamento Pix para o valor total, que é então enviada ao smartphone do cliente via um aplicativo de mensagens. O cliente abre seu aplicativo bancário, aprova a solicitação de pagamento e os fundos são transferidos instantaneamente para a conta bancária da loja, completando a transação em tempo real.

Requisição

curl --location 'https://pix.onz.finance/cob' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJh...' \
  --data {
    "calendario": {
      "expiracao": 3600
    },
    "valor": {
      "original": "0.03",
      "modalidadeAlteracao": 0
    },
    "devedor": {
      "logradouro": "Rua das Flores 456, Jardim Botânico, apto 401",
      "cidade": "Rio de Janeiro",
      "uf": "RJ",
      "cep": "22461120",
      "cpf": "20344948064",
      "nome": "John Doe"
    },
    "infoAdicionais": [
      {
        "nome": "Invoice",
        "valor": "BR0001x15"
      }
    ],
    "chave": "b8xxxd2a-b353-4475-af38-d94exxxx5e2f"
  }

Campo	Obrigatório	Descrição
calendario.expiracao	Sim	Tempo de expiração em segundos para a cobrança, após o qual não é mais válida.
valor.original	Sim	Valor para cobrança de pagamento imediato. Deve apresentar valores maiores que zero, exceto no caso em que o campo `valor.modalidadeAlteracao` apresenta o valor 1. Validação: `\d{1,10}\.\d{2}`
valor.modalidadeAlteracao	Não	Indica o modo de modificação aplicado ao valor definido para a cobrança. Se ausente, assume-se que o modo aplicado é 0, significando que o valor da cobrança não pode ser alterado. Se o valor for 1, o valor da cobrança pode ser modificado. Além disso, se `valor.modalidadeAlteracao` for 1, `valor.original` pode atuar como um 'valor sugerido.' Se este valor sugerido for zero, o usuário pagador deve inserir um valor válido maior que zero.
devedor.logradouro	Não	Endereço do devedor
devedor.cidade	Não	Nome do município do devedor
devedor.uf	Não	Abreviação do estado do devedor
devedor.cep	Não	Código postal do devedor
devedor.cpf	Não	CPF do devedor (ver CPF)
devedor.cnpj	Não	CNPJ do devedor (ver CNPJ)
devedor.nome	Não	Nome do devedor
infoAdicionais.nome	Não	Nome do campo adicional (comprimento máximo de 50 caracteres)
infoAdicionais.valor	Não	Dados do campo adicional (comprimento máximo de 200 caracteres)
chave	Sim	Chave Pix do parceiro Onz (ver Pix Key)

Resposta

{
  "revisao": 0,
  "loc": {
    "id": 1424948,
    "location": "qrcodes-h.sulcredi.coop.br/v2/v3/at/1ecb1147-ac25-4454-bbb9-bce9b5603ffa",
    "tipoCob": "cob",
    "criacao": "2024-05-06T19:12:09.690Z"
  },
  "location": "qrcodes-h.sulcredi.coop.br/v2/v3/at/1ecb1147-ac25-4454-bbb9-bce9b5603ffa",
  "calendario": {
    "criacao": "2024-05-06T19:12:09Z",
    "expiracao": 3600
  },
  "devedor": {
    "cpf": "20344948064",
    "nome": "John Doe"
  },
  "valor": {
    "original": "0.03",
    "modalidadeAlteracao": 0
  },
  "chave": "b8xxxd2a-b353-4475-af38-d94exxxx5e2f",
  "txid": "2ddea1656f412dxxxxc6abbb66a021",
  "status": "ATIVA",
  "infoAdicionais": [
    {
      "nome": "AVISO",
      "valor": "Pagamento"
    }
  ],
  "pixCopiaECola": "00020126940014br.gov.bcb.pix2572qrcodes-h.sulcredi.coop.br/v2/v3/at/1ecb1147-ac25-4454-bbb9-bcexxxx03ffa52040000530398xxxxxBR5919MATH JOES6014SAO PAULO 62070503***63043C7D"
}

Campo	Descrição
revisao	Indicador do número de revisão da cobrança (alteração dos dados da cobrança), permitindo a rastreabilidade das mudanças.
loc.id	ID da localização da cobrança.
loc.location	URL da localização da cobrança.
loc.tipoCob	Tipo de cobrança.
loc.criacao	Data e hora de criação da cobrança.
location	URL da localização da cobrança.
txid	ID da Transação (ver txId).
status	Status atual da cobrança (ver Status da Cobrança).
pixCopiaECola	Conteúdo da sequência de caracteres que representa o Código BR (ver Pix Copia e Cola).

Cobrança com pagamento automático (somente para testes, somente em ambiente de homologação)

O ambiente de testes oferece a funcionalidade de criação de cobranças imediatas com pagamento automático como forma de facilitar e agilizar o desenvolvimento da integração. As cobranças criadas utilizando o verbo PUT e fornecendo um txtId finalizado com a letra “z” serão liquidadas automaticamente após alguns segundos, simulando o pagamento da cobrança.

Exemplo:

curl --location --request PUT 'https://pix.onz.finance/cob/0123456789fff3456789012349z' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJhb...' \
  --data {
    "calendario": {
      "expiracao": 3600
    },
    "valor": {
      "original": "0.22",
      "modalidadeAlteracao": 0
    },
    "chave": "b8xxxd2a-b353-4475-af38-d94exxxx5e2f"
  }

Outras operações de cobrança de pagamento imediato:

Crie uma cobrança de pagamento imediato informando seu próprio txId.
Alteração de dados de cobrança de pagamento imediato.
Removendo uma cobrança de pagamento imediato.
Obtenha uma lista de cobranças de pagamento imediato.
Obtenha detalhes de uma cobrança de pagamento imediato.

Cobrança de pagamento imediato

Cobrança com pagamento automático (somente para testes, somente em ambiente de homologação)​

Cobrança com pagamento automático (somente para testes, somente em ambiente de homologação)