Para estornar cobrança no cartão, será necessário realizar uma chamada na api Estornar Cobrança no cartão utilizando o método PUT, onde na requisição é necessário informar o Identificador da Cobrança.

Modelo de requisição:

curl --location --request PUT 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/charges/{chargeId}/{typeId}/reverse' \
  --header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    
    "valueToReverse": 1000

}
'
📘

O campo valueToReverse é opcional. Caso não informado, será considerado o valor total da cobrança

Tabela descritiva dos campos

Campo

Descrição

Tipo

chargeId

Identificador da cobrança

typeId

Tipo do identificador. Valores possíveis para informar no campo:

  • *1. galaxPayId **- Identificador da Celcoin.
  • 2. myId -* Identificador único da empresa..

valueToReverse

Valora ser estornado

Modelo de retorno:


{
    "Charge": {
        "galaxPayId": 1,
        "myId": "pay-67f95fd1e9cfe8.93565161",
        "mainPaymentMethodId": "creditcard",
        "paymentLink": "https://app.celcoin.com.br/link-payment",
        "value": 12999,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "status": "active",
        "createdAt": "2020-06-02 10:10:00",
        "updatedAt": "2020-06-02 10:10:00",
        "Transactions": [
            {
                "galaxPayId": 1,
                "myId": "pay-67f95fd20b78c5.61798477",
                "value": 12999,
                "payday": "2025-04-11",
                "additionalInfo": "Lorem ipsum dolor sit amet.",
                "installment": 3,
                "statusDate": "2025-04-11 15:30:42",
                "datetimeLastSentToOperator": "2025-04-11 15:30:42",
                "status": "captured",
                "createdAt": "2020-06-02 10:10:00",
                "fee": 300,
                "statusDescription": "Capturada na Operadora",
                "tid": "pay-67f95fd22382c1.40673689",
                "authorizationCode": "pay-67f95fd224d531.00132717",
                "CreditCard": {
                    "Card": {
                        "myId": "pay-67f95fd2260c18.50206926",
                        "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,bin"
                        },
                        "expiresAt": "2025-04"
                    }
                }
            }
        ],
        "Customer": {
            "galaxPayId": 1,
            "myId": "pay-67f95fd2376ba3.41318868",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "65587323510",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "Address": {
                "zipCode": "30411330",
                "street": "Rua platina",
                "number": "1330",
                "complement": "2º andar",
                "neighborhood": "Prado",
                "city": "Belo Horizonte",
                "state": "MG"
            }
        },
        "PaymentMethodCreditCard": {
            "Card": {
                "galaxPayId": 1,
                "myId": "pay-67f95fd25851c3.42861518",
                "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": "bin,rede"
                },
                "expiresAt": "2025-04"
            }
        }
    }
}

Cancelar uma Cobrança Avulsa