Tipos e identificadores
Encontre o significado dos identificadores, tipos e estados usados pela Raims.
Use este mapa para entender um valor retornado pela API ou um identificador apresentado no Dashboard. Cada página explica o que o valor representa, onde aparece e o que ele permite concluir.
Como encontrar o significado
| O que você encontrou | Onde consultar |
|---|---|
Um ID como st_, ch_, wd_ ou med_ | Identificadores e prefixos |
statement_type, reference_type ou meio de pagamento | Tipos financeiros |
| Estado de cobrança ou estorno, etapa e motivo de contestação | Estados e resultados |
| Sandbox, Produção ou chave de API | Autenticação e Chaves de API |
Um erro de requisição, como INVALID_FIELDS | Códigos HTTP das respostas |
| Nome de evento ou permissão de colaborador | Webhooks e Usuários e permissões |
Para pix_status, veja Receber o Pix na criação.
Os motivos que impedem uma devolução estão em
Consultar o valor devolvível.
A consulta de links
explica sua disponibilidade para pagamento. Para tax_id e tax_id_type,
consulte Validação de CPF e CNPJ.
Os códigos de resposta ajudam a interpretar o recurso consultado. Os parâmetros de cada endpoint informam quais valores podem ser enviados em uma requisição. Por exemplo, reconhecer um meio de pagamento na resposta não significa que ele possa ser escolhido na criação de uma cobrança.
O mesmo valor em campos diferentes
O significado depende do nome do campo e do recurso consultado. No extrato:
statement_type: 2indica uma tarifa.reference_type: 2indica que a referência é uma contestação.
Esses campos podem aparecer no mesmo lançamento. Um descreve a movimentação; o outro identifica a categoria do recurso relacionado. Veja Tipos de lançamento e Categorias de referência.
Um identificador também não é um estado. rf_ identifica um estorno, mas não
informa se ele foi concluído. Consulte o estado da solicitação para acompanhar
o resultado. Do mesmo modo, uma contestação encerrada não comprova que houve
devolução de dinheiro.
Quando o código não estiver no guia
Não atribua um significado apenas pelo número, prefixo ou semelhança com outro campo. Preserve o valor original e confira o recurso, o nome do campo e o ambiente da consulta. Um valor desconhecido não deve ser tratado automaticamente como sucesso, falha, pagamento confirmado ou autorização para repetir um pedido.
Consulte a referência do endpoint e a versão atual deste mapa. Se a dúvida continuar, informe ao suporte o campo e o identificador do recurso, sem enviar chaves de API, segredos de webhook ou outros dados de autenticação.
null indica ausência de um valor naquele campo. Ele não equivale a zero nem
comprova que uma transação nunca existiu. Campos como refund_id e dispute_id
ficam nulos quando não há um vínculo confirmado para apresentar.