Realizar nova cobrança

POST /v1/charges

cURL

ChargeCardExample

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"
    }
  }
}
'

201

ChargeCard

{
  "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 · header · required

X-Api-Key · string · header · required

Body

application/json

merchantId · string<uuid> · 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 · Cartão · object · required

Define o método de cobrança

Cartão

Pix

Boleto

NuPay

Drip

Voucher

Picpay

Apple Pay

Click to Pay

Show child attributes

paymentSource · Cartão tokenizado · object · required

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

Cartão tokenizado

Cartão one shot

Token

Cartão com Customer salvo

Pagamentos com dados de Customer

Cartão com tokenCvv

Apple Pay

Click to Pay

Show child attributes

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

description · string

Descrição da cobrança para consulta futura

customerId · string<uuid>

Identificador de comprador na Malga para consulta futura - Integração com a API de customer

fraudAnalysis · object

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

Show child attributes

splitRules · object[]

Parâmetros adicionais para transacionar com Split

Show child attributes

vendor · object

Parâmetros adicionais para transacionar com vendors

Show child attributes

paymentFlow · object

Campos adicionais para uso em condicionais dos fluxos inteligentes

Show child attributes

threeDSecure2 · object

Parâmetros adicionais para transacionar com 3D Secure 2

Show child attributes

appInfo · object

Informações sobre a rastreabilidade da cobrança

Show child attributes

Response

201

application/json

Created

id · string

Identificador da transação

clientId · string<uuid>

Identificador do cliente na Malga

merchantId · string<uuid>

Identificador do merchant id utilizado na transação

customerId · string<uuid>

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 · Cartão de crédito · object

Cartão de crédito

Pix

Boleto

NuPay

Drip

Voucher

ApplePay

Show child attributes

paymentSource · Cartão de crédito · object

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

Cartão de crédito

Cartão tokenizado

Customer

Wallet

Show child attributes

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

Show child attributes

paymentFlow · object

Campos adicionais para uso em condicionais dos fluxos inteligentes

Show child attributes

transactionRequests · object[]

Show child attributes

threeDSecure2 · object

Show child attributes

appInfo · object

Informações sobre a rastreabilidade da cobrança

Show child attributes

splitRules · object[]

Parâmetros adicionais para transacionar com Split

Show child attributes

platformFee · object

Detalhes da taxa de plataforma aplicada na cobrança quando há splitRules e o merchant tem platform fee habilitado. Ausente quando não há aplicação de platform fee.

Show child attributes