Estornar cobrança no cartão

PUT /transactions/{transactionId}/{typeId}/reverse

Para utilizar esse método, o access_token deve conter o scope transactions.write

Método utilizado para realizar o estorno da transação de uma assinatura/contrato.

Parâmetros da URL:

{transactionId}: Id da transação.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

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

reverse

URL da Requisição

https://api.sandbox.cel.cash/v2/transactions/1/myId/reverse

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "Transaction": {
        "myId": "pay-664ae2583b0128.50367270",
        "galaxPayId": 1,
        "subscriptionMyId": "2A",
        "subscriptionGalaxPayId": 1,
        "value": 12990,
        "payday": "2024-05-20",
        "payedOutsideGalaxPay": false,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "statusDate": "2024-05-20 02:40:40",
        "status": "captured",
        "fee": 300,
        "datetimeLastSentToOperator": "2024-05-20 02:40:40",
        "createdAt": "2020-06-02 10:10:00",
        "statusDescription": "Capturada na Operadora",
        "tid": "pay-664ae2584e1268.21808443",
        "authorizationCode": "pay-664ae2584f21d6.44013713",
        "CreditCard": {
            "Card": {
                "myId": "pay-664ae2585028e2.19325766",
                "galaxPayId": 1,
                "number": "5451*********1515",
                "createdAt": "2020-06-02 10:10:00",
                "updatedAt": "2020-06-02 10:10:00",
                "Brand": {
                    "id": "mastercard",
                    "name": "MasterCard",
                    "maxInstallment": 12,
                    "operatorIds": "pagseguro,rede"
                },
                "expiresAt": "2024-05"
            }
        }
    },
    "PaymentMethodCreditCard": {
        "Card": {
            "galaxPayId": 1,
            "myId": "pay-664ae2585c3de8.14597678",
            "number": "5451*********1515",
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "expiresAt": "2024-05"
        }
    }
}

Nome

Tipo

Explicação

Transaction

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

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

subscriptionMyId

string 255 caracteres

Subscription.myId.
Id da assinatura referente no seu sistema.

subscriptionGalaxPayId

int 11 dígitos

Subscription.galaxPayId.
Id da assinatura no cel_cash.

value

int 11 dígitos

Valor estornado.

payday

date

Data de vencimento do pagamento.

payedOutsideGalaxPay

bool

Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.

additionalInfo

text

Texto para informações adicionais sobre a transação. Essa informação é exibida no boleto ao cliente.

statusDate

datetime

Data do status

status

string 30 caracteres

Status da transaçao.

Valor

Explicação

Opções válidas para cartão de crédito:

notSend

Ainda não enviada para operadora de Cartão

authorized

Autorizado

captured

Capturada na Operadora de Cartão

denied

Negada na Operadora de Cartão

reversed

Estornada na Operadora de Cartão

chargeback

Estorno por chargeback

Opções válidas para boleto Bancário:

pendingBoleto

Boleto em aberto

payedBoleto

Boleto compensado

notCompensated

Boleto baixado por decurso de prazo

lessValueBoleto

Pago valor menor que o original

moreValueBoleto

Pago valor maior que o original

paidDuplicityBoleto

Pago em duplicidade

Opções válidas para Pix:

pendingPix

Pix em aberto

payedPix

Pix pago

unavailablePix

Pix indisponível para pagamento

Opções válidas para qualquer forma de pagamento:

cancel

Cancelada manualmente

payExternal

Paga fora do sistema

cancelByContract

Cancelada ao cancelar a cobrança

free

Isento

fee

int 30 dígitos

Taxa paga. Valor em centavos, sendo as duas últimas casas decimais.

datetimeLastSentToOperator

datetime

Data de último envio para a operadora

createdAt

datetime

Data de criação.

statusDescription

string 255 caracteres

Mais informações sobre o status da transação.

tid

string 255 caracteres

TID: Identificador da transação na operadora.

authorizationCode

string 255 caracteres

Código de autorização da transação na operadora.

CreditCard

Dados do cartão de crédito da transação.
Clique para ver os campos.

Card

Cartão.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.

galaxPayId

int 11 dígitos

Id no cel_cash

number

string 30 caracteres

Número truncado do cartão.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

PaymentMethodCreditCard

Configurações do meio de pagamento de cartão.
Clique para ver os campos.

Card

Cartão
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

number

string 30 caracteres

Número do cartão truncado.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Transação não encontrada.