Links de pagamento

Consultar link (em breve)

GET
/v2/payment-links/{id}
AuthorizationBearer <token>

Chave de API da sua empresa. Por enquanto a SwitchPay gera a chave e entrega à sua empresa; em breve será possível criar pelo painel.

In: header

Path Parameters

idstring

Id com prefixo, exatamente como a API devolveu.

Lengthlength <= 64

Response Body

curl -X GET "https://api.sandbox.switchpay.app.br/v2/payment-links/string"

{
  "id": "pl_9c1e2d3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
  "url": "https://pay.switchpay.app.br/l/O6yG0w_aj7KnHu5Qe8swH",
  "status": "ACTIVE",
  "amountCents": 19900,
  "methods": [
    "PIX",
    "CREDIT_CARD"
  ],
  "referenceId": "pedido-9001",
  "dueDate": "2026-10-09T23:59:59.000Z",
  "createdAt": "2026-10-06T13:30:00.000Z"
}

{
  "code": "UNAUTHORIZED",
  "message": "Chave de API ausente, inválida ou de outro ambiente."
}

{
  "code": "FORBIDDEN",
  "message": "Sua chave não tem permissão para esta operação."
}

{
  "code": "NOT_FOUND",
  "message": "Recurso não encontrado."
}

{
  "code": "RATE_LIMITED",
  "message": "Limite de chamadas atingido. Aguarde e tente de novo."
}

{
  "code": "SERVICE_UNAVAILABLE",
  "message": "Serviço de autorização indisponível. Tente novamente em instantes."
}