PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

AdaptiveRefund Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdaptiveRefund component is used to make refunds of simple, chained, or parallel payments that were authorized via the ADAPTIVEPAY component.

Syntax

AdaptiveRefund

Remarks

In a refund, the terms sender and recipient refer to sender and receivers of the original payment made using the AdaptivePay class. When making a refund, the sender's account receives the refund and the receivers' accounts are the sources of the refund. Refunds are made from one or more receivers to a sender.

To make a refund using the AdaptiveRefund class, you must have made an AdaptivePay request for which payment you want to refund, or you must have received the part of the payment you want to refund, and you must have permission to make a refund on behalf of the receiver, unless you are also the receiver; in other words, each receiver from whose account is the source of the refund must have granted you third-party access permission to call the Refund API operation.

To refund a payment from all receivers associated with a payment, simply specify the PaymentKey or TrackingId and call IssueRefund. You can also make a refund to the sender of a payment from specific receivers associated with a PaymentKey or TrackingId. In this case, you must also specify the PaymentKey or TrackingId associated with the original payment, but in addition you need to supply the RecipientEmail and RecipientAmount for each of the Recipients you wish to make a refund from. Then call IssueRefund.

A payment can also be identified as a set of PayPal transactions between the sender and each specific receiver. You can refund only one of the transactions in this set by specifying the TransactionId instead.

After calling IssueRefund, the results of each refund processed will be stored in the Refunds collection.

Additional Notes About the Refund API Operation

  • Note that payments made using the AdaptivePay class cannot be refunded using the RefundTransaction class. You must use the AdaptiveRefund class or log in to PayPal to issue the refund.
  • A personal account holder cannot grant API access to a third party. A personal account holder must issue the refund by specifying the TransactionId, or by logging in to paypal.com to make the refund.
  • A payment made using the AdaptivePay class cannot be refunded by logging in to paypal.com if the fees cannot be refunded. In these cases, you must use the AdaptiveRefund class operation to issue the refund.
  • In the refund request, Specify the payment you're interested in using either the PaymentKey, TransactionId, or TrackingId. It is not recommended to specify more than one of these properties, unless they identify the same payment. If the properties do not belong to the same payment, the TransactionId is used; next, PayPal uses the PaymentKey. If more than one of these is specified, the TrackingId is never used.
  • With the AdaptivePay class you can make payments to a person who does not have a PayPal account. In essence, you send a payment request that includes an email address for a receiver, and this email address is not linked to a registered PayPal account. The receiver receives an email notifying the receiver to create an account and claim the payment. Supporting features include email notifications and IPNs to the sender, receiver, and API caller, plus the ability to cancel unclaimed payments. You can make such a payment in the same way that you make any other kind of payment; however, PayPal holds a payment to a receiver whose email address is not yet registered or confirmed until the receiver creates a PayPal account and confirms the email address. If a refund specifies a receiver whose email address is not yet registered or confirmed, the payment to the receiver is canceled.
  • For chained payments, if the primary recipient's account has insufficient funds to cover the refund, an eCheck is issued, and the refund is put on hold until the check clears. No money will be moved from the secondary receivers' accounts until the primary receiver's fund are available using eCheck. Note that the Refund API operation does not support iACH.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AckAcknowledgement code received from PayPal.
ApplicationIdYour application's identification, which is issued by PayPal.
AuthorizingAccountThird-party permission specification.
CurrencyCodeThe currency being used for this payment.
DeviceIdClient's device ID.
DeviceIPClient's IP address.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
PasswordPassword for communicating with PayPal.
PaymentKeyToken used to identify a payment.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RecipientCountThe number of records in the Recipient arrays.
RecipientAmountAmount to be refunded by the recipient.
RecipientEmailEmail that identifies each recipient issuing a refund.
RefundCountThe number of records in the Refund arrays.
RefundErrorInformation about why a refund failed.
RefundFeeAmountRefundedThe amount of fees that have been refunded.
RefundFullRefundIndicates whether you have refunded the total amount of the payment.
RefundGrossAmountRefundedGross amount of the refund, including the total amount from this recipient plus fees.
RefundNetAmountRefundedThe total amount of the refund from this receiver.
RefundPrimaryRecipientWhether this recipient is the primary receiver.
RefundRecipientEmailEmail address of the receiver.
RefundRefundStatusStatus of the refund.
RefundTotalOfAllRefundsThe total of all refunds actually paid.
RefundTransactionAmountAmount to be refunded to the receiver.
RefundTransactionIdThe encrypted PayPal transaction ID for this refund.
RefundTransactionStatusThe status of the refund transaction.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TimeStampThe date on which the response was sent.
TrackingIdUser-generated unique tracking number.
TransactionIdThe PayPal transaction ID associated with the payment.
URLURL all PayPal transactions are posted to.
UserUser name for communicating with Paypal.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetResponseVarIt is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
InterruptInterrupt the current method.
IssueRefundRefunds a payment originally made using the ADAPTIVEPAY component.
ResetReset the internal state of the component and all properties to their default values.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
WarningInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AuthorizingAccountAuthorizing Account Email Address for third-party API access.
AuthAccessTokenThe access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationIdThe Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeaderThe PayPal Permissions Service authentication header.
AuthAuthHeaderNameThe name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURLThe URL where PayPal will post the RequestToken and VerificationCode.
AuthPasswordAPI Password for the PayPal Permissions Service.
AuthRequestTokenThe request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
AuthRequestURLThe URL for the PayPal Permissions Service operation being requested.
AuthScopeScope of permissions to be requested for PayPal Permissions Service.
AuthSignatureAPI Signature for the PayPal Permissions Service.
AuthTokenSecretThe token secret returned by the PayPal Permission Service's GetAccessToken operation.
AuthUsernameAPI Username for the PayPal Permissions Service.
AuthVerificationCodeThe verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
BuildReturns the Build number contained in the response.
RawRequestReturns the raw request sent to the server.
RawResponseReturns the full response.
ResponseVersionReturns the Version number contained in the response.
VersionAllows the user to set the Version number in the request.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0