curl --request POST \
--url https://api.malga.io/v1/subacquirer/{transactionId}/receipts \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"type": "cancellation_letter"
}
'{
"type": "refund_receipt",
"url": "https://files.malga.io/receipts/comprovante-estorno-c26aeb9c-f20b-4b33-8144-924d9dec1056.pdf"
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}Gerar documento comprobatório de estorno
Gera o documento que comprova o estorno de uma cobrança e devolve a URL de download do arquivo.
Disponível apenas para transações processadas pelo provedor Malga.
curl --request POST \
--url https://api.malga.io/v1/subacquirer/{transactionId}/receipts \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"type": "cancellation_letter"
}
'{
"type": "refund_receipt",
"url": "https://files.malga.io/receipts/comprovante-estorno-c26aeb9c-f20b-4b33-8144-924d9dec1056.pdf"
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}{
"error": {
"type": "api_error",
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}Path Parameters
Identificador da cobrança estornada.
Body
Documento solicitado. O documento concreto é resolvido pelo type informado e pelo método de pagamento da cobrança:
type | Método de pagamento | Documento |
|---|---|---|
cancellation_letter | Cartão de crédito | Carta de cancelamento |
cancellation_letter | Pix | Não existe, retorna 422 |
refund_receipt | Cartão de crédito | Comprovante de estorno |
refund_receipt | Pix | Comprovante de devolução |
cancellation_letter, refund_receipt "refund_receipt"
Response
Documento gerado com sucesso
Documento gerado, o mesmo informado na requisição.
A carta de cancelamento é emitida por evento de estorno. Quando a cobrança tem mais de um estorno confirmado, a URL aponta para um arquivo .zip com uma carta por evento. O comprovante é sempre um arquivo único, com o consolidado de todos os estornos confirmados até o momento da chamada.
cancellation_letter, refund_receipt "refund_receipt"
URL temporária para download do arquivo. Aponta para um .zip quando a chamada gera mais de uma carta de cancelamento.
Was this page helpful?