Identifiers and prefixes | Raims Documentation

Learn which resource each identifier belongs to and distinguish IDs from credentials.

A prefix is the initial part of an identifier, before the rest of the code. It helps you recognize the resource. You need the full identifier to retrieve that record; the prefix alone does not identify a transaction.

Financial identifiers

Code or value	Meaning	How to interpret
`ch_`	Charge	Identifies a charge in API responses, links, and the Dashboard. Use the full value when retrieving the charge; it remains distinct from customer, payment link, and refund IDs.
`rf_`	Pix refund	Identifies a request to return a Pix payment. It can appear in refund history and the statement refund_id field; check the refund status to know whether the money has been returned.
`pl_`	Payment link	Identifies the payment link record. The checkout URL may use another token without a prefix; copy the returned URL instead of constructing it from this ID.
`cus_`	Customer	Identifies the customer registered by the company and linked to a charge. This is the value used in customer_id; it is not the CPF, CNPJ, or customer reference in your system.
`st_`	Statement entry	Identifies an individual statement entry. A single charge can generate several entries, each with its own ID, such as incoming funds, a fee, and a refund.
`dp_`	Dispute	Identifies a payment dispute and can appear in the dispute_id field or as a statement reference. Keep the ID you received; MED cases use a different format.
`wd_`	Withdrawal	Identifies a withdrawal in the Dashboard and API responses. It can appear in the statement reference_id field; use the full value to retrieve the withdrawal and track its result.
`wdst_`	Withdrawal destination	Identifies a verified Pix destination owned by the company, returned by the Production destination query. Use the full value to retrieve its masked details; it does not identify a withdrawal or change the default destination.
`adj_`	Financial adjustment	Identifies the adjustment related to a statement entry. Check the entry type and amount to distinguish a credit from a debit; the ID does not indicate the adjustment direction or define a separate public endpoint.
`med_`	MED case	Identifies a case under the Pix Mecanismo Especial de Devolução, with a decimal numeric suffix. It can appear as a dispute ID and in the statement dispute_id field; closing the case alone does not prove that money has been returned.

A MED case ID uses a decimal number after the prefix. Keep the format you received when retrieving a dispute.

The other IDs in this group use a case-sensitive combination of letters and numbers. Copy the full value as received, without removing zeros, changing letters, or converting the code to a number.

Account and Dashboard identifiers

These identifiers appear in account, key, and webhook settings, dispute files, and checkout image uploads. Copy the full value when you need to identify the resource. They do not replace authentication credentials.

Code or value	Meaning	How to interpret
`mk_`	API key record	Identifies the key managed in the Dashboard, including configuration and rotation actions. It is not the secret used in the Authorization header and does not authenticate a request.
`cau_`	Checkout image upload	Identifies an authorized logo or icon upload. After uploading the file, use the ID in the corresponding checkout customization field. The ID is not the image URL and does not prove that the image has been applied.
`co_`	Company	Identifies the business account in Dashboard information and activity records. Knowing this ID does not grant access to company data; the session or API key still defines the permitted access.
`whk_`	Webhook record	Identifies the destination configured in the Dashboard Webhooks area. It is different from the secret used to verify notification origin.
`emp_`	Team member	Identifies a person with account access through the team. It can appear in their record, invitations, and activities; their permissions are still defined by the access granted to them.
`df_`	Dispute file	Identifies a file linked to a dispute, such as an evidence document. Access to its contents depends on account permissions; the ID is not the download address.

Credentials and secrets

These prefixes identify authentication data rather than a resource record:

Code or value	Meaning	How to interpret
`sk_test_`	Sandbox API key	Prefix of the secret used to authenticate requests with test data. Send the full key in the Authorization header with the Bearer scheme and keep the secret protected in your application backend.
`sk_live_`	Production API key	Prefix of the secret used to authenticate requests in the environment for real transactions. The prefix does not prove that the key is valid: access, environment, and restrictions are checked on every request.

Code or value	Meaning	How to interpret
`whsec_`	Webhook secret	Prefix of the signing secret shown when managing a webhook. Protect the full value and follow the webhook validation guidance; it is not the record ID or an API Bearer key.

A key's mk_ ID does not authenticate requests. A webhook's whk_ ID does not let you verify a message signature. Use the appropriate credential or secret for these purposes, as described in Authentication and Webhooks.

Do not publish credentials, include them in URLs, or send them to support. Documentation examples abbreviate secrets; they are not valid credentials.

References without a prefix

In a statement, a manual reference may appear without a prefix. In that case, reference_type identifies its category. The absence of a prefix does not justify treating the value as a charge, refund, or dispute ID.

The token in a payment URL is also different from the link's pl_ ID. Keep the URL provided by Raims; do not construct a checkout URL by changing or adding prefixes.

How to use an identifier

A prefix does not indicate the company, environment, amount, or resource status. Sandbox and Production IDs use the same resource prefixes. Access depends on the credential and its association with the correct company and environment.

A st_ identifies an entry. Its reference_id, refund_id, and dispute_id fields, when populated, identify other related resources. Use the right field for each query; a charge and its entries do not have the same identifier.