API Reference

Standard HTTP error codes are used to indicate the processing status of the API request. A code of 200 indicates a successful response. Additionally, the result and result_description fields communicate the application-level outcome of the transaction.




Error codes and messages are provided to the Merchant in the following format:

{
  "error":"error message",
  "code":"XXXX"
}



The currently supported languages for error messages are Brazilian Portuguese (pt-BR) and English United States (en-US), with the base language set as en-US. To receive error messages in another language, include the desired language in the HTTP request header 'Accept-Language'. Please note that specifying the language in the request header is optional.

Note: All error responses will be returned as plain JSON data, without JWT encoding.