PayPal · Schema

Card Stored Credential

Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
payment_initiator object
payment_type object
usage object
previous_network_transaction_reference object
View JSON Schema on GitHub

JSON Schema

paypal-card-stored-credential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/card_stored_credential",
  "title": "Card Stored Credential",
  "type": "object",
  "description": "Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).<br/>Parameter compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.</li><li>Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.</li></ul>",
  "properties": {
    "payment_initiator": {
      "$ref": "#/components/schemas/payment_initiator"
    },
    "payment_type": {
      "$ref": "#/components/schemas/stored_payment_source_payment_type"
    },
    "usage": {
      "$ref": "#/components/schemas/stored_payment_source_usage_type"
    },
    "previous_network_transaction_reference": {
      "$ref": "#/components/schemas/network_transaction_reference"
    }
  },
  "required": [
    "payment_initiator",
    "payment_type"
  ]
}