Referência API

API Início rápido

Crie uma chave MakePay API e envie sua primeira solicitação de servidor.

Escolha uma equipe e uma chave API

Crie uma chave API de MakePay no portal MakeCrypto ou na guia de teste API quando você estiver conectado. A guia de teste API carrega suas equipes, filtra as chaves API de MakePay, abre o modal de criação de chave quando a equipe selecionada ainda não possui uma chave MakePay e pode enviar solicitações autenticadas com o ID e o segredo da chave selecionada.

Base URL

Todas as rotas API do parceiro MakeCrypto têm versão na origem de produção.

https://www.makecrypto.io/api/partner/v1

Para desenvolvimento local, use sua origem local MakeCrypto com a mesma estrutura de roteamento.

Autenticação

As integrações de servidor devem enviar um ID de chave API de MakePay e um segredo API em cada solicitação. O segredo é retornado somente quando a chave API é criada, portanto, armazene-o em um gerenciador de segredos do lado do servidor e nunca envie-o para navegadores clientes.

CabeçalhoValorNotas
x-makecrypto-key-idID da chave API MakePayComeça com mk_makepay_ para as APIs de pagamento MakePay.
x-makecrypto-key-secretSegredo API de uso únicoExibido apenas quando a chave é criada. Armazene-o no gerenciador de segredos do servidor.

Primeira solicitação de leitura

Comece com uma solicitação de leitura antes de criar links pagos reais. Uma resposta correta confirma que o ID da chave, o segredo, o escopo do produto MakePay e a empresa proprietária da chave são válidos.

curl
curl "https://www.makecrypto.io/api/partner/v1/makepay/payment-links" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Primeira solicitação de criação

Crie links de pagamento em seu servidor quando um pedido, fatura ou sessão checkout estiver pronto para pagamento.

curl
curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/payment-links" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active",
  "sendPaymentRequestEmail": false,
  "payload": {
    "title": "Website order #1042",
    "description": "Checkout for order #1042",
    "amount": "129.99",
    "fiatCurrency": "USD",
    "currency": "USDT",
    "orderId": "order_1042",
    "customerEmail": "buyer@example.com",
    "returnUrl": "https://merchant.example/orders/1042",
    "successUrl": "https://merchant.example/orders/1042/success",
    "failureUrl": "https://merchant.example/orders/1042/failure",
    "expirationTime": "12h",
    "metadata": {
      "cartId": "cart_7M2V",
      "source": "api"
    }
  }
}'

Lista de verificação operacional

  • Crie a chave API com o produto makepay.
  • Defina o ativo alvo padrão da empresa antes de criar links.
  • Mantenha o segredo API fora do controle de origem e dos pacotes de front-end.
  • Trate os UIDs dos links de pagamento como identificadores públicos, mas retenha os IDs de pedidos internos em payload.orderId ou payload.metadata.
  • Ouça webhooks ou verifique o status do link/sessão no portal até que seu fluxo backend webhook esteja ativo.

Precisa de ajuda na configuração de parceiro?

Abra a visualização de detalhes do link de pagamento no MakeCrypto para copiar os snippets gerados para um UID de pagamento real, ou volte ao portal para gerenciar as configurações do comerciante.

Abrir portal