Criar nova cobrança
Crie uma cobrança para um cliente cadastrado na sua conta Raims.
Cria uma cobrança para um cliente já cadastrado na empresa e no ambiente da
sua chave de API. Use em customer_id o identificador recebido no cadastro ou
na consulta do cliente.
Para receber os dados do Pix na criação, envie payment_method: 1 sem uma
lista própria em payment_method_types. A API usa o CPF/CNPJ do cliente
vinculado.
Para emitir boleto, envie payment_method: 2 sem lista própria. A emissão
usa o nome, e-mail válido, CPF/CNPJ e endereço do cliente. A Raims consulta seu catálogo de
CEPs para completar rua, bairro, cidade e UF ausentes quando esses dados
estiverem disponíveis. Informe o número no cadastro do cliente; ele não vem
do CEP. Veja as condições do endereço.
Se a emissão de Pix ou boleto estiver pendente, guarde o ID retornado e acompanhe a mesma cobrança pela consulta individual.
Para relacionar a cobrança ao pedido do seu sistema, use external_reference.
Consulte Referência no seu sistema
para entender esse vínculo e evitar cobranças duplicadas ao repetir uma requisição.
Use create_checkout: true para receber o link do checkout sem configurar
uma URL de retorno. Informar uma URL de retorno também gera o link, mesmo com
send_email: false, sem solicitar envio de e-mail. cancel_redirect_url é o destino
para voltar ao site da empresa; essa navegação não revoga a cobrança.
Consulte a visão geral de cobranças para entender o
vencimento, as URLs de retorno e o envio de e-mail. Os códigos de
payment_method e a escolha no checkout estão em
Meios de pagamento.
Parâmetros do corpo
ID de um cliente da empresa e do ambiente da chave de API. Copie o id retornado no cadastro ou na consulta. Pix direto exige CPF/CNPJ válido. Boleto direto exige nome, e-mail válido, CPF/CNPJ e endereço, incluindo CEP e número; complete esses dados no cadastro do cliente.
Até 100 caracteres
Valor da cobrança em centavos de real. Por exemplo, 10000 representa R$ 100,00.
De 100 a 999999999999
Meio da cobrança. Omitir ou enviar 0 permite escolher no checkout. Sem payment_method_types, 1 solicita Pix e 2 solicita boleto na criação, conforme os meios habilitados. Boleto usa o endereço do cliente e completa campos ausentes pelo CEP quando disponíveis. Com lista própria, envie 0 ou omita este campo; a emissão acontece após a escolha no checkout.
Vencimento em segundos Unix UTC, pelo menos cinco minutos no futuro. A data máxima é hoje mais dez anos, no calendário de São Paulo.
Título da cobrança. Você pode deixar este campo vazio.
Até 512 caracteres
Descrição da cobrança. Você pode deixar este campo vazio.
Até 512 caracteres
Com true, solicita o envio da cobrança ao e-mail do cliente e gera checkout_url. Em contas pendentes, o cliente precisa ter o mesmo e-mail principal da conta. Fora dessa condição, um e-mail ausente ou inválido impede o envio, mas permite criar a cobrança quando não houver emissão direta de boleto. Boleto direto exige e-mail válido mesmo com false. A resposta não confirma a entrega da mensagem.
Com true, gera o link retornado em checkout_url, sem exigir uma URL de retorno nem solicitar envio de e-mail. Com false, o link ainda é gerado quando send_email é true ou uma URL de retorno é informada.
URL HTTPS do seu site para retorno após a confirmação do pagamento. O redirecionamento não comprova o pagamento; consulte a cobrança para confirmá-lo. Não aceita credenciais no endereço, IP literal, localhost ou domínio Raims. Quando preenchida, gera checkout_url mesmo com send_email false. Se omitida, vazia ou null, o retorno não é definido.
Até 2048 caracteres
URL HTTPS do seu site para o pagador voltar pelo checkout. Voltar não cancela a cobrança, o Pix ou o boleto. Não aceita credenciais no endereço, IP literal, localhost ou domínio Raims. Quando preenchida, gera checkout_url mesmo com send_email false. Se omitida, vazia ou null, o retorno não é definido.
Até 2048 caracteres
Meios permitidos para a cobrança: 1 para Pix e 2 para boleto. Omitir ou enviar null usa a configuração de checkout herdada. Informe uma lista sem repetições. A configuração própria substitui o padrão da conta; uma configuração do link pode apenas restringir essa lista. Combine com payment_method omitido ou 0.
1 a 2 itens
Referência do pedido ou da cobrança no seu sistema. Null, vazio ou somente espaços deixam sem referência. Pode ser repetida e não evita cobranças duplicadas. É diferente da referência do cadastro do cliente.
Até 120 caracteres
Dados de integração associados à cobrança, em pares de chave e texto. Chaves diferenciam maiúsculas de minúsculas. Omitir, enviar null ou {} cria a cobrança sem esses dados; chaves com valor null não são gravadas. Texto vazio é um valor válido.
Até 32 entradas, Chaves: até 40 caracteres, Valores: até 500 caracteres, JSON: até 8192 bytes UTF-8
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.