Listar Chargebacks

GET /chargebacks

Para utilizar esse método, o access_token deve conter o scope chargeback.read

Retorna todas as informações de chargebacks de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

limit

int

Sim

Qtd máxima de registros para trazer.

startAt

int

Sim

Ponteiro inicial para trazer os registros.

status

string

Não

Status do chargeback. Separe cada valor por vírgula.

Valor	Explicação
awaitingDocumentation	A disputa de chargeback está aguardando a documentação ser enviada.
lostDispute	A disputa de chargeback foi perdida.
winsDispute	disputa de chargeback foi ganha.
inAnalysis	A disputa de chargeback está em análise pelo Galax Pay.
canceledDispute	A disputa de chargeback foi cancelada.

process

string

Não

Número do processo do chargeback. Separe cada valor por vírgula.

chargeGalaxPayIds

string

Não

Charge.galaxPayId. Id da cobrança avulsa no Galax Pay. Separe cada id por vírgula.

chargeMyIds

string

Não

Charge.myId.
Id da cobrança avulsa no seu sistema.
Separe cada id por vírgula.

transactionGalaxPayIds

string

Não

Transaction.galaxPayId. Id da transação no Galax Pay. Separe cada id por vírgula.

transactionMyIds

string

Não

Transaction.myId. Id da transação no seu sistema. Separe cada id por vírgula.

createdAtFrom

date

Não

Data de criação inicial do Chargeback

createdAtTo

date

Não

Data de criação final do Chargeback

expiryDateFrom

date

Não

data inicial até o limite de envio de documentação.

expiryDateTo

date

Não

data final até o limite de envio de documentação.

sendDocumentFrom

date

Não

Data inicial que o documento foi enviado.

sendDocumentTo

date

Não

Data final que o documento foi enviado.

URL da Requisição

https://api.sandbox.cel.cash/v2/chargebacks

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Chargebacks": [
        {
            "galaxPayId": 47,
            "createdAt": "2023-11-21 15:33:55",
            "expire": "2023-11-25 00:00:00",
            "process": "4913850291284",
            "value": 300,
            "status": "inAnalysis",
            "description": "chargeback description",
            "DocumentsChargeback": {
                "createdAt": "2023-11-22 15:33:55"
            },
            "Transaction": {
                "galaxPayId": 475,
                "myId": "TRANSACTION-MYID-475"
            },
            "PaymentBill": {
                "galaxPayId": 216,
                "myId": "CHARGE-MYID-216"
            }
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int

Quantidade total de registros do retorno da busca na página atual.

Chargebacks

Array de chargebacks.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id Galax Pay do Chargeback

createdAt

datetime

Data de criação.

expire

date

data até o limite de envio de documentação.

process

string 17 caracteres

Número do processo do chargeback. Separe cada valor por vírgula.

value

int 255 dígitos

Valor do chargeback.

status

string 255 caracteres

Status do chargeback.

Valor

Explicação

awaitingDocumentation

A disputa de chargeback está aguardando a documentação ser enviada.

lostDispute

A disputa de chargeback foi perdida.

winsDispute

disputa de chargeback foi ganha.

inAnalysis

A disputa de chargeback está em análise pelo Galax Pay.

canceledDispute

A disputa de chargeback foi cancelada.

description

string 255 caracteres

Descrição do chargeback.

DocumentsChargeback

Objeto da documentação de chargeback.
Clique para ver os campos.

createdAt

datetime

Data de criação.

Transaction

Informação da transação.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Transaction.galaxPayId. Id da transação no Galax Pay.

myId

string 255 caracteres

Transaction.myId. Id da transação no seu sistema.

PaymentBill

Informação da cobrança avulsa.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Charge.galaxPayId. Id da cobrança avulsa no Galax Pay.

myId

string 255 caracteres

Charge.myId. Id da cobrança avulsa no seu sistema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.