Top-level input field for creating a PayPal One-Time Payment.
amountMonetaryTotal amount for payment to be charged to consumer.
cancelURL!RequiredURL for redirect back to merchant app on the client indicating unsuccessful approval.
intentPayThe payment intent.
returnURL!RequiredURL for redirect back to merchant app on the client indicating successful approval.
amountPayThe amount breakdown for this transaction.
appPayContext information for enabling app switch to the PayPal app during checkout.
line[PayThe line items for this transaction. Maximum 249 line items.
merchantIDBraintree merchant account ID associated with the PayPal account to be used for the One-Time payment creation.
payerEmailEmail of the payer. This will prepopulate the input field in the PayPal approval login page.
paypalPayDefines the experience profile used to render the approval flow.
paypalIDPayPal Risk correlation ID (also known as the Client Metadata ID).
recipientEmailRecipient email address. This field is used when the buyer is different from the recipient of the product.
recurringPayBilling plan for recurring payments.
Indicates whether this payment uses the Billing Agreement with Purchase flow. This will request Billing Agreement approval from the customer, and a multi-use PayPal payment method will be created alongside the transaction.
shippingAddressMerchant-provided shipping address. If passing a shipping address, fields addressLine1, adminArea2, and countryCode are required.
shippingURLURL for redirecting back to the merchant app to update a customer shipping address.
shipping[PayList of shipping options offered by the payee or merchant to the payer to ship or pick up their items. Note: shippingOptions may not be passed with intent ORDER payments.
emailEmailUse payerEmail field instead.
Email of the payer. This will prepopulate the input field in the PayPal approval login page.
input CreatePayPalOneTimePaymentInput {
clientMutationId: String
merchantAccountId: ID
amount: MonetaryAmountInput!
cancelUrl: URL!
email: EmailAddress @deprecated(reason: "Use payerEmail field instead.")
intent: PayPalIntent!
lineItems: [PayPalLineItemInput!]
offerPayLater: Boolean
offerPayPalCredit: Boolean
payerEmail: EmailAddress
paypalRiskCorrelationId: ID
paypalExperienceProfile: PayPalExperienceProfileInput
requestBillingAgreement: Boolean
billingAgreementDescription: String
recipientEmail: EmailAddress
returnUrl: URL!
shippingAddress: AddressInput
shippingOptions: [PayPalShippingOptionInput!]
shippingCallbackUrl: URL
customerSessionId: String
appSwitchContext: PayPalAppSwitchContextInput
amountBreakDown: PayPalAmountBreakDownInput
recurringBillingPlan: PayPalRecurringBillingPlanInput
}