Cobrança de Pagamento Imediato

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

  1. Criação da Solicitação: O parceiro da Pagstar 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.
  2. 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.
  3. 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.
  4. 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.
  5. Notificação: A Pagstar 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://pagstar/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"
  }
CampoObrigatórioDescrição
calendario.expiracaoSimTempo de expiração em segundos para a cobrança, após o qual não é mais válida.
valor.originalSimValor 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.modalidadeAlteracaoNãoIndica 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.logradouroNãoEndereço do devedor
devedor.cidadeNãoNome do município do devedor
devedor.ufNãoAbreviação do estado do devedor
devedor.cepNãoCódigo postal do devedor
devedor.cpfNãoCPF do devedor
devedor.cnpjNãoCNPJ do devedor
devedor.nomeNãoNome do devedor
infoAdicionais.nomeNãoNome do campo adicional (comprimento máximo de 50 caracteres)
infoAdicionais.valorNãoDados do campo adicional (comprimento máximo de 200 caracteres)
chaveSimChave Pix do parceiro Pagstar

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"
}

CampoDescrição
revisaoIndicador do número de revisão da cobrança (alteração dos dados da cobrança), permitindo a rastreabilidade das mudanças.
loc.idID da localização da cobrança.
loc.locationURL da localização da cobrança.
loc.tipoCobTipo de cobrança.
loc.criacaoData e hora de criação da cobrança.
locationURL da localização da cobrança.
txidID da Transação
statusStatus atual da cobrança
pixCopiaEColaConteúdo da sequência de caracteres que representa o Código BR

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

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