Skip to main content
GET
/
v1
/
subacquirer
/
prepayment
/
{id}
Recuperar detalhes de uma antecipação
curl --request GET \
  --url https://api.malga.io/v1/subacquirer/prepayment/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
import requests

url = "https://api.malga.io/v1/subacquirer/prepayment/{id}"

headers = {
"X-Client-Id": "<api-key>",
"X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.malga.io/v1/subacquirer/prepayment/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.malga.io/v1/subacquirer/prepayment/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Client-Id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.malga.io/v1/subacquirer/prepayment/{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))

}
HttpResponse<String> response = Unirest.get("https://api.malga.io/v1/subacquirer/prepayment/{id}")
.header("X-Client-Id", "<api-key>")
.header("X-Api-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.malga.io/v1/subacquirer/prepayment/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "01964c5a-0001-7000-8000-000000000001",
  "status": "pending",
  "grossAmount": 20000,
  "netAmount": 19323,
  "markupAmount": 387,
  "feeAmount": 290,
  "effectiveRate": 0.03385,
  "monthlyRate": 0.015,
  "markup": 0.02,
  "expiresAt": "2026-05-27T18:00:00Z",
  "items": [
    {
      "receivableUnitExternalId": "ru-ext-ok-1",
      "grossAmount": 12000,
      "netAmount": 11594,
      "markupAmount": 232,
      "feeAmount": 174,
      "daysToAnticipate": 30,
      "settlementDate": "2026-06-15",
      "paymentArrangement": "vcc"
    },
    {
      "receivableUnitExternalId": "ru-ext-ok-2",
      "grossAmount": 8000,
      "netAmount": 7729,
      "markupAmount": 155,
      "feeAmount": 116,
      "daysToAnticipate": 30,
      "settlementDate": "2026-06-15",
      "paymentArrangement": "vcc"
    }
  ]
}
{
"error": {
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}
{
"code": "I-403",
"networkDeniedMessage": "Client is not eligible for prepayment"
}
{
"error": {
"code": 123,
"declinedCode": "<string>",
"key": "<string>",
"businessCode": "<string>",
"message": "<string>",
"details": "<array>"
}
}

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string<uuid>
required

Identificador da antecipação.

Response

Detalhes da antecipação

id
string<uuid>
required

Identificador da antecipação.

Example:

"01964c5a-0001-7000-8000-000000000001"

status
enum<string>
required

Status atual da antecipação:

  • pending: simulação criada, ainda não aceita.
  • committed: aceite confirmado, antecipação em processamento.
  • paid: pagamento da antecipação realizado.
  • expired: simulação expirou (passou de 15h sem aceite) ou aceite recusado porque o conjunto de recebíveis mudou.
Available options:
pending,
committed,
paid,
expired
Example:

"pending"

grossAmount
integer<int64>
required

Soma do valor original dos recebíveis, em centavos.

Example:

20000

netAmount
integer<int64>
required

Valor líquido a ser recebido pelo cliente após o desconto, em centavos.

Example:

19323

markupAmount
integer<int64>
required

Componente do desconto referente ao markup do contrato, em centavos.

Example:

387

feeAmount
integer<int64>
required

Componente do desconto referente à taxa base da Malga, em centavos.

Example:

290

effectiveRate
number<double>
required

Taxa efetiva total da antecipação sobre o valor bruto.

Example:

0.03385

monthlyRate
number<double>
required

Taxa mensal base aplicada no cálculo (decimal).

Example:

0.015

markup
number<double>
required

Markup mensal do contrato aplicado no cálculo (decimal).

Example:

0.02

expiresAt
string<date-time>
required

Data e hora limite para confirmar a antecipação (sempre 15h, horário de Brasília, do dia da simulação).

Example:

"2026-05-27T18:00:00Z"

items
object[]
required

Lista dos recebíveis incluídos na antecipação.