Referência API

API de links pagos

Crie, liste, inspecione, pause, arquive e envie links de pagamento MakePay.

Rotas

Use essas rotas para criar e gerenciar links de pagamento hospedados MakePay de MakeCrypto.

MétodoRota
GET/api/partner/v1/companies

Auth

Sessão

Uso

Listar empresas do usuário

Retorna as equipes disponíveis para as ferramentas do portal do usuário MakeCrypto autenticado.

POST/api/partner/v1/onboarding/company

Auth

Segredo de onboarding do parceiro

Uso

Criar link de onboarding da empresa

Cria um rascunho de onboarding preenchido pelo parceiro e retorna uma URL de reivindicação para o comerciante.

GET/api/partner/v1/makepay/payment-links

Auth

Chave API MakePay

Uso

Listar ou criar links de pagamento

Lê os links de pagamento da empresa associada à chave API ou cria links de checkout MakePay hospedados.

POST/api/partner/v1/makepay/payment-links

Auth

Chave API MakePay ou público

Uso

Listar ou criar links de pagamento

Lê os links de pagamento da empresa associada à chave API ou cria links de checkout MakePay hospedados.

POST/gateway/pay/{makepayKeyId}

Auth

Chave pública do formulário

Uso

Enviar formulário de pagamento HTML

Recebe campos de formulário do navegador, cria um link de pagamento hospedado e redireciona o comprador para o checkout.

GET/api/partner/v1/makepay/payment-links/{uid}

Auth

Chave API MakePay

Uso

Ler ou atualizar link de pagamento

Lê os detalhes de um link de pagamento ou altera seu status para active, paused ou archived.

PATCH/api/partner/v1/makepay/payment-links/{uid}

Auth

Chave API MakePay

Uso

Ler ou atualizar link de pagamento

Lê os detalhes de um link de pagamento ou altera seu status para active, paused ou archived.

POST/api/partner/v1/makepay/payment-links/{uid}/send-request-email

Auth

Chave API MakePay

Uso

Enviar solicitação de pagamento

Envia ou reenvia o link hospedado ao e-mail do cliente.

GET/api/partner/v1/makepay/subscriptions

Auth

Chave API MakePay

Uso

Listar ou criar assinaturas

Retorna planos de assinatura recorrente MakePay ou cria uma assinatura e a primeira fatura.

POST/api/partner/v1/makepay/subscriptions

Auth

Chave API MakePay

Uso

Listar ou criar assinaturas

Retorna planos de assinatura recorrente MakePay ou cria uma assinatura e a primeira fatura.

GET/api/partner/v1/makepay/customers

Auth

Chave API MakePay

Uso

Listar ou atualizar clientes

Retorna perfis de clientes MakePay ou cria/atualiza clientes por e-mail.

POST/api/partner/v1/makepay/customers

Auth

Chave API MakePay

Uso

Listar ou atualizar clientes

Retorna perfis de clientes MakePay ou cria/atualiza clientes por e-mail.

POST/api/partner/v1/makepay/customers/{customerId}/portal

Auth

Chave API MakePay

Uso

Criar link do portal do cliente

Gera sob demanda uma URL assinada do portal do cliente MakePay válida por 24 horas.

GET/api/partner/v1/timezones

Auth

Público

Uso

Listar fusos horários

Retorna identificadores de fuso horário IANA compatíveis.

GET/api/partner/v1/makepay/settings

Auth

Chave API MakePay

Uso

Ler ou atualizar configurações MakePay

Lê ou atualiza configurações de liquidação, redirecionamento, taxas e tratamento de pagamento insuficiente.

PUT/api/partner/v1/makepay/settings

Auth

Chave API MakePay

Uso

Ler ou atualizar configurações MakePay

Lê ou atualiza configurações de liquidação, redirecionamento, taxas e tratamento de pagamento insuficiente.

GET/api/partner/v1/makepay/destination-assets

Auth

Chave API MakePay

Uso

Listar ativos de destino

Retorna os ativos de liquidação compatíveis e o ativo padrão atual.

GET/api/partner/v1/makepay/webhook-requests

Auth

Chave API MakePay

Uso

Listar entregas de webhook

Mostra tentativas de entrega de webhooks de pagamento e assinatura, além do status de nova tentativa.

A rota de construção insere um link de pagamento MakePay, resolve a marca do comerciante e os padrões de liquidação, injeta campos de cobrança no tempo de execução e retorna o URL público de checkout.

POST /api/partner/v1/makepay/payment-links
json
{
  "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"
    }
  }
}

Para um botão do navegador checkout sem código ou com pouco código, consulte Pagamento pelo envio de formulário. Aceite um simples POST HTML, crie o mesmo tipo de link de pagamento hospedado e redirecione o comprador para checkout de MakePay.

Configuração necessária

A empresa deve ter um ativo de destino padrão MakePay. Caso a liquidação não esteja configurada, a rota retorna 409 com errorCode: "onboarding_required".

Campos de valor e ativo

Use payload.amount para o valor visível para o cliente. Envie payload.asset para um ativo de destino exato ou payload.currency quando o ativo padrão da empresa puder resolver a sequência. Se uma moeda estiver habilitada em várias cadeias e não houver nenhum padrão correspondente na empresa, envie payload.asset explicitamente.

Expiração

payload.expirationTime aceita 15m, 1h, 12h, 24h, 72h ou never. O API salva o carimbo de data/hora expires_at resolvido no link de pagamento.

Resposta de criação

json
{
  "ok": true,
  "paymentRequestEmailSent": false,
  "paymentRequestEmailError": null,
  "paymentLink": {
    "id": "8d15bb78-d0f8-45ef-88d7-2a1f1f79644b",
    "uid": "01hzy4k6p4w9y2x7e2z7n8a2xm",
    "status": "active",
    "expires_at": "2026-04-19T12:00:00.000Z",
    "created_at": "2026-04-19T00:00:00.000Z",
    "updated_at": "2026-04-19T00:00:00.000Z",
    "publicUrl": "https://makepay.io/payment/01hzy4k6p4w9y2x7e2z7n8a2xm",
    "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"
      },
      "asset": "ETH.USDT-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "runtimeMode": "merchant_target_net_v2",
      "billingVersion": "v2",
      "merchantName": "Merchant Co",
      "merchantPaymentLinkTheme": "system"
    }
  }
}

Use a rota de listagem para reconciliação de back-office, painéis e testes de fumaça.

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"

Utilize o caminho detalhado quando você já possui um link de pagamento UID e precisa do link normalizado, do URL público de checkout, da última sessão de pagamento e dos eventos da linha do tempo.

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

Use o caminho do estado para evitar que um link seja pagável ou para ocultá-lo de operações ativas.

curl
curl -X PATCH "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'

status deve ser active, paused ou archived.

Enviar um e-mail de solicitação de pagamento

MakeCrypto pode enviar o link hospedado diretamente para o e-mail do cliente da carga útil do link de pagamento ou para um e-mail alternativo no corpo da solicitação.

curl
curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/payment-links/PAYMENT_LINK_UID/send-request-email" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"email":"buyer@example.com"}'

Somente links de pagamento ativos podem ser enviados por email. Links concluídos não podem ser encaminhados.

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