PApaypal
Wallets

Terminate wallet

delete/wallets/{wallet_id}

Request

Path parameters

wallet_idstring required

Wallet ID

Response

Wallet terminated successfully

external_customer_idstring required

External system reference to the customer

status'ACTIVE' | 'TERMINATED' | 'PENDING' required

Current status of the wallet

namestring

Human-readable wallet name

rate_amountstring required

Price charged per credit unit

available_creditsstring

Current credit balance available

ongoing_usage_creditsstring

This reflects all current usage and draft invoices.

net_balance_creditsstring

This represents the real time balance after accounting for current usage.

consumed_creditsstring

Total credits consumed so far

created_atstring date-time

Date and time in ISO 8601 format.

expiration_atstring date-time

Date and time in ISO 8601 format.

terminated_atstring date-time

Date and time in ISO 8601 format.

idstring

Unique identifier for the wallet

Example response

{
  "external_customer_id": "client-12345",
  "status": "ACTIVE",
  "available_balance": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "ongoing_usage": {
    "value": 100,
    "currency_code": "USD"
  },
  "net_balance": {
    "value": 50,
    "currency_code": "USD"
  },
  "name": "Prepaid Wallet",
  "rate_amount": "1.5",
  "available_credits": "28.0",
  "ongoing_usage_credits": "10.0",
  "net_balance_credits": "18.0",
  "consumed_credits": "2.0",
  "created_at": "2023-10-01T12:00:00Z",
  "expiration_at": "2023-10-01T12:00:00Z",
  "terminated_at": "2023-10-01T12:00:00Z",
  "applies_to": {
    "fee_types": [
      "SUBSCRIPTION"
    ]
  },
  "recurring_transaction_rules": [
    {
      "trigger": "THRESHOLD",
      "paid_credits": "20.0",
      "granted_credits": "10.0",
      "method": "FIXED",
      "interval": "MONTHLY",
      "started_at": "2023-10-01T12:00:00Z",
      "expiration_at": "2023-10-01T12:00:00Z",
      "threshold_credits": "5.0",
      "target_ongoing_balance": "200.0"
    }
  ],
  "id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
}

Changes

No recorded changes to this operation across all 1 revision of this API.