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
.
TransactionHistoryId
is a unique value assigned by
ProtectPay® and is the primary identifier that you should use when processing voids, refunds, or capture requests. It is the
ProtectPay®
API's primary transaction identifier.TransactionId
is a value assigned by the gateway to which ProtectPay sends a transaction request. One of the key competitive advantages that
ProtectPay® offers over most tokenization solutions is that it can process transactions against several credit card processing gateways. While TransactionHistoryId
is the primary identifier for
ProtectPay® transactions, you should also save TransactionId
so that, if you ever need to look up a transaction on your credit card gateway, you can easily find the one you are looking for.HTTP URL(s) | https://xmltestapi.propay.com/ProtectPay/VoidedTransactions/ |
HTTP Verb | PUT |
HTTP Header | Authorization |
SOAP Action | VoidPaymentV2 |
WSDL URL | https://xmltestapi.propay.com/protectpay/sps.svc?wsdl |
WSDL Operation | VoidPaymentV2(ID,VoidRequest) |
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. |
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. |
Your next step it familiarize yourself with how to refund a transaction.