Merchant Services

Commissions

Payment Facilitator!

Get the Hosted Transaction's Results

When the ProtectPay Hosted Payments Page is finished processing a customer payment, it will return a simple “success” message to the page which called it. Upon receipt of this message, you should use GetHostedResult to obtain the results of a transaction completed on the Hosted Payment Page. As a means to combat spoofing, the Hosted Page does not provide the merchant with a response that includes information on the success or failure of payment processing. Instead, the merchant should make this call to the ProtectPay API and get the transaction’s result.

Example Requests and Responses

How to call this method:

SOAP Action GetHostedResult
WSDL URL https://xmltestapi.propay.com/protectpay/sps.svc?wsdl
WSDL Operation SPSService.GetHostedResult (ID)
Example Request
Example Response

How to call this method:

HTTP URL(s)
HTTP Verb GET
HTTP Header Authorization
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 Element Type Max Required Notes
AuthorizationToken String 100 Authorization Valid value is a GUID. Values supplied by ProPay. Used to access the PCI.
BillerAccountID String 16 Authorization Value supplied by ProPay. Used to identify the correct collection of tokens.
HostedTransactionId String 36 Required The hosted transaction ID (GUID) that was returned from the cell to "CreateHostedTransactionIdentifier"
Response Values
Response Attribute Type Notes
RequestResult.RequestValue String The Method Response Value:
SUCCESS indicates the method completed;
FAILURE indicates the method call failed and the reason is indicated in the ResultCode and ResultMessage
RequestResult.ResultCode String The ProtectPay API Method Response Code. See Protectpay API Appendix
RequestResult.ResultMessage String The ProtectPay API Method Response Message.
AuthCode String The auth code supplied by the issuing bank.
* Only returned on a successful transaction.
AVSResponse String AVS response produced by gateway.
* Only returned if AVS information is supplied and AVS is supported by the gateway.
CreationDate DateTime Date the Hosted Transaction Identifier was created.
CurrencyConversionRate Decimal The rate for currency conversion used for multi-currency transactions.
CurrencyConvertedAmount Long Gross converted amount of transaction in the number of [currency] without decimals for multi-currency transactions.
CurrencyConvertedCurrencyCode String The currency the transaction was converted to for multi-currency transactions.
CVVResponseCode String The issuer CVV response
* Only returned if supplied
* ProtectPay WILL NOT share the CVV code of the Credit Card Payment Method.
GrossAmt Long Gross amount of transaction of pennies in USD, or the number of [currency] without decimals.
GrossAmtLessNetAmt Long Total amount of fees charged, * ProPay Gateway Only.
HostedTransactionIdentifier String The hosted transaction ID (GUID) that was returned from the call to "CreateHostedTransactionIdentifier"
NetAmt Long Net amount of transaction after fees charged. * ProPay Gateway Only.
PayerId Long The PayerId of the Payment Method if requested to Store Payment Method and belongs to the BillerID that created the Transaction.
PaymentMethodInfo Collection
PaymentMethodInfo.AccountName String The name on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.Address1 String The address on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.Address2 String The address on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.Address3 String The address on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.City String The city on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.Country String The country on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.Email String The email on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.State String The state on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.TelephoneNumber String The telephone number on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.BillingInformation.ZipCode String The postal code on the account for a payment method. * Stored if requested to store payment.
PaymentMethodInfo.DateCreated DateTime Date the PaymentMethodID was created. * Stored if requested to store payment.
PaymentMethodInfo.Description String Description of the Payment Method as Input by the payer. * Stored if requested to store payment.
PaymentMethodInfo.ExpirationDate String Expiration Date of the Payment Method. * Stored if requested to store payment.
PaymentMethodInfo.ObfuscatedAccountNumber String Obfuscated Account Numberof the Payment Method. * Stored if requested to store payment.
PaymentMethodInfo.PaymentMethodId String This is the ProtectPay ID for the Payment Method, also called Token belongs to the PayerId it was created for.
* Stored if requested to store payment.
PaymentMethodInfo.PaymentMethodType String The Payment Method Type:
  • Visa
  • MasterCard
  • AMEX
  • Discover
  • DinersClub
  • JCB
  • ProPayToProPay
  • Checking
  • Savings
PaymentMethodInfo.Protected Boolean Payment methods set to 'true' cannot be deleted by a payer
PerTransFee Int Per transaction fee. * ProPay Gateway Only
Rate Decimal Percentage fee. * ProPay Gateway Only
TransactionHistoryId Long Unique transaction number assigned by ProtectPay
TransactionId String Transaction number assigned by processor (Gateway)
TransactionResult String The result value of the transaction request as reported by ProtectPay SUCCESS or FAILURE
TransactionResultMesssage String The ProtectPay API Method Response Code. See Protectpay API Appendix
Data from ProPay, Inc PCI documentation.