Boarding with ProPay's website (with web hooks)

Perhaps the easiest way that you can provide a great signup experience to your merchants is to send them to the ProPay website while using our web hooks solution to automatically obtain account information as they complete the signup process.

The signup experience can be co-branded for your specific merchants.
In the very near future, ProPay will also offer full-branding of the signup page along with the rest of the ProPay website. At present, much of the look and feel of the signup pages can already be customized.


Web hook setup.
  • You need to create a web page to "catch" our message, read it in, and do what you do with a newly signed up account.
  • You need to provide us with the IP address of that web page so that we can allow messages to go out of our system and to yours.
In order to use Web Hooks, there needs to be a shared value.
The ProPay Web-Hook message will contain both the ProPay information: 
  • The account number
  • The status of the account (whether the account was approved or denied)
  • The type of account that the user has signed up for. Some partners elect to offer several kinds of accounts to their merchants.
  • The accounts' expiration date and, if the account will be automatically renewed, its renewal frequency.
  • Processing limits for the new account
In order to make use of all this information, you need the ability to recognize the user for whom it is sent. ProPay passes one more, very important piece of data via our Web-Hook. An [externalId] is YOUR unique identifier. If you pre-populate the ProPay signup experience by passing an [externalId] into the ProPay signup URL, you can know of whom we speak when we send you a web-hook.

Example:
http://www.propay.com/?refid=[YOURSELF]F&exid=[YOURCUSTOMERIDENTIFIER]...

Query String Parameters
Parameter When do I receive this? Description
NotificationEvent On all notifications. The specific event that has occurred. See table 1.1 for possible values.
Status UserSignup , UserStatusChange The new status that this user’s account has entered. See table 1.2 for possible values.
UserEmail UserSignup , UserStatusChange The user’s email address
ExternalId UserSignup , UserStatusChange The user’s ID number
AccountNumber UserSignup , UserStatusChange The user’s account number
AccountType UserSignup, UserStatusChange The type of account that the user has signed up for.
SignupDateTime UserSignup The date/time that the user signed up, in mmddyyyy format.
ExpirationDateTime UserSignup The date/time that the user’s account will expire, in mmddyyyyhhmm format.
PerTransactionLimitCC UserSignup , UserStatusChange The account’s credit card processing per-transaction limit
MonthlyLimitCC UserSignup , UserStatusChange The account’s credit card processing monthly limit.
PerTransactionLimitAch UserSignup , UserStatusChange The account’s ACH processing per-transaction limit.
MonthlyLimitAch UserSignup , UserStatusChange The account’s ACH processing monthly limit.
PropayIn UserSignup , UserStatusChange Is the account allowed to receive funds from another ProPay account?
PropayOut UserSignup , UserStatusChange Is the account allowed to have its funds sent to another ProPay account?
AchFrom UserSignup , UserStatusChange Is the account able to receive funds from its own on-file direct deposit account?
AchTo UserSignup , UserStatusChange Is the account allowed to have its funds sent to its own on-file direct deposit account?
CCProcessing UserSignup , UserStatusChange Can the account currently process credit cards?
RenewalTerm UserSignup , UserStatusChange Renewal term for the account.
LineOfCredit UserSignup , UserStatusChange A line of credit that can be used to issue refunds when no funds are currently available.
CCHoldDays UserSignup , UserStatusChange A number of days that credit card transactions will be held before being made available in the account.
AchHoldDays UserSignup , UserStatusChange A number of days that ACH transactions will be held before being made available in the account.
IdentityId UserSignup , UserStatusChange The user’s Identity Id. Used with mobile API
AccountStatusChangeReason UserSignup , UserStatusChange The reason for user account status change.

Notification Events
NotificationEvent Description
UserStatusChange The user’s account status has been modified.
UserSignup The user has attempted to sign up for an account.

Statuses
Status Description
Ready User has been approved.
ClosedRisk User’s account has been cancelled because of a review by the Risk department.
ClosedCustomer User’s account has been cancelled.
UnPaid User has not paid yet.
Pending User is pending a review from the Risk department.
PendingUnpaid User is pending a review from the Risk department and has not paid yet.
Unpaid User has been approved but must still pay before account can be accessed.
Denied User’s account has been denied.

Reason for change
Reason Description
AccountCancellation Account cancelled (most often by account holder.)
AccountActivation Account moved to an active status.
Prohibited ProPay Risk Team has determined that this account has been used for prohibited business.
Fraud ProPay Risk Team has determined that this account has been used for fraud.
IDTheft ProPay Risk Team has determined that this account must be closed due to ID theft.
CustomerRequest The account status has been changed based on customer request.
CannotValidate Cannot validate this account owner’s identity.
PartnerRequest The account status has been changed based on a partner request.
DataChange Generic reason not otherwise categorized.
AccountCancellation Account cancelled (most often by account holder.)
AccountActivation Account moved to an active status.
Prohibited ProPay Risk Team has determined that this account has been used for prohibited business.
Fraud ProPay Risk Team has determined that this account has been used for fraud.
 
Just take me to the API docs