ProPay Provisioning Transaction UML

Entity that represents information about provisioning transaction as it is represented in ProPay certification.

Identifier of the account assigned by a processor.

Country code specified in ProPay account.

Name of the ProPay account.

Account number of the user. Required if adding bank account info as part of the signup

Encoded account number.

Masked account number of the client.

Required if adding bank account info as part of the signup. Valid values are ‘Personal’ or ‘Business’ If accountType is G, then this value is always overwritten as ‘Business’.

Type of account from which funds are being pulled. Valid values are “Savings” or “Checking”.

Address of the user.

Physical address of the user.

Either aptNum or addr2. Do not supply both for this field. Refer to the cpecification of the processor for more information.

Name of the issuing bank.

Business address of the user.

Address (line 2) of the business address.

City of the associated business address.

Country code of the business address.

State code of the business address of the client.

ZIP (or postal) code of the business address. If domestic signup this value MUST be either 5 or 9 characters with no dash. For Canada this value MUST be 6 characters.

City address of the user.

Country code of the business address.

Code of the currency used in the transaction.

Day phone used for iscussing any processing issues. If domestic or Canadian signup this value must be 10 characters with no dash.

Description of bank account. ‘Personal’ or ‘Business’.

The date of birth of the user.
mm-dd-yyyy. The person must be at least 18 years old to obtain an account.

Merchant's DBA ("Doing Business As") name.

Employer identification number associated with transaction.

Encoded EIN (Employer Identification Number).

Note: EIN can be added to a ProPay account. Including this value does not satisfy the SSN requirement for SSN.

Code of the error message generated by the procesor.

Error message generated by a processor.

Evening phone number for discussing any processing issues. If domestic or Canadian signup this value must be 10 characters with no dash.

Expiration date of the credit card used in the transaction.

External identification number of the account. One of the optional account identification values.

First name of the ProPay account holder.

Identifier of the object used for references; auto-incremented integer value.

Omit unless specially instructed by ProPay.

Transient field that indicates whether it is required to send additional data to the processor or not.

Last name of the ProPay account holder.

Mailing address of the user.

Mailing address values will override user address for shipping a debit card.

City mailing address of the user.

Mailing address of the ProPay account.

State code of the mailing address of the user.

ZIP (or postal) code of the mailing address of the user. If domestic signup this value MUST be either 5 or 9 characters with no dash. For Canada this value MUST be 6 characters.

Merchant category code.

Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.

The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

Title of the customer.

Password associated with user ProPay account.

Used to pay for an account via a ProtectPay Payment Method ID. Valid value is a GUID.

Numeric value which will give access to your user to ProPay’s IVR system. Also used to reset password if you forget your login.

Code of the portfolio associated with the record.

Reference to the entity taht represents information about provisioning transaction.

Code of the reseller assigned to the transaction.

Reference to the entity that represents a group of real-time transactions which must be settled together.

Routing number of the bank account.

Encoded routing number of the bank account.

Masked routing number of the bank account.

Required if adding secondary bank account. Must be ISO standard 3 character code. This will become the account to which proceeds of transactions are sent in split sweep functionality.

Required if adding secondary bank account info as part of the signup. This will become the account to which proceeds of transactions are sent in split sweep functionality.

Secondary bank account number.

Encoded secondary account number.

Required if adding secondary bank account info as part of the signup. This will become the account to which proceeds of transactions are sent in split sweep functionality.

Required if adding secondary account as part of the signup. Valid values are ‘Personal’ or ‘Business’ If accountType is G, then this value is always overwritten as ‘Business’ This will become the account to which proceeds of transactions are sent in split sweep functionality.

Required if adding secondary bank account info as part of the signup. Valid values are ‘Checking’, ‘Savings’, or simply ‘C’ or ‘S’. ‘G’ must be passed for GL accounts. This will become the account to which proceeds of transactions are sent in split sweep functionality.

Secondary bank name. This field is needed for "Edit Account" request.

Secondary routing number of the secondary bank account.

Encoded secondary routing number.

Required if adding secondary bank account info as part of the signup, must be a valid Fedwire ACH participant routing number. This will become the account to which proceeds of transactions are sent in split sweep functionality.

Omit unless specially instructed by ProPay.

Required for USA. Not for CAN or other country codes. Must be 9 characters with no dash if USA.

Encoded SSN (Social Security Number).

State of the physical address of the user.

Status of the transaction.

Identifier of the terminal assigned within the system.

The type of ProPay account owned by this user. Your ProPay affiliation will have pre-defined tiers available to it.

Type of the transaction.

Short description of the processed transaction (if required).

Unique identifier of the ProPay user.

ZIP (or postal) code o the client's address.