Payment Links

Links de pagamento persistentes de uma oferta.

get /v1/payment-links — Listar Payment Links
post /v1/payment-links — Criar Payment Link
get /v1/payment-links/{id} — Consultar Payment Link
patch /v1/payment-links/{id}/status — Ativar ou desativar Payment Link

get/v1/payment-links

Listar Payment Links (listPaymentLinks)

Com os Payment Links desligados no ambiente (kill switch PAYMENT_LINKS_ENABLED) toda rota /v1/payment-links* responde 404 RESOURCE_NOT_FOUND.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: offers:read
URL: https://api.v2.wolfpayteste.online/v1/payment-links

Parâmetros

Nome	Onde	Tipo	Detalhes
`offer_id`	consulta	string	Padrão `^off_[A-Za-z0-9]+$` até 128 caracteres
`status`	consulta	string	Valores: `active`, `inactive`
`limit`	consulta	integer	de 1 a 100 Padrão: `50`
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Resposta 200

Payment Links, mais recentes primeiro.

Objeto PaymentLinkList

Resposta 200 de listPaymentLinks
Campo	Tipo	Detalhes
`data` obrigatório	PaymentLink[]

Exemplo de resposta 200 json

{
  "data": [
    {
      "id": "plk_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
      "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
      "status": "active",
      "session_count": 12,
      "completed_session_count": 7,
      "last_session_at": "2026-11-06T12:00:05.000Z",
      "created_at": "2026-11-06T12:00:00.000Z",
      "updated_at": "2026-11-06T12:00:00.000Z"
    }
  ]
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/payment-links

Criar Payment Link (createPaymentLink)

Cria um link active para uma oferta active do seller. A URL pública é https://checkout.<domínio>/l/{id}. Com os Payment Links desligados no ambiente (kill switch PAYMENT_LINKS_ENABLED) → 404 RESOURCE_NOT_FOUND. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve a mesma resposta com idempotent-replayed: true; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: offers:read,offers:write
URL: https://api.v2.wolfpayteste.online/v1/payment-links

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CreatePaymentLinkRequest

Corpo de createPaymentLink
Campo	Tipo	Detalhes
`offer_id` obrigatório	string	Padrão `^off_[A-Za-z0-9]+$` até 128 caracteres

Exemplo de corpo json

{
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901"
}

Resposta 201

Payment Link criado.

Objeto PaymentLink

Resposta 201 de createPaymentLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^plk_[A-Za-z0-9]{1,64}$`
`offer_id` obrigatório	string	Começa com `off_`
`status` obrigatório	string	Valores: `active`, `inactive`
`session_count` obrigatório	integer	de 0 a 9007199254740991
`completed_session_count` obrigatório	integer	de 0 a 9007199254740991
`last_session_at` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string

Exemplo de resposta 201 json

{
  "id": "plk_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "status": "active",
  "session_count": 0,
  "completed_session_count": 0,
  "last_session_at": null,
  "created_at": "2026-11-06T12:00:00.000Z",
  "updated_at": "2026-11-06T12:00:00.000Z"
}

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — IDEMPOTENCY_CONFLICT,IDEMPOTENCY_IN_PROGRESS,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

get/v1/payment-links/{id}

Consultar Payment Link (getPaymentLink)

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: offers:read
URL: https://api.v2.wolfpayteste.online/v1/payment-links/{id}

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do Payment Link (`plk_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do Payment Link (plk_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Payment Link.

Objeto PaymentLink

Resposta 200 de getPaymentLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^plk_[A-Za-z0-9]{1,64}$`
`offer_id` obrigatório	string	Começa com `off_`
`status` obrigatório	string	Valores: `active`, `inactive`
`session_count` obrigatório	integer	de 0 a 9007199254740991
`completed_session_count` obrigatório	integer	de 0 a 9007199254740991
`last_session_at` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string

Exemplo de resposta 200 json

{
  "id": "plk_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "status": "active",
  "session_count": 12,
  "completed_session_count": 7,
  "last_session_at": "2026-11-06T12:00:05.000Z",
  "created_at": "2026-11-06T12:00:00.000Z",
  "updated_at": "2026-11-06T12:00:00.000Z"
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

patch/v1/payment-links/{id}/status

Ativar ou desativar Payment Link (setPaymentLinkStatus)

Um link inactive não abre sessões. Repetir o estado atual não muda nada. Com os Payment Links desligados no ambiente (kill switch PAYMENT_LINKS_ENABLED) toda rota /v1/payment-links* responde 404 RESOURCE_NOT_FOUND.

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: offers:read,offers:write
URL: https://api.v2.wolfpayteste.online/v1/payment-links/{id}/status

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do Payment Link (`plk_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do Payment Link (plk_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto PaymentLinkStatusRequest

Corpo de setPaymentLinkStatus
Campo	Tipo	Detalhes
`status` obrigatório	string	Valores: `active`, `inactive`

Exemplo de corpo json

{
  "status": "inactive"
}

Resposta 200

Payment Link atualizado.

Objeto PaymentLink

Resposta 200 de setPaymentLinkStatus
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^plk_[A-Za-z0-9]{1,64}$`
`offer_id` obrigatório	string	Começa com `off_`
`status` obrigatório	string	Valores: `active`, `inactive`
`session_count` obrigatório	integer	de 0 a 9007199254740991
`completed_session_count` obrigatório	integer	de 0 a 9007199254740991
`last_session_at` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string

Exemplo de resposta 200 json

{
  "id": "plk_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "status": "inactive",
  "session_count": 12,
  "completed_session_count": 7,
  "last_session_at": "2026-11-06T12:00:05.000Z",
  "created_at": "2026-11-06T12:00:00.000Z",
  "updated_at": "2026-11-06T12:00:00.000Z"
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR