1
0
Files
PayPal-PHP-Server-SDK/doc/models/order-capture-request-payment-source.md
Patrick Powers 504c367386 Release 0.7.0
Beta Release 0.7.0 including:

- Bug fixes
- Updated model/function names
- Updated models to reflect changes in APIs
2025-03-20 13:18:55 -05:00

4.2 KiB

Order Capture Request Payment Source

The payment source definition.

Structure

OrderCaptureRequestPaymentSource

Fields

Name Type Tags Description Getter Setter
card ?CardRequest Optional The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide. getCard(): ?CardRequest setCard(?CardRequest card): void
token ?Token Optional The tokenized payment source to fund a payment. getToken(): ?Token setToken(?Token token): void
paypal ?PaypalWallet Optional A resource that identifies a PayPal Wallet is used for payment. getPaypal(): ?PaypalWallet setPaypal(?PaypalWallet paypal): void
applePay ?ApplePayRequest Optional Information needed to pay using ApplePay. getApplePay(): ?ApplePayRequest setApplePay(?ApplePayRequest applePay): void
googlePay ?GooglePayRequest Optional Information needed to pay using Google Pay. getGooglePay(): ?GooglePayRequest setGooglePay(?GooglePayRequest googlePay): void
venmo ?VenmoWalletRequest Optional Information needed to pay using Venmo. getVenmo(): ?VenmoWalletRequest setVenmo(?VenmoWalletRequest venmo): void

Example (as JSON)

{
  "card": {
    "name": "name6",
    "number": "number6",
    "expiry": "expiry4",
    "security_code": "security_code8",
    "billing_address": {
      "address_line_1": "address_line_12",
      "address_line_2": "address_line_28",
      "admin_area_2": "admin_area_28",
      "admin_area_1": "admin_area_14",
      "postal_code": "postal_code0",
      "country_code": "country_code8"
    }
  },
  "token": {
    "id": "id6",
    "type": "BILLING_AGREEMENT"
  },
  "paypal": {
    "vault_id": "vault_id0",
    "email_address": "email_address0",
    "name": {
      "given_name": "given_name2",
      "surname": "surname8"
    },
    "phone": {
      "phone_type": "OTHER",
      "phone_number": {
        "national_number": "national_number6"
      }
    },
    "birth_date": "birth_date8"
  },
  "apple_pay": {
    "id": "id0",
    "name": "name0",
    "email_address": "email_address8",
    "phone_number": {
      "national_number": "national_number6"
    },
    "decrypted_token": {
      "transaction_amount": {
        "currency_code": "currency_code6",
        "value": "value2"
      },
      "tokenized_card": {
        "name": "name4",
        "number": "number2",
        "expiry": "expiry2",
        "card_type": "CB_NATIONALE",
        "type": "UNKNOWN"
      },
      "device_manufacturer_id": "device_manufacturer_id6",
      "payment_data_type": "3DSECURE",
      "payment_data": {
        "cryptogram": "cryptogram6",
        "eci_indicator": "eci_indicator0",
        "emv_data": "emv_data0",
        "pin": "pin4"
      }
    }
  },
  "google_pay": {
    "name": "name8",
    "email_address": "email_address6",
    "phone_number": {
      "country_code": "country_code2",
      "national_number": "national_number6"
    },
    "card": {
      "name": "name6",
      "type": "UNKNOWN",
      "brand": "RUPAY",
      "billing_address": {
        "address_line_1": "address_line_12",
        "address_line_2": "address_line_28",
        "admin_area_2": "admin_area_28",
        "admin_area_1": "admin_area_14",
        "postal_code": "postal_code0",
        "country_code": "country_code8"
      }
    },
    "decrypted_token": {
      "message_id": "message_id0",
      "message_expiration": "message_expiration2",
      "payment_method": "CARD",
      "card": {
        "name": "name6",
        "number": "number6",
        "expiry": "expiry4",
        "last_digits": "last_digits0",
        "type": "UNKNOWN"
      },
      "authentication_method": "PAN_ONLY",
      "cryptogram": "cryptogram6",
      "eci_indicator": "eci_indicator0"
    }
  }
}