RefundTransaction API Operation (SOAP)

TransactionID

xs:string

(Required) Unique identifier of the transaction to be refunded.

PayerID

ebl:UserIDType

(Optional) Encrypted PayPal customer account identification number. Supported only for Point of Sale transactions.

Character length and limitations: 13 single-byte alphanumeric characters

InvoiceID

xs:string

(Optional) Your own invoice or tracking ID number.

Character length and limitations: 127 single-byte alphanumeric characters

RefundType

ebl:RefundPurposeTypeCodeType

Type of refund you are making. Value is:

• Full — Full refund (default).

• Partial — Partial refund.

Amount

ebl:BasicAmountType

(Optional) Refund amount. Required if RefundType is Partial or for refunds greater than 100%.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Memo

xs:string

(Optional) Custom memo about the refund.

Character length and limitations: 255 single-byte alphanumeric characters

RefundSource

ebl:RefundSourceCodeType

(Optional)Type of PayPal funding source (balance or eCheck) that can be used for auto refund. Value is:

• any — The merchant does not have a preference. Use any available funding source.

• instant — Use the merchant's balance as the funding source.

• eCheck — The merchant prefers using the eCheck funding source. If the merchant's PayPal balance can cover the refund amount, use the PayPal balance.

This field is available since version 82.0.

MerchantStoreDetails

ebl:MerchantStoreDetailsType

(Optional) Information about the merchant store. Supported only for Point of Sale transactions.

This field is available since version 82.0.

RefundAdvice

xs:boolean

(Deprecated) Flag indicates the buyer received store credit for a given transaction. Supported only for Point of Sale transactions and is one of the following values:

• true — The buyer was already given store credit for a given transaction.

• false — The buyer was not given store credit for a given transaction.

This field is available since version 85.0.

MsgSubId

xs:string

(Optional) A message ID that uniquely identifies the request. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: string of up to 38 single-byte characters.

This field is available since version 92.0.

StoreID

xs:string

Identifier of the merchant store at which the refund is given. This field is required for point-of-sale transactions.

Character length and limitations: 50 single-byte characters

This field is available since version 82.0.

TerminalID

xs:string

(Optional) ID of the terminal.

Character length and limitations: 50 single-byte characters

This field is available since version 82.0.

Type

xs:string

(Required) The type of additional fee.

Amount

cc:BasicAmountType

(Required) The amount of the additional fee.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

RefundTransactionID

xs:string

Unique transaction ID of the refund.

FeeRefundAmount

ebl:BasicAmountType

The refunded amount of the PayPal transaction fees (all or part of the variable fee). PayPal's transaction fees for merchants typically consist of a variable fee and a fixed fee. For example, for a $100 payment amount, if the standard per transaction fee is the sum of a variable fee of 2.9% plus a fixed fee of $0.30, the fees would be $2.90 + $0.30. For a full refund of $100.00, the FeeRefundAmount is 2.90, or 100% of the variable fee.
Note: PayPal does not refund the fixed per transaction fee, which is typically $0.30 in the U.S. or its equivalent for your country. See PayPal Merchant Fees for more information.
For partial refunds, a percentage of the variable fee is refunded, equivalent to the percentage of the refund from the original payment amount. In this example, for a partial refund of $50.00, the FeeRefundAmount is 1.45.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

GrossRefundAmount

ebl:BasicAmountType

Amount refunded to the buyer in this refund transaction. For example, a buyer originally made a $100.00 payment, the buyer was refunded $20.00 a week ago and is refunded $30.00 in this transaction. The gross refund amount is $30.00, only the amount refunded in this transaction.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

NetRefundAmount

ebl:BasicAmountType

Amount deducted from your PayPal account to make this refund. This is the GrossRefundAmount minus the FeeRefundAmount.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

TotalRefundedAmount

ebl:BasicAmountType

Total amount refunded so far from the original payment. For example, a buyer originally made a $100.00 payment, the buyer was refunded $20.00 a week ago and is refunded $30.00 in this transaction. The TotalRefundedAmount is $50.00.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

This field is available since version 67.0.

RefundInfo

ebl:RefundInfoType

Contains refund payment status information.

This field is available since version 84.0.

MsgSubId

xs:string

(Optional) A message ID used for idempotency to uniquely identify a message. This ID can later be used to request the latest results for a previous request without generating a new request. Examples of this include requests due to timeouts or errors during the original request.

Character length and limitations: string of up to 38 single-byte characters. This field is available since version 92.0.

RefundStatus

ns:PaymentStatusCodeType

Status of the refund. Value is:

• none — returned if the refund transaction fails (Ack=Failure).

• instant

• delayed

This field is available since version 84.0.

PendingReason

xs:PendingStatusCodeType

Reason that the refund payment status is delayed. Value is:

• none — The refund status is instant.

• echeck — The refund status is delayed.

• regulatoryreview - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review.

This field is available since version 84.0.

RefundItemDetails

(No replacement)

ebl:InvoiceItemType

(Optional) Details about the individual items to be returned.

March 2019

ShippingAmount

(No replacement)

cc:BasicAmountType

(Optional) The amount of shipping paid.

March 2019

TaxAmount

(No replacement)

cc:BasicAmountType

(Optional) The amount of tax paid.

March 2019

Name

(No replacement)

xs:string

(Optional) A human readable item name.

Character length and limitations: 127 single-byte characters.

March 2019

Description

(No replacement)

xs:string

(Optional) A human readable item description.

Character length and limitations: 127 single-byte characters.

March 2019

EAN

(No replacement)

xs:string

(Optional) The International Article Number or Universal Product Code (UPC) for the item. An empty string is allowed.

Character length and limitations: 17 single-byte characters.

March 2019

SKU

(No replacement)

xs:string

(Optional) The Stock-Keeping Unit or other identification code assigned to the item.

Character length and limitations: 64 single-byte characters.

March 2019

Price

(No replacement)

cc:BasicAmountType

(Optional) The total price of this item.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

March 2019

ItemPrice

(No replacement)

cc:BasicAmountType

(Optional) The price for one item.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

March 2019

ItemCount

(No replacement)

xs:double

(Conditional) Required if ItemCountUnit is passed. The quantity of the item. Must be positive.

March 2019

ItemCountUnit

(No replacement)

ebl:UnitOfMeasure

(Conditional) Required if ItemCount is passed. Unit of measure for the ItemCount.

It is one of the following:

• EA — Each
• Hours — Hours
• Days — Days
• Seconds — Seconds
• CrateOf12 — Crate of 12 bottles of beer
• 6Pack — 6Pack
• GLI — Gallon (UK)
• GLL — Gallon (US)
• LTR — Litre
• INH — Inch
• FOT — Foot
• MMT — Millimeter
• CMQ — Centimeter
• MTR — Meter
• MTK — Square Meter
• MTQ — Cubic Meter
• GRM — Gram
• KGM — Kilogram
• KG — Kilogram
• LBR — Pound
• ANN — Annual
• CEL — Degree Celcius
• FAH — Degree Fahrenheit

March 2019

TaxRate

(No replacement)

xs:double

(Optional) The tax percentage applied to the item. This is only displayed in the receipt and is not used in pricing calculations.

March 2019

AdditionalFees

(No replacement)

ebl:AdditionalFeeType

(Optional) Additional fees applied for this item.

March 2019

MPN

(No replacement)

xs:string

(Optional) Manufacturer part number.

March 2019

ISBN

(No replacement)

xs:string

(Optional) International Standard Book Number. Reference International Standard Book Number.

Character length and limitations: 32 single-byte characters.

March 2019

PLU

(No replacement)

xs:string

(Optional) Price Look-Up code. Reference https://en.wikipedia.org/wiki/Price_Look-Up_code.

Character length and limitations: 5 single-byte characters.

March 2019

ModelNumber

(No replacement)

xs:string

(Optional) The item manufacturer's model number.

Character length and limitations: 32 single-byte characters.

March 2019

StyleNumber

(No replacement)

xs:string

(Optional) The item manufacturer's style number.

Character length and limitations: 32 single-byte characters.

March 2019