POST
/
v1
/
sessions

Authorizations

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

Body

application/json
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.

amount
number
required

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.

isActive
boolean

Determina se a sessão está ativa

capture
boolean

Determina se a transação deve ser capturada automaticamente

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

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

paymentMethods
object[]
required

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

items
object[]
required

Itens do pedido

vendor
object

Parâmetros adicionais para transacionar com vendors

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?

Estornar cobrança aprovadaRecuperar detalhes de uma sessão