Skip to content
Get started

Developer introduction

Your integration.
A clear starting point.

Read capabilities first. Build against the API version shown in your account. Never assume a payment operation is available because an endpoint exists.

Your workflow. Your code.

The building blocks.
Without the guesswork.

Start with your account’s capabilities. Use scoped credentials, handle asynchronous status, and keep the financial work on the server.

  • Scoped API credentials
  • Version-aware integration
  • Confirmed payment events
Developer introduction
capabilities.sh
# Check access before initiating payments

curl "https://api.teepay.me/v1/capabilities" \
  -H "Authorization: Bearer $TEEPAY_API_KEY"
Implemented read endpoint · use your server environment key
payment.completedConfirmed event example

Verify the signature. Handle retries. Process each event idempotently.

Start server-side.

  • Create a developer application in your TeePay account.
  • Issue credentials with only the scopes your integration needs.
  • Read GET /v1/capabilities before initiating financial operations.
  • Use the request schema and API version available in your account, and retain idempotency keys across retries.
Open developer workspace ↗

Expect asynchronous.

A submitted request is not necessarily a completed payment. Read authoritative status, verify webhook signatures against your configured signing secret, and deduplicate event deliveries.

The example uses an environment variable, not an issued API credential. This page is an introduction, not a complete mutation contract or a promise of live account activation.

View account API versions ↗