REFRESH ACCESS_TOKEN - Como fazer o refresh do access_token

Renovação do Access Token (Refresh Token)

O access_token possui validade de 24 horas. Para utilizá-lo em requisições protegidas, é necessário mantê-lo válido.

Essa requisição permite renovar o access_token sem precisar gerar um novo access_token toda vez que for usá-lo.

O refresh_token tem validade de 1 ano. Caso ele expire, será necessário gerar um novo access_token utilizando a API de criação de tokens:

  • https://api.intermediador.sandbox.yapay.com.br/api/authorizations/access_token

Corpo da requisição

  • access_token: Token atual que deseja renovar.
  • refresh_token: Token de renovação correspondente ao access_token.
  • type_response: Define o formato do retorno. Use "J" para JSON; se não for informado, o retorno será em XML.

Exemplo de requisição (JSON):

{
  "access_token": "SEU_ACCESS_TOKEN",
  "refresh_token": "SEU_REFRESH_TOKEN",
  "type_response": "J"
}

Retorno da requisição

Ao renovar com sucesso, a API retorna os novos tokens e suas datas de expiração.

Exemplo de retorno (JSON):

{
    "message_response": {
        "message": "success"
    },
    "data_response": {
        "authorization": {
            "access_token": "593032221d87f60f1ff5f1b9be62abde112be4c4ebdebbd44f6ca5ed1c69d5d0",
            "access_token_expiration": "2025-12-30T16:49:34.365-03:00",
            "refresh_token": "71d06f17ea947af8603e5b59d5048f6b",
            "refresh_token_expiration": "2026-03-29T16:49:34.365-03:00"
        }
    }
}

Descrição dos campos do retorno

  • access_token: Novo token de acesso a ser usado nas requisições protegidas.

  • access_token_expiration: Data e hora de expiração do novo access_token.

  • refresh_token: Token que pode ser usado para futuras renovações sem gerar um novo access_token.

  • refresh_token_expiration: Data e hora de expiração do refresh_token. Após essa data, será necessário gerar um novo access_token através da API de criação de tokens.

Language
Response
Click Try It! to start a request and see the response here!