PayPal · Schema

Currency

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

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
currency	string	The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/).
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/currency",
  "title": "Currency",
  "type": "object",
  "description": "The currency and amount for a financial transaction, such as a balance or payment due.",
  "properties": {
    "currency": {
      "type": "string",
      "description": "The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/)."
    },
    "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 - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)."
    }
  },
  "required": [
    "currency",
    "value"
  ]
}