{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars/sdk_sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Installation","description":"The specifications of Ratepay's APIs for easy payment transactions.","siteUrl":"https://docs.ratepay.com","keywords":"Ratepay developer portal, Ratepay api portal, Ratepay api reference docs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"installation","__idx":0},"children":["Installation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Ratepay Java SDK is published as a Maven artifact under the group ID ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["com.ratepay.sdk"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-the-dependency","__idx":1},"children":["Add the dependency"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Maven","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","data-title":"pom.xml","header":{"title":"pom.xml","controls":{"copy":{}}},"source":"<dependency>\n    <groupId>com.ratepay.sdk</groupId>\n    <artifactId>ratepay-sdk-core</artifactId>\n    <version>1.16.1</version>\n</dependency>\n","lang":"xml"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Gradle (Kotlin DSL)","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"kotlin","data-title":"build.gradle.kts","header":{"title":"build.gradle.kts","controls":{"copy":{}}},"source":"dependencies {\n    implementation(\"com.ratepay.sdk:ratepay-sdk-core:1.16.1\")\n}\n","lang":"kotlin"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Gradle (Groovy DSL)","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"groovy","data-title":"build.gradle","header":{"title":"build.gradle","controls":{"copy":{}}},"source":"dependencies {\n    implementation 'com.ratepay.sdk:ratepay-sdk-core:1.16.1'\n}\n","lang":"groovy"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verifying-the-install","__idx":2},"children":["Verifying the install"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To verify that the SDK is installed and your credentials are working, initialize a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RatepayClient"]}," and call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validateCredentials()"]},". This method requests or reuses an OAuth access token to verify authentication without initiating a payment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For instructions on initializing the client and managing authentication, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/developer/sdk/client/client-configuration"},"children":["Client configuration"]}," and"," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/developer/sdk/client/authentication"},"children":["Authentication"]},"."]}]},"headings":[{"value":"Installation","id":"installation","depth":1},{"value":"Add the dependency","id":"add-the-dependency","depth":2},{"value":"Verifying the install","id":"verifying-the-install","depth":2}],"frontmatter":{"seo":{"title":"Installation"}},"lastModified":"2026-11-04T12:44:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/developer/sdk/getting-started/installation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}