POST
/
v1
/
charges
curl --request POST \
  --url https://api.malga.io/v1/charges \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '{
  "appInfo": {
    "platform": {
      "integrator": "malga",
      "name": "pluging-vtex-ppp",
      "version": "1.12"
    },
    "device": {
      "name": "iOS",
      "version": "10.12"
    },
    "system": {
      "name": "VTEX",
      "version": "13.12"
    }
  },
  "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
  "amount": 150,
  "currency": "BRL",
  "statementDescriptor": "LOJA JOAO",
  "description": "Descrição longa da cobrança",
  "capture": false,
  "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
  "paymentMethod": {
    "paymentType": "credit",
    "installments": 1
  },
  "paymentSource": {
    "sourceType": "card",
    "card": {
      "cardNumber": "5261424250184574",
      "cardCvv": "321",
      "cardExpirationDate": "06/2028",
      "cardHolderName": "JOAO DA SILVA"
    }
  }
}'
{
  "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
  "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
  "createdAt": "2012-06-30 23:59:59 +0000",
  "amount": 150,
  "currency": "BRL",
  "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
  "statementDescriptor": "LOJA JOAO",
  "description": "Descrição longa da cobrança",
  "capture": false,
  "isDispute": false,
  "status": "pre_authorized",
  "paymentMethod": {
    "paymentType": "credit",
    "installments": 1
  },
  "paymentSource": {
    "sourceType": "card",
    "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
  },
  "transactionRequests": [
    {
      "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
      "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
      "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
      "providerType": "STRIPE",
      "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
      "amount": 1500,
      "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
      "requestStatus": "success",
      "requestType": "authorization",
      "responseTs": "2633ms",
      "createdAt": "2021-08-12T16:08:39.536Z",
      "updatedAt": "2021-08-12T16:08:42.212Z",
      "providerAuthorization": {
        "networkAuthorizationCode": "00",
        "networkResponseCode": ""
      }
    }
  ],
  "appInfo": {
    "platform": {
      "integrator": "malga",
      "name": "pluging-vtex-ppp",
      "version": "1.12"
    },
    "device": {
      "name": "iOS",
      "version": "10.12"
    },
    "system": {
      "name": "VTEX",
      "version": "13.12"
    }
  }
}

Authorizations

X-Client-Id
string
headerrequired
X-Api-Key
string
headerrequired

Body

application/json
merchantId
string
required

Identificação do merchant id a ser utilizado

amount
number
required

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

paymentMethod
object
required

Define o método de cobrança

paymentSource
object
required

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

currency
string
default: BRL

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

statementDescriptor
string

Descrição a ser exibida fatura do comprador

capture
boolean
default: false

Determina se a transação deve ser capturada automaticamente

orderId
string

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

providerReferenceKey
string

Identificador único da cobrança do lado do cliente utilizado para referenciar a cobrança do lado do adquirente/provedor. Caso não enviado a gestão dessa informação será feita pela Malga, que gera um uuid para cada requisição nova aos provedores.

description
string

Descrição da cobrança para consulta futura

customerId
string

Identificador de comprador para consulta futura

fraudAnalysis
object

Parâmetros adicionais para análise de fraude, necessários para processamento com provedores específicos

splitRules
object[]

Parâmetros adicionais para transacionar com Split

vendor
object

Parâmetros adicionais para transacionar com vendors

paymentFlow
object

Campos adicionais para uso em condicionais dos fluxos inteligentes

threeDSecure2
object

Parâmetros adicionais para transacionar com 3D Secure 2

appInfo
object

Informações sobre a rastreabilidade da cobrança

Response

201 - application/json
id
string

identificador da transação

clientId
string

identificador do cliente na Malga

merchantId
string

identificador do merchant id utilizado na transação

customerId
string

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

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

originalAmount
number

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

currency
string
default: BRL

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

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
enum<string>

status da transação na Malga

Available options:
pending,
pre_authorized,
authorized,
failed,
canceled,
voided,
charged_back,
refund_pending,
capture_pending
orderId
string

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

responsibleProviderType
string

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

paymentMethod
object
paymentSource
object

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

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

fraudAnalysisMetadata
object

Parâmetros adicionais para analise de fraude

paymentFlow
object

Campos adicionais para uso em condicionais dos fluxos inteligentes

transactionRequests
object[]
threeDSecure2
object
appInfo
object

Informações sobre a rastreabilidade da cobrança

Was this page helpful?

Listar cobrançasRecuperar detalhes de cobrança