POST
/
v1
/
charges
/
{id}
/
capture

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string
required

id da cobrança que deseja capturar

Body

application/json
amount
number

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

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

id
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
transactionRequests
object[]
updatedAt
string

Data de atualização do cartão

Was this page helpful?