Skip to main content

Getting Started

This guide gets you from zero to your first transaction in a few minutes.

1. Get API credentials​

Create API keys from the Peak Gateway dashboard:

  • Test key for sandbox transactions
  • Live key for production processing

Keep keys server-side and never expose them in frontend code.

2. Install an SDK​

TypeScript​

npm install @peakgateway/sdk

Kotlin / Android​

Use:

  • gateway-sdk-android
  • gateway-sdk-core

from the sdks/ workspace packages.

3. Create your first transaction​

curl -X POST "https://api.peakgateway.co/v1/transactions" \
  -H "Authorization: Bearer <YOUR_TEST_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2500,
    "currency": "USD",
    "capture": false,
    "reference": "order_1001"
  }'

4. Confirm and capture​

Use the transaction ID from the create response to retrieve and optionally capture funds:

  • GET /v1/transactions/:id
  • POST /v1/transactions/:id/capture

Next steps​

  • Configure webhooks for async state changes
  • Add subscriptions for recurring billing
  • Reconcile settlement batches daily