1
0
Files
PayPal-PHP-Server-SDK/doc/models/supplementary-data.md
Dani Kirby 6b43a4225b Beta Release 0.5.0 (#3)
* Automated commit message

* Automated commit message

* Automated commit message

* Automated commit message

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2024-09-09 12:10:34 -05:00

1.7 KiB

Supplementary Data

Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data.

Structure

SupplementaryData

Fields

Name Type Tags Description Getter Setter
card ?CardSupplementaryData Optional Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. getCard(): ?CardSupplementaryData setCard(?CardSupplementaryData card): void

Example (as JSON)

{
  "card": {
    "level_2": {
      "invoice_id": "invoice_id4",
      "tax_total": {
        "currency_code": "currency_code4",
        "value": "value0"
      }
    },
    "level_3": {
      "shipping_amount": {
        "currency_code": "currency_code0",
        "value": "value6"
      },
      "duty_amount": {
        "currency_code": "currency_code6",
        "value": "value2"
      },
      "discount_amount": {
        "currency_code": "currency_code2",
        "value": "value8"
      },
      "shipping_address": {
        "address_line_1": "address_line_10",
        "address_line_2": "address_line_20",
        "admin_area_2": "admin_area_24",
        "admin_area_1": "admin_area_16",
        "postal_code": "postal_code2",
        "country_code": "country_code0"
      },
      "ships_from_postal_code": "ships_from_postal_code4"
    }
  }
}