Criar nova sessão

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

dueDate

string

required

Data de expiração de uma sessão

items

object[]

required

Itens do pedido

merchantId

string

required

Identificação do merchant id a ser utilizado

name

string

required

Nome que identifica a sessão

paymentMethods

object[]

required

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

capture

boolean

Determina se a transação deve ser capturada automaticamente

createLink

boolean

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

currency

string

default:

BRL

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

description

string

Descrição da sessão

isActive

boolean

Determina se a sessão está ativa

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.

statementDescriptor

string

Descrição a ser exibida fatura do comprador

vendor

object

Parâmetros adicionais para transacionar com vendors

Response

201 - application/json

amount

number

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

capture

boolean

Determina se a transação deve ser capturada automaticamente

clientId

string

Identificador do cliente na Malga

createdAt

string

Data de criação da sessão

currency

string

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

description

string

Descrição da sessão

dueDate

string

Data de expiração de uma sessão

string

Identificação da sessão

isActive

boolean

Determina se a sessão está ativa

items

object[]

Itens do pedido

merchantId

string

Identificação do merchant id a ser utilizado

name

string

Nome que identifica a sessão

orderId

string

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

paymentLink

string

Link para acessar o Link de Pagamento desta sessão

paymentMethods

object[]

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

publicKey

string

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

statementDescriptor

string

Descrição a ser exibida fatura do comprador

status

enum<string>

Status da sessão

Available options:

created,

paid,

canceled,

voided

updatedAt

string

Data da atualização da sessão