curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"allowedScopes": ["account:read", "payments:read"]
}'
{
"success": true,
"message": "Aplicação OAuth criada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"clients": [],
"createdAt": "2026-09-04T12:00:00.000Z"
}
},
"requestId": "req_oauth_create"
}
Gestão
Criar aplicação OAuth
Registra uma nova aplicação OAuth na conta.
POST
/
oauth-apps
/
create
curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"allowedScopes": ["account:read", "payments:read"]
}'
{
"success": true,
"message": "Aplicação OAuth criada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"clients": [],
"createdAt": "2026-09-04T12:00:00.000Z"
}
},
"requestId": "req_oauth_create"
}
Permissão:
oauth-apps/create. Requer API pública habilitada na conta.
curl -X POST 'https://api.goatpay.com.br/v1/oauth-apps/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"allowedScopes": ["account:read", "payments:read"]
}'
{
"success": true,
"message": "Aplicação OAuth criada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças para clientes",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"website": "https://sua-app.com",
"developerName": "Sua Empresa LTDA",
"clients": [],
"createdAt": "2026-09-04T12:00:00.000Z"
}
},
"requestId": "req_oauth_create"
}
Corpo da requisição
string
required
Nome exibido no consentimento (máx. 120 caracteres).
array
required
Scopes que o app pode solicitar. Use scopes/list.
string
Descrição opcional no consentimento (máx. 500 caracteres).
string
URL do site da aplicação.
string
URL do logo (HTTPS).
string
URL da política de privacidade.
string
URL dos termos de uso.
string
Nome do desenvolvedor exibido no consentimento.
Após criar, gere credenciais com clients/ensure para DEV e PRODUCTION.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json

