SaleDetails
Query details about a Sale Transaction.
Table Specific Information
Select
The only filter supported by the PayPal API is Id, which is required. The add-in processes other filters client side within the add-in.
For example, the following queries are processed server side and retrieve details for a specific Sale.
SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'
SELECT * FROM SaleDetails WHERE Id IN ('6M2430095X488331A', '6M2410805X488331A')
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the sale transaction. | |
| State | String | The state of the sale. One of the following: pending, completed, refunded, or partially_refunded. | |
| Currency | String | The 3-letter currency code. | |
| Subtotal | Decimal | The amount of the subtotal of the items. | |
| TaxAmount | Decimal | The amount charged for tax. | |
| ShippingAmount | Decimal | The amount charged for shipping. | |
| ShippingDiscount | Decimal | The amount being discounted for the shipping fee. Only supported when the payment method is set to paypal. | |
| HandlingFeeAmount | Decimal | The amount being charged for the handling fee. Only supported when the payment method is set to paypal. | |
| InsuranceAmount | Decimal | The amount being charged for the insurance fee. Only supported when the payment method is set to paypal. | |
| TotalAmount | Decimal | 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 | The expected clearing time for e-check transactions. Only supported when the payment method is set to paypal. | |
| CreateTime | Datetime | The time of sale. | |
| Description | String | The description of the sale. | |
| ExchangeRate | String | 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 | The description of the filter. | |
| FmfFilterId | String | 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 | 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 | The name of the filter. | |
| ParentPayment | String | The Id of the payment resource on which this transaction is based. | |
| PaymentMode | String | 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 | 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 | 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 | 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 | 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 | The 16-digit number payment identification number returned for guest users to identify the payment. | |
| ReceivableAmount | Decimal | The receivable amount. | |
| TransactionFee | Decimal | The transaction fee. | |
| UpdateTime | Datetime | The time that the sale was last updated. |