Types and identifiers
Find the meaning of the identifiers, types, and statuses used by Raims.
Use this map to understand a value returned by the API or an identifier shown in the Dashboard. Each page explains what the value represents, where it appears, and what you can conclude from it.
How to find the meaning
| What you found | Where to look |
|---|---|
An ID such as st_, ch_, wd_, or med_ | Identifiers and prefixes |
statement_type, reference_type, or a payment method | Financial types |
| A charge or refund status, dispute stage or reason | Statuses and results |
| Sandbox, Production, or an API key | Authentication and API keys |
A request error such as INVALID_FIELDS | HTTP response codes |
| An event name or team member permission | Webhooks and Users and permissions |
For pix_status, see Receive Pix details during creation.
Reasons that prevent a refund are described in
Check the refundable amount.
Retrieving links
explains their availability for payment. For tax_id and tax_id_type, see
CPF and CNPJ validation.
Response codes help you interpret the resource you retrieved. Each endpoint's parameters explain which values can be sent in a request. For example, recognizing a payment method in a response does not mean you can select it when creating a charge.
The same value in different fields
The meaning depends on the field name and the resource retrieved. In a statement:
statement_type: 2indicates a fee.reference_type: 2indicates that the reference is a dispute.
These fields can appear in the same entry. One describes the movement; the other identifies the category of the related resource. See Statement entry types and Reference categories.
An identifier is not a status either. rf_ identifies a refund but does not
tell you whether it has been completed. Check the request status to track the
result. Similarly, a closed dispute does not prove that money was returned.
When a code is not in the guide
Do not assign meaning based only on a number, prefix, or similarity to another field. Keep the original value and check the resource, field name, and query environment. An unknown value should not automatically be treated as success, failure, confirmed payment, or permission to repeat a request.
Check the endpoint reference and the current version of this map. If you still have questions, give support the field name and resource identifier without sending API keys, webhook secrets, or other authentication data.
null indicates the absence of a value in that field. It does not equal zero
or prove that a transaction never existed. Fields such as refund_id and
dispute_id are null when there is no confirmed association to show.