{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api-docs/getting-started/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Getting started

\n

Before you start the process of integrating with the Ripple Payments Direct 2.0 API, you need to address the following items:

\n\n

GitHub repository

\n

The official Payments Direct 2.0 GitHub repository is the single source of truth for everything you need to integrate with Payments Direct 2.0:

\n\n

See the repository README for installation instructions and usage examples.

\n

Tooling

\n

To prepare for integrating with the Ripple Payments Direct 2.0 API:

\n\n

User creation

\n

To set up accounts for developers, your organization administrator must:

\n
    \n
  1. \nAccess the \nRipple Payments UI\n.\n
    2. \n
  2. \nNavigate to \nSettings\n and then select \nUsers\n.\n
    3. \n
  3. \nSelect \nNew User\n.\n
    4. \n
  4. \nCheck \nCan Read\n API Credentials permission.\n
    5. \n
  5. \nCheck \nCan Edit\n API Credentials permission.\n
    6. \n
  6. \nSave the user and repeat the process for each developer on the team.\n
    7. \n
\n

API credentials

\n

To set up API credentials, each developer must:

\n
    \n
  1. \nAccess the \nRipple Payments UI\n, click \nSettings\n, and then click \nAPI Credentials\n in the Integration section.\n
    2. \n
  2. \nClick \nNew Credential\n.\n
    3. \n
  3. \nEnter a name for your new credential.\n
    4. \n
  4. \nClick \nSave & Generate Key\n.\n
    5. \n
  5. \nCopy the credential and store it in a secure location to use for API calls.\n
    6. \n
  6. \nTo finish credential creation, click \nClose\n.\n
    7. \n
","headings":[{"value":"Getting started","depth":1},{"value":"GitHub repository","depth":2},{"value":"Tooling","depth":2},{"value":"User creation","depth":2},{"value":"API credentials","depth":2}]},"contentItem":{"data":{"lastModified":"2025-11-13T00:24:58.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":true,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"b4c4b464-d12c-590e-8b87-8d48fad4c6be__redocly content/api-docs/getting-started/","seo":{"title":"Getting started","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api-docs/getting-started.md","pageBaseUrl":"/api-docs/getting-started","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Getting started","id":"getting-started"},{"depth":2,"value":"GitHub repository","id":"github-repository"},{"depth":2,"value":"Tooling","id":"tooling"},{"depth":2,"value":"User creation","id":"user-creation"},{"depth":2,"value":"API credentials","id":"api-credentials"}]},"data":{"title":""},"catalogInfo":null,"link":"/api-docs/getting-started/","sidebarName":"__root-sidebar__-data-69308394-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}