Cobranças

Uma cobrança informa o valor que um cliente deve pagar à sua empresa. Depois de criá-la, acompanhe o status para saber se o cliente pagou. A criação por si só não confirma pagamento nem saldo disponível na conta.

A base das requisições é https://api.raims.com.

Cliente e ambiente

Use um cliente já cadastrado na empresa e no ambiente da chave de API. Se precisar cadastrar o pagador, consulte Criar um cliente. Para obter os dados de um cadastro existente, use Recuperar um único cliente.

Copie o id do cliente para customer_id ao criar a cobrança. Não envie o identificador do seu próprio sistema nesse campo. Cadastros e cobranças de Sandbox ficam separados dos dados de Produção. Use Sandbox para testar sem movimentar valores reais.

Use Simulação para confirmar um pagamento ou aplicar uma falha a uma cobrança de teste. Você também pode testar a emissão e o cancelamento pendentes ou com falha, além da compensação do boleto antes da liquidação. Esses endpoints são exclusivos do Sandbox e permitem conferir o resultado sem realizar um pagamento real.

Para emitir Pix na criação, o cliente vinculado precisa ter um CPF/CNPJ válido. A API usa esse cadastro; não envie outro documento no pedido da cobrança. O documento identifica o cliente cobrado, sem exigir que o pagamento venha de uma conta bancária desse titular.

Criar uma cobrança

Criar nova cobrança, com POST /v1/charges, recebe o cliente e o valor da cobrança. Envie amount_cents como um inteiro em centavos: 10000 representa R$ 100,00. O valor permitido vai de 100 a 999999999999 centavos.

Cada requisição cria uma cobrança única. payment_method_types permite definir uma lista própria de meios aceitos, que substitui o padrão da conta somente nessa cobrança. Omitir a lista ou enviar null mantém a herança da configuração usada pelo checkout. A disponibilidade da plataforma continua valendo, e uma configuração própria do link pode reduzir as opções da cobrança.

payment_method é separado da lista e mantém os comportamentos de escolha ou restrição a um meio quando ela não é informada. Com uma lista própria, omita esse campo ou envie 0. Consulte os formatos e códigos em Meios de pagamento.

Título e descrição são opcionais e aceitam até 512 caracteres cada.

Guarde o identificador retornado pela API para relacionar a cobrança ao seu sistema. Se uma requisição terminar sem uma resposta conclusiva, confira o resultado antes de repetir o pedido.

Receber o Pix na criação

Em POST /v1/charges, envie customer_id de um cliente já cadastrado e payment_method: 1, sem uma lista própria em payment_method_types. A emissão usa o CPF/CNPJ válido desse cadastro; não envie outro documento, nome ou e-mail no pedido da cobrança. A resposta inclui payment_information.pix, com copy_paste, expires_at e qr_code_base64. Você pode apresentar esses dados no seu sistema, sem encaminhar o pagador ao checkout da Raims. A emissão não confirma pagamento.

payment_information.pix_status informa o resultado: available quando o Pix está disponível, pending enquanto a emissão não foi confirmada, failed quando não foi possível emitir e not_generated quando não há uma emissão Pix disponível. Em failed, confira payment_information.pix_error para identificar o motivo.

Exibir o QR Code e usar o copia e cola

Ao receber o Pix na criação com POST /v1/charges, o QR Code vem em payment_information.pix.qr_code_base64, como imagem PNG em Base64. Para exibi-lo em uma página, use o prefixo data:image/png;base64, antes desse valor. copy_paste é o código para copiar, e expires_at informa a expiração em segundos Unix UTC.

Respostas 201 e 202 para Pix

Se receber 202, a cobrança já tem um ID, mas o Pix ainda não está disponível. Guarde esse ID e consulte a mesma cobrança em Recuperar uma única cobrança. Não crie outra cobrança para acompanhar essa emissão. A consulta devolve os dados disponíveis e o status atual; consultar não emite outro código.

Se a emissão continuar pendente ou falhar, entre em contato com o suporte e informe o ID da cobrança. Uma resposta 201 confirma a criação da cobrança. Confira payment_information.pix_status e os dados de pagamento para saber se o Pix está disponível.

Pix na criação ou no checkout

Uma lista como payment_method_types: [1] configura os meios aceitos, mas mantém a emissão após a escolha no checkout. Para solicitar o Pix na própria criação, use o campo payment_method: 1.

Receber o boleto na criação

Em POST /v1/charges, envie payment_method: 2, sem lista própria em payment_method_types. Use em customer_id o ID de um cliente com nome, e-mail válido, CPF/CNPJ válido e endereço. O CEP fica em zip_code e o número em street_number no cadastro do cliente. Você não precisa enviar outro pagador ou endereço na requisição da cobrança. O e-mail é necessário para a emissão mesmo com send_email: false; informá-lo no cadastro não solicita envio de mensagem.

A Raims consulta seu catálogo de CEPs para completar logradouro, bairro, cidade e UF ausentes, quando esses dados estiverem disponíveis. Os valores já informados no endereço são preservados. O número precisa estar no cadastro; ele e o complemento não vêm do CEP. O complemento é opcional. Se o CEP não fornecer todos os dados necessários, complete o endereço em Atualizar cliente existente antes de emitir o boleto.

O endereço usado na emissão não altera o cadastro do cliente. Essa regra é diferente do preenchimento ao criar um cliente: naquele cadastro, informar número ou complemento impede o preenchimento pelo CEP. Na emissão do boleto, eles podem estar preenchidos enquanto a Raims completa os demais campos ausentes.

Quando o boleto estiver disponível, payment_information.boleto contém line_digits, barcode e due_date. Use a linha digitável e o código de barras no seu sistema. O vencimento vem em segundos Unix UTC e corresponde à data do boleto. Emitir esses dados não confirma pagamento. No Sandbox, o boleto é simulado e não deve ser usado para um pagamento real.

Uma lista como payment_method_types: [2] configura o boleto no checkout, com emissão após a escolha do pagador. Para emitir na criação, use payment_method: 2.

Respostas 201 e 202 para boleto

payment_information.boleto_status informa available quando os dados estão disponíveis, pending quando a emissão ainda não foi confirmada, failed quando não foi possível emitir e not_generated quando não há emissão disponível ou solicitada. boleto_error informa o motivo da pendência ou da falha, quando houver.

Uma resposta 201 confirma a criação da cobrança; confira boleto_status para saber se o boleto foi emitido. Em 202, guarde o ID e acompanhe a mesma cobrança em Recuperar uma única cobrança. A consulta não repete nem renova a emissão. Se a pendência persistir ou houver falha, contate o suporte com o ID da cobrança, sem criar outra para repetir a emissão.

Se os dados do cliente impedirem a criação, corrija o cadastro indicado pelo erro antes de enviar novamente a requisição. Uma emissão confirmada também não significa que o cliente pagou; acompanhe o status da cobrança.

O andamento do pagamento do boleto aparece em payment_information.boleto_payment_status: awaiting_payment para boleto emitido que aguarda pagamento, compensated para pagamento compensado que aguarda liquidação e settled para pagamento liquidado. Sem andamento disponível, o campo retorna null. A compensação ainda não representa crédito disponível. Para testar essas etapas, veja Compensação e liquidação do boleto.

Referência no seu sistema

Envie em external_reference o identificador do pedido ou da cobrança no seu sistema, por exemplo PEDIDO-123. Esse campo pertence à cobrança e é independente da referência externa cadastrada no cliente.

A referência é opcional. Na criação, omitir o campo, enviar null, texto vazio ou somente espaços deixa a cobrança sem referência. A API remove os espaços nas bordas. A resposta da criação, as consultas e a resposta da edição incluem external_reference, com o valor cadastrado ou null.

Você pode alterar ou remover a referência em Atualizar cobrança existente. Omitir o campo mantém o valor atual; enviar null, texto vazio ou somente espaços remove a referência. Essa alteração não muda o identificador da Raims nem o cliente vinculado.

Na listagem GET /v1/charges, o filtro external_reference busca o valor completo atual da referência da cobrança. A comparação distingue maiúsculas, minúsculas e acentos. Mantenha o mesmo valor com os demais filtros ao navegar por cursor. Uma criação ou edição pode levar alguns segundos para aparecer nessa busca; evite consultas contínuas em intervalos curtos.

A mesma referência pode aparecer em mais de uma cobrança. Repetir essa referência, por si só, não faz a API reutilizar uma cobrança. Guarde também o id retornado para reconhecer cada cobrança e conferir um resultado inconclusivo antes de tentar novamente.

Dados adicionais da integração

Use metadata para guardar pequenas informações que relacionem a cobrança ao seu sistema, como uma filial ou um canal de venda. Os dados do cliente e os da cobrança são separados: o mapa do cliente não é copiado para uma nova cobrança.

{
  "metadata": {
    "filial": "SP-01",
    "canal": "site"
  }
}

O mapa aceita até 32 chaves, com nomes formados por letras sem acentos, números, ponto, hífen ou sublinhado e valores em texto. Os nomes diferenciam maiúsculas de minúsculas. Os limites também valem para o mapa completo depois de uma atualização. Não armazene senhas, tokens, documentos pessoais ou outros dados sensíveis.

Se metadata não for informado na criação, a cobrança fica com um mapa vazio. Na atualização, as chaves enviadas são adicionadas ou substituídas; as demais permanecem. Omitir metadata ou enviar {} mantém os dados. Envie null no valor de uma chave para removê-la, ou metadata: null para apagar o mapa. Um texto vazio é um valor válido e não remove a chave.

As respostas de criação, atualização e consulta retornam metadata, com {} quando não há valores. Esses dados não alteram valor, vencimento ou pagamento. Eles não são filtros da listagem nem entram automaticamente no corpo dos webhooks. Para pesquisar pelo código do seu sistema, use external_reference.

Você pode atualizar somente metadata depois do pagamento ou estorno da cobrança. Se o mesmo pedido também alterar título, descrição ou referência externa, ele fica sujeito às regras desses campos. Quando o estado impedir essa edição, nenhum dos campos do pedido será alterado.

Vencimento

Informe o vencimento em due_date, em segundos Unix UTC. Escolha uma data e horário pelo menos cinco minutos à frente do momento em que a requisição chegar à API. Considere o tempo de envio ao calcular esse prazo. O limite máximo é o dia correspondente a dez anos após hoje, no horário de São Paulo.

No Pix, o vencimento conserva o horário informado. O boleto usa a data de vencimento de São Paulo, inclusive o mesmo dia. A expiração da cobrança e do checkout não confirma o cancelamento de um boleto já emitido. Para deixar de receber por esse boleto, acompanhe a confirmação da revogação da cobrança.

Link do checkout e envio de e-mail

Para receber checkout_url sem enviar e-mail, use create_checkout: true na criação da cobrança e mantenha send_email: false. Não é necessário configurar uma URL de retorno para receber o link. Use o endereço retornado para encaminhar o pagador ao checkout daquela cobrança.

Os campos success_redirect_url e cancel_redirect_url configuram os destinos de retorno do checkout ao site da empresa. success_redirect_url é o destino após a confirmação do pagamento. cancel_redirect_url é o destino da opção de voltar ao site; essa navegação não revoga a cobrança.

Envie URLs HTTPS completas, de até 2048 caracteres cada, em um domínio da empresa. Não use credenciais na URL, endereço IP, localhost ou domínio Raims. Os campos são opcionais: você pode omiti-los, enviar null ou deixá-los vazios. Campos só com espaços também não definem uma URL de retorno. Informar pelo menos uma dessas URLs gera o link. Consulte a cobrança para confirmar o pagamento no seu sistema, mesmo que o pagador tenha voltado pela URL de sucesso.

create_checkout e send_email são opcionais e usam false quando omitidos. Sem essas opções e sem URLs de retorno, a requisição cria a cobrança sem gerar link nem solicitar e-mail; checkout_url retorna null.

Use send_email: true para solicitar o envio da cobrança ao e-mail cadastrado do cliente. Você também recebe o link em checkout_url. Confira antes se o cliente tem um e-mail válido. Para obter somente o link, use create_checkout: true com send_email: false.

Esse checkout pertence a uma cobrança específica. Para obter ou configurar o link de uma cobrança já criada, use Links de pagamento.

Enquanto a empresa aguarda a conclusão da análise cadastral, o envio fica restrito ao e-mail do titular. Um e-mail ausente, inválido ou diferente do e-mail do titular nessa condição impede a criação com envio. Fora dessa restrição de cadastro pendente, um e-mail ausente ou inválido não impede a criação da cobrança e do link, mas não há envio. A emissão direta de boleto exige e-mail válido mesmo sem solicitar mensagem. O sucesso da requisição não confirma que o e-mail foi entregue nem que a cobrança foi paga.

Listar cobranças

Listar cobranças, com GET /v1/charges, consulta os cadastros da empresa e do ambiente da chave. Use os filtros por identificador da cobrança, referência externa, cliente, e-mail registrado na cobrança, status, meio de pagamento cadastrado e intervalos de criação, vencimento e pagamento. Alterar o e-mail do cliente não modifica o e-mail já registrado nas cobranças existentes.

Use customer_id com o ID recebido no cadastro ou na consulta do cliente para listar suas cobranças. O vínculo continua o mesmo se o nome ou o e-mail do cliente mudar. Você pode combinar esse filtro com os demais. Um ID válido sem cobranças acessíveis na empresa e no ambiente da chave retorna uma lista vazia. Mantenha também customer_id ao copiar o cursor para a próxima página.

Use external_reference para procurar pelo valor atual da referência da cobrança. A comparação é exata e distingue maiúsculas, minúsculas e acentos: PEDIDO-123 não corresponde a pedido-123 nem a um trecho como 123. Você pode combinar esse filtro com os demais; mantenha o mesmo valor ao navegar por cursor. Uma criação ou edição pode levar alguns segundos para aparecer nessa busca. Evite consultas contínuas em intervalos curtos para tentar antecipar a atualização.

Os filtros status e payment_method aceitam códigos separados por vírgula. Para status, use os códigos de 0 a 13 descritos no endpoint. Os códigos do filtro de meio de pagamento estão em Meios de pagamento.

A resposta contém list e page. Comece sem cursor e processe as cobranças recebidas. Enquanto page.has_next for true, copie page.next_after para after na próxima requisição, mantendo os filtros e a ordenação. Copie o cursor completo, sem interpretar ou calcular seu conteúdo. A página aceita até 100 cobranças e usa 10 quando page_size não é informado. O guia de Listagem e paginação também explica como voltar com before. Envie apenas um cursor por requisição.

created_gte e created_lte filtram a data de criação, em segundos Unix UTC, incluindo os instantes informados. Por padrão, os cadastros mais recentes aparecem primeiro. sort_key aceita amount_cents ou created_at; sort_order aceita asc ou desc, com padrão desc, e também permite inverter a direção da ordenação padrão. Se informar um intervalo de criação sem escolher sort_key, a consulta ordena por created_at.

Use due_gte e due_lte para consultar cobranças pelo vencimento, em segundos Unix UTC. Os limites são inclusivos: due_gte inclui vencimentos a partir do instante informado, e due_lte inclui vencimentos até esse instante. Você pode informar somente um limite ou combinar os dois; o limite final deve ser igual ou posterior ao inicial. Para consultar um dia inteiro, converta o início e o fim desse dia para UTC conforme o fuso horário usado no seu sistema.

O intervalo considera o due_date da cobrança, inclusive em cobranças pagas. Combine com status quando precisar selecionar uma situação específica, como cobranças expiradas. O filtro de vencimento pode ser usado junto dos demais filtros e não muda a ordenação escolhida. Mantenha todos os filtros ao usar after ou before; para consultar outro período, comece novamente sem cursor.

Use paid_gte e paid_lte para encontrar cobranças pagas em um período. Os valores são segundos Unix UTC e incluem os dois limites. O filtro usa a data do pagamento original da cobrança, não a data de criação, o vencimento ou a data de disponibilidade do dinheiro.

Cobranças sem uma data de pagamento ficam fora desse filtro. Um estorno posterior não retira a cobrança do período em que ela foi paga; combine com status se precisar restringir a situação atual. A confirmação de um pagamento pode levar alguns segundos para aparecer na busca. Mantenha os mesmos filtros ao navegar por cursor e evite consultas contínuas para tentar antecipar a atualização.

payment_method informa o meio atual da cobrança; payment_method_types informa a lista própria configurada, ou null para herança, sem representar as opções disponíveis naquele momento. checkout_payment_method informa o meio usado para gerar o pagamento no checkout. Se payment_method era 0, gerar Pix ou boleto no checkout muda esse valor para 1 ou 2, respectivamente. Apenas selecionar a opção no checkout não muda o filtro. Consulte Meios de pagamento.

checkout_url devolve um link já existente ou null. Listar cobranças não cria link nem solicita e-mail. O status retornado considera o vencimento da cobrança. O filtro de status pode levar alguns segundos para refletir alterações; evite consultar continuamente em intervalos curtos para tentar acelerar essa atualização.

Recuperar uma cobrança

Recuperar uma única cobrança, com GET /v1/charges/{id}, consulta o cadastro, o status e os dados de pagamento em uma única requisição. Use o identificador recebido na criação ou na listagem. A cobrança precisa pertencer à empresa e ao ambiente da chave.

payment_information.pix_status e payment_information.pix_error informam o resultado da emissão do Pix. Para boleto, confira boleto_status e boleto_error no mesmo objeto. Se a criação retornou 202, use o mesmo ID nessa consulta. A resposta pode continuar pendente; consultas repetidas não reiniciam a emissão.

Use status para acompanhar a situação da cobrança e is_payable para saber se ela pode receber pagamento. payment_method informa o meio atual da cobrança; payment_method_types informa a lista própria configurada ou null para herança; checkout_payment_method informa o meio usado para gerar o pagamento, ou null antes da geração. Selecionar uma opção na tela não confirma emissão nem pagamento. Ao criar com payment_method: 1, confira payment_information.pix; com payment_method: 2, confira payment_information.boleto para obter os dados disponíveis.

O objeto payment_information reúne o QR Code, o Pix copia e cola e sua expiração, ou os dados do boleto já emitido. Pix e boleto podem ser emitidos na criação com o respectivo payment_method ou após a escolha no checkout. Antes da emissão, a cobrança pode aceitar pagamento sem ter dados de Pix ou boleto. Quando não há uma emissão disponível para o meio escolhido ou a cobrança não pode receber pagamento, os dados ficam nulos. O cadastro e o status continuam disponíveis, inclusive para cobranças pagas, canceladas ou expiradas.

A consulta devolve o link do checkout existente ou null. Ela não altera a cobrança nem gera ou renova Pix, boleto ou link. Também não solicita envio de e-mail. Consultas repetidas não aceleram a emissão ou a confirmação do pagamento. A listagem mostra um resumo da cobrança e seu status, sem os dados de Pix e boleto.

Para consultar quantidades, valores e taxa de pagamento, veja Estatísticas de cobranças em Informações financeiras.

Boleto em PDF

Use Baixar boleto, com GET /v1/charges/{id}/boleto, para obter o PDF de um boleto já emitido. O identificador é o da cobrança. Você pode anexar o arquivo ao seu sistema ou entregá-lo ao cliente sem abrir o checkout. A requisição exige a chave de API da mesma empresa e ambiente.

O download exige um boleto emitido, com os dados necessários para gerar o arquivo. Você pode obtê-lo enquanto ele aguarda pagamento, na compensação e após a liquidação. Um boleto cancelado, com falha ou sem os dados de emissão não tem PDF disponível. A expiração da cobrança, por si só, não confirma o cancelamento do boleto.

Se receber BOLETO_DOCUMENT_NOT_AVAILABLE, consulte a cobrança para conferir a emissão e o andamento do boleto. Repetir o download não emite nem renova o boleto e não muda seu vencimento.

O endpoint retorna JSON com url e expires_at. Faça um GET na url completa para baixar o PDF em files.raims.com, sem enviar Authorization ou a chave de API nesse download. expires_at informa a expiração em segundos Unix UTC; depois dela, consulte novamente o endpoint autenticado. Um link inválido ou expirado pode receber HTTP 403 no download, sem o envelope JSON de erros da API. A URL pode ser reutilizada até expirar e permite acesso a quem a possuir. Compartilhe-a somente com pessoas autorizadas e não a registre em logs.

O documento contém as instruções do boleto e não comprova pagamento. No Sandbox, ele é identificado como simulação e não deve ser usado para pagar. Para comprovar um pagamento confirmado, use o recibo descrito a seguir.

Dados do pagamento e recibo

Use Consultar dados do pagamento, com GET /v1/charges/{id}/payment, para obter os dados de um pagamento confirmado e apresentá-los no seu sistema. Para receber o documento pronto, use Baixar recibo de pagamento, com GET /v1/charges/{id}/receipt. O identificador é o da cobrança, com prefixo ch_.

O recibo fica disponível para cobranças pagas, parcialmente devolvidas ou com contestação vencida pela empresa, desde que o pagamento tenha valor e data registrados. Se o documento não estiver disponível, consulte a cobrança para conferir seu estado antes de tentar novamente.

A consulta dos dados informa o valor, o meio de pagamento, a data e os dados cadastrais do pagador e da empresa recebedora. O nome e o documento do pagador são os registrados na cobrança; eles não comprovam a titularidade da conta bancária que realizou o pagamento. Campos sem informação disponível podem ficar null.

Nos pagamentos Pix de Produção, end_to_end_id informa o identificador bancário do recebimento quando ele está disponível. Use-o para conferir o pagamento com o comprovante bancário ou na conciliação do seu sistema. O campo fica null quando não há identificação bancária confirmada, nos pagamentos por boleto e no Sandbox. Um valor nulo não desfaz a confirmação do pagamento. Esse identificador é diferente do ID ch_ da cobrança e dos dados usados para iniciar o Pix.

A resposta do endpoint é JSON com url e expires_at. Faça a requisição pelo servidor da sua integração com a chave de API. Baixe o PDF pela url completa em files.raims.com, sem enviar a chave nesse download. expires_at informa a expiração em segundos Unix UTC. Se o link expirar, consulte novamente o endpoint autenticado para obter outro. Um link inválido ou expirado pode receber HTTP 403 no download, sem o envelope JSON de erros da API. A URL pode ser reutilizada até expirar e permite acesso a quem a possuir; compartilhe-a somente com pessoas autorizadas e não a registre em logs. O documento é emitido pela Raims e não substitui nota fiscal ou comprovante bancário. No Sandbox, os dados e o recibo identificam o pagamento como simulado.

Uma devolução parcial não muda o valor original do recibo de pagamento. Para comprovar cada devolução concluída, use o comprovante do estorno, com o identificador rf_ da solicitação correspondente.

Atualizar uma cobrança

Atualizar cobrança existente, com PATCH /v1/charges/{id}, altera o título, a descrição, a referência externa e os dados de metadata pelo identificador público. Envie os campos que deseja mudar. Campos omitidos preservam o valor atual; nos campos de texto, null ou texto vazio limpa o campo enviado. Um corpo vazio ({}) mantém os dados. O mapa metadata segue a atualização por chave. Veja como usar external_reference em Referência no seu sistema.

O valor, o vencimento e o cliente vinculado são definidos na criação e não podem ser alterados por essa requisição. Para cobrar outro valor ou usar outro vencimento, revogue a cobrança elegível. Aguarde a confirmação da revogação antes de criar a cobrança substituta. O vencimento, por si só, não impede editar uma cobrança que permanece aberta. Cobranças pagas, canceladas, devolvidas ou em outros estados finais não permitem editar esses campos. Um pedido que altere somente metadata continua permitido em uma cobrança existente; veja Dados adicionais da integração.

Se o estado impedir a edição, CHARGE_NOT_UPDATABLE informa o estado atual e os aceitos. Consulte a cobrança antes de decidir como continuar; a edição não altera seu estado financeiro.

A edição mantém o identificador, o status e os dados de pagamento. Ela não gera ou renova Pix, boleto ou link de checkout, nem solicita envio de e-mail.

Revogar uma cobrança

Revogar cobrança, com DELETE /v1/charges/{id}, cancela uma cobrança que não deve mais receber pagamento. Use o ID da criação ou da consulta, na mesma empresa e no mesmo ambiente da chave.

Em Sandbox, você pode testar a revogação sem movimentar valores reais. Para conferir o acompanhamento de um cancelamento pendente ou com falha, prepare o resultado no recurso de Simulação antes de enviar a revogação.

Em Produção, a revogação depende do status da cobrança e dos dados de pagamento já emitidos. Para Pix emitido, o cancelamento precisa ser confirmado. Para boleto, o pedido pode continuar pendente até a confirmação. Acompanhe a mesma cobrança pela consulta individual; um pedido aceito não significa cancelamento concluído. Se não receber a confirmação do cancelamento, consulte a mesma cobrança antes de tentar novamente.

Uma recusa por CHARGE_NOT_REVOCABLE informa o estado ou a condição do pagamento que impediu a ação. Boleto ainda em emissão, pagamento já identificado e cancelamento recusado exigem acompanhamentos diferentes. Confira a mensagem e a cobrança; a revogação não é uma forma de estornar.

O cadastro e o histórico continuam disponíveis para consulta após a revogação. Se repetir a requisição para uma cobrança já cancelada na mesma empresa e ambiente, receberá a mesma confirmação. Para voltar a cobrar, crie outra cobrança.

Uma cobrança Pix paga pode seguir o fluxo de estorno. Revogar não estorna, reembolsa ou devolve valores e não solicita envio de e-mail.

Consulte os campos e as respostas em Criar nova cobrança, Listar cobranças, Recuperar uma única cobrança, Atualizar cobrança existente e Revogar cobrança. Para preparar a credencial da integração, consulte Autenticação.