curl --request GET \
--url https://api.malga.io/v1/sessions/{id} \
--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}', 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}"
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": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"captchaEnabled": false,
"clientId": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9b4f66f3-d45d-4946-b719-48f43fb90c52",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [
{
"paymentType": "credit",
"installments": 1
}
],
"items": [
{
"id": "2405d3ad-886e-4541-bd2e-8489e6f54dd4",
"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": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"multiplePayments": {
"allow": false,
"maxPayments": null,
"paymentCount": 0,
"pendingCount": 0,
"status": "active"
},
"splitRules": [
{
"sellerId": "d98106e8-568a-44c3-94d0-0e0bbd8b7e08",
"percentage": 100,
"processingFee": false,
"chargeEntireFee": false,
"chargeRemainderFee": false,
"liable": true,
"transactionOwner": true,
"fares": {
"mdr": 2.5,
"fee": 30
}
}
]
}Recuperar detalhes de uma sessão
Retorna a sessão completa. Use este endpoint como fonte do estado agregado de multiplePayments após criação, pagamento, atualização, cancelamento ou consulta de histórico.
curl --request GET \
--url https://api.malga.io/v1/sessions/{id} \
--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}', 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}"
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": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"captchaEnabled": false,
"clientId": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9b4f66f3-d45d-4946-b719-48f43fb90c52",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [
{
"paymentType": "credit",
"installments": 1
}
],
"items": [
{
"id": "2405d3ad-886e-4541-bd2e-8489e6f54dd4",
"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": "5bf7cbdf-02b7-489d-bc44-21ff1358d5fa",
"multiplePayments": {
"allow": false,
"maxPayments": null,
"paymentCount": 0,
"pendingCount": 0,
"status": "active"
},
"splitRules": [
{
"sellerId": "d98106e8-568a-44c3-94d0-0e0bbd8b7e08",
"percentage": 100,
"processingFee": false,
"chargeEntireFee": false,
"chargeRemainderFee": false,
"liable": true,
"transactionOwner": true,
"fares": {
"mdr": 2.5,
"fee": 30
}
}
]
}Path Parameters
Identificação da sessão a ser recuperada
Response
OK
Identificação da sessão
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 (omitempty) quando a sessão foi criada sem data de vencimento.
Descrição da sessão
Descrição a ser exibida fatura do comprador
Indica se a sessão usa verificação por CAPTCHA no Link de Pagamento.
Itens do pedido
Show child attributes
Show child attributes
Link para acessar o Link de Pagamento desta sessão
Parâmetros adicionais para transacionar com vendors
Show child attributes
Show child attributes
Métodos de pagamento disponíveis na sessão
- Cartão de crédito
- Pix
- Boleto
- Drip
- NuPay
- Múltiplos cartões
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
Chave de referência da sessão no provedor
Regras de split persistidas nesta sessão (definidas na criação quando informadas).
Show child attributes
Show child attributes
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
Was this page helpful?