Detalhe/status do link de compra

GET

/api/purchase-links/{{purchase_link_id}}

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: products:read.

Detalhe/status de um link de compra individual — ideal para polling do status pela sua integração: paid: true quando existir cobrança COMPLETED do link. Inclui charges com as últimas tentativas de cobrança do link (um link pode ter várias tentativas — ex.: PIX expirou e o comprador tentou de novo ou pagou no cartão).

Retorna 404 (nunca 403) quando o link não existe ou não pertence à sua conta.

Prefira o webhook EVENT:CHARGE_PAID (objeto purchaseLink) para saber do pagamento em tempo real; use este endpoint como fallback/conciliação.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/api/purchase-links/{{purchase_link_id}}' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "id": "clplink0001",
  "url": "https://app.dotfy.com.br/checkout/curso-marketing-digital?pl=a1b2c3d4e5f60718293a4b5c6d7e8f901234567890abcdef",
  "productId": "clprodNew",
  "productTitle": "Curso de Marketing Digital",
  "customer": {
    "name": "Maria Silva",
    "email": "maria@exemplo.com",
    "phone": "5511999998888",
    "taxId": "12345678901"
  },
  "isActive": true,
  "createdVia": "API",
  "paid": true,
  "paidAt": "2026-07-02T12:34:56.000Z",
  "charges": [
    {
      "id": "clch001",
      "correlationId": "dotfy-1719900000000-def67890",
      "status": "COMPLETED",
      "paymentMethod": "PIX",
      "paidAt": "2026-07-02T12:34:56.000Z",
      "value": 29700
    }
  ],
  "createdAt": "2026-07-02T12:00:00.000Z"
}

Modificado em 2026-07-02 06:57:27

Página anterior

Listar links de compra do produto

Próxima página

Revogar link de compra

Detalhe/status do link de compra

Autenticação#

Requisição

Respostas

Autenticação