---
title: "Terminate wallet"
method: DELETE
path: "/wallets/{wallet_id}"
tags: ["Wallets"]
---

# Terminate wallet

`DELETE /wallets/{wallet_id}`

## Request

- Base URL: `https://api-m.sandbox.paypal.com`
- URL: `https://api-m.sandbox.paypal.com/wallets/{wallet_id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/oauth-proxy` scopes: `read`, `write`
- TypeScript: <https://skmtc.dev/paypal/apis/usage-based-billing-api/docs/wallets/:wallet_id/delete.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `wallet_id` string, required

## Response `200`

Wallet terminated successfully

- WalletWithId
  - `external_customer_id` string, required: External system reference to the customer
  - `status` 'ACTIVE' | 'TERMINATED' | 'PENDING', required: Current status of the wallet
  - `available_balance` Amount
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `ongoing_usage` object: The ongoing usage of the wallet, and it reflects all current usage and draft invoices including taxes.
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `net_balance` object: This represents the real-time balance after accounting for current usage,.
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `name` string: Human-readable wallet name
  - `rate_amount` string, required: Price charged per credit unit
  - `available_credits` string: Current credit balance available
  - `ongoing_usage_credits` string: This reflects all current usage and draft invoices.
  - `net_balance_credits` string: This represents the real time balance after accounting for current usage.
  - `consumed_credits` string: Total credits consumed so far
  - `created_at` string, date-time: Date and time in ISO 8601 format.
  - `expiration_at` string, date-time: Date and time in ISO 8601 format.
  - `terminated_at` string, date-time: Date and time in ISO 8601 format.
  - `applies_to` PrepaidCreditAppliesTo: Indicates whether the prepaid credit applies to the entire invoice or only to specific line items.
    - `fee_types` FeeType[]
  - `recurring_transaction_rules` RecurringTransactionRule[]: List of recurring transaction rules for automatic top-ups
    - `trigger` 'INTERVAL' | 'THRESHOLD', required: Condition that triggers the recurring transaction rule
    - `paid_credits` string: Number of paid credits to be added when the rule is triggered. Must be a positive value
    - `granted_credits` string: Number of granted credits to be added when the rule is triggered. Must be a positive value
    - `method` 'FIXED' | 'TARGET', required: Method for recurring transaction execution
    - `interval` 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY': The billing cycle indicating how often the subscription is charged
    - `started_at` string, date-time: Date and time in ISO 8601 format.
    - `expiration_at` string, date-time: Date and time in ISO 8601 format.
    - `threshold_credits` string: Threshold of credits that triggers the recurring transaction rule.
    - `target_ongoing_balance` string: Target ongoing balance that triggers the recurring transaction rule.
  - `id` string: Unique identifier for the wallet

## Other responses

- `400`: Bad Request - Invalid input data
- `403`: Authorization failed due to insufficient permissions.
- `404`: Resource Not Found.
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)