Skip to main content
POST
/
v1
/
sessions
Criar nova sessão
curl --request POST \
  --url https://api.malga.io/v1/sessions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '{
  "amount": 100,
  "name": "Loja 1",
  "merchantId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
  "dueDate": "2022-10-25T09:28:45.000Z",
  "createLink": true,
  "paymentMethods": [
    {
      "paymentType": "pix",
      "expiresIn": 30
    }
  ],
  "items": [
    {
      "name": "Item 1",
      "description": "Item do carrinho",
      "unitPrice": 1000,
      "quantity": 1,
      "tangible": false
    }
  ]
}'
{
  "id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
  "name": "Nome da sessão",
  "status": "created",
  "isActive": true,
  "clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
  "orderId": null,
  "amount": 100,
  "currency": "BRL",
  "capture": true,
  "merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
  "dueDate": "2022-10-25T09:28:45.000Z",
  "description": "Promoção Black Friday",
  "statementDescriptor": "LOJA JOAO",
  "paymentMethods": [
    {
      "paymentType": "credit",
      "installments": 1
    }
  ],
  "items": [
    {
      "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
      "name": "Item 1",
      "description": "Descrição do item",
      "unitPrice": 10000,
      "quantity": 1,
      "tangible": false
    }
  ],
  "createdAt": "2022-10-25T09:28:45.000Z",
  "updatedAt": "2022-10-25T09:28:45.000Z",
  "publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1"
}

Authorizations

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

Body

application/json
​
amount
number
required

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

​
merchantId
string
required

Identificação do merchant id a ser utilizado

​
dueDate
string
required

Data de expiração de uma sessão

​
name
string
required

Nome que identifica a sessão

​
paymentMethods
(Cartão de crédito · object | Pix · object | Boleto · object | Drip · object | NuPay · object)[]
required

Métodos de pagamento disponíveis na sessão

  • Cartão de crédito
  • Pix
  • Boleto
  • Drip
  • NuPay
​
items
object[]
required

Itens do pedido

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

​
currency
string
default:BRL

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

​
isActive
boolean

Determina se a sessão está ativa

​
capture
boolean

Determina se a transação deve ser capturada automaticamente

​
description
string

Descrição da sessão

​
statementDescriptor
string

Descrição a ser exibida fatura do comprador

​
createLink
boolean

Determina se a sessão terá um Link de Pagamento

​
vendor
object

Parâmetros adicionais para transacionar com vendors

Response

201 - application/json

Created

​
id
string

Identificação da sessão

​
name
string

Nome que identifica a sessão

​
status
enum<string>

Status da sessão

Available options:
created,
paid,
canceled,
voided
​
isActive
boolean

Determina se a sessão está ativa

​
clientId
string

Identificador do cliente na Malga

​
orderId
string

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

​
amount
number

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

​
currency
string

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

​
capture
boolean

Determina se a transação deve ser capturada automaticamente

​
merchantId
string

Identificação do merchant id a ser utilizado

​
dueDate
string

Data de expiração de uma sessão

​
description
string

Descrição da sessão

​
statementDescriptor
string

Descrição a ser exibida fatura do comprador

​
items
object[]

Itens do pedido

​
paymentLink
string

Link para acessar o Link de Pagamento desta sessão

​
paymentMethods
(Cartão de crédito · object | Pix · object | Boleto · object | Drip · object | NuPay · object)[]

Métodos de pagamento disponíveis na sessão

  • Cartão de crédito
  • Pix
  • Boleto
  • Drip
  • NuPay
​
createdAt
string

Data de criação da sessão

​
updatedAt
string

Data da atualização da sessão

​
publicKey
string

Chave de acesso com escopo restrito, usada para pagar a sessão

⌘I