Meios de pagamento

A Raims oferece Pix e boleto. O checkout mostra as opções permitidas para a cobrança, respeitando a disponibilidade da plataforma e as configurações da cobrança, do link e da conta. Cartão de crédito e cartão de débito estão desabilitados e não são oferecidos para pagamento.

Pix e boleto

No Pix, o pagador usa o QR Code ou o código Pix copia e cola apresentado no checkout. No boleto, usa o documento ou a linha de pagamento disponibilizada. A emissão dos dados de pagamento não confirma que a cobrança foi paga. Confira o estado da cobrança para acompanhar a confirmação.

Para ajustar as opções padrão da conta, consulte Checkout e formas de pagamento.

Códigos na API

Ao criar uma cobrança, use payment_method_types para definir uma lista própria de meios aceitos. Envie os códigos como números, sem repetição: [1] aceita Pix, [2] aceita boleto e [1, 2] aceita ambos. A lista preenchida substitui o padrão da conta somente nessa cobrança. Ela continua respeitando os meios disponíveis na plataforma, e uma configuração própria do link pode reduzir as opções dessa lista.

Omitir payment_method_types ou enviar null mantém a herança da configuração usada pelo checkout. Quando não há uma configuração própria do link, vale o padrão atual da conta, inclusive suas alterações posteriores. Uma lista vazia não representa essa herança.

payment_method é um campo separado, opcional, que usa 0 quando omitido. Sem uma lista própria, ele mantém os seguintes comportamentos:

Sem payment_method_types, escolher payment_method: 1 ou payment_method: 2 restringe a cobrança ao meio indicado, sem habilitar uma opção desativada na configuração usada pelo checkout. Se esse meio estiver desabilitado, outro não é oferecido como alternativa.

Com uma lista própria em payment_method_types, omita payment_method ou envie 0. Não combine a lista com payment_method: 1 ou payment_method: 2. A cobrança começa com meio indefinido, mesmo que a lista permita somente Pix ou somente boleto.

A lista aceita somente 1 e 2. Não envie 0, outros códigos, textos, booleanos ou itens null. Nenhuma dessas configurações altera o padrão da conta nem confirma pagamento. Com payment_method: 1, os dados disponíveis do Pix vêm em payment_information.pix; com payment_method: 2, os do boleto vêm em payment_information.boleto. Uma emissão pendente conserva o ID da cobrança para acompanhamento pela consulta individual. Veja Receber o Pix na criação e Receber o boleto na criação, incluindo os dados do cliente e o preenchimento do endereço por CEP.

Meio cadastrado e escolha do checkout

Nas consultas da API, payment_method informa o meio atual cadastrado na cobrança. Quando a geração de Pix ou boleto é registrada, uma cobrança indefinida passa de 0 para 1 ou 2, conforme o meio usado. payment_method_types informa a lista própria configurada na criação, ou null quando a cobrança usa a herança. Essa lista não muda para refletir o meio escolhido nem representa as opções disponíveis naquele momento. checkout_payment_method informa o meio registrado no checkout e retorna null enquanto esse registro não existir.

Por exemplo, depois de registrar a geração de Pix para uma cobrança criada com payment_method: 0, a consulta informa payment_method: 1 e checkout_payment_method: 1. Definir payment_method: 1 na criação solicita a emissão direta do Pix. Selecionar uma opção na tela, por si só, não confirma geração nem pagamento.

Se a cobrança foi criada com payment_method_types: [1, 2], registrar a geração de Pix faz a consulta informar payment_method: 1, preservando payment_method_types: [1, 2].

O filtro payment_method de Listar cobranças considera o meio atual cadastrado. Um clique no checkout sem registro da geração não faz uma cobrança indefinida corresponder ao filtro de Pix ou boleto.