API technical errors (Code and Message)

Errors returned in Code and Message

The Code and Message parameters appear in the response body when an HTTP error occurs, usually a 4xx. They detail the cause of the failure in the request or processing, allowing you to quickly identify the problem.

• Code: numeric code that identifies the error type;
• Message: text message describing the error.

Example

See below an example of a response body for a VerifyCard request when there's an error in MerchantId

[
  {
    "Code": 114,
    "Message": "The provided MerchantId is not in correct format"
  }
]

How to handle Code and Message errors?

• Fix the submitted data: check required fields, formats, and sizes;
• Check credentials: MerchantId and MerchantKey;
• Confirm the enabled services on the Cielo website, under the E-commerce tab;
• Confirm authorized IPs on the Cielo website;
• Check API Status for persistent 5xx errors.

Code and Message table

Code and Message show the same values as ProviderReturnCode and ProviderReturnMessage, but are returned in different situations:

• The ProviderReturnCode and ProviderReturnMessage values are returned in successful HTTP operations (200 or 201);
• The Code and Message values are returned in HTTP error operations (e.g., 400).

See the full table: