{"templateId":"markdown","versions":[{"version":"v2026.04","label":"v2026.04","link":"/pt-br/products/payments-direct-2/api-docs/developer-guides/request-an-access-token","default":true,"active":true,"folderId":"7e5507fe"},{"version":"v2026.03","label":"v2026.03","link":"/pt-br/products/payments-direct-2/v2026.03/api-docs/developer-guides/request-an-access-token","default":false,"active":false,"folderId":"7e5507fe"},{"version":"v2025.11","label":"v2025.11","link":"/pt-br/products/payments-direct-2/v2025.11/api-docs/developer-guides/request-an-access-token","default":false,"active":false,"folderId":"7e5507fe"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Solicitar um token de acesso","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"solicitar-um-token-de-acesso","__idx":0},"children":["Solicitar um token de acesso"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Os tokens de acesso são usados na autenticação baseada em token para conceder a aplicativos acesso a APIs em nome de um usuário. Depois que um usuário faz login e autoriza o acesso, o aplicativo recebe um token de acesso. Esse token funciona como uma credencial que o aplicativo usa para se identificar e identificar o usuário autorizado ao chamar a API de destino."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Você precisa incluir um token de acesso válido no cabeçalho da requisição ao enviar requisições para endpoints de API protegidos."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Para obter um token de acesso, você precisa do seu client ID e client secret. Saiba como gerar um client ID e um client secret na ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api"},"children":["referência da API do ","Payments Direct"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"formato-da-requisição","__idx":1},"children":["Formato da requisição"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Para obter um token de autenticação para o ambiente ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UAT"]},", envie uma requisição ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," para a seguinte URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"plaintext","header":{"controls":{"copy":{}}},"source":"https://api.test.ripple.com/v2/oauth/token\n","lang":"plaintext"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requisição-de-autenticação","__idx":2},"children":["Requisição de autenticação"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Para obter um token de acesso, use a operação authenticate na ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api"},"children":["referência da API do ","Payments Direct"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Inclua ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["audience"]}," e ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["grant_type"]}," conforme o exemplo abaixo."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["O valor do campo ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["audience"]}," é baseado na sintaxe ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://en.wikipedia.org/wiki/Uniform_Resource_Name"},"children":["URN"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Formato"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["urn:ripplexcurrent-ENVIRONMENT_STRING:YOUR_TENANT_ID"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Exemplo"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["urn:ripplexcurrent-uat:YOUR_TENANT_ID"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST 'https://api.test.ripple.com/v2/oauth/token' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n    \"client_id\": \"{YOUR_CLIENT_ID}\",\n    \"client_secret\": \"{YOUR_CLIENT_SECRET}\",\n    \"audience\": \"urn:ripplexcurrent-uat:{YOUR_TENANT_ID}\",\n    \"grant_type\": \"client_credentials\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resposta-de-autenticação","__idx":3},"children":["Resposta de autenticação"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Armazene o ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access_token"]}," para usar em todas as demais operações da API. O valor de ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]}," lista os escopos contidos no token."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ\",\n  \"scope\": \"identities:create identities:read identities:write quote_collection:quote:create quote_collection:quote:read quote:quote:read pos:payments:create pos:payments:read ledger:balance:read\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"erros","__idx":4},"children":["Erros"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Se uma requisição de token for rejeitada, o corpo da resposta contém um ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," e um ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_description"]},". Um ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," com ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error: unauthorized_client"]}," significa que o cliente não está autorizado a solicitar um token; um ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," com ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error: access_denied"]}," significa que o serviço não está habilitado para o domínio solicitado. Trate esses casos pelo código de status HTTP, e não pela string ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},", e não repita uma requisição ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," idêntica. Para ver a lista completa de respostas de autenticação, consulte a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api"},"children":["referência da API do ","Payments Direct"]},"."]}]},"headings":[{"value":"Solicitar um token de acesso","id":"solicitar-um-token-de-acesso","depth":1},{"value":"Formato da requisição","id":"formato-da-requisição","depth":3},{"value":"Requisição de autenticação","id":"requisição-de-autenticação","depth":2},{"value":"Resposta de autenticação","id":"resposta-de-autenticação","depth":2},{"value":"Erros","id":"erros","depth":2}],"frontmatter":{"toc":{"enable":true,"maxDepth":2},"seo":{"title":"Solicitar um token de acesso"}},"lastModified":"2026-10-21T04:11:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/payments-direct-2/api-docs/developer-guides/request-an-access-token","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}