Merchant Services

Commissions

Payment Facilitator!

Account Signups

Use this service to create a new ProPay Commission account. ProPay will use the information provided to create the new account, and will respond to your request with an account number and temporary password.

Unique Email Constraint

ProPay uses email address that you provide as the username for your new account holder. As such, sourceEmail must be unique across the entire ProPay platform. If you submit a signup request with an already-used email address, you will receive a status response of 87 which indicates that the email address has already been taken. You should then instruct the user to choose another and try again.

Who Pays for the Account?

ProPay accounts require that an annual fee is collected before the customer is allowed to access his or her account. Partners can elect to pay for these fees, or can require that the merchant pay him or herself. If a partner chooses the latter option, payment data should be collected and provided as part of the signup process. Use the tags ccNum and expDate for this purpose.

Success, Failure, and International

In the United States and Canada, ProPay has integrated to providers who help us perform an identity check on new accounts. Outside of these markets, we cannot use these same systems and our process has to change a bit.

Good Data Validation is the Key to Successful Signups

In order to create an effective signup experience, a developer needs to quickly adopt the mindset that it is crucial to protect distributors from themselves. Otherwise they will be denied an account when ProPay performs our "Know Your Customer" process. The most common elements that users provide incorrect values for are as follows:

The double entry of key data fields such as SSN, and birth date, will prevent a user from 'fat fingering' information and failing identity checks. "Help" warnings next to important fields will help remind users of the importance of using correct information.


Example Requests and Responses

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)
Example Request
Example Response
Method Implementation
Method Implementation
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
Basic Account Information
NOTE Required, unless noted, for all transactions of this type.
REST/SOAP Element XML Element Type Max Required Notes
SignupAccountData{
Tier
tier String 55 Required* One of the previously assigned merchant tiers.
*If not provided, will default to cheapest available tier.
SignupAccountData{
CurrencyCode
currencyCode String 3 Optional Required to specify the currency in which funds should be held, if other than USD. An affiliation must be granted permission to create accounts in currencies other than USD. ISO 4217 standard 3 character currency code.
SignupAccountData{
ExternalId
externalId String 20 Optional This is a client's own unique identifier. Typically used as the distributor or consultant ID.
SignupAccountData{
PhonePin
phonePin String 4 Optional Numeric value which will give a user access to ProPay's IVR system. Also used to reset password.
SignupAccountData{
UserId
userId String 55 Optional ProPay account username. Must be unique in ProPay system.
*Username defaults to Merchant/Individual email if userId is not provided.
Address{
Address1
addr String 100 Required Merchant/Individual physical street Address. PO Boxes are not allowed.
Address{
City
city String 30 Required Merchant/Individual physical Address city.
PersonalData{
PhoneInformation{
DayPhone
dayPhone String Required Merchant/Individual day phone number.
*For USA and CAN, value must be 10 characters with no dashes
PersonalData{
DateOfBirth
dob String Required Merchant/Individual Date of birth. Must be in 'mm-dd-yyyy' format.
*Individual must be 18+ to obtain an account.
PersonalData{
PhoneInformation{
EveningPhone
evenPhone String Required Merchant/Individual evening phone number.
*For USA and CAN, value must be 10 characters with no dashes
PersonalData{
FirstName
firstName String 20 Required Merchant/Individual first names.
PersonalData{
LastName
lastName String 25 Required Merchant/Individual last name.
PersonalData{
SourceEmail
sourceEmail String 55 Required Merchant/Individual email address. Must be unique in ProPay system.
*ProPay's system will send automated emails to the email address on file unless Notification Email is specified.
*Truncated, if value provided is greater than max value.
PersonalData{
SocialSecurityNumber
ssn String Required Merchant/Individual social security number. Must be 9 characters without dashes.
*Required for USA.
Address{
State
state String 3 Required Merchant/Individual physical Address state.
*Standard 2 character abbreviation for state, province, prefecture, etc.
Address{
Zip
zip String Required Merchant/Individual physical Address zip/postal code.
*For USA: 5 or 9 characters without dash. For CAN: 6 characters postal code with a space "XXX XXX"
Address{
Address2
addr3 String 100 Optional Merchant/Individual physical Address.
Address{
Country
country String Optional ISO 3166 standard 3 character country codes. Required if creating an account in a country other than USA.
*Country must be an approved country to create a ProPay account.
MailAddress{
Address1
mailAddr String 100 Optional Merchant/Individual mailing address if different than physical address.
MailAddress{
Address2
mailAddr3 String 100 Optional Merchant/Individual mailing address if different than physical address.
Address{
City
mailCity String 30 Optional Merchant/Individual mailing city if different than physical address.
Address{
State
mailState String 3 Optional Merchant/Individual mailing state if different than physical address.
*Standard 2 character abbreviation for state, province, prefecture, etc.
Address{
Zip
mailZip String Optional Merchant/Individual mailing zip/postal code if different than physical address.
*For USA: 5 or 9 characters without dash. For CAN: 6 characters postal code with a space "XXX XXX"
PersonalData{
MiddleInitial
mInitial String 2 Optional Merchant/Individual middle initial.
PersonalData{
NotificationEmail
NotificationEmail String 55 Optional Merchant/Individual email address.
*ProPay's system will send automated emails to the email address on file.
For a complete list of elements refer to ProPay's API documentation.
Merchant Threat Risk Assessment Information
NOTE Required for usage of Threat Assessment.
REST/SOAP Element XML Element Type Max Required Notes
FraudDetectionData{
MerchantSourceIp
MerchantSourceIp String 64 Required Source of Merchant, see ProPay Fraud Detection Solutions Manual.
FraudDetectionData{
ThreatMetrixPolicy
ThreatMetrixPolicy String 32 Required Threat Metrix Policy, see ProPay Fraud Detection Solutions Manual.
*Threat Metrix Only
FraudDetectionData{
ThreatMetrixSessionId
ThreatMetrixSessionId String 128 Required SessionId for Threat Metrix, see ProPay Fraud Detection Solutions Manual.
*Threat Metrix Only
For a complete list of elements refer to ProPay's API documentation.
Primary Bank Account Information
NOTE Required, unless noted, if adding Personal Bank Account information.
REST/SOAP Element XML Element Type Max Required Notes
BankAccount{
AccountCountryCode
AccountCountryCode String 3 Required ISO standard 3 character country code for a foreign currency transaction.
BankAccount{
AccountName
accountName String 32 Required Merchant/Individual Name
BankAccount{
BankAccountNumber
AccountNumber String 25 Required Financial institution account number
BankAccount{
AccountOwnershipType
AccountOwnershipType String 15 Required Valid values are:
  • Personal
  • Business

* If accountType is G, then this value is always overwritten as 'Business'

BankAccount{
AccountType
accountType String 1 Required Valid values are:
  • C – Checking
  • S – Savings
  • G – General Ledger
BankAccount{
BankName
BankName String 50 Required Name of financial institution.
BankAccount{
RoutingNumber
RoutingNumber String 9 Required Financial institution routing number.
*Must be a valid ACH routing number
Description String 50 Optional Merchant/Individual description of account
For a complete list of elements refer to ProPay's API documentation.
Merchant Business Information
NOTE Required, unless noted, for Merchant Accounts.
REST/SOAP Element XML Element Type Max Required Notes
AuthorizedSigner{
FirstName
AuthorizedSignerFirstName String 20 Best Practice Seller's Authorized Signer First Name. By default Merchant's First name is saved*.
AuthorizedSigner{
LastName
AuthorizedSignerLastName String 25 Best Practice Seller's Authorized Signer Last Name. By default Merchant's Last name is saved*.
AuthorizedSigner{
Title
AuthorizedSignerTitle String 20 Optional This field contains the Seller's Authorized Signer Title*. Commonly used Authorized Signer Titles include:
Owner President
Vice President
Treasurer
Controller or Comptroller
CEO or CFO
Chairman
General
Manager
Partner
Co-owner
Director
Office Manager
BusinessData{
AverageTicket
AverageTicket Int(64) Signed Int(64) Best Practice The average amount of an individual transaction; Value representing the number of pennies in USD, or the number of [currency] without decimals. Defaults to $300.00 if not sent.
BusinessAddress{
Address1
BusinessAddress String 100 Best Practice Business Physical Address
BusinessAddress{
Address2
BusinessAddress2 String 100 Optional Business Physical Address
BusinessData{
BusinessLegalName
BusinessLegalName String 255 Best Practice The legal name of the business as registered.
BusinessAddress{
City
BusinessCity String 30 Best Practice Business Physical Address City
BusinessAddress{
Country
BusinessCountry String Best Practice Must be ISO standard 3 character country code.
BusinessData{
BusinessDescription
BusinessDescription String 255 Best Practice The Business' description
BusinessAddress{
State
BusinessState String 3 Best Practice If domestic signup this value MUST be one of the standard 2 character abbreviations. Rule also applies for Canadian signups. (Must be standard province abbreviation.)
BusinessAddress{
Zip
BusinessZip String Best Practice For USA: 5 or 9 characters without dash. For CAN: 6 characters postal code with a space "XXX XXX"
BusinessData{
DoingBusinessAs
DoingBusinessAs String 255 Best Practice This field can be used to provide DBA information on an account. ProPay accounts can be configured to display DBA on cc statements.
BusinessData{
EIN
EIN String Best Practice Employer Identification Number can be added to a ProPay account.
BusinessData{
HighestTicket
HighestTicket Int(64) Signed Int(64) Best Practice The highest transaction amount; Value representing the number of pennies in USD, or the number of [currency] without decimals. Defaults to $300.00 if not sent.
BusinessData{
MerchantCategoryCode
MCCCode String 4 Optional Merchant Category Code
BusinessData{
MonthlyBankCardVolume
MonthlyBankCardVolume Int(64) Signed Int(64) Best Practice The monthly volume of bank card transactions; Value representing the number of pennies in USD, or the number of [currency] without decimals. Defaults to $1000.00 if not sent
SignificantOwner{
FirstName
SignificantOwnerFirstName String 20 Optional For US: Seller's Significant Owner First Name.
For CAN: Seller's Significant Owner or Authorized Signer First Name.
SignificantOwner{
LastName
SignificantOwnerLastName String 20 Optional For US: Seller's Significant Owner Last Name.
For CAN: Seller's Significant Owner or Authorized Signer Last Name.
SignificantOwner{
SSN
SignificantOwnerSSN String 9 Optional Social Security Number of the Seller's Significant Owner. Should be 9 digits.
SignificantOwner{
DateOfBirth
SignificantOwnerDateOfBirth Date Optional Date of Birth of the Seller's Significant Owner. Must be in ‘mm-dd-yyyy' format.
SignificantOwner{
Address1
SignificantOwnerStreetAddress String 40 Optional Street address where Seller's Significant Owner resides.
SignificantOwner{
City
SignificantOwnerCityName String 40 Optional The name of the city where the Seller's Significant Owner resides.
SignificantOwner{
RegionCode
SignificantOwnerRegionCode String 6 Optional The region code that corresponds to the state where the Seller's Significant Owner resides.
SignificantOwner{
Zip
SignificantOwnerPostalCode String 9 Optional The postal code for where the Seller's Significant Owner resides.
SignificantOwner{
CountryCode
SignificantOwnerCountryCode String 2 Optional The two-character, alpha country code for where the Seller's Significant Owner resides.
SignificantOwner{
Title
SignificantOwnerTitle String 50 Optional This field contains the Seller's Significant Signer Title.
SignificantOwner{
Percentage
SignificantOwnerPercentage Byte Optional Percentage for Significant Owner. Percentage should be in between 0 and 100.
BusinessData{
WebsiteURL
WebsiteURL String 255 Best Practice The Business' website URL
For a complete list of elements refer to ProPay's API documentation.
Account Payment Information
NOTE Required, unless noted, for account payment.
REST/SOAP Element XML Element Type Max Required Notes
CreditCardData{
CreditCardNumber
ccNum String 16 Optional Must pass Luhn check. Used to pay for an account if ProPay has not set account type up as free to users
CreditCardData{
ExpDate
expDate String 4 Optional Used to pay for an account if ProPay has not set account type up as free to users. Submitted as mmyy
PaymentMethodId paymentMethodId String Optional Used to pay for an account via a ProtectPay Payment Method ID. Valid value is a GUID
PaymentBank{
AccountNumber
PaymentBankAccountNumber String Optional Used to pay for an account via ACH and monthly renewal. Financial institution account number
PaymentBank{
RoutingNumber
PaymentBankRoutingNumber String Optional Used to pay for an account via ACH and monthly renewal. Financial institution routing number.
*Must be a valid ACH routing number.
PaymentBank{
AccountType
PaymentBankAccountType String Optional Used to pay for an account via ACH and monthly renewal. Valid values are:
  • Checking
  • Savings
  • GeneralLedger
* If an account is set to be paid for by the individual user, either this information must be passed, or the account holder must log into the ProPay website to pay for the account before it will be fully functional.
For a complete list of elements refer to ProPay's API documentation.
Response Values
REST/SOAP Element XML Element Type Notes
status String Result of the transaction request.
See ProPay API Appendix B for result code definitions.
accntNum Integer Assigned to each account by ProPay.
password String Temporary password. Will need to be charged on first login.
sourceEmail String Email address used for signup.
tier String Type of ProPay account provided to user.
For a complete list of elements refer to ProPay's API documentation.

What's Your Next Step?