Expand description

Paypal object definitions used by the orders api.

Structs

Represents an amount of money.

Customize the payer experience during the approval process for the payment with PayPal.

A payment authorization.

Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

A captured payment.

Details about the captured payment status.

The payment card to use to fund a payment.

Exchange rate.

An invoice number.

Represents an item.

The net breakdown of the refund.

An order represents a payment between two or more parties.

A order payload to be used when creating an order.

The merchant who receives payment for this transaction.

The customer who approves and pays for the order. The customer is also known as the payer.

Builder for Payer.

Represents a payer name.

The comprehensive history of payments for the purchase unit.

Any additional payment instructions for PayPal Commerce Platform customers.

A payment method.

The payment source used to fund the payment.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant’s PayPal account.

The phone number, in its canonical international E.164 numbering plan format.

Fees, commissions, tips, or donations

Represents either a full or partial order that the payer intends to purchase from the payee.

A refund

Details about the status of the refund.

The breakdown of the refund.

The name and address of the person to whom to ship the items.

The name of the person to whom to ship the items.

The tax information of the payer.

The customer’s wallet used to fund the transaction.

Enums

The status of the payment authorization.

The capture status.

Capture status reason.

The card brand or network.

The funds that are held on behalf of the merchant

The intent to either capture payment immediately or authorize a payment for an order after order creation.

The item category type.

The type of landing page to show on the PayPal site for customer checkout.

Error type for OrderPayloadBuilder

The status of an order.

The merchant-preferred payment sources.

Error type for PayerBuilder

The status of the refund

Refund status reason.

The shipping preference

The customer’s tax ID type. Supported for the PayPal payment method only.

Configures a Continue or Pay Now checkout flow.