Payoes
Log inSign up
Documentation

Learn, integrate, ship

Guides, a five-minute quickstart, and a full API reference for accepting USDC and XLM payments on Stellar.

QuickstartAPI reference

From zero to paid in five minutes

The quickstart walks you through the full loop on Stellar Testnet, with nothing at stake.

  1. 1

    Create a sandbox API key

    In the dashboard, go to Developers, then API Keys, and create a sandbox key. It uses the pk_test_ prefix and is shown only once.

  2. 2

    Create a payment

    One POST request returns a payment ID and a hosted checkout URL to share with your customer.

  3. 3

    Pay on Testnet

    Open the checkout URL, connect a Stellar Testnet wallet, and approve the transaction with test funds.

  4. 4

    Receive the webhook

    Payoes verifies the payment on-chain, marks it completed, and delivers a signed payment.completed event.

Create a sandbox payment

  1. 1

    Send the request

    POST to /api/v1/payments with an amount and a settlement asset, authorized by your pk_test_ key.

  2. 2

    Get a payment back

    The response returns a payment ID (pay_...), a pending status, and a hosted checkout_url.

  3. 3

    Share the checkout URL

    Send your customer there. Payoes handles wallet connection and on-chain verification.

Guides

Everything from core concepts to running Payoes on your own infrastructure.

Get started

  • Introduction What Payoes is and how the pieces fit together.
  • Quickstart Create your first payment on Stellar Testnet.

Core concepts

  • Concepts & object model Payments, sessions, links, invoices, and their IDs.
  • Authentication Bearer API keys and how scopes are enforced.
  • Environments Sandbox on Testnet, production on Mainnet.
  • Customers Organize payers and their payment history.

Payments

  • Checkout Hosted pages, wallet connection, and QR payments.
  • Settlement wallet Where your funds land and how to configure it.
  • Webhooks Signed events, retries, and signature verification.
  • Error handling Status codes and how to recover gracefully.

Self-hosting

  • Local setup Run the whole platform with Docker and Postgres.
  • Environment variables Every knob, documented.
  • Webhook retry worker Schedule the retry cron for reliable delivery.
  • KYC verification Wire up Persona for business verification.

API reference

Authenticate with a Bearer API key against /api/v1. Sandbox keys use pk_test_, production keys use pk_live_.

Payments

  • GET /payments
  • POST /payments
  • GET /payments/{id}

Customers

  • GET /customers
  • POST /customers
  • GET /customers/{id}

Checkout sessions

  • GET /checkout-sessions
  • GET /checkout-sessions/{id}

Payment links

  • GET /payment-links
  • POST /payment-links
  • GET /payment-links/{id}

Invoices

  • GET /invoices
  • POST /invoices
  • GET /invoices/{id}
  • POST /invoices/{id}/finalize

Full OpenAPI spec

Request and response schemas for every endpoint.

View on GitHub
Documentation

Ready to build?

Grab a sandbox key and make your first request in minutes.

Start for free
← Back to home