GET
/
v1
/
sessions
/
{id}

Authorizations

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

Path Parameters

​
id
string
required

Identificação da sessão a ser recuperada

Response

201 - application/json
​
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
object[]

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

​
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

Was this page helpful?

Criar nova sessãoAtualizar o status de uma sessão