Skip to main content
GET
/
api
/
v1
/
payment-links
Listar links de pagamento
curl --request GET \
  --url https://upay-sistema-api.onrender.com/api/v1/payment-links \
  --header 'X-API-Key: <api-key>'
{
  "message": "<string>",
  "paymentLinks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "title": "<string>",
      "description": "<string>",
      "amount": 123,
      "currency": "BRL",
      "status": "ACTIVE",
      "expiresAt": "2023-11-07T05:31:56Z",
      "redirectUrl": "<string>",
      "settings": {},
      "salesCount": 0,
      "timesUsed": 0,
      "metaPixelCode": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "cursor": "<string>",
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Response

Lista de links de pagamento

message
string
pagination
object