Autenticação
POST/oauth2/token
Utilize esse endereço para gerar o token de autorização que deve ser enviado no header das demais requisições. É necessário utilizar o CLIENT_ID
e CLIENT_SECRET
definidos na credencial fornecida pelo PicPay.
Cada token de autorização gerado terá a validade de 5 (cinco) minutos, sendo necessário a solicitação de um novo token. Esse fluxo precisa estar contemplado na sua aplicação.
Para mais detalhes, veja a nossa página sobre o processo de autenticação.
Request
- application/json
Body
required
Possible values: [client_credentials
]
Define o fluxo oauth da requisição de token.
No caso da API de Adquirência do PicPay é sempre
client_credentials
.
Possible values: Value must match regular expression ^[\w\-]+$
Possible values: Value must match regular expression ^[\w]+$
Responses
- 200
- 401
Resposta de sucesso no fluxo de autenticação e de atualização do token.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: Value must match regular expression ^([\w=]+)\.([\w=]+)\.([\w\-\+\/=]*)
Possible values: Value must match regular expression ^[\w]+$
Possible values: Value must match regular expression ^[\w\.\- ]+$
Uma string com todos os escopos da credencial separados por um espaço vazio.
Possible values: Value must match regular expression ^[\d]+$
Possible values: Value must match regular expression ^[\d]+$
Possible values: Value must match regular expression ^[\d]+$
authorization_details
TokenResponseAuthorizationDetail[]
Possible values: Value must match regular expression ^[\w]+$
Possible values: Value must match regular expression ^[\w\-]+$
Possible values: Value must match regular expression ^[\w\-]+$
Possible values: Value must match regular expression ^[\w\- ]+$
{
"access_token": "string",
"expires_in": 300,
"refresh_expires_in": 0,
"token_type": "Bearer",
"not-before-policy": 1640873903,
"scope": "ecommerce.checkout.transactional credential.client_secret.rotate",
"core-seller-id": "000000",
"merchant-document": "22896431000110",
"seller-acquirer-id": "0000000005968341",
"authorization_details": [
{
"type": "authorized_account",
"account_id": "28a1586b-c810-48df-99ba-f1d304ba00f9",
"fingerprint": "28a1586b-c810-48df-99ba-f1d304ba00f9",
"display_name": "PicPay Wallet"
}
]
}
Os erros de 400 Bad Request são causados por alguma falha durante a autenticação. Podem ser apresentados os seguintes erros:
-
invalid_client: Falha na autenticação do cliente. Por exemplo, quando o cliente inclui client_id e client_secret no cabeçalho de autorização, mas não há tal cliente com esse client_id e client_secret.
-
unauthorized_client: O cliente não tem permissão para fluxo de concessão de código ou para tokens de atualização.
-
unsupported_grant_type: Retornado se grant_type for diferente de authorization_code ou refresh_token.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: Value must match regular expression ^[\w]+$
Possible values: Value must match regular expression ^[\w\.\-= ]+$
{
"error": "unauthorized_client",
"error_description": "Invalid client or Invalid client credentials"
}