Referência

Referência de rota

Integração de parceiro OAuth

POST /api/partner/v1/onboarding/company pode incluir um objeto opcional oauth. MakeCrypto valida o aplicativo OAuth, redireciona o URI, os escopos e o desafio PKCE antes de criar o link de integração. Quando o comerciante conclui a integração, MakeCrypto cria a empresa, concede ao aplicativo OAuth acesso a essa empresa e redireciona para o redirectUri registrado com uma autorização code.

{
  "idempotencyKey": "merchant_123",
  "company": {
    "name": "Acme Markets",
    "website": "https://acme.example"
  },
  "oauth": {
    "clientId": "mco_app_example",
    "redirectUri": "https://apps.makecrypto.io/oauth/callback",
    "scope": "company:read makepay:payment-links:write makepay:settings:read",
    "state": "merchant_123",
    "codeChallenge": "PKCE_S256_CODE_CHALLENGE",
    "codeChallengeMethod": "S256"
  }
}

O aplicativo parceiro deve reter o code_verifier PKCE correspondente e trocar o código retornado usando POST /oauth/token.

Objeto PaymentLink

PagamentoLinkPayload

Objeto Cliente

Resposta do Portal do Cliente

POST /api/partner/v1/makepay/customers/{customerId}/portal retorna um portal assinado URL para o cliente salvo.

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

O URL é válido por 24 horas e usa o payment_link_domain verificado pela empresa quando disponível. Caso contrário, cabe à fonte pública MakePay.

Gera links do portal sob demanda quando o cliente abre o faturamento. URLs de clientes expirados, alterados ou outros são rejeitados antes de carregar os dados do portal.

Objeto de assinatura

As assinaturas passam para overdue quando um ciclo não pago excede seu carimbo de data/hora dueAt em pelo menos 24 horas. MakePay envia um makepay.subscription.status_changed assinado webhook sempre que o status da assinatura muda.

Configurações de MakePay

Ativo de destino

Valores de status

• active: O link pode ser aberto e pago.
• paused: O link ainda está visível para o comerciante, mas não deve aceitar novas iniciações de pagamento.
• archived: O link está oculto nas visualizações ativas e deve ser tratado como fechado.

Valores de status da assinatura:

• active: A assinatura cobra faturas programadas normalmente.
• paused: Lembretes e alterações do comerciante/cliente pausaram a assinatura.
• overdue: Pelo menos um ciclo não pago está vencido há 24 horas ou mais.
• cancelled: A assinatura foi encerrada e os ciclos gerados não pagos foram cancelados.

Formato de erro

Os erros retornam JSON com error e, quando disponível, errorCode.

{
  "errorCode": "invalid_destination_asset",
  "error": "payload.asset ETH.USDT-... is not available for supported settlement routes."
}