List & Get Wallets

---

List Wallets

Returns all wallets for your organization with pagination.

Endpoint

GET /api/v2/organizations/{org_id}/wallets

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
quantity	integer	No	Items per page (default: 25)

Request

curl "https://api.4pay.cc/api/v2/organizations/{org_id}/wallets?page=1&quantity=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

200 OK

{
  "data": [
    {
      "id": "8f3d0c3d-9f3e-4ef6-8fae-c3169025dfcb",
      "name": "Business Wallet",
      "balance": "1000.00",
      "currency": "USD",
      "status": "active",
      "cards": 5,
      "allowedCardTypes": ["virtual", "physical"],
      "createdAt": "2025-06-02T15:38:49+00:00",
      "updatedAt": "2025-06-02T15:38:49+00:00"
    }
  ],
  "pagination": {
    "quantity": 25,
    "totalQuantity": 1,
    "currentPage": 1,
    "pages": 1
  }
}

---

Get Wallet Details

Returns detailed information about a specific wallet including balances, fees, and BIN configurations.

Endpoint

GET /api/v2/organizations/{org_id}/wallets/{wallet_id}

Path Parameters

Parameter	Type	Required	Description
org_id	string	Yes	Your organization ID
wallet_id	string	Yes	Wallet UUID

Request

curl "https://api.4pay.cc/api/v2/organizations/{org_id}/wallets/{wallet_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

200 OK

{
  "data": {
    "id": "8f3d0c3d-9f3e-4ef6-8fae-c3169025dfcb",
    "name": "Business Wallet",
    "balance": "1000.00",
    "availableBalance": "950.00",
    "holdedBalance": "50.00",
    "currency": "USD",
    "status": "active",
    "cards": 5,
    "allowedCardTypes": ["virtual", "physical"],
    "isTransferAllowed": true,
    "fees": {
      "cardTransactions": {
        "type": "percent",
        "percent": "2.5",
        "inherited": false
      },
      "cardIssuing": {
        "type": "amount",
        "amount": "5.00",
        "currency": "USD",
        "inherited": true
      }
    },
    "createdAt": "2025-06-02T15:38:49+00:00",
    "updatedAt": "2025-06-02T15:38:49+00:00"
  }
}

Response Fields

Field	Type	Description
id	string	Wallet UUID
name	string	Wallet name
balance	string	Total balance
availableBalance	string	Spendable balance (after holds)
holdedBalance	string	Amount on hold
currency	string	Wallet currency (ISO 4217)
status	string	active or inactive
cards	integer	Number of cards issued from this wallet
allowedCardTypes	array	virtual, physical, or both
isTransferAllowed	boolean	Whether this wallet can send/receive transfers
fees.cardTransactions	object	Fee per card transaction
fees.cardIssuing	object	Fixed fee per card issuance
fees.*.inherited	boolean	true = using provider default, false = custom