---
title: "Wallet transaction created."
method: POST
path: "usage-billing.wallet-transaction.created"
tags: ["Wallets"]
---

# Wallet transaction created.

`POST usage-billing.wallet-transaction.created` (webhook)

Webhook for wallet transaction creation.

## Headers

- `paypal-transmission-id` string
- `paypal-transmission-time` string

## Payload

- object
  - `id` string, required: Unique identifier for the webhook event.
  - `create_time` string, date-time, required: Date and time in ISO 8601 format.
  - `event_version` string: Version of the event schema.
  - `summary` string: Brief description of the event.
  - `resource_version` string: Version of the resource schema.
  - `links` Link[]: HATEOAS links for the webhook event.
    - `href` string, uri, required: URL for the action.
    - `rel` string, required: Relation type of the link.
    - `method` string, required: HTTP method to use with the URL.
  - `resource_type` 'subscription-alert' | 'wallet' | 'wallet-transaction' | 'credit-note' | 'invoice' | 'subscription', required: Type of resource that triggered the webhook.
  - `event_type` 'USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED' | 'USAGE-BILLING.WALLET.CREATED' | 'USAGE-BILLING.WALLET.UPDATED' | 'USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED' | 'USAGE-BILLING.WALLET.TERMINATED' | 'USAGE-BILLING.WALLET-TRANSACTION.CREATED' | 'USAGE-BILLING.WALLET-TRANSACTION.UPDATED' | 'USAGE-BILLING.CREDIT-NOTE.CREATED' | 'USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED' | 'USAGE-BILLING.INVOICE.CREATED' | 'USAGE-BILLING.INVOICE.PAYMENT.OVERDUE' | 'USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED' | 'USAGE-BILLING.INVOICE.PAYMENT.FAILED' | 'USAGE-BILLING.SUBSCRIPTION.UPDATED' | 'USAGE-BILLING.SUBSCRIPTION.TERMINATED' | 'USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED', required: Type of event that occurred in webhooks.
  - `resource` WalletWithId, required
    - `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

## Acknowledgement `204`

Return a 204 status to indicate that the data was received successfully.

---

[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)