Referência da API

Carregamentos em cripto

Carregue o saldo em cripto: obtenha o endereço de depósito e o montante exato, envie exatamente esse montante, assinale o pagamento como enviado (o ID da transação é opcional) e acompanhe o carregamento até o saldo ser creditado. O saldo paga qualquer um dos nossos planos.

Última atualização: 15 de outubro de 2026 · 7 min de leitura

Endpoints nesta página

GET /v1/catalog/coins: Criptomoedas e redes aceites (com o respetivo endereço fixo de depósito)
POST /v1/topups: Iniciar um carregamento do saldo em cripto (endereço fixo, montante exato)
POST /v1/topups/{topUpId}/txid: Assinalar o pagamento como enviado (TXID opcional)
GET /v1/topups/{topUpId}: Obter um carregamento (consultar o estado atual)
GET /v1/topups: Listar carregamentos em cripto

URL base https://africaproxies.com/api/v1. Autenticação, erros e limites: consulte a visão geral da API.

Criptomoedas e redes aceites (com o respetivo endereço fixo de depósito)

GET/v1/catalog/coins

Público: não é necessária uma chave API.

Resposta `200 OK`

{
  "data": [
    {
      "code": "BTC",
      "name": "Bitcoin",
      "networks": [
        {
          "id": "bitcoin",
          "name": "Bitcoin",
          "confirmationsRequired": 2,
          "estimatedMinutes": null,
          "memoRequired": false,
          "address": "DEPOSIT_ADDRESS"
        }
      ]
    }
  ]
}

Exemplos de código

curl

curl -s "https://africaproxies.com/api/v1/catalog/coins"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"

r = requests.get(f"{API}/catalog/coins", timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/catalog/coins`);
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Iniciar um carregamento do saldo em cripto (endereço fixo, montante exato)

POST/v1/topups

amountUsd ≥ 25.00 USD e ≤ o máximo (10,000.00 por predefinição): caso contrário, 422 em amountUsd.
coin + network têm de constar de GET /v1/catalog/coins (caso contrário, 409 coin_unavailable).
Devolve o address fixo da rede e o amountCrypto exato = amountUsd / rate, arredondado para cima à precisão da moeda (BTC/LTC/ETH/SOL com 8 casas decimais, USDT/USDC com 6), mais um pequeno desvio único nos últimos algarismos para que dois carregamentos abertos da mesma rede não peçam o mesmo montante. rate fica bloqueada até expiresAt (30 minutos); txidDeadline = expiresAt + 72 h.
purchase opcional (o mesmo corpo de POST /v1/orders): validada e com preço calculado agora (422 com nomes de campos prefixados por purchase., 409 plan_unavailable…). amountUsd tem de cobrir o total de purchase − saldo atual (422 too_small em amountUsd). Quando o carregamento é creditado, a encomenda é efetuada com o saldo na mesma transação; purchase.status passa a completed (com orderId) ou failed (failureReason; os fundos permanecem no saldo).

Autenticação: API chave no cabeçalho Authorization: Bearer API_KEY.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`Idempotency-Key`	header	string	Não	Chave única (por exemplo, um UUID) para repetir um POST com segurança. Conservada durante 24 h. — máx. 128 caracteres

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`amountUsd`	string (USD, 2 decimals)	Sim	USD a adicionar: ≥ 25.00, ≤ 10,000.00 por predefinição.
`coin`	string	Sim	—
`network`	string	Sim	—
`purchase`	object	Não	Plano a comprar com o saldo quando o carregamento for creditado (o mesmo corpo de `POST /v1/orders`).

Exemplo: Saldo

{
  "amountUsd": "50.00",
  "coin": "USDT",
  "network": "tron"
}

Exemplo: Finalizar compra

{
  "amountUsd": "25.00",
  "coin": "BTC",
  "network": "bitcoin",
  "purchase": {
    "planId": "res-10",
    "quantity": 1
  }
}

Resposta `201 Created`

{
  "id": "top_7d2kq9x1",
  "status": "verifying",
  "final": false,
  "amountUsd": "25.00",
  "coin": "USDT",
  "network": "tron",
  "address": "DEPOSIT_ADDRESS",
  "amountCrypto": "25.000137",
  "rate": "1.00",
  "paymentUri": "PAYMENT_URI",
  "expiresAt": "2026-10-05T14:33:11Z",
  "txidDeadline": "2026-10-08T14:33:11Z",
  "confirmationsRequired": 20,
  "confirmations": 7,
  "txid": "9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "txidSubmittedAt": "2026-10-05T14:09:42Z",
  "amountReceivedCrypto": "25.000137",
  "explorerUrl": "https://tronscan.org/#/transaction/9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "creditedUsd": null,
  "creditedAt": null,
  "rejection": null,
  "purchase": {
    "planId": "res-10",
    "planName": "Team",
    "quantity": 1,
    "options": {},
    "promoCode": null,
    "total": "5.94",
    "status": "pending",
    "orderId": null,
    "failureReason": null
  },
  "createdAt": "2026-10-05T14:03:11Z"
}

Exemplos de código

curl

curl -s -X POST "https://africaproxies.com/api/v1/topups" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"amountUsd":"50.00","coin":"USDT","network":"tron"}'

Python

import os, uuid
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}", "Idempotency-Key": str(uuid.uuid4())}

r = requests.post(f"{API}/topups", headers=HEADERS, json={"amountUsd": "50.00", "coin": "USDT", "network": "tron"}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
import { randomUUID } from 'node:crypto';

const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/topups`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Idempotency-Key': randomUUID(), 'Content-Type': 'application/json' },
  body: JSON.stringify({ amountUsd: '50.00', coin: 'USDT', network: 'tron' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Assinalar o pagamento como enviado (TXID opcional)

POST/v1/topups/{topUpId}/txid

Assinale o pagamento como enviado depois de sair da sua carteira ou plataforma de câmbio: esta é a versão API do botão «Já enviei o pagamento». O ID da transação (TXID) é opcional: envie um corpo vazio ({}) ou acrescente txid se o tiver. O pagamento é associado a este carregamento pelo montante exato (amountCrypto), na rede e no endereço do carregamento; envie exatamente esse montante.

É aceite enquanto o carregamento estiver awaiting_payment, expired ou rejected e antes de txidDeadline (expiresAt + 72 h): uma comunicação tardia nunca faz perder um pagamento. Se fornecer um txid, o formato é validado para a rede (422 em txid) e não pode já estar associado a outro carregamento (409 txid_already_used). Um carregamento encerrado devolve 409 topup_closed. O carregamento passa então a verifying enquanto o pagamento é verificado na blockchain e termina como credited quando a rede confirma a transação, ou rejected (com rejection).

Autenticação: API chave no cabeçalho Authorization: Bearer API_KEY.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`topUpId`	path	string	Sim	—

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`txid`	string	Não	Opcional. Hash da transação: 64 caracteres hexadecimais (bitcoin, litecoin, tron), 0x + 64 caracteres hexadecimais (ethereum), assinatura base58 (solana). Vazio ou ausente: o pagamento é associado pelo montante exato. — máx. 128 caracteres

Exemplo: Pagamento enviado

{}

Exemplo: Com o TXID (opcional)

{
  "txid": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"
}

Resposta `200 OK`

{
  "id": "top_7d2kq9x1",
  "status": "verifying",
  "final": false,
  "amountUsd": "25.00",
  "coin": "USDT",
  "network": "tron",
  "address": "DEPOSIT_ADDRESS",
  "amountCrypto": "25.000137",
  "rate": "1.00",
  "paymentUri": "PAYMENT_URI",
  "expiresAt": "2026-10-05T14:33:11Z",
  "txidDeadline": "2026-10-08T14:33:11Z",
  "confirmationsRequired": 20,
  "confirmations": 7,
  "txid": "9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "txidSubmittedAt": "2026-10-05T14:09:42Z",
  "amountReceivedCrypto": "25.000137",
  "explorerUrl": "https://tronscan.org/#/transaction/9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "creditedUsd": null,
  "creditedAt": null,
  "rejection": null,
  "purchase": {
    "planId": "res-10",
    "planName": "Team",
    "quantity": 1,
    "options": {},
    "promoCode": null,
    "total": "5.94",
    "status": "pending",
    "orderId": null,
    "failureReason": null
  },
  "createdAt": "2026-10-05T14:03:11Z"
}

Exemplos de código

curl

curl -s -X POST "https://africaproxies.com/api/v1/topups/top_7d2kq9x1/txid" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/topups/top_7d2kq9x1/txid", headers=HEADERS, json={}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/topups/top_7d2kq9x1/txid`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Obter um carregamento (consultar o estado atual)

GET/v1/topups/{topUpId}

Consulte esta rota para acompanhar um carregamento: a cada 10 s enquanto status = verifying, a cada 30 s enquanto aguarda o pagamento, e pare quando final = true. Um carregamento passa a expired se o pagamento não tiver sido assinalado como enviado antes de expiresAt; ainda pode ser assinalado até txidDeadline.

Autenticação: API chave no cabeçalho Authorization: Bearer API_KEY.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`topUpId`	path	string	Sim	—

Resposta `200 OK`

{
  "id": "top_7d2kq9x1",
  "status": "verifying",
  "final": false,
  "amountUsd": "25.00",
  "coin": "USDT",
  "network": "tron",
  "address": "DEPOSIT_ADDRESS",
  "amountCrypto": "25.000137",
  "rate": "1.00",
  "paymentUri": "PAYMENT_URI",
  "expiresAt": "2026-10-05T14:33:11Z",
  "txidDeadline": "2026-10-08T14:33:11Z",
  "confirmationsRequired": 20,
  "confirmations": 7,
  "txid": "9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "txidSubmittedAt": "2026-10-05T14:09:42Z",
  "amountReceivedCrypto": "25.000137",
  "explorerUrl": "https://tronscan.org/#/transaction/9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
  "creditedUsd": null,
  "creditedAt": null,
  "rejection": null,
  "purchase": {
    "planId": "res-10",
    "planName": "Team",
    "quantity": 1,
    "options": {},
    "promoCode": null,
    "total": "5.94",
    "status": "pending",
    "orderId": null,
    "failureReason": null
  },
  "createdAt": "2026-10-05T14:03:11Z"
}

Exemplos de código

curl

curl -s "https://africaproxies.com/api/v1/topups/top_7d2kq9x1" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/topups/top_7d2kq9x1", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/topups/top_7d2kq9x1`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Listar carregamentos em cripto

GET/v1/topups

Autenticação: API chave no cabeçalho Authorization: Bearer API_KEY.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`page`	query	integer	Não	≥ 1, predefinição `1`
`perPage`	query	integer	Não	1–100, predefinição `20`
`status`	query	`awaiting_payment` · `verifying` · `credited` · `rejected` · `expired`	Não	`final` = creditado, ou expirado / rejeitado após `txidDeadline`.

Resposta `200 OK`

{
  "data": [
    {
      "id": "top_7d2kq9x1",
      "status": "verifying",
      "final": false,
      "amountUsd": "25.00",
      "coin": "USDT",
      "network": "tron",
      "address": "DEPOSIT_ADDRESS",
      "amountCrypto": "25.000137",
      "rate": "1.00",
      "paymentUri": "PAYMENT_URI",
      "expiresAt": "2026-10-05T14:33:11Z",
      "txidDeadline": "2026-10-08T14:33:11Z",
      "confirmationsRequired": 20,
      "confirmations": 7,
      "txid": "9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
      "txidSubmittedAt": "2026-10-05T14:09:42Z",
      "amountReceivedCrypto": "25.000137",
      "explorerUrl": "https://tronscan.org/#/transaction/9d2e5c0b1f7a4e3d8c6b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f41c7",
      "creditedUsd": null,
      "creditedAt": null,
      "rejection": null,
      "purchase": {
        "planId": "res-10",
        "planName": "Team",
        "quantity": 1,
        "options": {},
        "promoCode": null,
        "total": "5.94",
        "status": "pending",
        "orderId": null,
        "failureReason": null
      },
      "createdAt": "2026-10-05T14:03:11Z"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "totalPages": 1
  }
}

Exemplos de código

curl

curl -s "https://africaproxies.com/api/v1/topups" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/topups", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/topups`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Criptomoedas e redes aceites (com o respetivo endereço fixo de depósito)

Resposta 200 OK

Exemplos de código

Iniciar um carregamento do saldo em cripto (endereço fixo, montante exato)

Parâmetros

Corpo da requisição

Resposta 201 Created

Exemplos de código

Assinalar o pagamento como enviado (TXID opcional)

Parâmetros

Corpo da requisição

Resposta 200 OK

Exemplos de código

Obter um carregamento (consultar o estado atual)

Parâmetros

Resposta 200 OK

Exemplos de código

Listar carregamentos em cripto

Parâmetros

Resposta 200 OK

Exemplos de código

Páginas relacionadas

Resposta `200 OK`

Resposta `201 Created`

Resposta `200 OK`

Resposta `200 OK`

Resposta `200 OK`