{"templateId":"markdown","versions":[{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/api-docs/best-practices/base-urls","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/best-practices/base-urls","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Base URLs","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","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":"base-urls","__idx":0},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple makes RESTful APIs available to integrate, manage and interact with Ripple products and services. To use these APIs, you need to use the correct base URL. A base URL is part of a well-formed REST URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To form the final API request, append the necessary version, path, resource, and parameters to the base URL."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"All environments use unique base URLs"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on the correct base URL for the API environment you interact with, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#base-url-by-api-environment"},"children":["Base URL by API environment"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"components-of-a-base-url","__idx":1},"children":["Components of a base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A base URL includes the HTTPS protocol, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[domainPrefix]"]},", and the domain. A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[domainPrefix]"]}," refers to a segment of the base URL that's variable depending on the API and environment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example uses the  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uat"]}," environment using the ","Ripple Payments"," API:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"https","header":{"controls":{"copy":{}}},"source":"https://{domainPrefix}.{domain}/{apiVersion}/{path}?{parameters}\n","lang":"https"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"https://api.test.ripple.com/v2/identities\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes each component of a complete API request:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"120px"}},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"180px"}},"children":["Example value"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Protocol"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ripple uses the HTTPS protocol for all APIs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Domain Prefix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.test"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Each base URL is prefixed by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api"]}," followed by an optional ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#base-url-by-api-environment"},"children":["API environment"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]},": This example uses the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.test"]}," environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Domain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ripple.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ","Ripple Payments"," API uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ripple.com"]}," as the domain."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The latest ","Ripple Payments"," API version is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/identities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The path is appended to the base URL to reach the endpoint for the API operation.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This example targets the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/identities"]}," endpoint."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url-for-ripple-payments-api","__idx":2},"children":["Base URL for ","Ripple Payments"," API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ","Ripple Payments"," API includes a domain prefix that consists of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.{environment}"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The production environment does not have an environment variable."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use ","Ripple Payments"," APIs in the following environments:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UAT"]}," : Simulated partners and simulated currency."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}," : Production environment with actual partners and currency."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url-by-api-environment","__idx":3},"children":["Base URL by API environment"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Tokens are unique per environment"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In addition to unique base URLs, access tokens are also unique per environment. Be sure to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/payments-direct-2/api-docs/best-practices/authentication#request-the-access-token"},"children":["request the access token"]}," for the desired environment."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"120px"}},"children":["Domain Prefix"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Domain"},"children":["Domain"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UAT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.test."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ripple.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.test.ripple.com/v2"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ripple.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ripple.com/v2"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The following examples use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uat"]}," environment."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"https","header":{"controls":{"copy":{}}},"source":"https://{domainPrefix}.{domain}/{path}?{parameters}\n\n# This is the URL format.\n","lang":"https"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"https","header":{"controls":{"copy":{}}},"source":"https://api.test.ripple.com/\n\n# This is the base URL for the UAT environment.\n","lang":"https"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"https","header":{"controls":{"copy":{}}},"source":"https://api.test.ripple.com/v2/identities\n\n# This connects to the UAT environment and requests a list of identities.\n","lang":"https"},"children":[]}]},"headings":[{"value":"Base URLs","id":"base-urls","depth":1},{"value":"Components of a base URL","id":"components-of-a-base-url","depth":2},{"value":"Base URL for Ripple Payments API","id":"base-url-for-ripple-payments-api","depth":2},{"value":"Base URL by API environment","id":"base-url-by-api-environment","depth":2}],"frontmatter":{"seo":{"title":"Base URLs"}},"lastModified":"2026-03-11T21:13:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/best-practices/base-urls","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}