Estornar cobrança aprovada

Authorizations

X-Client-Id

string

header

required

X-Api-Key

string

header

required

Path Parameters

string

required

id da cobrança que deseja estornar

Body

application/json

amount

number

valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00

delayToCompose

number

número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay.

splitRules

object[]

parâmetro que indica o valor a ser estornado e seu respectivo recebedor

Response

201 - application/json

amount

number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

appInfo

object

Informações sobre a rastreabilidade da cobrança

capture

boolean

determina se a transação deve ser capturada automaticamente

clientId

string

identificador do cliente na Malga

createdAt

string

Data de criação do cartão

currency

string

default:

BRL

Identificador da moeda para processamento da cobrança, formato ISO 4217.

customerId

string

identificador do customer id

description

string

Descrição da cobrança para consulta futura

fraudAnalysisMetadata

object

Parâmetros adicionais para analise de fraude

fraudAnalysisMetadata.cart

object

Detalhe do carrinho de produtos

fraudAnalysisMetadata.cart.items

object[]

fraudAnalysisMetadata.cart.items.categoryId

string

Categoria a qual o item/evento pertence

fraudAnalysisMetadata.cart.items.date

string

Definição de data, em caso de evento

fraudAnalysisMetadata.cart.items.description

string

Descrição do item/evento

fraudAnalysisMetadata.cart.items.genre

string

Definição do gênero, em caso de evento

fraudAnalysisMetadata.cart.items.locality

string

Definição de local, em caso de evento

fraudAnalysisMetadata.cart.items.location

object

Definição de endereço, em caso de evento

fraudAnalysisMetadata.cart.items.name

string

nome do item/evento

fraudAnalysisMetadata.cart.items.quantity

integer

quantidade de itens do pedido

fraudAnalysisMetadata.cart.items.risk

enum<string>

definição do indice de risco do item

Available options:

High,

Low

fraudAnalysisMetadata.cart.items.sku

string

identificador único do item na loja

fraudAnalysisMetadata.cart.items.tickets

object

Informações relacionadas aos ingressos, em caso de evento

fraudAnalysisMetadata.cart.items.type

number

Definição de tipo, em caso de evento

fraudAnalysisMetadata.cart.items.unitPrice

integer

valor unitário do item/evento em centavos

fraudAnalysisMetadata.customer

object

Dados do comprador

fraudAnalysisMetadata.sla

number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

string

identificador da transação

isDispute

boolean

determina se a transação está em disputa

merchantId

string

identificador do merchant id utilizado na transação

orderId

string

Identificador único da cobrança do lado do cliente para conciliação futura

originalAmount

number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

paymentFlow

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

paymentMethod

object

paymentSource

object

dados para cobrança por cartão de crédito salve

responsibleProviderType

string

Nome do provedor de pagamento responsável pela transação

statementDescriptor

string

descrição a ser exibida na fatura do comprador

status

enum<string>

status da transação na Malga

Available options:

pending,

pre_authorized,

authorized,

failed,

canceled,

voided,

charged_back,

refund_pending,

capture_pending

threeDSecure2

object

threeDSecure2.authData

object

Dados de autenticação do provedor

threeDSecure2.billingAddress

object

Endereço de cobrança

threeDSecure2.browser

object

Informações sobre o navegador do usuário

threeDSecure2.cardHolder

object

Endereço para envio

threeDSecure2.redirectURL

string

URL para redirecionamento de autenticação

threeDSecure2.requestorURL

string

URL de origem da requisição

threeDSecure2.requiresLiabilityShift

boolean

Indica a ocorrência de mudança de responsabilidade

threeDSecure2.setupId

string

Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga

threeDSecure2.shippingAddress

object

Endereço para envio

transactionRequests

object[]

transactionRequests.amount

number

valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação

transactionRequests.authorizationNsu

string

identificador único da transação retornado pelo provider

transactionRequests.createdAt

string

Data de criação do request feito ao provedor

transactionRequests.id

string

identificador único do request feito ao provedor

transactionRequests.idempotencyKey

string

chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor.

transactionRequests.providerAuthorization

object

dados adicionais do retorno da autorização do provider no processamento da transação

transactionRequests.providerError

object

detalhes do erro em caso de falha no processamento da transação

transactionRequests.providerId

string

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

transactionRequests.providerType

string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

transactionRequests.requestStatus

enum<string>

status do processamento da requisição no provider

Available options:

running,

failed,

success,

timeout,

internal_error,

processing

transactionRequests.requestType

enum<string>

identifica o tipo da requisição feita para o provider

Available options:

pending,

authorization,

pre_authorization,

void,

capture,

probe,

charge_back,

zero_dollar,

anti_fraud

transactionRequests.responseTs

string

tempo de duração do processamento da requisição no provider

transactionRequests.tokenizedPayment

boolean

identifica se a transação foi processada usando um token externo

transactionRequests.transactionId

string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

transactionRequests.updatedAt

string

Data de atualização do request feito ao provedor

updatedAt

string

Data de atualização do cartão