RefundTransaction API

Use the RefundTransaction API to make full or partial refunds.

Diagram of RefundTransaction Types

The following diagram represents the composition of the RefundTransactionRequestType and RefundTransactionResponseType elements.

Figure 8.1

RefundTransaction Types

RefundTransactionRequest

Request to refund a payment.

With RefundTransactionRequest, you must always pass the values of TransactionID and RefundType. If RefundType is set to Full, you must not set Amount.

if RefundType is Partial, you must set Amount.

Table 8.1

RefundTransactionRequest Fields

Field	Description	Required?
TransactionID	xs:string Unique identifier of a transaction Character length and limitations: 17 single-byte alphanumeric characters	Yes
RefundType	ebl:RefundPurposeTypeCodeType Type of refund you are making l Other l Full l Partial	Yes
Amount	ebl:BasicAmountType Refund amount. Amount is required if RefundType is Partial. Note: If RefundType is Full, do not set Amount.	See description
Memo	xs:string Custom memo about the refund. Character length and limitations: 255 single-byte alphanumeric characters	No

RefundTransactionResponse

Response to RefundTransactionRequest.

Table 8.2

RefundTransactionResponse Fields

Field	Description
RefundTransactionID	xs:string Unique transaction ID of the refund. Character length and limitations:17 single-byte characters
FeeRefundAmount	ebl:BasicAmountType Transaction fee refunded to original recipient of payment
GrossRefundAmount	ebl:BasicAmountType Amount of money refunded to original payer
NetRefundAmount	ebl:BasicAmountType Amount subtracted from PayPal balance of original recipient of payment to make this refund