Quickstart

You will create an API key, ask for 10 XLM, pay it on the Stellar testnet and see your application credited. Everything here runs in the sandbox, so no real money moves.

Create an account and an application

Sign up at dashboard.useroutr.com, verify your email and create your first application. An application is the product or service that receives the funding.

Create a test API key

In the dashboard, open Developers → API keys and create a key. It starts with ur_test_, which points the SDK at the sandbox. The secret is shown once, so store it now.

.env

USEROUTR_API_KEY=ur_test_...

An API key belongs on your server. Never ship it to a browser or a mobile app.

Install the SDK

npm install @useroutr/sdk

pnpm add @useroutr/sdk

yarn add @useroutr/sdk

bun add @useroutr/sdk

The SDK needs Node.js 20 or later.

Choose where funds settle

Settled value goes to a Stellar account you control. For this test, create a testnet account in Stellar Lab and fund it with Friendbot, then set its address as the default destination in Settings → Default destination. You can also pass a destination on each funding intent instead.

Create a funding intent

A funding intent asks for an exact amount of an exact asset. The idempotency key makes the call safe to retry: send the same key again and you get the same intent back.

create-intent.ts

import { Useroutr } from "@useroutr/sdk";

const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY });

const intent = await useroutr.fundingIntents.create(
  { amount: "10", asset: "asset_xlm_stellar", reference: "quickstart-1" },
  { idempotencyKey: "quickstart-1" },
);

console.log(intent.id, intent.status);
console.log(intent.hosted_funding_url);

The intent starts CREATED and becomes AWAITING_PAYMENT within seconds, once it is registered on the Useroutr protocol.

Pay it

Open hosted_funding_url and follow the checkout, or pay directly: the intent’s funding_instructions name a deposit account created for this intent alone and the exact amount. Send 10 testnet XLM to funding_instructions.deposit.address from any testnet wallet. No memo is needed.

See it credited

Useroutr detects the payment, verifies it, settles it and posts one credit to your ledger. Poll the intent until it reaches CREDITED, or better, receive a webhook.

const current = await useroutr.fundingIntents.retrieve(intent.id);
console.log(current.status); // "CREDITED"

The payment, the settlement and the credit are all visible in the dashboard too.

What you just proved

The whole path works: a request for value, a payment on chain, a verified settlement and exactly one credit. Everything else builds on this.

Embed the checkout

Take the payment inside your app with the React component.

Handle webhooks

Fulfil orders the moment a funding intent is credited.

Get started

Accept payments

Concepts

After a payment

Integrate

What you just proved

Embed the checkout

Handle webhooks

​What you just proved

Embed the checkout

Handle webhooks

What you just proved