Erros da API

A API E-commerce Cielo pode ter dois tipos principais de códigos retornados nas operações, os códigos de motivo da resposta (ReasonCode) e os códigos de retorno padrão (ReturnCode).

Códigos de motivo da resposta

São apresentados nos campos ReasonCode e ReasonMessage, e indicam se a operação desejada foi bem sucedida ou não, informando o motivo.

O ReasonCode e ReasonMessage estão mais associados aos fluxos operacionais internos da Cielo e/ou entre a Cielo e a bandeira/emissor que ocorrem depois que a API E-commerce recebe a requisição (status HTTP 200 ou 201).

O ReasonCode indica o código, enquanto o ReasonMessage traz a descrição correspondente ao código. As principais operações que retornam ReasonCode e ReasonMessage são:

Captura;
Cancelamento;
Conversão de moedas;
Criação de pagamento com boleto.

Confira a tabela completa de ReasonCode e ReasonMessage.

Códigos de retorno padrão

Para as operações que envolvem a criação de uma transação de qualquer meio de pagamento, o código de resposta mais comum é o ReturnCode, que vem acompanhado da sua mensagem explicativa em ReturnMessage.

[
  {
    "ReturnCode": 126,
    "ReturnMessage": "Credit Card Expiration Date is invalid"
  }
]

Além disso, os retornos da Abecs (Associação Brasileira das Empresas de Cartões de Crédito e Serviços) também são apresentados em ReturnCode e ReturnMessage, e são essenciais para determinar se uma transação é elegível à retentativa.

o ReturnCode e ReturnMessage podem retornar também nas operações de captura, cancelamento, conversão de moedas e boleto.

Confira a tabela completa de ReturnCode e ReturnMessage.

Confira a tabela da Abecs.

Outros códigos

Em alguns casos, a API pode retornar o código ProviderReturnCode (e sua mensagem correspondente em ProviderReturnMessage). Esse retorno pode ser observado, por exemplo, nas transações de cartão de crédito com o conversor de moedas. Apesar da nomenclatura, os valores costumam ser equivalentes aos códigos do ReturnCode e ReturnMessage.

ℹ️
Importante
Os códigos retornados são dinâmicos e dependem do fluxo percorrido por cada solicitação.

Tabela de Erros da API

Códigos retornados em caso de erro, identificando o motivo do erro e suas respectivas mensagens.

ReturnCode	ReturnMessage	Descrição
00	Internal error	Dado enviado excede o tamanho do campo
100	RequestId is required	Campo enviado está vazio ou inválido
101	MerchantId is required	Campo enviado está vazio ou inválido
102	Payment Type is required	Campo enviado está vazio ou inválido
103	Payment Type can only contain letters	Caracteres especiais não permitidos
104	Customer Identity is required	Campo enviado está vazio ou inválido
105	Customer Name is required	Campo enviado está vazio ou inválido
106	Transaction ID is required	Campo enviado está vazio ou inválido
107	OrderId is invalid or does not exists	Campo enviado excede o tamanho ou contem caracteres especiais
108	Amount must be greater or equal to zero	Valor da transação deve ser maior que "0"
109	Payment Currency is required	Campo enviado está vazio ou inválido
110	Invalid Payment Currency	Campo enviado está vazio ou inválido
111	Payment Country is required	Campo enviado está vazio ou inválido
112	Invalid Payment Country	Campo enviado está vazio ou inválido
113	Invalid Payment Code	Campo enviado está vazio ou inválido
114	The provided MerchantId is not in correct format	O MerchantId enviado não é um GUID
115	The provided MerchantId was not found	O MerchantID não existe ou pertence a outro ambiente (EX: Sandbox)
116	The provided MerchantId is blocked	Loja bloqueada, entre em contato com o suporte Cielo
117	Credit Card Holder is required	Campo enviado está vazio ou inválido
118	Credit Card Number is required	Campo enviado está vazio ou inválido
119	At least one Payment is required	Nó "Payment" não enviado
120	Request IP not allowed. Check your IP White List	IP bloqueado por questões de segurança
121	Customer is required	Nó "Customer" não enviado
122	MerchantOrderId is required	Campo enviado está vazio ou inválido
123	Installments must be greater or equal to one	Numero de parcelas deve ser superior a 1
124	Credit Card is Required	Campo enviado está vazio ou inválido
125	Credit Card Expiration Date is required	Campo enviado está vazio ou inválido
126	Credit Card Expiration Date is invalid	Campo enviado está vazio ou inválido
127	You must provide CreditCard Number	Numero do cartão de crédito é obrigatório
128	Card Number length exceeded	Numero do cartão superiro a 16 digitos
129	Affiliation not found	Meio de pagamento não vinculado a loja ou Provider inválido
130	Could not get Credit Card	Pode significar que não foi possível encontrar um cartão pelo cardtoken enviado ou que houve uma interrupção na consulta.
131	MerchantKey is required	Campo enviado está vazio ou inválido
132	MerchantKey is invalid	O Merchantkey enviado não é um válido
133	Provider is not supported for this Payment Type	Provider enviado não existe
134	FingerPrint length exceeded	Dado enviado excede o tamanho do campo
135	MerchantDefinedFieldValue length exceeded	Dado enviado excede o tamanho do campo
136	ItemDataName length exceeded	Dado enviado excede o tamanho do campo
137	ItemDataSKU length exceeded	Dado enviado excede o tamanho do campo
138	PassengerDataName length exceeded	Dado enviado excede o tamanho do campo
139	PassengerDataStatus length exceeded	Dado enviado excede o tamanho do campo
140	PassengerDataEmail length exceeded	Dado enviado excede o tamanho do campo
141	PassengerDataPhone length exceeded	Dado enviado excede o tamanho do campo
142	TravelDataRoute length exceeded	Dado enviado excede o tamanho do campo
143	TravelDataJourneyType length exceeded	Dado enviado excede o tamanho do campo
144	TravelLegDataDestination length exceeded	Dado enviado excede o tamanho do campo
145	TravelLegDataOrigin length exceeded	Dado enviado excede o tamanho do campo
146	SecurityCode length exceeded	Dado enviado excede o tamanho do campo
147	Address Street length exceeded	Dado enviado excede o tamanho do campo
148	Address Number length exceeded	Dado enviado excede o tamanho do campo
149	Address Complement length exceeded	Dado enviado excede o tamanho do campo
150	Address ZipCode length exceeded	Dado enviado excede o tamanho do campo
151	Address City length exceeded	Dado enviado excede o tamanho do campo
152	Address State length exceeded	Dado enviado excede o tamanho do campo
153	Address Country length exceeded	Dado enviado excede o tamanho do campo
154	Address District length exceeded	Dado enviado excede o tamanho do campo
155	Customer Name length exceeded	Dado enviado excede o tamanho do campo
156	Customer Identity length exceeded	Dado enviado excede o tamanho do campo
157	Customer IdentityType length exceeded	Dado enviado excede o tamanho do campo
158	Customer Email length exceeded	Dado enviado excede o tamanho do campo
159	ExtraData Name length exceeded	Dado enviado excede o tamanho do campo
160	ExtraData Value length exceeded	Dado enviado excede o tamanho do campo
161	Boleto Instructions length exceeded	Dado enviado excede o tamanho do campo
162	Boleto Demostrative length exceeded	Dado enviado excede o tamanho do campo
163	Return Url is required	URL de retorno não é valida - Não é aceito paginação ou extenções (EX .PHP) na URL de retorno
166	AuthorizeNow is required
167	Antifraud not configured	Antifraude não vinculado ao cadastro do lojista
168	Recurrent Payment not found	Recorrência não encontrada
169	Recurrent Payment is not active	Recorrência não está ativa. Execução paralizada
170	Cartão Protegido not configured	Token não vinculado ao cadastro do lojista
171	Affiliation data not sent	Falha no processamento do pedido - Entre em contato com o suporte Cielo
172	Credential Code is required	Falha na validação das credenciadas enviadas
173	Payment method is not enabled	Meio de pagamento não vinculado ao cadastro do lojista
174	Card Number is required	Campo enviado está vazio ou inválido
175	EAN is required	Campo enviado está vazio ou inválido
176	Payment Currency is not supported	Campo enviado está vazio ou inválido
177	Card Number is invalid	Campo enviado está vazio ou inválido
178	EAN is invalid	Campo enviado está vazio ou inválido
179	The max number of installments allowed for recurring payment is 1	Campo enviado está vazio ou inválido
180	The provided Card PaymentToken was not found	Token não encontrado
181	The MerchantIdJustClick is not configured	Token bloqueado
182	Brand is required	Bandeira do cartão não enviado
183	Invalid customer bithdate	Data de nascimento inválida ou futura
184	Request could not be empty	Falha no formado da requisição. Verifique o código enviado
185	Brand is not supported by selected provider	Bandeira não suportada pela API Cielo
186	The selected provider does not support the options provided (Capture, Authenticate, Recurrent or Installments)	Meio de pagamento não suporta o comando enviado
187	ExtraData Collection contains one or more duplicated names
188	Avs with CPF invalid
189	Avs with length of street exceeded
190	Avs with length of number exceeded
191	Avs with length of district exceeded
192	Avs with zip code invalid
193	Split Amount must be greater than zero	O valor para a realização de Split deve ser maior que 0
194	Split Establishment is Required	Campo enviado está vazio ou inválido
195	The PlataformId is required	Campo enviado está vazio ou inválido
196	DeliveryAddress is required	Campo enviado está vazio ou inválido
197	Street is required	Campo enviado está vazio ou inválido
198	Number is required	Campo enviado está vazio ou inválido
199	ZipCode is required	Campo enviado está vazio ou inválido
200	City is required	Campo enviado está vazio ou inválido
201	State is required	Campo enviado está vazio ou inválido
202	District is required	Campo enviado está vazio ou inválido
203	Cart item Name is required	Campo enviado está vazio ou inválido
204	Cart item Quantity is required	Campo enviado está vazio ou inválido
205	Cart item type is required	Campo enviado está vazio ou inválido
206	Cart item name length exceeded	Os dados enviados excedem o tamanho do campo
207	Cart item description length exceeded	Os dados enviados excedem o tamanho do campo
208	Cart item sku length exceeded	Os dados enviados excedem o tamanho do campo
209	Shipping addressee sku length exceeded	Os dados enviados excedem o tamanho do campo
210	Shipping data cannot be null	Campo obrigatório não enviado
211	WalletKey is invalid	Dados inválidos do Visa Checkout
212	Merchant Wallet Configuration not found	A Wallet utilizada não está habilitada, entre em contato com o suporte Cielo para habilitar
213	Credit Card Number is invalid	O cartão de crédito enviado é inválido
214	Credit Card Holder Must Have Only Letters	Não deve conter caracteres especiais
215	Agency is required in Boleto Credential	Campo obrigatório não enviado
216	Customer IP address is invalid	IP bloqueado por motivos de segurança
228	Customer Anddress Country is required	Campo enviado está vazio ou inválido.
300	MerchantId was not found
301	Request IP is not allowed	O serviço de restrição de IP pode estar habilitado e o IP informado não está configurado. Entre em contato com o suporte para habilitar o IP
302	Sent MerchantOrderId is duplicated
303	Sent OrderId does not exist
304	Customer Identity is required	Campo enviado está vazio ou inválido
306	Merchant is blocked	Merchant está bloqueado
307	Transaction not found	Transação não encontrada ou não existe no ambiente
308	Transaction not available to capture	Transação não pode ser capturada - Recomendamos consultar o status da transação via API. A captura só pode ser realizada se o status da transação for 1. Cada transação pode ser capturada apenas uma vez, mesmo em casos de captura parcial. Para saber mais, entre em contato com o suporte da Cielo.
309	Transaction not available to void	Transação não pode ser cancelada - Entre em contato com o suporte da Cielo
310	Payment method doest not support this operation	Comando enviado não suportado por meios de pagamento
311	Refund is not enabled for this merchant	Cancelamento após 24 horas não é liberado para o comerciante
312	Transaction not available to refund	A transação não permite cancelamento após 24 horas
313	Recurrent Payment not found	Recorrência não está habilitada, entre em contato com o suporte Cielo para habilitar
314	Invalid Integration
315	Cannot change NextRecurrency with pending payment
316	Cannot set NextRecurrency to past date	Não é permitido alterar a data de recorrência para uma data passada
317	Invalid Recurrency Day
318	No transaction found
319	Smart recurrency is not enabled	Recorrência não vinculada ao cadastro do comerciante
320	Can not Update Affiliation Because this Recurrency not Affiliation saved
321	Can not set EndDate to before next recurrency
322	Zero Dollar Auth is not enabled	O Zero Auth não está habilitado, entre em contato com o suporte Cielo para habilitar
323	Bin Query is not enabled	A Consulta Bin não está habilitada, entre em contato com o suporte Cielo para habilitar

Tabela de Motivo de Retorno

Reason Code	Reason Message
00	Successful
01	AffiliationNotFound
02	IssuficientFunds
03	CouldNotGetCreditCard
04	ConnectionWithAcquirerFailed
05	InvalidTransactionType
06	InvalidPaymentPlan
07	Denied
08	Scheduled
09	Waiting
10	Authenticated
11	NotAuthenticated
12	ProblemsWithCreditCard
13	CardCanceled
14	BlockedCreditCard
15	CardExpired
16	AbortedByFraud
17	CouldNotAntifraud
18	TryAgain
19	InvalidAmount
20	ProblemsWithIssuer
21	InvalidCardNumber
22	TimeOut
23	CartaoProtegidoIsNotEnabled
24	PaymentMethodIsNotEnabled
25	CouldNotFindPaymentToken
26	MerchantIdJustClickNotFound
27	BrandNotSupported
28	CardOptionsNotSupported
29	WalletKeyIsInvalid
30	MerchantWalletConfigurationNotFound
31	BoletoRequiredDataNotSupported
32	ConnectionWithAntifraudFailed
33	AbortedByCardVerification
34	ProblemsWithAcquirer
35	ValidationError
36	AcquirerTransactionNotFound
37	SplitTransactionalError
38	MerchantSplitConfigurationNotFound
39	SplitSoftDescriptorIsRequired
40	SplitFraudAnalysisIsRequired
41	SplitAntifraudMerchantConfigurationNotFound
42	ProviderNotFound
43	PaymentSettingsNotFound
44	SubAcquirerMerchantConfigurationNotFound
45	AbortedBySubAcquirer
98	InvalidRequest
99	InternalError
100	CieloPayCardHolderIsNotActive
101	CieloPayStrongValidationIsInvalid
102	CieloPayExpireDateDoesNotMatch
103	CieloPayCardHolderApiError
104	SplitPaymentFacilitatorDataNotFound