Authorization

The authorization details.

Schema Information

Type:object

Properties

id

Type: string

The ID of the authorization.

amountrequired

Type: object

The amount being authorized.

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"

The payment mode of the authorization.

state

Type: string

Enum: "pending", "authorized", "partially_captured", "captured", "expired", "denied", "voided"

The authorized payment state.

reason_code

Type: string

Enum: "AUTHORIZATION"

The reason code for the pending transaction state.

pending_reason

Type: string

Enum: "AUTHORIZATION"

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 present for the transaction. Supported for the PayPal payment method only.

protection_eligibility_type

Type: string

Enum:

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

The type of seller protection for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported for the PayPal payment method only.

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.

parent_payment

Type: string

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

processor_response

Type: object

The processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card.

response_coderequired

Type: string

Max length: 4

The PayPal normalized response code, which is generated from the processor's specific response code.

avs_code

Type: string

Pattern: [A-z0-9]{1}

Max length: 1

The Address Verification System (AVS) response code.

cvv_code

Type: string

Pattern: [A-z0-9]{1}

Max length: 1

The CVV system response code.

advice_code

Type: string

Enum:

"01_NEW_ACCOUNT_INFORMATION", "02_TRY_AGAIN_LATER", "02_STOP_SPECIFIC_PAYMENT", "03_DO_NOT_TRY_AGAIN", "03_REVOKE_AUTHORIZATION_FOR_FUTURE_PAYMENT", "21_DO_NOT_TRY_AGAIN_CARD_HOLDER_CANCELLED_RECURRRING_CHARGE", "21_CANCEL_ALL_RECURRING_PAYMENTS"

The merchant advice on how to handle declines for recurring payments.

eci_submitted

Type: string

The processor-provided authorization response.

vpas

Type: string

The processor-provided Visa Payer Authentication Service (VPAS) status.

valid_until

Type: string

Format: date-time

The date and time when the authorization expires, in Internet date and time format.

create_time

Type: string

Format: date-time

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

update_time

Type: string

Format: date-time

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

receipt_id

Type: string

Pattern: ^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$

The receipt ID, which identifies the payment. Value is 16-digit numeric payment ID number that is returned for guest users.

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 authorization.

amountrequired

Type: object

The amount being authorized.

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"

The payment mode of the authorization.

state

Type: string

Enum: "pending", "authorized", "partially_captured", "captured", "expired", "denied", "voided"

The authorized payment state.

reason_code

Type: string

Enum: "AUTHORIZATION"

The reason code for the pending transaction state.

pending_reason

Type: string

Enum: "AUTHORIZATION"

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 present for the transaction. Supported for the PayPal payment method only.

protection_eligibility_type

Type: string

Enum:

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

The type of seller protection for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported for the PayPal payment method only.

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.

parent_payment

Type: string

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

processor_response

Type: object

The processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card.

response_coderequired

Type: string

Max length: 4

The PayPal normalized response code, which is generated from the processor's specific response code.

avs_code

Type: string

Pattern: [A-z0-9]{1}

Max length: 1

The Address Verification System (AVS) response code.

cvv_code

Type: string

Pattern: [A-z0-9]{1}

Max length: 1

The CVV system response code.

advice_code

Type: string

Enum:

"01_NEW_ACCOUNT_INFORMATION", "02_TRY_AGAIN_LATER", "02_STOP_SPECIFIC_PAYMENT", "03_DO_NOT_TRY_AGAIN", "03_REVOKE_AUTHORIZATION_FOR_FUTURE_PAYMENT", "21_DO_NOT_TRY_AGAIN_CARD_HOLDER_CANCELLED_RECURRRING_CHARGE", "21_CANCEL_ALL_RECURRING_PAYMENTS"

The merchant advice on how to handle declines for recurring payments.

eci_submitted

Type: string

The processor-provided authorization response.

vpas

Type: string

The processor-provided Visa Payer Authentication Service (VPAS) status.

valid_until

Type: string

Format: date-time

The date and time when the authorization expires, in Internet date and time format.

create_time

Type: string

Format: date-time

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

update_time

Type: string

Format: date-time

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

receipt_id

Type: string

Pattern: ^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$

The receipt ID, which identifies the payment. Value is 16-digit numeric payment ID number that is returned for guest users.

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.

Authorization

Schema Information

Properties

On this page

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

Authorization

Schema Information

Properties