Skip to main content

Endpoint

GET /wallets/all

Description

Use this endpoint to fetch all wallets associated with your account. Filters can be applied to narrow results based on customer or wallet attributes.

Query Parameters (Filters)

ParameterTypeDescription
customer_idstring (UUID)Filter wallets by customer
currencystringFilter wallets by currency (e.g. NGN, USD)
statusstringFilter wallets by status (active, frozen, deleted)

Example cURL Request

curl -X GET "https://api.spendjuice.com/wallets/all?currency=NGN&status=active" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

Success Response (200 OK)

{
  "data": [
    {
      "id": "wallet_id",
      "customer_id": "customer_id",
      "currency": "NGN",
      "status": "active",
      "balance": {
        "amount": 1500,
        "currency": "NGN"
      }
    }
  ]
}

List Wallet Transactions

This endpoint retrieves a list of wallet transactions. You can filter transactions by wallet or transaction type.

Endpoint

GET /wallets/transactions

Description

Use this endpoint to list all transactions across wallets or to retrieve transactions for a specific wallet.

Query Parameters (Filters)

ParameterTypeDescription
wallet_idstring (UUID)Filter transactions by wallet
typestringFilter by transaction type (debit, credit)

Example cURL Request

curl -X GET "https://api.spendjuice.com/wallets/transactions?wallet_id=wallet_id&type=debit" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

Success Response (200 OK)

{
  "data": [
    {
      "id": "transaction_id",
      "wallet_id": "wallet_id",
      "type": "debit",
      "amount": 500,
      "description": "Customer payout",
      "created_at": "2025-07-24T10:15:30Z"
    }
  ]
}

Retrieve a Transaction

This endpoint retrieves the details of a single wallet transaction by its ID.

Endpoint

GET /wallets/transactions/{id}

Description

Use this endpoint to fetch full details of a specific transaction, including amount, type, and timestamps.

Path Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesUnique transaction identifier

Example cURL Request

curl -X GET "https://api.spendjuice.com/wallets/transactions/{id}" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

Success Response (200 OK)

{
  "data": {
    "id": "transaction_id",
    "wallet_id": "wallet_id",
    "type": "credit",
    "amount": 1000,
    "description": "Wallet top-up",
    "created_at": "2025-07-24T09:45:00Z"
  }
}

Common Errors

Status CodeDescription
401Unauthorized
404Resource not found
400Invalid request parameters

Notes & Best Practices

  • Use filters to reduce payload size and improve performance.
  • Always verify wallet status before initiating related actions.
  • Paginate responses if supported to handle large result sets.
  • Use transaction IDs for reconciliation and audit purposes.