Skip to main content
Creates a new consumer and funds their initial wallet in a single call. The initialFunds amount is deducted from your partner wallet balance.
POST /api/partner/v1/customer

Request headers

All standard authentication headers required. See the Authentication page.

Request body

  • fullName (string, required) — The consumer’s full name
  • email (string, required) — The consumer’s email address. Must be unique per partner.
  • currency (string, required) — ISO 4217 currency code, e.g. USD, EUR
  • initialFunds (number, required) — Amount to load into the consumer’s wallet on creation

Example request

curl -X POST https://partner.orbt.com/api/partner/v1/customer \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-06-03T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE" \
  -d '{
    "fullName": "Jane Smith",
    "email": "jane.smith@yourcompany.com",
    "currency": "USD",
    "initialFunds": 50.00
  }'

Success response (200)

{
  "success": true,
  "data": {
    "id": 101,
    "walletId": "101",
    "fullName": "Jane Smith",
    "email": "jane.smith@yourcompany.com",
    "walletBalance": 50.00,
    "currency": "USD"
  }
}

Error responses

  • 400 VALIDATION_ERROR — Consumer with this email already has a wallet in the requested currency
  • 402 BUSINESS_RULE_ERROR — Your partner wallet has insufficient funds to cover initialFunds
  • 403 Forbidden — Authentication failed. Check your credentials and signature.

List consumers

Returns a paginated list of all consumers you have created.
GET /api/partner/v1/customer

Query parameters

  • page (integer, optional) — Page number, zero-indexed. Default: 0
  • size (integer, optional) — Number of results per page. Default: 20, max: 50

Example request

curl -X GET "https://partner.orbt.com/api/partner/v1/customer?page=0&size=20" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-client-id: YOUR_CLIENT_ID" \
  -H "x-timestamp: 2026-06-03T10:00:00.000Z" \
  -H "x-body-hash: BODY_HASH" \
  -H "x-signature: SIGNATURE"

Success response (200)

{
  "content": [
    {
      "consumerId": 101,
      "consumerName": "Jane Smith",
      "consumerEmail": "jane.smith@yourcompany.com",
      "totalStandardWallets": 1,
      "totalCampaignWallets": 0
    }
  ],
  "page": 0,
  "size": 20,
  "hasNext": false
}

Error responses

  • 403 Forbidden — Authentication failed
  • 422 Unprocessable Entity — Invalid query parameters