Response Format

Business responses typically use an envelope with status, msg, and data.

The response code status is of type int, with 200 as the success value (unquoted in the JSON examples); the success description msg is the Portuguese "sucesso". Business enums such as MED flow statuses and an order's orderStatus are different fields from the integer response codes; their types and values follow the corresponding endpoint definitions.

Business Status Fields in Transaction Query Responses

Cashin, refund, cashout, and exchange order queries use dataStatus and dataMsg inside data to indicate the business processing result, i.e. data.dataStatus and data.dataMsg. The outer status and msg still indicate the API response status and description.

Balance queries, MED-related endpoints, Pix Key queries, exchange-rate quotes, and payment voucher queries do not add dataStatus or dataMsg. Operational endpoints such as order creation, refund requests, registration, uploads, and submissions do not add these fields either; the original outer status and msg remain unchanged.

Field	Type	Description
data.dataStatus	int	Response code
data.dataMsg	string	Corresponds to dataStatus

dataStatus is of type int; dataStatus = 200 means the business processing is OK, in which case dataMsg = "SUCCESS"; any value other than 200 indicates a business error, with the reason in dataMsg. Judge by the integer status code, not by whether the field has a value; a missing, empty, or wrongly typed field must not be treated as business success. Business success does not mean the transaction is complete; transaction progress and final results still follow business status fields such as orderStatus.

Exact field definitions follow the synchronized Merchant API pages and schemas.