Order

The order transaction details.

Schema Information

Type:object

Properties

id

Type: string

The ID of the order transaction.

amountrequired

Type: object

The amount to collect.

Note: For an order authorization, you cannot include amount details.

currencyrequired

Type: string

The three-character ISO-4217 currency code. PayPal does not support all currencies.

totalrequired

Type: string

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like JPY do not support decimals.

details

Type: object

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

subtotal

Type: string

The subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shipping

Type: string

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

tax

Type: string

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_fee

Type: string

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discount

Type: string

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurance

Type: string

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrap

Type: string

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

payment_mode

Type: string

Enum: "INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"

The transaction payment mode.

state

Type: string

Enum: "PENDING", "AUTHORIZED", "CAPTURED", "COMPLETED", "VOIDED"

The state of the order transaction.

reason_code

Type: string

Enum:

"PAYER_SHIPPING_UNCONFIRMED", "MULTI_CURRENCY", "RISK_REVIEW", "REGULATORY_REVIEW", "VERIFICATION_REQUIRED", "ORDER", "OTHER"

The reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.

pending_reason

Type: string

Enum:

"payer_shipping_unconfirmed", "multi_currency", "risk_review", "regulatory_review", "verification_required", "order", "other"

Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.

protection_eligibility

Type: string

Enum: "ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"

The level of seller protection in effect for the transaction.

protection_eligibility_type

Type: string

Enum:

"ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"

The kind of seller protection in effect for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.

parent_payment

Type: string

The ID of the payment on which this transaction is based.

fmf_details

Type: object

The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary.

filter_typerequired

Type: string

Enum: "ACCEPT", "PENDING", "DENY", "REPORT"

The filter type.

filter_idrequired

Type: string

Enum:

"AVS_NO_MATCH", "AVS_PARTIAL_MATCH", "AVS_UNAVAILABLE_OR_UNSUPPORTED", "CARD_SECURITY_CODE_MISMATCH", "MAXIMUM_TRANSACTION_AMOUNT", "UNCONFIRMED_ADDRESS", "COUNTRY_MONITOR", "LARGE_ORDER_NUMBER", "BILLING_OR_SHIPPING_ADDRESS_MISMATCH", "RISKY_ZIP_CODE", "SUSPECTED_FREIGHT_FORWARDER_CHECK", "TOTAL_PURCHASE_PRICE_MINIMUM", "IP_ADDRESS_VELOCITY", "RISKY_EMAIL_ADDRESS_DOMAIN_CHECK", "RISKY_BANK_IDENTIFICATION_NUMBER_CHECK", "RISKY_IP_ADDRESS_RANGE", "PAYPAL_FRAUD_MODEL"

The filter ID.

name

Type: string

The filter name.

description

Type: string

The filter description.

create_time

Type: string

Format: date-time

The date and time when the resource was created, in Internet date and time format.

update_time

Type: string

Format: date-time

The date and time when the resource was last updated, in Internet date and time format.

links

Type: array

An array of request-related HATEOAS links.

Array Items

items

Type: object

The request-related HATEOAS link information.

hrefrequired

Type: string

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

relrequired

Type: string

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method

Type: string

Enum: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"

The HTTP method required to make the related call.

Properties

id

Type: string

The ID of the order transaction.

amountrequired

Type: object

The amount to collect.

Note: For an order authorization, you cannot include amount details.

currencyrequired

Type: string

The three-character ISO-4217 currency code. PayPal does not support all currencies.

totalrequired

Type: string

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like JPY do not support decimals.

details

Type: object

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

subtotal

Type: string

The subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shipping

Type: string

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

tax

Type: string

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_fee

Type: string

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discount

Type: string

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurance

Type: string

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrap

Type: string

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

payment_mode

Type: string

Enum: "INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"

The transaction payment mode.

state

Type: string

Enum: "PENDING", "AUTHORIZED", "CAPTURED", "COMPLETED", "VOIDED"

The state of the order transaction.

reason_code

Type: string

Enum:

"PAYER_SHIPPING_UNCONFIRMED", "MULTI_CURRENCY", "RISK_REVIEW", "REGULATORY_REVIEW", "VERIFICATION_REQUIRED", "ORDER", "OTHER"

The reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.

pending_reason

Type: string

Enum:

"payer_shipping_unconfirmed", "multi_currency", "risk_review", "regulatory_review", "verification_required", "order", "other"

Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.

protection_eligibility

Type: string

Enum: "ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"

The level of seller protection in effect for the transaction.

protection_eligibility_type

Type: string

Enum:

"ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"

The kind of seller protection in effect for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.

parent_payment

Type: string

The ID of the payment on which this transaction is based.

fmf_details

Type: object

filter_typerequired

Type: string

Enum: "ACCEPT", "PENDING", "DENY", "REPORT"

The filter type.

filter_idrequired

Type: string

Enum:

"AVS_NO_MATCH", "AVS_PARTIAL_MATCH", "AVS_UNAVAILABLE_OR_UNSUPPORTED", "CARD_SECURITY_CODE_MISMATCH", "MAXIMUM_TRANSACTION_AMOUNT", "UNCONFIRMED_ADDRESS", "COUNTRY_MONITOR", "LARGE_ORDER_NUMBER", "BILLING_OR_SHIPPING_ADDRESS_MISMATCH", "RISKY_ZIP_CODE", "SUSPECTED_FREIGHT_FORWARDER_CHECK", "TOTAL_PURCHASE_PRICE_MINIMUM", "IP_ADDRESS_VELOCITY", "RISKY_EMAIL_ADDRESS_DOMAIN_CHECK", "RISKY_BANK_IDENTIFICATION_NUMBER_CHECK", "RISKY_IP_ADDRESS_RANGE", "PAYPAL_FRAUD_MODEL"

The filter ID.

name

Type: string

The filter name.

description

Type: string

The filter description.

create_time

Type: string

Format: date-time

The date and time when the resource was created, in Internet date and time format.

update_time

Type: string

Format: date-time

The date and time when the resource was last updated, in Internet date and time format.

links

Type: array

An array of request-related HATEOAS links.

Array Items

items

Type: object

The request-related HATEOAS link information.

hrefrequired

Type: string

relrequired

Type: string

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method

Type: string

Enum: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"

The HTTP method required to make the related call.

Order

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Order

Schema Information

Properties