PayPal · Schema

Money

The currency and amount for a financial transaction, such as a balance or payment due.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
currency_code object
value string The value, which might be:
  • An integer for currencies like `JPY` that are not typically fractional.
  • A decimal fraction for currencies like `TND` that are subdivided into thousandths.
View JSON Schema on GitHub

JSON Schema

paypal-money-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/money",
  "title": "Money",
  "type": "object",
  "description": "The currency and amount for a financial transaction, such as a balance or payment due.",
  "properties": {
    "currency_code": {
      "$ref": "#/components/schemas/currency_code"
    },
    "value": {
      "type": "string",
      "description": "The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).",
      "maxLength": 32,
      "pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$"
    }
  },
  "required": [
    "currency_code",
    "value"
  ]
}