curl 'https://api.goatpay.com.br/v1/payment-links/list?page=1&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de links de pagamento",
"data": {
"items": [
{
"id": "clx_link",
"name": "Plano Pro",
"slug": "plano-pro",
"publicCode": "abc12",
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro"
}
],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Links de pagamento
Listar links de pagamento
Lista links de pagamento com paginação.
GET
/
payment-links
/
list
curl 'https://api.goatpay.com.br/v1/payment-links/list?page=1&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de links de pagamento",
"data": {
"items": [
{
"id": "clx_link",
"name": "Plano Pro",
"slug": "plano-pro",
"publicCode": "abc12",
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro"
}
],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
URL:
GET https://api.goatpay.com.br/v1/payment-links/list · Permissão: payment-links/listcurl 'https://api.goatpay.com.br/v1/payment-links/list?page=1&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de links de pagamento",
"data": {
"items": [
{
"id": "clx_link",
"name": "Plano Pro",
"slug": "plano-pro",
"publicCode": "abc12",
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro"
}
],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Query
number
Página (padrão 1).
number
Itens por página (máx. 100).
string
ACTIVE ou INACTIVE.string
Nome, slug ou
publicCode.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
ACTIVE, INACTIVE 
