Quickstart

You need an API key with the read and entries:write scopes, on a tenant with an NGN ledger. Use a test key on a sandbox tenant. These examples use curl, and set two variables first.

export PANOQORE_URL="https://api.sandbox.panoqore.example" # your API host
export PANOQORE_API_KEY="pk_test_..."

1. Check the key

curl "$PANOQORE_URL/v1/me" -H "Authorization: Bearer $PANOQORE_API_KEY"

The answer lists the key’s scopes and its tenant.

2. Open a settlement account

This account mirrors what your partner holds for you. The code decides its type: AST is an asset, and SET makes it a settlement account. Account codes are unique, so if AST:SET:NGN:SHV already exists on your tenant, use its id from GET /v1/accounts instead.

curl -X POST "$PANOQORE_URL/v1/accounts" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"AST:SET:NGN:SHV","name":"Safehaven settlement","currency":"NGN"}'

Keep the id from the answer. Below, it is $SETTLEMENT.

3. Open a customer wallet

LIA is a liability, because this money is owed to the customer, and WAL makes it a wallet. ownerRef is your own id for the customer.

curl -X POST "$PANOQORE_URL/v1/accounts" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"LIA:WAL:NGN:0001","name":"First wallet","currency":"NGN","ownerRef":"cust_1"}'

{
  "id": "acc_01M6F1BK8KE6JT32WRN50HYC4R",
  "code": "LIA:WAL:NGN:0001",
  "name": "First wallet",
  "type": "LIABILITY",
  "normalSide": "CREDIT",
  "currency": "NGN",
  "ownerRef": "cust_1",
  "status": "ACTIVE",
  "category": "WALLET",
  "balance": { "currency": "NGN", "posted": "0", "pending": "0", "available": "0", "asOf": "2026-11-02T21:06:31.319271Z" },
  "overdraftLimit": "0",
  "createdAt": "2026-11-02T21:06:31.315105Z",
  "updatedAt": "2026-11-02T21:06:31.315105Z"
}

Below, this id is $WALLET.

4. Post an entry

A customer paid in ₦5,000.00. Your settlement asset goes up, and so does what you owe the customer. Debits equal credits, so the entry balances.

curl -X POST "$PANOQORE_URL/v1/entries" \
  -H "Authorization: Bearer $PANOQORE_API_KEY" \
  -H "Idempotency-Key: deposit-1" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "TRANSFER_IN",
    "description": "Opening deposit",
    "externalRef": "deposit-1",
    "postings": [
      {"accountId": "'"$SETTLEMENT"'", "side": "DEBIT",  "amount": "500000", "currency": "NGN"},
      {"accountId": "'"$WALLET"'",     "side": "CREDIT", "amount": "500000", "currency": "NGN"}
    ]
  }'

The answer is the entry, with "status": "POSTED" and both postings. If the request times out, send it again with the same Idempotency-Key: see Idempotency.

5. Read the balance

curl "$PANOQORE_URL/v1/accounts/$WALLET/balance" -H "Authorization: Bearer $PANOQORE_API_KEY"

{
  "currency": "NGN",
  "posted": "500000",
  "pending": "0",
  "available": "500000",
  "version": "1",
  "asOf": "2026-11-02T21:06:31.743691Z"
}

Holds reserve money before a payout.
Named accounts turn partner credits into wallet credits.
Webhooks tell your product when something posts.

Get started

Using the API

Concepts

Guides

1. Check the key

2. Open a settlement account

3. Open a customer wallet

4. Post an entry

5. Read the balance

Next

​1. Check the key

​2. Open a settlement account

​3. Open a customer wallet

​4. Post an entry

​5. Read the balance

​Next

1. Check the key

2. Open a settlement account

3. Open a customer wallet

4. Post an entry

5. Read the balance

Next