Amount with Breakdown

The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.

Schema Information

Type:object

Properties

gross_amountrequired

Type: object

The amount for this transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

total_item_amount

Type: object

The item total for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

fee_amount

Type: object

The fee details for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

shipping_amount

Type: object

The shipping amount for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

tax_amount

Type: object

The tax amount for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

net_amount

Type: object

The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Properties

gross_amountrequired

Type: object

The amount for this transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

total_item_amount

Type: object

The item total for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

fee_amount

Type: object

The fee details for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

shipping_amount

Type: object

The shipping amount for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

tax_amount

Type: object

The tax amount for the transaction.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

net_amount

Type: object

The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee.

currency_coderequired

Type: string

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Amount with Breakdown

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

Amount with Breakdown

Schema Information

Properties