Pagar uma sessão

POST

sessions

{id}

charge

curl --request POST \
  --url https://api.malga.io/v1/sessions/{id}/charge \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '{
  "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",
  "merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
  "description": "Descrição longa da cobrança",
  "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
  "createdAt": "2012-06-30 23:59:59 +0000",
  "amount": 150,
  "originalAmount": 150,
  "currency": "BRL",
  "statementDescriptor": "LOJA JOAO",
  "status": "pending",
  "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": ""
      }
    }
  ]
}

Authorizations

X-Client-Id

string

header

required

X-Api-Key

string

header

required

Path Parameters

string

required

Identificação da sessão a ser paga

Body

application/json

paymentMethod

object

required

Define o método de cobrança

paymentSource

object

required

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

customerId

string

Identificador de comprador para consulta futura

fraudAnalysis

object

Parâmetros adicionais para análise de fraude. Alguns destes campos podem ser necessários para processar com provedores específicos.

fraudAnalysis.sla

number

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

fraudAnalysis.customer

object

Dados do comprador

fraudAnalysis.customer.name

string

nome do usuario

fraudAnalysis.customer.email

string

email do usuario

fraudAnalysis.customer.phone

string

telefone de contato do usuario

fraudAnalysis.customer.identityType

string

Tipo de documento, consultar tabela de tipos suportados

fraudAnalysis.customer.identity

string

Número do documento formato conforme tipo selecionado

fraudAnalysis.customer.registrationDate

string

Data de registro do cliente

fraudAnalysis.customer.deliveryAddress

object

Endereço de entrega

fraudAnalysis.customer.billingAddress

object

Endereço de cobrança

fraudAnalysis.customer.browser

object

Informações sobre o navegador do usuário

fraudAnalysis.cart

object

Detalhe do carrinho de produtos

fraudAnalysis.cart.items

object[]

fraudAnalysis.cart.items.name

string

nome do item/evento

fraudAnalysis.cart.items.quantity

integer

quantidade de itens do pedido

fraudAnalysis.cart.items.sku

string

identificador único do item na loja

fraudAnalysis.cart.items.unitPrice

integer

valor unitário do item/evento em centavos

fraudAnalysis.cart.items.risk

enum<string>

definição do indice de risco do item

Available options:

High,

Low

fraudAnalysis.cart.items.description

string

Descrição do item/evento

fraudAnalysis.cart.items.categoryId

string

Categoria a qual o item/evento pertence

fraudAnalysis.cart.items.locality

string

Definição de local, em caso de evento

fraudAnalysis.cart.items.date

string

Definição de data, em caso de evento

fraudAnalysis.cart.items.type

number

Definição de tipo, em caso de evento

fraudAnalysis.cart.items.genre

string

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

fraudAnalysis.cart.items.tickets

object

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

fraudAnalysis.cart.items.location

object

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

fraudAnalysis.device

object

Detalhes do aparelho do consumidor

fraudAnalysis.device.id

string

id do dispositivo

fraudAnalysis.device.sessionId

string

ID da sessão

fraudAnalysis.device.os

object

fraudAnalysis.device.model

string

modelo do aparelho

fraudAnalysis.device.ramCapacity

integer

capacidade da memória RAM do aparelho

fraudAnalysis.device.diskCapacity

integer

capacidade de armazenamento do aparelho

fraudAnalysis.device.freeDiskSpace

integer

quantidade de memória livre

fraudAnalysis.device.resolution

integer

resolução do aparelho

fraudAnalysis.device.vendors

object[]

fraudAnalysis.device.vendorAttributes

object

atributos do aparelho fornecidos pelo fornecedor

fraudAnalysis.airline

object

Detalhes da reserva de passagem aérea

fraudAnalysis.orderOrigin

enum<string>

Origem do pedido

Available options:

app,

web,

telesales,

social_network,

other

fraudAnalysis.operationalSystem

string

Tipo de sistema operacional do cliente

fraudAnalysis.marketplaceType

enum<string>

Tipo de mercado

Available options:

b2b,

b2c

fraudAnalysis.purchaseInformation

object

Informações sobre o canal de compra

Informações da rede social do comprador

fraudAnalysis.giftList

object

Lista de presentes

fraudAnalysis.hotels

object[]

Informações sobre reservas de hotéis

Response

201 - application/json

Created

string

Identificador da transação

clientId

string

Identificador do cliente na Malga

merchantId

string

Identificador do merchant id utilizado na transação

description

string

Descrição da cobrança para consulta futura

orderId

string

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

createdAt

string

Data de criação do cartão

amount

number

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

originalAmount

number

Valor original 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

status

enum<string>

Status da sessão

Available options:

created,

paid,

canceled,

voided

paymentMethod

object

paymentSource

object

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

transactionRequests

object[]

transactionRequests.id

string

identificador único do request feito ao provedor

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.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.authorizationNsu

string

identificador único da transação retornado pelo provider

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.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.tokenizedPayment

boolean

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

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.responseTs

string

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

transactionRequests.providerError

object

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

transactionRequests.providerAuthorization

object

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

transactionRequests.createdAt

string

Data de criação do request feito ao provedor

transactionRequests.updatedAt

string

Data de atualização do request feito ao provedor

Was this page helpful?

curl --request POST \
  --url https://api.malga.io/v1/sessions/{id}/charge \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '{
  "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",
  "merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
  "description": "Descrição longa da cobrança",
  "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
  "createdAt": "2012-06-30 23:59:59 +0000",
  "amount": 150,
  "originalAmount": 150,
  "currency": "BRL",
  "statementDescriptor": "LOJA JOAO",
  "status": "pending",
  "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": ""
      }
    }
  ]
}

Visão Geral

Client-token

Cards

Tokens

Charges

Sessions

Customers

Merchants

Vendors

Sellers

Flows

Webhooks

Reports

Settings

Pagar uma sessão

Authorizations

Path Parameters

Body

Response