PayPal · Schema

Payment Instruction

Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
platform_fees array An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.
disbursement_mode object The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.
payee_pricing_tier_id string This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_i
payee_receivable_fx_rate_id string FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.
View JSON Schema on GitHub

JSON Schema

paypal-payment-instruction-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_instruction",
  "title": "Payment Instruction",
  "type": "object",
  "description": "Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.",
  "properties": {
    "platform_fees": {
      "type": "array",
      "description": "An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.",
      "minItems": 0,
      "maxItems": 1,
      "items": {
        "$ref": "#/components/schemas/platform_fee"
      }
    },
    "disbursement_mode": {
      "description": "The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.",
      "$ref": "#/components/schemas/disbursement_mode"
    },
    "payee_pricing_tier_id": {
      "type": "string",
      "description": "This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^.*$"
    },
    "payee_receivable_fx_rate_id": {
      "type": "string",
      "description": "FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.",
      "maxLength": 4000,
      "minLength": 1,
      "pattern": "^.*$"
    }
  }
}