Payment API

Commissions

Payment Facilitator

Create A Hosted Transaction

Once you have a PayerId, you can proceed by creating a checkout page that uses the HPP. Your next step is to provision an instance of our page and define many of its characteristics. Here are a few of the properties that you can define:

The response from the ProtectPay API will include a HostedTransactionIdentifier that is used when you wish to embed the HPP onto your checkout page.

Example Requests and Responses

How to call this method:

SOAP Action
WSDL URL https://protectpaytest.propay.com/API/SPS.svc?wsdl
WSDL Operation SPSService.CreateHostedTransaction(ID,HostedTransactionDetail)
Example Request
Example Response

How to call this method:

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

How to call this method:

You should submit a post of XML data to the following URL

HTTP URL(s)
HTTP Verb GET
HTTP Header Authorization
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.
Amount Integer Required The value representing the number of pennies in USD, or the number of [currency] without decimals.
AuthOnly Boolean Required* Valid values are:
  • true
  • false
If True: Only authorize the card transactions; The "ProcessCard" property is ignored.
AvsRequirementType Integer 1 Required Indicates if the 'AVS' section should be required, option, or hidden.
1 = Required: The section is required (it is displayed, and user must fill it out).
2 = Optional: The section is optional (is is displayed, and user may or may ot fill it out).
3 = Hidden: The section is hidden (it is not displayed to the user).
CardHolderNameRequirementType Integer 1 Required Indicates if the 'CardHolderName' section should be required, optional, or hidden.
1 = Required: The section is required (it is displayed, and user must fill it out).
2 = Optional: The section is optional (it is displayed, and user may or may not fill it out).
3 = Hidden: The section is hidden (it is not displayed to the user).
Comment1 String 128 Optional Comment 1 to be displayed to the user on the Hosted Page.
Comment2 DateTime -
CssUrl String 1024 Optional The fully qualified URL to use for the CSS that drives the look of the page.
  • Custom CSS Files must be hosted on HTTPS connection
  • Sending an empty value will remove all styles
CurrentyCode String 3 Required ISO 4217 standard 3 character currency code.
Fraudedetectors Object - Optional Please see ProPay Fraud Detection Solutions Manual
Frauddetectors.FrauddetectorsProviderName String Required * If using Frauddetectors Object this Element is required.
HostedTransactionIdentifier String - The hosted transaction ID (GUID) that was returned from the call to 'CreateHostedTransactionIdentifier'
InvoiceNumber String 50 Optional Highly recommended. Transaction description-only passed if supported by the gateway.
MerchantProfileId Long - Required Used to specify which processor and merchant account to process the transaction against.
OnlyStoreCardOnSuccessfulProcess Boolean - Required Valid values are:
  • true
  • false
Only stored the card information if the card transaction was successful.
* This is ignored if the 'StoreCard' property is set to true
PaymentTypeId String 1 Required Valid values are:
  • 0 = Credit Card
  • 1 = ACH
PaymentId
PayerAccountId REST Value
Long 16 Required The Payer under which the 'PaymentMethodId' should be created under. If no payer account is specified, a new payer account will automatically be created.
ProcessCard Boolean - Required * Valid values are:
  • true
  • false
Process (authorize and capture) the card transaction. This property is ignored if the 'AuthOnly' property is true.
SecurityCodeRequirementtype Integer 1 Required Indicates if the 'SecurityCode' section should be required, optional, or hidden.
1 = Required: The section is requierd (it is displayed, and user must fill it out).
2 = Optional: The section is optional (it is displayed, and user may or may not fill it out).
3 = Hidden: The section is hidden (it is not displayed to the user).
StoreCard Boolean Required * Valid values are:
  • true
  • false
Always store the card information. This is ignored if the 'OnlyStoreCardOnSuccessfulProcess' property is true.
Important* If [AuthOnly], [ProcessCard] and [StoreCard] are set to False, the hosted page will hosted page will not do anything.
Response Values
Response Element Type Notes
RequestResult.ResultValue String The ProtectPay API 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.
HostedTransactionIdentifier String Unique One Time use only identifier for a Hosted Transaction Page
Data from ProPay, Inc API documentation.