Payment API

Commissions

Payment Facilitator

Refund a Transaction

SHARE

This method is used to refund a completed debit or credit card transaction that has been settled. Here are the cases when you should use this method:

  1. When voids are not possible. (Many gateways will not allow you to void a transaction after it has been captured. ProPay® allows this but only until the transaction has been sent to the card brand, or until the merchant has received funds for the transaction.
  2. To perform a partial refund.

As you run this method you will find the server's response codes below.

How to call this method:

HTTP URL(s)
HTTP Verb GET
HTTP Header Authorization
Example Request
Example Response

How to call this method:

SOAP Action GetTempToken
WSDL URL https://protectpaytest.propay.com/API/SPS.svc?wsdl
WSDL Operation SPSService.GetTempToken(TempTokenRequest)
Example Request
Example Response
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation Header
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Request Values
Request Attribute Max Length Required Format Notes
AuthenticationToken 100 Authorization String Valid value is a GUID. Value supplied by ProPay®. Used to access the API.
BillerAccountId 16 Authorization String Value supplied by ProPay®. Used to identify the correct collection of tokens.
Comment1 128 No String
Comment2 128 No String
MerchantProfileId No Interger Used to specify merchant account when your biller ID has access to multiple merchant accounts.
*If your account is set to point to multiples this value is required.
originalTransactionID No** String Identifier for the transaction you wish to capture.
This value would have been returned to you by AuthorizePaymentMethodTransaction.
**This is the Gateway's identifier.
TransactionHistoryId No** Interger Identifier for the transaction you wish to capture.
This value would have been returned to you by AuthorizePaymentMethodTransaction.
**This ProtectPay's identifier.
** Either the originalTransactionID or the TransactionHistoryId is required. If both are sent, the TransactionHistoryId is disregarded and the originalTransactionID is used.
Response Values
Request Attribute Notes
RequestResult.ResultValue The ProtectPay® API Method Response Value;
SUCCESS: indicates the method completed;
FAILURE: indicates the method call failed and you should reference the code and message.
RequestResult.ResultCode The ProtectPay® API Method Response Code.
RequestResult.ResultMessage The ProtectPay® API Method Response Message.
AuthorizationCode Will return null as it is not applicable for Refunds.
AVSCode Will return as Not Present as it is not applicable for Refunds.
CurrencyConversionRate The rate for currency conversion used for multi-currency transactions.
CurrencyConvertedAmount Gross converted amount of transaction in the number of [currency] without decimals for multi-currency transactions.
CurrencyConvertedCurrencyCode The currency the transaction was converted to for multi-currency transactions.
CVVResponseCode Will not Return as it is not applicable for Refunds.
GrossAmt Gross amount of transaction of pennies in USD, or the number of [currency] without decimals.
GrossAmtLessNetAmt Total amount of fees charged; *ProPay® Gateway Only.
NetAmt Net amount of transaction after fees charged; *ProPay® Gateway Only.
PerTransFee Per transaction fee; *ProPay® Gateway Only.
Rate Percentage fee; *ProPay® Gateway Only.
Transaction.ResultCode.ResultValue The result value of the transaction request as reported by the ProtectPay®. SUCCESS or FAILURE
Transaction.ResultCode.ResultCode The result code of the transaction request as reported by ProtectPay®.
Transaction.ResultCode.ResultMessage The result message of the transaction request as reported by ProtectPay®.
TransactionHistoryId Unique transaction number assigned by ProtectPay.
TransactionId Transaction number assigned by processor (Gateway).
TransactionResult Transaction result as reported by processor (Gateway).
Data from ProPay, Inc API documentation.

What's Your Next Step?

Congratulations, once you've completed the Void and Refund sections, you've completed your integration!