PayPal · Schema

Capture Identifier

The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
invoice_id	string	The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
note_to_payer	string	An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/supplementary_purchase_data",
  "title": "Capture Identifier",
  "type": "object",
  "description": "The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.",
  "properties": {
    "invoice_id": {
      "description": "The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.",
      "type": "string",
      "maxLength": 127,
      "minLength": 1,
      "pattern": "^.{1,127}$"
    },
    "note_to_payer": {
      "type": "string",
      "description": "An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.",
      "maxLength": 255,
      "minLength": 1,
      "pattern": "^.{1,255}$"
    }
  }
}