v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Obter access token

post/oauth2/token

Headers

Authorizationstring

Token de autenticação. Deve ser enviado no formato Bearer <token>.

X_CLIENT_IDstring

Identificador único fornecido no momento da criação da aplicação.

X_CLIENT_SECRETstring

Chave privada a aplicação fornecida no momento da criação.

Request body

grant_type'sms' | 'authorization_code' | 'challenge' required

Indica o tipo de autenticação utilizada.

codestring

Código que foi enviado para URL no momento da permissão usuário (Connect Authorization). Obrigatório quando grant_type = authorization_code.

sms_codestring

Código SMS enviado para o número cadastrado na base PagSeguro (Connect SMS). Obrigatório quando grant_type = sms.

redirect_uristring

URL de redirecionamento do cliente, deve ser a mesma do momento da permissão. Obrigatório quando grant_type = authorization_code.

emailstring

E-mail do cliente PagBank que deseja conceder permissão para o parceiro efetuar ações em nome dele na plataforma PagSeguro. Obrigatório quando grant_type = sms.

scopestring

Nome do escopo. Quando grant_tpe for informado como challenge, obrigatoriamente use certificate.create para solicitar a criação de um certificado digital.

authorization_idstring

Identifica a autorização obtida ao solicitar a autorização via SMS.

Response

200

OR
OR

Example response

{
  "token_type": "bearer",
  "access_token": "2YotnFZFEjr1zCsicMWpAA",
  "expires_in": "xxxxxx",
  "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
  "scope": "scope.name",
  "account_id": "ACCO_737348328392943"
}