curl --request GET \
--url https://api.malga.io/v1/sessions/{id}/link \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};
fetch('https://api.malga.io/v1/sessions/{id}/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.malga.io/v1/sessions/{id}/link"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Client-Id", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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",
"multiplePayments": {
"allow": true,
"maxPayments": 5,
"paymentCount": 1,
"pendingCount": 0,
"status": "active"
},
"settings": {
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"email": "company@email.com",
"phone": "5551996225566",
"statementDescription": "LOJA JOAO",
"logo": "https://logo.com/images/logo.png",
"mainColor": "#fff000",
"secondaryColor": "#fff000",
"attentionColor": "#333333",
"errorColor": "#ff0000",
"successColor": "#00FF00",
"backgroundColor": "#fff000",
"companyName": "Company Name",
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"documentNumber": "011001001001000010",
"language": "pt_BR"
}
}Recupera sessão com os dados das configurações da empresa
Retorna a sessão completa junto das configurações da empresa usadas no Link de Pagamento. Também inclui multiplePayments para indicar a disponibilidade agregada do link em sessões 1:1 e 1:N.
curl --request GET \
--url https://api.malga.io/v1/sessions/{id}/link \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};
fetch('https://api.malga.io/v1/sessions/{id}/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.malga.io/v1/sessions/{id}/link"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Client-Id", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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",
"multiplePayments": {
"allow": true,
"maxPayments": 5,
"paymentCount": 1,
"pendingCount": 0,
"status": "active"
},
"settings": {
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"email": "company@email.com",
"phone": "5551996225566",
"statementDescription": "LOJA JOAO",
"logo": "https://logo.com/images/logo.png",
"mainColor": "#fff000",
"secondaryColor": "#fff000",
"attentionColor": "#333333",
"errorColor": "#ff0000",
"successColor": "#00FF00",
"backgroundColor": "#fff000",
"companyName": "Company Name",
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"documentNumber": "011001001001000010",
"language": "pt_BR"
}
}Path Parameters
Identificação da sessão a ser recuperada
Response
Created
Identificação da sessão a ser utilizada
Nome que identifica a sessão
Status da sessão
created, paid, canceled, voided Determina se a sessão está ativa
Identificador do cliente na Malga
Identificador único da cobrança do lado do cliente para conciliação futura
Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Identificador da moeda para processamento da cobrança, formato ISO 4217.
Determina se a transação deve ser capturada automaticamente
Identificação do merchant id a ser utilizado
Data limite da sessão, em ISO 8601. Pode estar ausente quando a sessão foi criada sem data de vencimento.
Descrição da sessão
Descrição a ser exibida fatura do comprador
Itens do pedido
Show child attributes
Show child attributes
Link para acessar o Link de Pagamento desta sessão
Métodos de pagamento disponíveis na sessão
- Cartão de crédito
- Pix
- Boleto
- Drip
- NuPay
Show child attributes
Show child attributes
Data de criação da sessão
Data da atualização da sessão
Chave de acesso com escopo restrito, usada para pagar a sessão
Estado conceitual de disponibilidade do link para receber uma próxima cobrança.
Retornado em respostas completas de sessão. Em respostas parciais de atualização ou pagamento, consulte GET /v1/sessions/{id} para obter o estado agregado atualizado.
Show child attributes
Show child attributes
Configurações da empresa
Show child attributes
Show child attributes
Related topics
Sobre as APIs da MalgaSobre a MalgaRecuperar o histórico da sessãoNov 14 - API SettingsWas this page helpful?