PayPal Connector Objects (REST Schema)

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name	Description
AuthorizationDetails	Query details about Authorizations.
Balances	List all non crypto balances.
CaptureDetails	Query details about a captured Payment.
CreditCardDetails	Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.
CryptoBalances	List all crypto balances.
DisputeDetails	PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
Disputes	PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
DisputeTransactions	PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
Invoices	Query Invoices in PayPal.
Notifications	Query the list of event types that are subscribed to a Webhook.
OrderDetails	Query details about an Order.
OrderItems	Get the items in an Order.
Payments	Query details about authorized Payments.
PaymentTokens	Lists merchant-created templates with associated details.
PaymentTransactions	Query Transaction details including the amount and item details.
PayoutDetails	Retrieve details about Payouts.
PayoutItems	Retrieve payout items from a Payout.
Plans	List the Billing Plans.
RefundDetails	Query details about a specific Refund.
SaleDetails	Query details about a Sale Transaction.
Subscriptions	Get billing and subscription details.
SubscriptionTransactions	Lists transactions for a subscription.
Templates	Lists merchant-created templates with associated details.
TransactionReports	Lists transaction reports.
TransactionReportsCartInfoItemDetails	List Cart Info of Transaction Reports.
TransactionReportsIncentiveDetails	List Incentive Details of Transaction Reports.
UserInfo	Shows OpenID Connect user profile information for standard claims.
Webhooks	Query the list of Webhooks.

AuthorizationDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the authorized payment.
Status	String	False	No	The status for the authorized payment.
StatusDetails	String	False	No	The details of the authorized order pending status.
AmountTotal	Decimal	False	No	The amount for this authorized payment.
AmountCurrency	String	False	No	The currency of the amount.
InvoiceId	String	False	No	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.
CustomId	String	False	No	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus	String	False	No	The level of protection offered as defined by PayPal Seller Protection for Merchants.
ExpirationTime	Datetime	False	No	The amount being charged for the handling fee. Only supported when the payment method is set to paypal.
CreateTime	Datetime	False	No	The time of authorization.
UpdateTime	Datetime	False	No	The time that the resource was last updated.

Return to Top

Balances

Name	Type	ReadOnly	FilterOnly	Description
Currency [KEY]	String	True	No	Currency Code of the balances listed.
AccountId	String	True	No	The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
AvailableBalanceCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
AvailableBalanceValue	String	True	No	The value, which might be an integer or a decimal.
Primary	Boolean	True	No	Optional field representing if the currency is primary currency or not.
TotalBalanceCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
TotalBalanceValue	Decimal	True	No	The value, which might be:An integer or A decimal.
WithheldBalanceCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
WithheldBalanceValue	String	True	No	The value, which might be:An integer or A decimal.
AsOfTime	Datetime	True	No	The requested date and time or the last date and time when the balances can be served.
LastRefreshTime	Datetime	True	No	The date and time when the balances was last refreshed.

Return to Top

CaptureDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the captured payment.
Status	String	False	No	The status of the captured payment.
StatusDetails	String	False	No	The details of the captured payment status.
AmountValue	Decimal	False	No	The amount for this captured payment.
AmountCurrency	String	False	No	The currency of the amount for this captured payment.
InvoiceId	String	False	No	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.
CustomId	String	False	No	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus	String	False	No	The level of protection offered as defined by PayPal Seller Protection for Merchants.
FinalCapture	Boolean	False	No	Indicates whether you can make additional captures against the authorized payment.
DisbursementMode	String	False	No	The funds that are held on behalf of the merchant.
SellerGrossAmount	Decimal	False	No	The amount for this captured payment.
SellerPaypalFee	Decimal	False	No	The applicable fee for this captured payment.
SellerNetAmount	Decimal	False	No	The net amount that the payee receives for this captured payment in their PayPal account.
SellerReceivableAmount	Decimal	False	No	The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
SellerExchangeRate	Decimal	False	No	The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
CreateTime	Datetime	False	No	The time of authorization.
UpdateTime	Datetime	False	No	The time that the resource was last updated.

Return to Top

CreditCardDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The Id of the credit card.
Number	String	False	No	The redacted credit card number.
Type	String	False	No	The credit card type. Valid types are: visa, mastercard, discover, amex.
ExpireMonth	Integer	False	No	The expiration month with no leading zero. Acceptable values are 1 through 12.
ExpireYear	Integer	False	No	The 4-digit expiration year.
FirstName	String	False	No	The first name of the cardholder.
LastName	String	False	No	The last name of the cardholder.
AddressLine1	String	False	No	The billing address associated with card. Line 1 of the address (e.g., number, street, etc.).
AddressLine2	String	False	No	The optional line 2 of the Address (e.g., suite, apt number, etc.).
City	String	False	No	The city name.
CountryCode	String	False	No	The 2-letter country code.
PostalCode	String	False	No	The ZIP code or equivalent is usually required for countries that have them.
Phone	String	False	No	The phone number in E.123 format.
ExternalCustomerId	String	False	No	The unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator.
MerchantId	String	False	No	The user-provided, optional field that functions as a unique identifier for the merchant holding the card. Note that this has no relation to PayPal merchant Id.
ExternalCardId	String	False	No	The unique identifier of the bank account resource. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant.
CreateTime	Datetime	False	No	The resource creation time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z).
UpdateTime	Datetime	False	No	The resource update time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z).
State	String	False	No	The state of the credit card funding instrument: expired or ok.
ValidUntil	Datetime	False	No	The funding instrument expiration date.

Return to Top

CryptoBalances

Name	Type	ReadOnly	FilterOnly	Description
AssetSymbol [KEY]	String	True	No	The Cryptocurrency ticker symbol / code as assigned by liquidity providers.
AccountId	String	True	No	The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
Quantity	Decimal	True	No	Quantity of a cryptocurrency asset.
AsOfTime	Datetime	True	No	The requested date and time or the last date and time when the balances can be served.
LastRefreshTime	Datetime	True	No	The date and time when the balances were last refreshed.

Return to Top

DisputeDetails

Name	Type	ReadOnly	FilterOnly	Description
DisputeId [KEY]	String	False	No	The ID of the dispute.
CreatedTime	Datetime	False	No	The date and time when the dispute was created.
UpdatedTime	Datetime	False	No	The date and time when the dispute was updated.
Status	String	False	No	The status of the dispute.
Reason	String	False	No	The reason for the item-level dispute.
DisputeState	String	False	No	The state of the dispute.
DisputeCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue	Decimal	False	No	The value of the amount.
ExternalReasonCode	String	False	No	The code that identifies the reason for the credit card chargeback.
DisputeOutcomeCode	String	False	No	The outcome of a resolved dispute.
DisputeOutcomeAmountRefundedCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
DisputeOutcomeAmountRefundedValue	Decimal	False	No	The value of the amount.
DisputeLifecycleStage	String	False	No	The stage in the dispute lifecycle.
DisputeChannel	String	False	No	The channel where the customer created the dispute.
OfferType	String	False	No	The merchant-proposed offer type for the dispute.
BuyerRequestedAmountCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
BuyerRequestedAmountValue	Decimal	False	No	The value of the amount.
BuyerResponseDueDate	Datetime	False	No	The date and time by when the customer must respond to the dispute.
SellerOfferedAmountCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
SellerOfferedAmountValue	Decimal	False	No	The value of the amount.
SellerResponseDueDate	Datetime	False	No	The date and time by when the seller must respond to the dispute.
Email	String	False	No	The email address that is provided by the merchant where the customer can share the evidences.
Note	String	False	No	The merchant provided notes that are visible to both the customer and PayPal.
TimePosted	Datetime	False	No	The date and time when the contact details were posted.
DisputeAssetSymbol	String	False	No	The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeAssetQuantity	String	False	No	The quantity of a cryptocurrency asset.
DisputeAssetQuantityInSubunits	String	False	No	The quantity of a cryptocurrency asset in the currency's sub units.
DisputeOutcomeAssetRefundedSymbol	String	False	No	The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeOutcomeAssetRefundedQuantity	Decimal	False	No	The quantity of a cryptocurrency asset.
RefundAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
RefundAmountValue	Decimal	False	No	The maximum refundable amount.

Return to Top

Disputes

Name	Type	ReadOnly	FilterOnly	Description
DisputeId [KEY]	String	False	No	The ID of the dispute.
CreatedTime	Datetime	False	No	The date and time when the dispute was created.
UpdatedTime	Datetime	False	No	The date and time when the dispute was updated.
Status	String	False	No	The status of the dispute.
Reason	String	False	No	The reason for the item-level dispute.
DisputeState	String	False	No	The state of the dispute.
DisputeCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue	Decimal	False	No	The value of the amount.
DisputeLifecycleStage	String	False	No	The stage in the dispute lifecycle.
DisputeChannel	String	False	No	The channel where the customer created the dispute.
BuyerResponseDueDate	Datetime	False	No	The date and time by when the customer must respond to the dispute.
SellerResponseDueDate	Datetime	False	No	The date and time by when the seller must respond to the dispute.

Return to Top

DisputeTransactions

Name	Type	ReadOnly	FilterOnly	Description
DisputeId [KEY]	String	False	No	The ID of the dispute.
CreatedTime	Datetime	False	No	The date and time when the transaction was created.
TransactionStatus	String	False	No	The transaction status.
GrossAmountCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
GrossAmountValue	Decimal	False	No	The value of the amount.
BuyerName	String	False	No	The customer's name.
BuyerTransactionId	String	False	No	The customer's transaction ID.
SellerEmail	String	False	No	The email address for the merchant's PayPal account.
SellerMerchantId	String	False	No	The PayPal account ID for the merchant.
SellerTransactionId	String	False	No	The ID, as seen by the merchant, for this transaction.
SellerName	String	False	No	The name of the merchant.
SellerProtectionEligible	Boolean	False	No	Indicator if the seller is eligible for protection.
Custom	String	False	No	A free-text field that is entered by the merchant during checkout.
InvoiceNumber	String	False	No	The ID of the invoice for the payment.
ReferenceId	String	False	No	The ID, as seen by the partner, for this transaction.

Return to Top

Invoices

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The ID of the invoice.
ParentId	String	False	No	The parent ID to an invoice that defines the group invoice to which the invoice is related.
Status	String	False	No	The status of the invoice.
Reference	String	False	No	The reference data. Includes a post office (PO) number.
Currency	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
Note	String	False	No	A note to the invoice recipient. Also appears on the invoice notification email.
TermsAndConditions	String	False	No	The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
Memo	String	False	No	A private bookkeeping memo for the user.
InvoiceDate	Datetime	False	No	The invoice date as specificed by the sender, in Internet date and time format.
InvoiceNumber	String	False	No	A private bookkeeping memo for the user.
TermType	String	False	No	The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
DueDate	Datetime	False	No	The date when the invoice payment is due, in Internet date and time format.
DueAmount	Decimal	False	No	The due amount, which is the balance amount outstanding after payments.
Gratuity	Decimal	False	No	The amount paid by the payer as gratuity to the invoicer.
PaidAmount	Decimal	False	No	The aggregated payment amounts against this invoice.
RefundAmount	Decimal	False	No	The aggregated refund amounts.
CreatedTime	Datetime	False	No	The date and time when the resource was created, in Internet date and time format.
CreatedBy	String	False	No	The email address of the account that created the resource.
LastUpdatedTime	Datetime	False	No	The date and time when the resource was last edited, in Internet date and time format.
LastUpdatedBy	String	False	No	The email address of the account that last edited the resource.
CancelTime	Datetime	False	No	The date and time when the resource was canceled, in Internet date and time format.
CancelledBy	String	False	No	The actor who canceled the resource.
FirstSentTime	Datetime	False	No	The date and time when the resource was first sent, in Internet date and time format.
LastSentTime	Datetime	False	No	The date and time when the resource was last sent, in Internet date and time format.
LastSentBy	String	False	No	The email address of the account that last sent the resource.
CreatedByFlow	String	False	No	The flow variation that created this invoice.
RecipientViewUrl	String	False	No	The URL for the invoice payer view hosted on paypal.com.
InvoicerViewUrl	String	False	No	The URL for the invoice merchant view hosted on paypal.com.
InvoicerBusinessName	String	False	No	The business name of the party.
InvoicerPrefixName	String	False	No	The prefix, or title, to the party's name.
InvoicerFirstName	String	False	No	When the party is a person, the party's given, or first, name.
InvoicerMiddleName	String	False	No	When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
InvoicerLastName	String	False	No	When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person.
InvoicerSuffixName	String	False	No	The suffix for the party's name.
InvoicerFullName	String	False	No	When the party is a person, the party's full name.
InvoicerAddressLine1	String	False	No	The first line of the address. For example, number or street.
InvoicerAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
InvoicerAddressLine3	String	False	No	The third line of the address, if needed.
InvoicerAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
InvoicerAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
InvoicerAddressStreetNumber	String	False	No	The street number.
InvoicerAddressStreetName	String	False	No	The street name. Just Drury in Drury Lane.
InvoicerAddressStreetType	String	False	No	The street type. For example, avenue, boulevard, road, or expressway.
InvoicerAddressDeliveryService	String	False	No	The delivery service. Post office box, bag number, or post office name.
InvoicerAddressBuildingName	String	False	No	A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number.
InvoicerAddressSubBuilding	String	False	No	The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name.
InvoicerEmail	String	False	No	The invoicer email address, which must be listed in the user's PayPal profile.
InvoicerWebsite	String	False	No	The invoicer's website.
InvoicerTaxId	String	False	No	The invoicer's tax ID.
InvoicerAdditionalNotes	String	False	No	Any additional information. Includes business hours.
InvoicerLogoUrl	String	False	No	The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
TaxCalculatedAfterDiscount	Boolean	False	No	Indicates whether the tax is calculated before or after a discount.
TaxInclusive	Boolean	False	No	Indicates whether the unit price includes tax.
AllowTip	Boolean	False	No	Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateId	String	False	No	The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
AllowPartialPayment	Boolean	False	No	Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
MinimumAmountDue	String	False	No	The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
InvoiceAmount	Decimal	False	No	The invoice amount summary of item total, discount, tax total and shipping.
InvoiceCurrency	String	False	No	The invoice amount summary of item total, discount, tax total and shipping.
ItemTotal	Decimal	False	No	The subtotal for all items. Must equal the sum of (quantity * price) for all items.
InvoiceDiscountPercentage	String	False	No	The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
InvoiceDiscountValue	Decimal	False	No	The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
ItemDiscountValue	Decimal	False	No	The discount as an amount at item level.
TaxTotal	Decimal	False	No	The aggregated amount of the item and shipping taxes.
ShippingAmount	Decimal	False	No	The shipping fee for all items. Includes tax on shipping.
ShippingTaxAmount	Decimal	False	No	The calculated tax amount. The tax amount is added to the item total.
ShippingTaxPercentage	String	False	No	The tax rate. Value is from 0 to 100. Supports up to five decimal places.
ShippingTaxName	String	False	No	The name of the tax applied on the invoice items.
DueAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
GratuityCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
PaidAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
RefundAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
MinimumAmountDueCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ItemTotalCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
InvoiceDiscountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ItemDiscountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ShippingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ShippingTaxAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.

Return to Top

Notifications

Name	Type	ReadOnly	FilterOnly	Description
Name	String	False	No	The unique event type name.
Description	String	False	No	The human-readable description of the event type.
WebhookId	String	False	No	Webhook Id.

Return to Top

OrderDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The ID of the order.
Status	String	False	No	The order status. The possible values are: CREATED, SAVED, APPROVED, VOIDED, COMPLETED.
Intent	String	False	No	The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are: CAPTURE, AUTHORIZE.
CreatedTime	Datetime	False	No	The date and time when the transaction occurred.
UpdatedTime	Datetime	False	No	The date and time when the transaction was last updated.
PayerId	String	False	No	The ID of the customer who approves and pays for the order. The customer is also known as the payer.
PayerGivenName	String	False	No	The name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerSurname	String	False	No	The last name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerEmail	String	False	No	The email of the customer who approves and pays for the order. The customer is also known as the payer.
PayerPhoneType	String	False	No	The phone type.
PayerPhoneNumber	String	False	No	The phone number, in its canonical international E.164 numbering plan format.
PayerBirthDate	String	False	No	The birth date of the payer in YYYY-MM-DD format.
PayerTaxId	String	False	No	The customer's tax ID. Supported for the PayPal payment method only.
PayerTaxType	String	False	No	The customer's tax ID type. Supported for the PayPal payment method only.
PayerAddressLine1	String	False	No	The first line of the address. For example, number or street.
PayerAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PayerAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PayerAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PayerAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PayerAddressAdminArea2	String	False	No	A city, town, or village.

Return to Top

OrderItems

Name	Type	ReadOnly	FilterOnly	Description
OrderId	String	False	No	The ID of the Order this Item belongs to.
Id	String	False	No	The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives.
ReferenceId	String	False	No	The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH.
Amount	String	False	No	The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
Description	String	False	No	The purchase description.
CustomId	String	False	No	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
InvoiceId	String	False	No	The API caller-provided external invoice ID for this order.
SoftDescriptor	String	False	No	The payment descriptor on account transactions on the customer's credit card statement.
ShipperFullName	String	False	No	When the party is a person, the party's full name.
ShippingAddressLine1	String	False	No	The first line of the address. For example, number or street.
ShippingAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
ShippingAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
ShippingAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PayeeEmail	String	False	No	The email address of merchant.
PayeeMerchantId	String	False	No	The encrypted PayPal account ID of the merchant.
DisbursementMode	String	False	No	The funds that are held on behalf of the merchant.

Return to Top

Payments

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the authorized payment.
Intent	String	False	No	The payment intent.
PayerPaymentMethod	String	False	No	The payment method.
PayerStatus	String	False	No	The status of payer's PayPal account.
PayerEmail	String	False	No	The payer's email address.
PayerSalutation	String	False	No	The payer's salutation.
PayerFirstName	String	False	No	The payer's first name.
PayerMiddleName	String	False	No	The payer's middle name.
PayerLastName	String	False	No	The payer's last name.
PayerSuffix	String	False	No	The payer's suffix.
PayerId	String	False	No	The PayPal-assigned encrypted payer ID.
PayerBirthDate	Date	False	No	The birth date of the payer, in Internet date format.
PayerTaxId	String	False	No	The payer's tax ID. Supported for the PayPal payment method only.
PayerTaxType	String	False	No	The payer's tax ID type. Supported for the PayPal payment method only.
PayerBillingAddressLine1	String	False	No	The first line of the address. For example, number, street, and so on.
PayerBillingAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PayerBillingAddressCity	String	False	No	The city name.
PayerBillingAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PayerBillingAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent.
PayerBillingAddressState	String	False	No	The code for a US state or the equivalent for other countries.
PayerBillingAddressPhone	String	False	No	The phone number, in E.123 format.
PayerBillingAddressNormalizationStatus	String	False	No	The address normalization status. Returned only for payers from Brazil.
PayerBillingAddressType	String	False	No	The type of address. For example, HOME_OR_WORK, GIFT, and so on.
PayerShippingAddressLine1	String	False	No	The first line of the address. For example, number, street, and so on.
PayerShippingAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PayerShippingAddressCity	String	False	No	The city name.
PayerShippingAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PayerShippingAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent.
PayerShippingAddressState	String	False	No	The code for a US state or the equivalent for other countries.
PayerShippingAddressPhone	String	False	No	The phone number, in E.123 format.
PayerShippingAddressNormalizationStatus	String	False	No	The address normalization status. Returned only for payers from Brazil.
PayerShippingAddressType	String	False	No	The type of address. For example, HOME_OR_WORK, GIFT, and so on.
State	String	False	No	The state of the payment, authorization, or order transaction.
ExperienceProfileId	String	False	No	The PayPal-generated ID for the merchant's payment experience profile. For information, see create web experience profile.
NoteToPayer	String	False	No	A free-form field that clients can use to send a note to the payer.
FailureReason	String	False	No	The reason code for a payment failure.
ReturnUrl	String	False	No	The URL where the payer is redirected after he or she approves the payment. Required for PayPal account payments.
CancelUrl	String	False	No	The URL where the payer is redirected after he or she cancels the payment. Required for PayPal account payments.
BrandName	String	False	No	A label that overrides the business name in the merchant's PayPal account on the PayPal checkout pages.
Locale	String	False	No	The locale of pages that the PayPal payment experience displays.
LandingPage	String	False	No	The type of landing page to show on the PayPal site for customer checkout.
ShippingPreference	String	False	No	The shipping preference.
UserAction	String	False	No	The user action. Presents the customer with either the Continue or Pay Now checkout flow.
CreatedTime	Datetime	False	No	The date and time when the transaction occurred.
UpdatedTime	Datetime	False	No	The date and time when the payment was updated, in Internet date and time format.

Return to Top

PaymentTokens

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the vault token.
CustomerId	String	False	No	The unique ID for a customer in merchant's or partner's system of records.
MerchantCustomerId	String	False	No	Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.
PaymentSourceCardName	String	False	No	The card holder's name as it appears on the card.
PaymentSourceCardLastDigits	String	False	No	The last digits of the payment card.
PaymentSourceCardVerificationNetworkTransactionId	String	False	No	Transaction Identifier as given by the network to indicate a previously executed CIT authorization.
PaymentSourceCardVerificationDate	Datetime	False	No	The date that the transaction was authorized by the scheme.
PaymentSourceCardVerificationNetwork	String	False	No	Name of the card network through which the transaction was routed.
PaymentSourceCardVerificationTime	String	False	No	The date and time when the instrument was verified.
PaymentSourceCardVerificationAmountValue	Decimal	False	No	The amount used for card verification.
PaymentSourceCardVerificationAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
PaymentSourceCardVerificationProcessorResponseAvsCode	String	False	No	The address verification code for Visa, Discover, Mastercard, or American Express transactions.
PaymentSourceCardVerificationProcessorResponseCvvCode	String	False	No	The card verification value code for for Visa, Discover, Mastercard, or American Express.
PaymentSourceCardNetworkTransactionReferenceId	String	False	No	Transaction reference id returned by the scheme.
PaymentSourceCardNetworkTransactionReferenceDate	Datetime	False	No	The date that the transaction was authorized by the scheme.
PaymentSourceCardNetworkTransactionReferenceNetwork	String	False	No	Name of the card network through which the transaction was routed.
PaymentSourceCardNetworkTransactionReferenceTime	Datetime	False	No	The date and time when the instrument was verified.
PaymentSourceCardBrand	String	False	No	The card brand or network. Typically used in the response.
PaymentSourceCardExpiry	String	False	No	The card expiration year and month.
PaymentSourceCardAddressLine1	String	False	No	The first line of the address. For example, number or street.
PaymentSourceCardAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PaymentSourceCardAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceCardAddressAdminArea2	String	False	No	A city, town, or village.
PaymentSourceCardAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceCardAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceCardAddressId	String	False	No	The resource ID of the address.
PaymentSourceCardAddressCompany	String	False	No	The name of the company or business associated to the address.
PaymentSourceCardAddressPhone	String	False	No	The phone number that can go on the mailing label with the address to track the shipping.
PaymentSourceCardAddressGivenName	String	False	No	When the party is a person, the party's given, or first, name.
PaymentSourceCardAddressNameSurname	String	False	No	When the party is a person, the party's surname or family name.
PaymentSourceCardAddressPhoneNumber	String	False	No	The national number.
PaymentSourceCardAddressPhoneNumberCountryCode	String	False	No	The country calling code (CC), in its canonical international
PaymentSourceCardVerificationStatus	String	False	No	Card verification status
PaymentSourceCardType	String	False	No	The payment card type.
PaymentSourcePaypalEmailAddress	String	False	No	The email address of the payer.
PaymentSourcePaypalPayerId	String	False	No	The PayPal-assigned ID for the payer.
PaymentSourcePaypalGivenName	String	False	No	When the party is a person, the party's given, or first, name.
PaymentSourcePaypalNameSurname	String	False	No	When the party is a person, the party's surname or family name.
PaymentSourcePaypalPhoneNumber	String	False	No	The national number.
PaymentSourcePaypalPhoneType	String	False	No	The phone type.
PaymentSourcePaypalAddressLine1	String	False	No	The first line of the address. For example, number or street.
PaymentSourcePaypalAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PaymentSourcePaypalAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourcePaypalAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourcePaypalAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourcePaypalAccountId	String	False	No	The account identifier for a PayPal account.
PaymentSourceVenmoEmailAddress	String	False	No	The email address of the payer.
PaymentSourceVenmoPayerId	String	False	No	The PayPal-assigned ID for the payer.
PaymentSourceVenmoGivenName	String	False	No	When the party is a person, the party's given, or first, name.
PaymentSourceVenmoNameSurname	String	False	No	When the party is a person, the party's surname or family name.
PaymentSourceVenmoPhoneNumber	String	False	No	The national number.
PaymentSourceVenmoPhoneType	String	False	No	The phone type.
PaymentSourceVenmoAddressLine1	String	False	No	The first line of the address. For example, number or street.
PaymentSourceVenmoAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PaymentSourceVenmoAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceVenmoAddressAdminArea2	String	False	No	A city, town, or village.
PaymentSourceVenmoAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceVenmoAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceVenmoUserName	String	False	No	The Venmo username, as chosen by the user.
PaymentSourceApplePayName	String	False	No	The card holder's name as it appears on the card.
PaymentSourceApplePayLastDigits	String	False	No	The last digits of the payment card.
PaymentSourceApplePayType	String	False	No	The payment card type.
PaymentSourceApplePayBrand	String	False	No	The card brand or network.
PaymentSourceApplePayAddressLine1	String	False	No	The first line of the address. For example, number or street.
PaymentSourceApplePayAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PaymentSourceApplePayAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceApplePayAddressAdminArea2	String	False	No	A city, town, or village.
PaymentSourceApplePayAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceApplePayAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.

Return to Top

PaymentTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
PaymentId	String	False	Payments.Id	No	The Id of the payment.
Amount	Decimal	False		No	The amount to collect.
Currency	String	False		No	The currency of the amount to collect.
PayeeEmail	String	False		No	The email address associated with the payee's PayPal account.
PayeeMerchantId	String	False		No	The PayPal account ID for the payee.
Description	String	False		No	The purchase description.
NoteToPayee	String	False		No	The note to the recipient of the funds in this transaction.
Custom	String	False		No	The free-form field for the client's use.
InvoiceNumber	String	False		No	The invoice number to track this payment.
SoftDescriptor	String	False		No	The soft descriptor to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string.
NotifyUrl	String	False		No	The URL to send payment notifications.
AllowedPaymentMethod	String	False		No	The payment method for this transaction. This field does not apply to the credit card payment method.
RecipientName	String	False		No	The name of the recipient.
ShippingPhoneNumber	String	False		No	The shipping phone number, in its canonical international format as defined by the E.164 numbering plan.
ShippingAddressLine1	String	False		No	The first line of the address. For example, number, street, and so on.
ShippingAddressLine2	String	False		No	The second line of the address. For example, suite or apartment number.
ShippingAddressCity	String	False		No	The city name.
ShippingAddressCountryCode	String	False		No	The two-character ISO 3166-1 code that identifies the country or region.
ShippingAddressPostalCode	String	False		No	The postal code, which is the zip code or equivalent.
ShippingAddressState	String	False		No	The code for a US state or the equivalent for other countries.
ShippingAddressPhone	String	False		No	The phone number, in E.123 format.
ShippingAddressNormalizationStatus	String	False		No	The address normalization status. Returned only for payers from Brazil.
ShippingAddressType	String	False		No	The type of address. For example, HOME_OR_WORK, GIFT, and so on.
ShippingMethod	String	False		No	The shipping method used for this payment, such as USPS Parcel.

Return to Top

PayoutDetails

Name	Type	ReadOnly	FilterOnly	Description
PayoutBatchId [KEY]	String	False	No	The ID of the payout for which to show details.
BatchStatus	String	False	No	The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.
TimeCreated	Datetime	False	No	The date and time when processing for the payout began
TimeCompleted	Datetime	False	No	The date and time when processing for the payout completed.
SenderBatchId	String	False	No	The sender-specified ID number. Tracks the payout in an accounting system.
SenderEmailSubject	String	False	No	The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients.
Amount	Decimal	False	No	The total amount,requested for the payouts.
Currency	String	False	No	The currency of the total amount
FeeAmount	Decimal	False	No	The amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.
FeeCurrency	String	False	No	The currency for the applicable payouts fees.
TimeClosed	Datetime	False	No	The date and time when the payout was closed, in Internet date and time format.
SenderEmailMessage	String	False	No	The email message that PayPal sends when the payout item completes. The message is the same for all recipients.
SenderEmailRecipientType	String	False	No	The ID type that identifies the payment receiver.
FundingSource	String	False	No	The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

Return to Top

PayoutItems

Name	Type	ReadOnly	FilterOnly	Description
PayoutBatchId [KEY]	String	False	No	The ID of the payout for which to show payout items details.
PayoutItemId [KEY]	String	False	No	The ID for the payout item
TransactionId	String	False	No	The PayPal-generated ID for the transaction.
TransactionStatus	String	False	No	The transaction status.
FeeAmount	Decimal	False	No	The amount for the applicable payout fee. Initially, the fee is 0. The fee is populated after the item moves to the PENDING state
FeeCurrency	String	False	No	The currency for the applicable payout fee
RecipientType	String	False	No	The recipient type.Value is: EMAIL, PHONE, PAYPAL_ID.
AmountValue	Decimal	False	No	The amount of payout item.
AmountCurrency	String	False	No	The currency of payout item.
Note	String	False	No	A sender-specified note for notifications.
Receiver	String	False	No	The receiver of the payment. Corresponds to the recipient_type value in the request.
SenderItemId	String	False	No	A sender-specified ID number. Tracks the payout in an accounting system.
TimeProcessed	Datetime	False	No	The date and time when this item was last processed.
ErrorsMessage	String	False	No	The message that describes the error, if any.
ErrorsName	String	False	No	The human-readable, unique name of the error, if any.
ErrorsDebugId	String	False	No	The PayPal internal ID. Used for correlation purposes.
ErrorsInformationLink	String	False	No	The information link, or URI, that shows detailed information about this error for the developer.
ActivityId	String	False	No	The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.
SenderBatchId	String	False	No	A sender-specified ID. Tracks the payout in an accounting system.
RecipientNamePrefix	String	False	No	The prefix, or title, to the party's name.
RecipientGivenName	String	False	No	When the party is a person, the party's given, or first, name.
RecipientSurname	String	False	No	When the party is a person, the party's surname or family name. Also known as the last name.
RecipientMiddleName	String	False	No	When the party is a person, the party's middle name.
RecipientFullName	String	False	No	When the party is a person, the party's full name.
RecipientWallet	String	False	No	The recipient wallet.
Purpose	String	False	No	The purpose of the transaction.

Return to Top

Plans

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The unique PayPal-generated ID for the plan.
CreateTime	Datetime	False	No	The date and time when the plan was created
Description	String	False	No	The detailed description of the plan.
BillingCyclesVersion	Integer	False	No	The active pricing scheme for this billing cycle.
BillingCyclesPricingModel	String	False	No	The active pricing scheme for this billing cycle.
BillingCyclesFrequency	String	False	No	The frequency details for this billing cycle.
BillingCyclesTenureType	String	False	No	The tenure type of the billing cycle.
BillingCyclesSequence	Integer	False	No	The order in which this cycle is to run among other billing cycles.
BillingCyclesTotalCycles	Integer	False	No	The number of times this billing cycle gets executed.
Links	String	False	No	contains the link of plan object
Name	String	False	No	The plan name.
ProductId	String	False	No	The ID for the product.
QuantitySupported	Boolean	False	No	Indicates whether you can subscribe to this plan by providing a quantity for the goods or service..
Status	String	False	No	The plan status.
TaxesInclusive	Boolean	False	No	Indicates whether the tax was already included in the billing amount.
TaxesPercentage	String	False	No	The tax percentage on the billing amount.
UpdateTime	Datetime	False	No	The date and time when the plan was last updated.

Return to Top

RefundDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the captured payment.
Status	String	False	No	The status of the captured payment.
StatusDetails	String	False	No	The details of the captured payment status.
AmountValue	Decimal	False	No	The amount for this captured payment.
AmountCurrency	String	False	No	The currency of the amount for this captured payment.
InvoiceId	String	False	No	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.
NoteToPayer	String	False	No	The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.
SellerGrossAmount	Decimal	False	No	The amount for this captured payment.
SellerPaypalFee	Decimal	False	No	The applicable fee for this captured payment.
SellerNetAmount	Decimal	False	No	The net amount that the payee receives for this captured payment in their PayPal account.
TotalRefundedMoney	Decimal	False	No	The total amount refunded from the original capture to date.
CreateTime	Datetime	False	No	The time of authorization.
UpdateTime	Datetime	False	No	The time that the resource was last updated.
CustomId	String	False	No	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions.
AcquirerReferenceNumber	String	False	No	Reference ID issued for the card transaction.
PayerEmailAddress	String	False	No	The email address of merchant.
PayerMerchantId	String	False	No	The encrypted PayPal account ID of the merchant.

Return to Top

SaleDetails

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The Id of the sale transaction.
State	String	False	No	The state of the sale. One of the following: pending, completed, refunded, or partially_refunded.
Currency	String	False	No	The 3-letter currency code.
Subtotal	Decimal	False	No	The amount of the subtotal of the items.
TaxAmount	Decimal	False	No	The amount charged for tax.
ShippingAmount	Decimal	False	No	The amount charged for shipping.
ShippingDiscount	Decimal	False	No	The amount being discounted for the shipping fee. Only supported when the payment method is set to paypal.
HandlingFeeAmount	Decimal	False	No	The amount being charged for the handling fee. Only supported when the payment method is set to paypal.
InsuranceAmount	Decimal	False	No	The amount being charged for the insurance fee. Only supported when the payment method is set to paypal.
TotalAmount	Decimal	False	No	The total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee.
ClearingTime	Datetime	False	No	The expected clearing time for e-check transactions. Only supported when the payment method is set to paypal.
CreateTime	Datetime	False	No	The time of sale.
Description	String	False	No	The description of the sale.
ExchangeRate	String	False	No	The exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
FmfDescription	String	False	No	The description of the filter.
FmfFilterId	String	False	No	The name of the fraud management filter. One of the following: MAXIMUM_TRANSACTION_AMOUNT (basic filter), UNCONFIRMED_ADDRESS (basic filter), COUNTRY_MONITOR (basic filter), AVS_NO_MATCH (address verification service no match -- advanced filter), AVS_PARTIAL_MATCH (address verification service partial match -- advanced filter), AVS_UNAVAILABLE_OR_UNSUPPORTED (address verification service unavailable or not supported -- advanced filter), CARD_SECURITY_CODE_MISMATCH (advanced filter), BILLING_OR_SHIPPING_ADDRESS_MISMATCH (advanced filter), RISKY_ZIP_CODE (high risk lists filter), SUSPECTED_FREIGHT_FORWARDER_CHECK (high risk lists filter), RISKY_EMAIL_ADDRESS_DOMAIN_CHECK (high risk lists filter), RISKY_BANK_IDENTIFICATION_NUMBER_CHECK (high risk lists filter), RISKY_IP_ADDRESS_RANGE (high risk lists filter), LARGE_ORDER_NUMBER (transaction data filter), TOTAL_PURCHASE_PRICE_MINIMUM (transaction data filter), IP_ADDRESS_VELOCITY (transaction data filter), and PAYPAL_FRAUD_MODEL (transaction data filter).
FmfFilterType	String	False	No	The type of the fraud management filter. One of the following: ACCEPT (an ACCEPT filter is triggered only for the TOTAL_PURCHASE_PRICE_MINIMUM filter setting and is returned only in direct credit card payments where payment is accepted), PENDING (triggers a PENDING filter action where you need to explicitly accept or deny the transaction), DENY (triggers a DENY action where payment is denied automatically), and REPORT (triggers the Flag testing mode where payment is accepted).
FmfName	String	False	No	The name of the filter.
ParentPayment	String	False	No	The Id of the payment resource on which this transaction is based.
PaymentMode	String	False	No	The payment mode of the transaction. Only supported when the payment method is set to paypal. One of the following: INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, DELAYED_TRANSFER, or ECHECK.
PendingReason	String	False	No	The reason the transaction is in a pending state. Only supported when the payment method is set to paypal. One of the following: PAYER-SHIPPING-UNCONFIRMED, MULTI-CURRENCY, RISK-REVIEW, REGULATORY-REVIEW, VERIFICATION-REQUIRED , ORDER, or OTHER.
ProtectionEligibility	String	False	No	The level of seller protection in force for the transaction. Only supported when the payment method is set to paypal. One of the following: ELIGIBLE, PARTIALLY_ELIGIBLE, INELIGIBLE.
ProtectionEligibilityType	String	False	No	The kind of seller protection in force for the transaction. This property is returned only when the ProtectionEligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the payment method is set to paypal. One of the following: ITEM_NOT_RECEIVED_ELIGIBLE or UNAUTHORIZED_PAYMENT_ELIGIBLE. One or both of the allowed values can be returned.
ReasonCode	String	False	No	The reason code for the transaction state being Pending or Reversed. Only supported when the payment method is set to paypal. One of the following: CHARGEBACK, GUARANTEE, BUYER_COMPLAINT, REFUND, UNCONFIRMED_SHIPPING_ADDRESS, ECHECK, INTERNATIONAL_WITHDRAWAL, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, PAYMENT_REVIEW, REGULATORY_REVIEW, UNILATERAL, or VERIFICATION_REQUIRED.
ReceiptId	String	False	No	The 16-digit number payment identification number returned for guest users to identify the payment.
ReceivableAmount	Decimal	False	No	The receivable amount.
TransactionFee	Decimal	False	No	The transaction fee.
UpdateTime	Datetime	False	No	The time that the sale was last updated.

Return to Top

Subscriptions

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The PayPal-generated ID for the subscription.
BillingInfocycle_executions	String	False	No	The trial and regular billing executions.
BillingInfo_FailedPaymentsCount	Integer	False	No	The Failed payments count.
BillingInfo_LastPaymentAmountCurrencyCode	String	False	No	The last payment amount currency code.
BillingInfo_LastPaymentAmountValue	String	False	No	The last payment amount.
BillingInfo_LastPaymentTime	Datetime	False	No	The date and time when the last payment was made.
BillingInfo_NextBillingTime	Datetime	False	No	The next date and time for billing this subscription.
BillingInfo_OutstandingBalanceCurrencyCode	String	False	No	The total pending bill amount, to be paid by the subscriber.
BillingInfo_outstandingBalanceValue	String	False	No	The total pending bill amount, to be paid by the subscriber.
CreateTime	Datetime	False	No	The date and time of subscription created.
Links	String	False	No	Links for the subscription objects.
PlanId	String	False	No	The ID of the plan.
Quantity	Integer	False	No	The quantity of the product in the subscription.
ShippingAmountCurrencyCode	String	False	No	The currency for a financial transaction, such as a balance or payment due.
ShippingAmountValue	String	False	No	The amount for a financial transaction, such as a balance or payment due.
StartTime	Datetime	False	No	The start date and time of the subscription.
Status	String	False	No	The status of the subscription.
StatusUpdateTime	Datetime	False	No	The date and time of status updated.
SubscriberEmailAddress	String	False	No	The email address of the payer.
SubscriberName_GivenName	String	False	No	The given name of the payer.
SubscriberName_Surname	String	False	No	The sur name of the payer.
SubscriberPayerId	String	False	No	The PayPal-assigned ID for the payer.
SubscriberShippingAddress_AddressAddressLine1	String	False	No	Primary address of the payer.
SubscriberShippingAddress_AddressAddressLine2	String	False	No	Secondary address of the payer.
SubscriberShippingAddress_AddressAdminArea1	String	False	No	Primary address of the payer.
SubscriberShippingAddress_AddressAdminArea2	String	False	No	Secondary address of the payer.
SubscriberShippingAddress_AddressCountryCode	String	False	No	Country code of the payer address.
SubscriberShippingAddress_AddressPostalCode	String	False	No	Postal code of the payer address.
SubscriberShippingAddress_NameFullName	String	False	No	Full name of the Payer.
UpdateTime	Datetime	False	No	The date and time of subscription updated.
SubscriberShippingAddress_Type	String	False	No	The method by which the payer wants to get their items from the payee e.g shipping, in-person pickup.
SubscriberPhoneType	String	False	No	The phone type.
SubscriberPhoneNumber	String	False	No	The phone number, in its canonical international E.164 numbering plan format.
StatusChangeNote	String	False	No	The reason or notes for the status of the subscription.
CustomId	String	False	No	The custom id for the subscription. Can be invoice id.
PlanOverridden	Boolean	False	No	Indicates whether the subscription has overridden any plan attributes.
BillingInfo_LastPaymentStatus	String	False	No	The status of the captured payment.
BillingInfo_FinalPaymentTime	Datetime	False	No	The date and time when the final billing cycle occurs, in Internet date and time format.

Return to Top

SubscriptionTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
SubscriptionId	String	False	Subscriptions.Id	No	The ID of the subscription.
AmountWithBreakdown_FeeAmountCurrencyCode	String	False		No	The fee details for the transaction.
AmountWithBreakdown_FeeAmountValue	String	False		No	The fee details for the transaction.
AmountWithBreakdown_GrossAmountCurrencyCode	String	False		No	The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_GrossAmountValue	String	False		No	The value of the currency.
AmountWithBreakdown_NetAmountCurrencyCode	String	False		No	The currency code of the net amount that the payee receives for this transaction in their PayPal account.
AmountWithBreakdown_NetAmountValue	String	False		No	The net amount that the payee receives for this transaction in their PayPal account.
PayerEmail	String	False		No	The email ID of the customer.
PayerNameGivenName	String	False		No	When the party is a person, the party's given, or first, name.
PayerNameSurname	String	False		No	When the party is a person, the party's surname or family name. Also known as the last name.
Status	String	False		No	The initial state of the plan.
Time	Datetime	False		No	The date and time when the transaction was processed.
AmountWithBreakdown_TotalItemAmountCurrencyCode	String	False		No	The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TotalItemAmountValue	Decimal	False		No	The item total for the transaction.
AmountWithBreakdown_ShippingAmountCurrencyCode	String	False		No	The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_ShippingAmountValue	Decimal	False		No	The shipping amount for the transaction.
AmountWithBreakdown_TaxAmountCurrencyCode	String	False		No	The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TaxAmountValue	Decimal	False		No	The tax amount for the transaction.
StartTime	Datetime	False		Yes	The start time of the range of transactions to list.
EndTime	Datetime	False		Yes	The end time of the range of transactions to list.

Return to Top

Templates

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The ID of the template.
Name	String	False	No	The template name.
DefaultTemplate	Boolean	False	No	Indicates whether this template is the default template.
StandardTemplate	Boolean	False	No	Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.
Links	String	False	No	An array of request-related HATEOAS links.
TemplateInfoDetailReference	String	False	No	The reference data. Includes a Purchase Order (PO) number.
TemplateInfoDetailNote	String	False	No	A note to the invoice recipient. Also appears on the invoice notification email.
TemplateInfoDetailTermsAndConditions	String	False	No	The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
TemplateInfoDetailMemo	String	False	No	A private bookkeeping memo for the user.
TemplateInfoDetailCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDetailPaymentTermType	String	False	No	The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
TemplateInfoMetadataCreatedBy	String	False	No	The email address of the account that created the resource.
TemplateInfoMetadataLastUpdatedBy	String	False	No	The email address of the account that last edited the resource.
TemplateInfoMetadataCreateTime	Datetime	False	No	The date and time, in Internet date and time format.
TemplateInfoMetadataLastUpdateTime	Datetime	False	No	The date and time, in Internet date and time format.
TemplateInfoInvoicerBusinessName	String	False	No	The business name of the party.
TemplateInfoInvoicerPrefixName	String	False	No	The prefix, or title, to the party's name.
TemplateInfoInvoicerFirstName	String	False	No	When the party is a person, the party's given, or first, name.
TemplateInfoInvoicerMiddleName	String	False	No	When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
TemplateInfoInvoicerLastName	String	False	No	When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person.
TemplateInfoInvoicerSuffixName	String	False	No	The suffix for the party's name.
TemplateInfoInvoicerFullName	String	False	No	When the party is a person, the party's full name.
TemplateInfoInvoicerAddressLine1	String	False	No	The first line of the address. For example, number or street.
TemplateInfoInvoicerAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
TemplateInfoInvoicerAddressLine3	String	False	No	The third line of the address, if needed.
TemplateInfoInvoicerAddressAdminArea1	String	False	No	The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
TemplateInfoInvoicerAddressAdminArea2	String	False	No	A city, town, or village.
TemplateInfoInvoicerAddressAdminArea3	String	False	No	A sub-locality, suburb, neighborhood, or district.
TemplateInfoInvoicerAddressAdminArea4	String	False	No	The neighborhood, ward, or district.
TemplateInfoInvoicerAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
TemplateInfoInvoicerAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
TemplateInfoInvoicerAddressStreetNumber	String	False	No	The street number.
TemplateInfoInvoicerAddressStreetName	String	False	No	The street name. Just Drury in Drury Lane.
TemplateInfoInvoicerAddressStreetType	String	False	No	The street type. For example, avenue, boulevard, road, or expressway.
TemplateInfoInvoicerAddressDeliveryService	String	False	No	The delivery service. Post office box, bag number, or post office name.
TemplateInfoInvoicerAddressBuildingName	String	False	No	A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number.
TemplateInfoInvoicerAddressSubBuilding	String	False	No	The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name.
TemplateInfoInvoicerPhones	String	False	No	An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.
TemplateInfoInvoicerWebsite	String	False	No	The invoicer's website.
TemplateInfoInvoicerTaxId	String	False	No	The invoicer's tax ID.
TemplateInfoInvoicerAdditionalNotes	String	False	No	Any additional information. Includes business hours.
TemplateInfoInvoicerLogoUrl	String	False	No	The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
TemplateInfoInvoicerEmail	String	False	No	The invoicer email address, which must be listed in the user's PayPal profile.
TemplateInfoConfigurationTaxCalculatedAfterDiscount	Boolean	False	No	Indicates whether the tax is calculated before or after a discount.
TemplateInfoConfigurationTaxInclusive	Boolean	False	No	Indicates whether the unit price includes tax.
TemplateInfoConfigurationAllowTip	Boolean	False	No	Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateInfoConfigurationAllowPartialPayment	Boolean	False	No	Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
TemplateInfoConfigurationMinimumAmountDue	Decimal	False	No	The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
TemplateInfoConfigurationMinimumAmountDueCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountValue	Decimal	False	No	The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountCurrencyCode	String	False	No	The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountBreakdownItemTotalValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemTotalCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownInvoiceDiscountPercentage	Decimal	False	No	The discount as a percentage value. Value is from 0 to 100.
TemplateInfoAmountBreakdownInvoiceDiscountValue	Decimal	False	No	The invoice level discount amount.
TemplateInfoAmountBreakdownInvoiceDiscountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownItemDiscountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemDiscountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownTaxTotalValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownTaxTotalCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingAmountValue	Decimal	False	No	The shipping fee for all items. Includes tax on shipping.
TemplateInfoAmountBreakdownShippingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxAmountValue	Decimal	False	No	The calculated tax amount. The tax amount is added to the item total.
TemplateInfoAmountBreakdownShippingTaxAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxPercentage	Decimal	False	No	The tax rate.
TemplateInfoAmountBreakdownShippingTaxName	String	False	No	The name of the tax applied on the invoice items.
TemplateInfoAmountBreakdownShippingTaxNote	String	False	No	The tax note used to track the tax related data.
TemplateInfoAmountBreakdownCustomLabel	String	False	No	The label to the custom amount of the invoice.
TemplateInfoAmountBreakdownCustomAmountValue	Decimal	False	No	The custom amount to apply to an invoice.
TemplateInfoAmountBreakdownCustomAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDueAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TemplateInfoDueAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ItemSettings	String	False	No	The template item headers display preference.
SubtotalSettings	String	False	No	The template subtotal headers display preference.
UnitOfMeasure	String	False	No	The unit of measure for the invoiced item.

Return to Top

TransactionReports

Name	Type	ReadOnly	FilterOnly	Description
AccountNumber	String	True	No	The merchant account number.
LastRefreshedDatetime	Datetime	True	No	The date and time when the data was last refreshed, in Internet date and time format.
AuctionInfoAuctionBuyerId	String	False	No	The ID of the buyer who makes the purchase in the auction.
AuctionInfoAuctionClosingDate	Datetime	False	No	The date and time when the auction closes.
AuctionInfoAuctionItemSite	String	False	No	The auction site URL.
AuctionInfoAuctionSite	String	False	No	The name of the auction site.
PayerInfoAccountId	String	False	No	The PayPal customer account ID.
PayerInfoAddressStatus	String	False	No	The address status of the payer.
PayerInfoCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region of the payer.
PayerInfoEmailAddress	String	False	No	The email address of the payer.
PayerInfoPayerNameAlternateFullName	String	False	No	The party's alternate name.
PayerInfoPayerNameGivenName	String	False	No	When the party is a person, the party's given, or first, name.
PayerInfoPayerNameSurname	String	False	No	When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
PayerInfoPayerStatus	String	False	No	The status of the payer. Value is Y or N.
ShippingInfoAddressCity	String	False	No	The city name.
ShippingInfoAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
ShippingInfoAddressLine1	String	False	No	The first line of the address. For example, number or street.
ShippingInfoAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
ShippingInfoAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent.
ShippingInfoName	String	False	No	The recipient's name.
StoreInfoStoreId	String	False	No	The ID of a store for a merchant in the system of record.
StoreInfoTerminalId	String	False	No	The terminal ID for the checkout stand in a merchant store.
TransactionInfoCustomField	String	False	No	The merchant-provided custom text.
TransactionInfoFeeAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoFeeAmountValue	String	False	No	The value of fee.
TransactionInfoInsuranceAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoInsuranceAmountValue	String	False	No	The value of insurance amount.
TransactionInfoInvoiceId	String	False	No	The invoice ID that is sent by the merchant with the transaction.
TransactionInfoPaypalAccountId	String	False	No	The ID of the PayPal account of the counterparty.
TransactionInfoProtectionEligibility	String	False	No	Indicates whether the transaction is eligible for protection.
TransactionInfoShippingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingAmountValue	String	False	No	The value of shipping amount.
TransactionInfoShippingDiscountAmountCurrency_code	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingDiscountAmountValue	String	False	No	The value of shipping discount amount.
TransactionInfoTransactionAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTransactionAmountValue	String	False	No	The value of transaction amount.
TransactionInfoTransactionEventCode	String	False	No	A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit.
TransactionInfoTransactionId	String	False	No	The PayPal-generated transaction ID.
TransactionInfoTransactionInitiationDate	Datetime	False	No	The date and time when work on a transaction began in the PayPal system, as expressed in the time zone of the account on this side of the payment.
TransactionInfoTransactionNote	String	False	No	A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions.
TransactionInfoTransactionStatus	String	False	No	A code that indicates the transaction status.
TransactionInfoTransactionSubject	String	False	No	The subject of payment. The payer passes this value to the payee. The payer controls this data through the interface through which he or she sends the data.
TransactionInfoTransactionUpdatedDate	Datetime	False	No	The date and time when the transaction was last changed, as expressed in the time zone of the account on this side of the payment.
TransactionInfoAnnualPercentageRate	Decimal	False	No	The percentage, as a fixed-point, signed decimal number.
PayerInfoAddressLine1	String	False	No	The first line of the address. For example, number or street.
PayerInfoAddressLine2	String	False	No	The second line of the address. For example, suite or apartment number.
PayerInfoAddressCity	String	False	No	The city name.
PayerInfoAddressState	String	False	No	The code for a US state or the equivalent for other countries.
PayerInfoAddressCountryCode	String	False	No	The two-character ISO 3166-1 code that identifies the country or region.
PayerInfoAddressPostalCode	String	False	No	The postal code, which is the zip code or equivalent.
ShippingInfoAddressState	String	False	No	The code for a US state or the equivalent for other countries.
ShippingInfoMethod	String	False	No	The shipping method that is associated with this order.
TransactionInfoPaypalReferenceId	String	False	No	The PayPal-generated base ID. PayPal exclusive.
TransactionInfoPaypalReferenceIdType	String	False	No	The PayPal reference ID type.
TransactionInfoPaymentTrackingId	String	False	No	The payment tracking ID, which is a unique ID that partners specify to either get information about a payment or request a refund.
TransactionInfoBankReferenceId	String	False	No	The bank reference ID.
TransactionInfoCreditTerm	String	False	No	The credit term.
TransactionInfoPaymentMethodType	String	False	No	The payment method that was used for a transaction. Value is PUI, installment, or mEFT.
TransactionInfoInstrumentType	String	False	No	A high-level classification of the type of financial instrument that was used to fund a payment. The pattern is not provided because the value is defined by an external party.
TransactionInfoInstrumentSubType	String	False	No	A finer-grained classification of the financial instrument that was used to fund a payment.
TransactionInfoDiscountAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoDiscountAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoSalesTaxAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoSalesTaxAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoShippingTaxAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingTaxAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoOtherAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoOtherAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoTipAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTipAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoEndingBalanceCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoEndingBalanceValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoAvailableBalanceCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoAvailableBalanceValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditTransactionalFeeCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditTransactionalFeeValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditPromotionalFeeCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditPromotionalFeeValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
StartDate	Datetime	False	Yes	The start date and time, in Internet date and time format.
EndDate	Datetime	False	Yes	The end date and time, in Internet date and time format.
TransactionId	String	False	Yes	The PayPal-generated transaction ID.
PaymentInstrumentType	String	False	Yes	Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly	String	False	Yes	Indicates whether the response includes only balance-impacting transactions or all transactions.
StoreId	String	False	Yes	Filters the transactions in the response by a store ID.
TerminalId	String	False	Yes	Filters the transactions in the response by a terminal ID.
TransactionAmount	String	False	Yes	Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency	String	False	Yes	Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus	String	False	Yes	Filters the transactions in the response by a PayPal transaction status code.
TransactionType	String	False	Yes	Filters the transactions in the response by a PayPal transaction event code.

Return to Top

TransactionReportsCartInfoItemDetails

Name	Type	ReadOnly	FilterOnly	Description
AccountNumber	String	True	No	The merchant account number.
LastRefreshedDatetime	Datetime	True	No	The date and time when the data was last refreshed, in Internet date and time format.
InvoiceNumber	String	True	No	The invoice number. An alphanumeric string that identifies a billing for a merchant.
ItemAmountCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
ItemAmountValue	String	True	No	The value of item amount.
ItemCode	String	True	No	An item code that identifies a merchant's goods or service.
ItemDescription	String	True	No	The item description.
ItemName	String	True	No	The item name.
ItemQuantity	String	True	No	The number of purchased units of goods or a service.
ItemUnitPriceCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
ItemUnitPriceValue	String	True	No	The value of item unit price.
TaxAmounts	String	True	No	An array of tax amounts levied by a government on the purchase of goods or services.
TotalItemAmountCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
TotalItemAmountValue	String	True	No	The value of total item amount.
DiscountAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
DiscountAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
AdjustmentAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
AdjustmentAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
GiftWrapAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
GiftWrapAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
TaxPercentage	Decimal	False	No	The percentage, as a fixed-point, signed decimal number.
BasicShippingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
BasicShippingAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
ExtraShippingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
ExtraShippingAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
HandlingAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
HandlingAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
InsuranceAmountCurrencyCode	String	False	No	The three-character ISO-4217 currency code that identifies the currency.
InsuranceAmountValue	Decimal	False	No	The amount for a financial transaction, such as a balance or payment due.
ItemOptions	String	True	No	The item options. Describes option choices on the purchase of the item in some detail.
StartDate	Datetime	False	Yes	The start date and time, in Internet date and time format.
EndDate	Datetime	False	Yes	The end date and time, in Internet date and time format.
TransactionId	String	False	Yes	The PayPal-generated transaction ID.
PaymentInstrumentType	String	False	Yes	Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly	String	False	Yes	Indicates whether the response includes only balance-impacting transactions or all transactions.
StoreId	String	False	Yes	Filters the transactions in the response by a store ID.
TerminalId	String	False	Yes	Filters the transactions in the response by a terminal ID.
TransactionAmount	String	False	Yes	Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency	String	False	Yes	Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus	String	False	Yes	Filters the transactions in the response by a PayPal transaction status code.
TransactionType	String	False	Yes	Filters the transactions in the response by a PayPal transaction event code.

Return to Top

TransactionReportsIncentiveDetails

Name	Type	ReadOnly	FilterOnly	Description
AccountNumber	String	True	No	The merchant account number.
LastRefreshedDatetime	Datetime	True	No	The date and time when the data was last refreshed, in Internet date and time format.
IncentiveAmountCurrencyCode	String	True	No	The three-character ISO-4217 currency code that identifies the currency.
IncentiveAmountValue	String	True	No	The value of incentive amount.
IncentiveCode	String	True	No	The code that identifies an incentive, such as a coupon.
IncentiveProgramCode	String	True	No	The incentive program code that identifies a merchant loyalty or incentive program.
IncentiveType	String	True	No	The type of incentive, such as a special offer or coupon.
StartDate	Datetime	False	Yes	The start date and time, in Internet date and time format.
EndDate	Datetime	False	Yes	The end date and time, in Internet date and time format.
TransactionId	String	False	Yes	The PayPal-generated transaction ID.
PaymentInstrumentType	String	False	Yes	Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly	String	False	Yes	Indicates whether the response includes only balance-impacting transactions or all transactions.
StoreId	String	False	Yes	Filters the transactions in the response by a store ID.
TerminalId	String	False	Yes	Filters the transactions in the response by a terminal ID.
TransactionAmount	String	False	Yes	Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency	String	False	Yes	Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus	String	False	Yes	Filters the transactions in the response by a PayPal transaction status code.
TransactionType	String	False	Yes	Filters the transactions in the response by a PayPal transaction event code.

Return to Top

UserInfo

Name	Type	ReadOnly	FilterOnly	Description
UserId	String	False	No	The user ID of the user.
Sub	String	False	No	The subject ID for the end user at the issuer.
Name	String	False	No	The full name of the user.
GivenName	String	False	No	The given, or first, name of the user.
FamilyName	String	False	No	The surname or family name of the user. Also known as the last name.
MiddleName	String	False	No	The middle name of the user.
Picture	String	False	No	The URL of the profile picture of the user.
Email	String	False	No	The internationalized email address.
EmailVerified	Boolean	False	No	Indicates whether the user's email address is verified.
Gender	String	False	No	The user's gender.
Birthdate	Datetime	False	No	The user's birthday, in YYYY-MM-DD format.
ZoneInfo	String	False	No	The time zone of the user.
Locale	String	False	No	The locale of the user.
PhoneNumber	String	False	No	The preferred telephone number of the user.
StreetAddress	String	False	No	The full street address. Can include the house number and street name.
Locality	String	False	No	The city or locality.
Region	String	False	No	The state, province, prefecture, or region.
PostalCode	String	False	No	The zip code or postal code.
Country	String	False	No	The country.
VerifiedAccount	Boolean	False	No	Indicates whether the account is verified.
AccountType	String	False	No	The account type.
AgeRange	String	False	No	The account holder's age range.

Return to Top

Webhooks

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	The identifier of the webhook resource.
Url	String	False		No	The webhook notification endpoint URL.

Return to Top