Consulta de contestações pendentes ou tratadas

post

https://apihml-internet.cielo.com.br/cielo-chargeback-sys-sandbox/chargeback/v1/{status}?page={page}&pageSize={pageSize}

Filtre contestações para visualizar ou tratar com base em diversos parâmetros, como período, número do EC, e outros.

Ambiente	Método	Endpoint
Sandbox	post	`https://apihml-internet.cielo.com.br/cielo-chargeback-sys-sandbox/chargeback/v1/{status}?page={page}&pageSize={pageSize}`
Produção	post	`https://api-internet.cielo.com.br/cielo-chargeback-sys-external/chargeback/v1/{status}?page={page}&pageSize={pageSize}`

❗️
Ao utilizar o campo "mainCustomer", é necessário também utilizar o "hierarchyType". Se utilizar o campo "establishmentNumber", não utilize os campos "mainCustomer" e "hierarchyType", pois serão desconsiderados.

Path Params

status

string

enum

required

Indica o status desejado, conforme domínios da tabela status.
Done = Tratada;
Pending = Pendente.

Allowed:

page

string

required

Número da página desejada, considerando que 0 é a primeira. Sempre iniciar a paginação pelo 0, exemplo page=0

pageSize

string

required

Tamanho de registros que retornam na página, considerando que o limite é 200

Query Params

orderBy

string

enum

Campo de ordenação da pesquisa

Allowed:

Order

string

enum

Forma de ordenação da pesquisa

Allowed:

Body Params

startNotificationPeriod

string

Data inicial da notificação. Formato yyyy-MM-dd

endNotificationPeriod

string

Data final da notificação. Formato yyyy-MM-dd

cardAssociationCode

integer

enum

Bandeira do cartão. Conteúdo somente numérico.
1 = Visa;
2 = Mastercard;
3 = American Express;
7 = Elo;
40 = Hipercard.

Allowed:

process

string

enum

Código do processo. Tamanho: 50.
1 = 1º Chargeback;
2 = Cobrança amigável;
3 = 2º Chargeback;
13 = Pré compliance;
15 = Arbitragem;
16 = Compliance.

Allowed:

reason

string

Id da razão do chargeback. Conteúdo: lista.

establishmentNumber

string

Número do estabelecimento comercial individual. Conteúdo: lista, numérico. Tamanho: 10.

mainCustomer

string

Número do estabelecimento comercial matriz. Conteúdo: lista, numérico.

hierarchyType

string

enum

Tipo de hierarquia. Tamanho: 1.
1 = Raiz de CNPJ;
2 = Matriz de pagamento
4 = Todos os tipos de hierarquia (fortemente recomendável para clientes integrados na API de Chargeback).

Allowed:

idcase

string

Id do case do chargeback. Tamanho: 20.

tid

string

Número TID. Tamanho: 40.

nsu

number

Número serial único. Tamanho: 9.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Requisição inválida

403Sem permissão

412Pré-condições inválidas

500Erro interno