orders library
An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders. For error handling and troubleshooting, see Orders v2 errors.
Classes
- AmountBreakdown
- Amount breakdown.
- AmountWithBreakdown
- Amount with breakdown.
- ApplicationContext
- AuthorizationWithAdditionalData
- Authorization with additional data.
- Capture
- A capture.
- Card
- A payment card.
- DisputeCategory
- Dispute category.
- Item
- NetworkTransactionReference
- The network transaction reference
- Order
- An order.
- OrderRequest
- An order request object.
- OrdersApi
- Orders API interface
- Payer
- The payer of an order.
- PaymentCollection
- A collection of payments
- PaymentMethod
- The payment method.
- PaymentSource
- A payment source
- PaymentSourceToken
- A payment source with token
- PurchaseUnit
- A purchase unit item
- PurchaseUnitRequest
- A purchase unit request item
- Refund
- A refund.
- RefundStatus
- The refund status.
- SellerProtection
- Seller protection.
- SellerReceivableBreakdown
- Seller receivable breakdown.
- StoredPaymentSource
- A stored payment source
- Token
- A payment source token.
Enums
- DisputeCategoryValue
- The condition that is covered for the transaction.
- ItemCategory
- The item category type.
- LandingPage
- The type of landing page to show on the PayPal site for customer checkout.
- Network
- Name of the card network through which the transaction was routed.
- OrderRequestIntent
- The intent to either capture payment immediately or authorize a payment for an order after order creation.
- PayeePreferred
- The merchant-preferred payment methods.
- PaymentInitiator
- The person or party who initiated or triggered the payment.
- PaymentType
- Indicates the type of the stored payment_source payment.
- RefundStatusValue
- The status of the refund.
- SellerProtectionStatus
- Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.
- ShippingPreference
- The shipping preference:
- StandardEntryClassCode
- NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
- Usage
- Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
- UserAction
- Configures a Continue or Pay Now checkout flow.