Payment API

Commissions

Payment Facilitator

Void A Transaction

DOWNLOAD

You can void a credit or debit card transaction, which has been authorized but has not yet been sent to settlement. Use the ProtectPay® method VoidPaymentV2.

Transaction History ID and Transaction ID

All of the ProtectPay processing API methods, and all of the ProtectPay Payer Management Interfaces, including the Seamless Payment Interface described in this website's recommended flow return two separate transaction Identifiers. Understanding the purpose for, and use of each of these is important when processing Void transactions.

How to call this method:

HTTP URL(s)
HTTP Verb PUT
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
Method Implementation
Method Implementation
Dependencies
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 Required Interger Used to specify which processor and merchant account to process the transaction against.
*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 voids.
AVSCode Will return as Not Present as it is not applicable for voids.
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 voids.
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?

Your next step it familiarize yourself with how to refund a transaction.