Skip to main content

Properties

PropertyTypeRequiredDescription
typestringYesPayment method type (e.g., apple_pay)
capabilitiesobjectYesWhat this payment method supports
availabilityobjectYesWhether this payment method is currently available

Capabilities

PropertyTypeRequiredDescription
supportedCurrenciesstring[]YesCurrencies supported (e.g., ["USD", "EUR"])
supportedTransactionTypesstring[]YesTransaction types supported (e.g., ["buy", "sell"])

Availability

PropertyTypeRequiredDescription
activebooleanYesWhether the payment method is currently available
unavailableReasonstringNoReason for unavailability, if applicable

Payment Method Types

TypeDescription
apple_payApple Pay

Example

{
  "type": "apple_pay",
  "capabilities": {
    "supportedCurrencies": ["USD", "EUR", "GBP"],
    "supportedTransactionTypes": ["buy"]
  },
  "availability": {
    "active": true
  }
}

Checking Availability

Always check availability.active before offering a payment method to users. If active is false, check unavailableReason for details:
{
  "type": "apple_pay",
  "capabilities": {
    "supportedCurrencies": ["USD"],
    "supportedTransactionTypes": ["buy"]
  },
  "availability": {
    "active": false,
    "unavailableReason": "Payment method is in maintenance"
  }
}