Pular para o conteúdo
Pagamentos

Listar links de pagamento

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/payment-links
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

Paginação por cursor, com filtro opcional por status (active ou closed).

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional
    • um de"active""closed"
  • cursorstringopcional
  • limitintegeropcional
    • padrão 25
    • faixa 1–100

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de links de pagamento, do mais novo para o mais antigo.

  • Cada item — V1PaymentLink

    • idstring
    • titlestring
    • descriptionstring | null
    • amountinteger
    • currency"BRL"
      • sempre "BRL"
    • methodsstring[]
    • maxInstallmentsinteger
    • statusstring
      • um de"active""closed"
    • urlstring (uri)
    • expiresAtstring | null
    • externalReferencestring | null
      • chave string
      • valor string | number | boolean | null

      Uma destas formas

      • string
      • number
      • boolean
    • createdAtstring
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.