Quickstart

This guide takes you from zero to a completed sandbox payin. You need a KryptaPay merchant account with KYB approved — see Verification and compliance.

Create a sandbox API key

In the dashboard, open Developers → API keys and create a key with the Sandbox environment.Copy the secret (kp_sandbox_…) right away: it is shown only once. Keep it on your server — never in a browser or mobile app.

export KRYPTAPAY_API_KEY="kp_sandbox_..."

Check your key

List your wallets. A 200 response means your key works.

curl https://staging.api.krypta-pay.com/v1/wallets \
  -H "Authorization: Bearer $KRYPTAPAY_API_KEY"

{
  "ok": true,
  "data": {
    "items": [
      { "id": "cmgx2k1qv0002s60f1a9b8c7d", "kind": "FIAT", "currency": "XOF", "balance": "0", "reserved": "0", "available": "0" }
    ]
  }
}

Collect a payment

Charge a Mobile Money customer. In production they receive a payment prompt on their phone; in sandbox the payment is simulated and no one is charged.

curl https://staging.api.krypta-pay.com/v1/payins/checkout \
  -H "Authorization: Bearer $KRYPTAPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "5000",
    "currency": "XOF",
    "network": "MTN_BJ",
    "customer": { "fullName": "Awa Koné", "msisdn": "22997000000" }
  }'

{
  "ok": true,
  "data": {
    "reference": "tx_3Jk9QwErTy7uIoPa2Sd",
    "status": "COMPLETED",
    "amount": "5000",
    "currency": "XOF",
    "checkoutUrl": null,
    "expiresInSec": 1800
  }
}

Store the reference: it identifies this payment in webhooks and lookups.

Sandbox payments complete instantly. In production the same call returns PENDING, and the final status arrives a few seconds to minutes later, once the customer approves. See Collect payments for operators that need a redirect or a code.

Get the result

Add a sandbox webhook endpoint in Developers → Webhooks subscribed to PAYIN_RECEIVED and PAYIN_FAILED, then repeat the previous step. KryptaPay calls your endpoint when the payment settles — see Webhooks to verify the signature.You can also check the status at any time:

curl https://staging.api.krypta-pay.com/v1/payins/tx_3Jk9QwErTy7uIoPa2Sd \
  -H "Authorization: Bearer $KRYPTAPAY_API_KEY"

In production, once status is COMPLETED the amount minus fees is credited to your wallet.

Next steps

Send a payout

Pay a recipient from your wallet.

Handle errors

Error format and codes to branch on.

Go live

Checklist before switching to production.

API reference

Every endpoint and field.

Get started

Essentials

Guides

Go live

Next steps

Send a payout

Handle errors

Go live

API reference

​Next steps

Send a payout

Handle errors

Go live

API reference

Next steps