Validações para geração

Só será possível gerar a carta de cancelamento quando o status type for igual a done. Ou seja, só será possível gerar a carta de cancelamento quando a solicitação estiver efetivada.

É possível solicitar a geração e carta por unidade ou lote.

A geração de carta pode ser gerada no idioma português ou inglês.

Não é possível gerar cartas em lote mesclados nos idiomas português e inglês.

Nas requisições de carta por lote, o limite é de 10 cartas por requisição.

Não é possível gerar um lote de cartas para ECs diferentes, na mesma requisição.

Solicitação de carta por unidade

Ambiente	Método	Endpoint
Homologação	POST	https://apihml-internet.cielo.com.br/refunds-api/v1/letter-api/pdf
Produção	POST	https://api-internet.cielo.com.br/cielo-refunds-exp-external/refunds/v1/letter-api/pdf

{
  "merchantId": 0,
  "cancellationId": 0,
  "language": "PT_BR"
}

No campo merchantId é necessário informar o número do estabelecimento (EC), do tipo number, este campo é obrigatório.

O Campo cancellationId é necessário informar o controlId, do tipo number, este campo é obrigatório.

O campo language é opcional, mantendo como default o idioma português, podendo também usar como o PT_BR para português ou EN_US para inglês.

Response em caso de erro

{
  "errorCode": 999,
  "errorMessage": "You don't have sufficient credentials to perform this operation",
  "date": "2012-04-23T18:25:43.511Z"
}

Solicitação de carta por lote

Ambiente	Método	Endpoint
Homologação	POST	https://apihml-internet.cielo.com.br/refunds-api/v1/letter-api/zip
Produção	POST	https://api-internet.cielo.com.br/cielo-refunds-exp-external/refunds/v1/letter-api/zip

{
  "merchantId": 0,
  "cancellations": [
    0,1,2,3
  ],
  "language": "PT_BR"
}

📘
Limite de itens por requisição
A API de cancelamento em lote aceita no máximo 10 itens por requisição. Requisições que excedam esse limite retornam uma mensagem de erro informando que o limite máximo foi excedido.

No campo merchantId é necessário informar o número do estabelecimento (EC), do tipo number, este campo é obrigatório.

O Campo cancellationId é necessário informar uma lista de controlId, separado por virgula (“,”), do tipo number, este campo é obrigatório.