Version 6.18.

20

PROPAY® APPLICATION PROGRAMMING INTERFACE - REST

Instruction to interface with ProPay®
 Revision History
Date Version Description Author
Updated various wording and 2ormatting
01/15/2020 6.18.7 Implementations
Updated Sample request for signups to include Beneficial Owner Data
01/23/2020 6.18.8 Added General Ledger to Gross Billing Bank Account Implementations
Updated several sample request
04/21/2020 6.18.9 Implementations
Updated birthday description field to reflect change in values to get a success
Added New Methods:
 4.2 Edit a ProPay Account sections 4.2 to 4.9
 5.6 Flash Funds – Add or Change Card Assigned to a ProPay Account
 5.7 Flash Funds – Push Funds to On-File Card
06/09/2020 6.18.10 Implementations
 8.2 Get Current ProPay Account Balance
**Note: To standardize new REST methods these will require the account number to
be included in the Resource URI. See specific section for details. Existing methods will
be updated in the future with sufficient notice.
Added New Method:
07/07/2020 6.18.11 Implementations
 8.4 Enhanced Account Details
2/17/2020 6.18.12 Portico updates added Implementations

7/7/22 6.18.13 Added new previous address and business info and tags to Transtype 01 Product

01/12/23 6.18.14 Added new UK tabs to transtype 42 (edit account and business address) Product
02/24/23 6.18.15 Added Equifax Address Lookup (Transtype 212) Product

03/01/23 6.18.16 Added beneficial owner info (Transtype 01) Previous address, etc. Product

09/07/23 6.18.16 Added 4.31 – Device order Tax Calculation Product

10/02/23 6.18.17 Added 4.30 – Device order (Transtype 430) Product

01/09/24 6.18.18 Added 4.32 – Edit Merchant Transfer Funds Configuration, Added Sweep note to 8.4 Product
04/09/24 6.18.19 Added additional fields to 8.4 – enhanced account ping Product
04/17/24 6.18.20 changed notes for average, highest, and bankcardvolume defaults to null, 4.1, 8.4 Product

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 2
Contents
GENERAL INFORMATION ABOUT THE PROPAY REST INTERFACE .................................................................................................................................. 4
4.1 CREATE A PROPAY ACCOUNT ................................................................................................................................................................................................ 5
4.2 EDIT A PROPAY ACCOUNT.................................................................................................................................................................................................... 25
4.21 Edit Merchant Contact Info .......................................................................................................................................................................................................................... 25
4.22 Edit Merchant Account Address ................................................................................................................................................................................................................. 27
4.23 Edit Merchant Renewal Payment Method ................................................................................................................................................................................................ 29
4.25 Edit Merchant Bank Account ....................................................................................................................................................................................................................... 32
4.26 Edit Merchant Gross Settle Payment Info ................................................................................................................................................................................................. 33
4.27 Edit Merchant Services ................................................................................................................................................................................................................................. 35
4.28 Edit Merchant Status ..................................................................................................................................................................................................................................... 37
4.29 Edit Merchant Credit Limit .......................................................................................................................................................................................................................... 38
4.30 Order a New Device ....................................................................................................................................................................................................................................... 39
4.31 Device order Tax Calculation ...................................................................................................................................................................................................................... 41
4.32 Edit Merchant Transfer Funds Configuration .......................................................................................................................................................................................... 43
4.3 ADDRESS LOOKUP (EQUIFAX) ............................................................................................................................................................................................ 44
4.4 RENEW PROPAY ACCOUNT .................................................................................................................................................................................................. 46
4.8 UPLOAD A CHARGEBACK DOCUMENT TO PROPAY ..................................................................................................................................................... 48
5.6 FLASH FUNDS – ADD OR CHANGE CARD ASSIGNED TO A PROPAY ACCOUNT .................................................................................................... 49
5.7 FLASH FUNDS – PUSH FUNDS TO ON-FILE CARD .......................................................................................................................................................... 50
7.1 PROPAY ACCOUNT PAYMENT DISBURSEMENT ............................................................................................................................................................ 51
7.5 SPLIT FUNDS FROM A PROPAY TRANSACTION (TIMED PULL) ............................................................................................................................... 52
8.2 GET CURRENT PROPAY ACCOUNT BALANCE ................................................................................................................................................................. 54
8.4 ENHANCED ACCOUNT DETAILS .......................................................................................................................................................................................... 56

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 3
General Information about the ProPay REST Interface
REST combines a base URI, mapped Resource URI elements, and standard HTTP methods for many ProPay API methods.
- When using the GET or DELETE HTTP methods, the API request does not need more information passed.
- When using POST and PUT HTTP methods, information is sent in the form of JavaScript Object Notation (JSON) objects.
- The API will return a JSON object as a response to each API request regardless of which HTTP method was used.
- When submitting JSON objects in an API request, the Content-Type should be set to ‘application/json’ and the Content-Length field should be set
to the length of the data.
- Developers should be prepared to handle null values. In case of a null value the ProPay API REST API may return “:null” or the element may not
be returned.

API Authorization
The REST interface uses Basic HTTP Authentication for API requests, with the CertStr as the username and the TermId as the password. This must be
added to the HTTP header as the value of the ‘Authorization’ field. Creating the Authorization Header value requires the following steps:
1. Combine the CertStr, a Colon, and the termId (MyCertStr:MyTermId). If a termId has not been provided only use the CertStr without a colon
(MyCertStr).
2. Convert the Result of Step 1 to an ASCII Byte Array
3. Base 64 Encode the Result of Step 2
4. Prepend “Basic “ to the Result of Step 3
5. Add ‘Authorization’ as an HTTP header and set its value to the result of Step 4

Sample HTTP Header

HTTP Header Field Value
Authorization Basic TXlUZXJtSWQ6TXlDZXJ0U3Ry
Content-Length *Varies Depending on Length of Content submitted
Content-Type application/json
Method *Varies Depending on Method: GET, DELETE, PUT, POST

Resource URI and HTTP Methods

The request URI is constructed from a Base URI and a Resource URI appended. A Resource URI may be used differently based on the HTTP verb of
the request. Consider the following Example:

ProPay Integration environment Base URI: https://xmltestapi.propay.com

Resource: /propayAPI/signup
HTTP Method: PUT
Request Endpoint: PUT https://xmltestapi.propay.com/propayapi/signup

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 4
4.1 Create a ProPay Account
This section describes data required to create a ProPay merchant account.
- Upon successful creation, an account number and temporary password will be returned. If the new account holder logs into ProPay’s website,
he or she will be afforded the opportunity to change his or her password.
- Items flagged a “Best Practice” are highly recommended when boarding a new merchant. Not providing these fields may increase the
likelihood of holds being placed on production accounts.

Identity Verification
In order to comply with Industry regulations and legal requirements, ProPay must validate the identity of each merchant account created. ProPay
uses a major third-party credit reporting services to perform identity validation on the individual or business enrolling for each account. Validation will
be performed based on either:

Personal Information
This validation is performed using the supplied required merchant/distributor personal information. Exact requirements differ by market.
- In the U.S. a social security number is required and used to validate the applicant’s identity
- In Canada, no specific government-issued document is required
- In Australia and New Zealand, the Medical Insurance Number is recommended for higher approval rates

Business Information
ProPay can validate a business using its Tax ID number along with other required fields. Note: Business validation is not possible for card-only
accounts or, currently, outside of the U.S. Approval to perform business validation is required.
- Business Accounts are ineligible for ProPay MasterCards
- Business Accounts cannot utilize ProPay API method 4.2.2. Reset ProPay Account Password. Passwords are reset online by supplying the EIN
instead of SSN, or by contacting ProPay Customer Service (NOTE: for UK merchants, do not pass the EIN value.)

ThreatMetrix Signup Validation:

ProPay uses a best in class fraud prevention tool provided by ThreatMetrix. Some of our API partners may also be required to implement this solution
into their own signup flows. ThreatMetrix requires that:
- The partner includes an ‘iFramed’ widget on their website. Into the URL of this iFrame, the partner passes a unique ID of their own creation.
- The partner then includes extra data in their signup API request (Including the same unique identifier passed into the iFrame).

International Signups:
Designating a signup as international is accomplished by specifying a <country> tag other than USA. If <country> is not passed, USA is assumed.
Most international signups are performed for a ProPay Card-Only account that cannot process credit cards. Merchant accounts are currently
available only in the US, Canada, Australia and New Zealand. Many of the formatting rules that exist for domestic signups are relaxed for
international accounts and many of the required tags are optional for international signups. Please note that state and country are still limited to 3
characters for international signups.

Even though addresses outside of the United States contain values other than ‘zip code’ or ‘state’, ProPay uses these tags to define their analogous
counterparts. Please use <zip> to define any type of postal routing code, and use <state> to define a province, county, shire, prefecture, etc.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 5
In the United States, state values must conform to standardized abbreviations, and zip codes must be of either 5 or 9 digit lengths without a dash.
These restrictions are not true for international signups where <state> can be longer than two characters. Formatting characters such as spaces and
dashes should be omitted, unless these are considered part of the actual state or zip in that country.

Similarly, in the United States, phone numbers must be standardized as ten digits while outside of the US, lengths may vary. Please omit all formatting
characters.

Paying for a ProPay Account

If the client program is configured in such a way that the business entity will pay for all ProPay accounts enrolled under its affiliation, or that the
individual users will pay ProPay directly when activating their account, no payment information is required to be submitted at the time of enrollment.

ProPay accounts must be paid for before funds can be accessed or payment transactions may be performed. If the client program involves a
direct payment for the account by the user at the time of enrollment, the optional payment information elements may be passed in the request.
International Card-Only accounts may receive commission disbursements prior to ID verification, but the user will not be able to access funds until
activation is complete.

Special notes on the use of ExternalId tag:

Generally the ‘ExternalId’ tag is used to store a value in ProPay that identifies the user in the client solution system. Omitting the ExternalId may
prevent users from restoring a lost password, and prevents an affiliate from performing a request for account details from ProPay using that value.

Personal Data – Required

Element Type Max Required Notes
PersonalData{
String 20 Required Merchant/Individual first names.
FirstName
PersonalData{
String 2 Optional Merchant/Individual middle initial.
MiddleInitial
PersonalData{
String 25 Required Merchant/Individual last name.
LastName
PersonalData{ Merchant/Individual Date of birth. Must be in ‘mm-dd-yyyy’ format. *Individual must be 18+ to obtain an
String Required
DateOfBirth account. A birthday of 01-01-1971 will return a Status 66 (Failed KYC) in the test environment.
PersonalData{ Merchant/Individual social security number. Must be 9 characters without dashes. *Required for USA when
String 9 Optional*
SocialSecurityNumber using personal validation. If business validated, do not pass!
Merchant/Individual email address. Must be unique in ProPay system. *ProPay’s system will send automated
PersonalData{
String 55 Required emails to the email address on file unless NotificationEmail is provided. *Truncated, if value provided is greater
SourceEmail
than max value.
PersonalData{
Merchant/Individual day phone number. *For USA, CAN, NZL and AUS value must be 10 characters with no
PhoneInformation{ String Required
dashes
DayPhone
PeronsalData{
Merchant/Individual evening phone number. *For USA, CAN, NZL and AUS value must be 10 characters with no
PhoneInformation{ String Required
dashes
EveningPhone
PersonalData{ Communication Email Address. *ProPay’s system will send automated emails to the NotificationEmail address
String 55 Optional
NotificationEmail on file rather than the Source Email.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 6
 PersonalData{
String 5 Optional Required for partners ordering Portico devices. Supported values (UTC, PT, MST, MT, CT, ET, HST, AT, AST, AKST)
TimeZone
PersonalData{
String Optional Signup IP Address
IPSignup
PersonalData{ When marked true, the submerchant is attesting that they are a US citizen. (Value passed should be either true,
String Optional
USCitizen false, or null)
When marked true, the submerchant is attesting that there are no other individuals that have 25% ownership or
PersonalData{ a controlling interest in the entity that have not already been disclosed elsewhere in the application
String Optional
BOAttestation process. The partner is also attesting that a pop up or other message has been displayed to the submerchant
to explain these requirements. (Value Passed should be Either true, false or null)
PersonalData{ The IP address of the device that was used to agree to ProPay's Terms and Conditions.(Maximum value should
String Optional
TermsAcceptanceIP be accepted 15 characters)
PersonalData{
TermsAcceptanceTim String Optional The timestamp associated with the agreement to ProPay's Terms and Conditions
eStamp
This refers to the version of our terms and conditions that was provided to the submerchant for review and to
which they are agreeing.(Valid numeric values are 1 - 5

PersonalData{ 1 - merchant US
String Optional
TermsVersion 2 - payment US
3 - merchant CA
4 - merchant UK
5 - merchant AU)
This represents the country in which the merchant was born. ISO 3166 3 Digit alpha code applies. For Example:
PersonalData{
String 3 Optional GBR, USA, etc.
Nationality
*Mandatory for UK merchants
Required to specify the currency in which funds should be held, if other than USD. An affiliation must be
SignupAccountData{
String 3 Optional* granted permission to create accounts in currencies other than USD. ISO 4217 standard 3 character currency
CurrencyCode
code.
SignupAccountData{
String Optional* One of the previously assigned merchant tiers. *If not provided, will default to cheapest available tier.
Tier
SignupAccountData{ This is a partner’s own unique identifier. Typically used as the distributor or consultant ID. For UK Merchant, use
String 20 Optional
ExternalId to capture Partner Bank CIN
SignupAccountData{
String 4 Optional Numeric value which will give a user access to ProPay’s IVR system. Can also be used to reset password.
PhonePin
SignupAccountData{ ProPay account username. Must be unique in ProPay system. *Username defaults to <sourceEmail> if userId is
String 55 Optional
UserId not provided.

Personal Address - Required
Element Type Max Required Notes
Address{ Merchant/Individual physical street Address. PO Boxes are not allowed. Alphanumeric. *For UK merchants, this is
Address1 String 100 Required Merchant/Individual physical street Address without the building / house number. For Example: 501a Halfway Street –
Value for this tag would be Halfway Street. *Mandatory for UK Merchants
Address{ String 100 Optional Merchant/Individual physical Address. Use for 2nd Address Line
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 7
 Address2
Address{ Merchant/Individual physical Address. Alphanumeric. *For UK Merchants, use to provide the Building / Home Name.
String 100 Optional
Address3 For Example: Primrose Cottage
Address{
String 30 Required Merchant/Individual physical Address city. *Mandatory for UK merchants
City
Address{ Merchant/Individual physical Address state. *Standard 2 character abbreviation for state, province, prefecture, etc.
String 3 Required
State *Does not apply to UK Merchants
Merchant/Individual physical Address zip/postal code. For the USA: 5 or 9 characters without a dash. For CAN: 6
Address{
characters postal code with a space “XXX XXX” For AUS and NZ 4 character code. For the UK: 6 - 8 alphanumeric
Zip String Required
character postal code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
*Mandatory for UK merchants
Address{ ISO 3166 standard 3 character country codes. Required if creating an account in a country other than USA.
Country String 3 Optional
*Country must be an approved country to create a ProPay account.
Address{ String Optional This is a unique address identification number assigned to each address returned by Equifax.
20
AddresId *The value for this tag is provided in the Address Lookup API response
String Optional This is the building / home number for the street address. For Example: 501a Halfway Street. Value for this tag would
Address{
50 be “501a”.
BldgNumber
*Mandatory for UK merchants
Address{ String Optional The District associated with the Merchant's address.
50
District *For use by UK merchants
Address{ String Optional The post town that is associated with the Merchant's address.
100
PostTown *Mandatory for UK merchants
String Optional The county associated with the Merchant's address.
Address{
50 *Mandatory for UK merchants
County
Address{ Optional The length of time the merchant has lived in their current address, represented in whole months (i.e. 5, 10, etc.).
Integer 3
TimeAtAddress *Mandatory for UK merchants

Personal Previous Address - Optional

Element Type Max Required Notes
PreviousAddress{ String Optional This is the building / home number for the previous street address. For Example: 501a Halfway Street. The value for
PreviousBuildingN 50 this tag would be 501a.
umber *Required for UK merchants if time in current address less than 24 months
String Optional Merchant/Individual physical previous street Address without the building / house number. For Example: 501a
PreviousAddress{
100 Halfway Street. The value for this tag would be Halfway Street. PO Boxes are not allowed. Alphanumeric.
PreviousAddress
*Required for UK merchants if time in current address less than 24 months
PreviousAddress{ String Optional
Merchant/Individual previous physical Address. Use for the 2nd Address Line.
PreviousAptNumb 100
*Required for UK merchants if time in current address less than 24 months
er
String Optional Merchant/Individual previous physical Address. Alphanumeric.
PreviousAddress3 100
*For UK merchants, use to provide the Building / Home Name. For Example: Primrose Cottage
PreviousAddress{ String Optional Merchant/Individual previous physical Address city.
30
PreviousCity *Required for UK merchants if time in current address less than 24 months
PreviousAddress{ String 50 Optional The county associated with the Merchant's previous address.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 8
 PreviousCounty *Required for UK merchants if time in current address less than 24 months
PreviousAddress{ String Optional The District associated with the Merchant's previous address.
50
PreviousDistrict *For use by UK merchants
PreviousAddress{ String Optional The post town that is associated with the Merchant's previous address.
100
PreviousPostTown *Required for UK merchants if time in current address less than 24 months
String Optional Merchant/Individual previous physical Address state. Standard 2 character abbreviation for state, province,
PreviousAddress{
3 prefecture, etc.
PreivousState
*Does not apply to UK merchants
String Optional Merchant/Individual previous physical Address zip/postal code. For the USA: 5 or 9 characters without a dash. For
PreviousAddress{ CAN: 6 character postal code with a space “XXX XXX” For AUS and NZ 4 character code. For the UK: 6 - 8
9
PreviousZip alphanumeric character postal code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
*Required for UK merchants if time in current address less than 24 months
String Optional ISO 3166 standard 3 character country codes. Required if creating an account in a country other than the USA.
PreviousAddress{
3 *Country must be an approved country to create a ProPay account. US Territories should use 'USA'.
PreviousCountry
*Required for UK merchants if time in current address less than 24 months
Address{ String 20 Optional This is a unique address identity number assigned to each distinct address returned by Equifax.
PreviousAddressI **The value for this tag is provided in the Address Lookup API response**
d

Business Data – Required for business validated accounts. May also be required for personal validated accounts by ProPay Risk Team
Element Type Max Required Notes
BusinessData{
String 255 Required The legal name of the business as registered.
BusinessLegalName
BusinessData{ This field can be used to provide DBA information on an account. ProPay accounts can be
String 255 Required
DoingBusinessAs configured to display DBA on cc statements.
BusinessData{ Employer Identification Number can be added to a ProPay account. Must be 9 Characters
String Required
EIN without dashes. *For UK, Do not pass
BusinessData{
String 4 Optional Merchant Category Code
MerchantCategoryCode
BusinessData{
String 255 Required The Business’ website URL
WebsiteURL
BusinessData{
String 255 Required The Business’ description
BusinessDescription
BusinessData{ The monthly volume of bank card transactions; Value representing the number of pennies in USD,
Int(64) Required
MonthlyBankCardVolume or the number of [currency] without decimals. Defaults to null if not sent.
BusinessData{ The average amount of an individual transaction; Value representing the number of pennies in
Int(64) Required
AverageTicket USD, or the number of [currency] without decimals. Defaults to null if not sent.
BusinessData{ The highest transaction amount; Value representing the number of pennies in USD, or the number
Int(64) Required
HighestTicket of [currency] without decimals. Defaults to null if not sent.
BusinessData{ String Optional Company registration number.
BusinessRegistrationNumber *Mandatory for merchants outside of the United States whose Business Type is Limited Company
BusinessData{ String Optional Business day phone number. *For USA, CAN, NZL and AUS values must be 10 characters. For the UK,
BusinessPhoneNumber the value must be 11 characters.
*Mandatory for UK merchants

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 9
 Busiiness Type is mandatory for Uk merchants. (UK mandatory values include D, P, Q, R, S)
Valid values are:
BusinessType Valid Value

C - Corp. (Non-publicly traded) D

Limited Company

C - Corp. (Publicly traded) E

501c3 Non-Profit Organization F

Municipality or Government Organization G

BusinessData{ LLC (Non-publicly traded) M

String Optional
BusinessType
LLC (Publicly traded) N

General Partnership Q

Publicly Traded Partnership R

Limited Liability Partnership

Sole Proprietorship S
Sole Trader

American Express Reserved Indicator X

Limited Partnership P
BusinessAddress{
String 100 Required Business Physical Address
Address1
BusinessAddress{ Business Physical Address
String 100 Optional
Address2 *For UK merchants, use to provide the Flat or Suite #. For Example: Flat B | Suite 103
BusinessAddress{
String 30 Required Business Physical Address City
City
BusinessAddress{
String Required Must be ISO standard 3 character country code.
Country
If domestic signup this value MUST be one of the standard 2 character abbreviations. Rule also
BusinessAddress{
String 3 Required applies for Canadian signups. (Must be standard province abbreviation.)
State
*Does not apply to UK merchants
For the USA: 5 or 9 characters without a dash. For CAN: 6 characters postal code with a space
BusinessAddress{
String Required “XXX XXX”. For AUS and NZ 4 character code. For the UK: 6 - 8 alphanumeric character postal
Zip
code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
BusinessAddress{ String Optional Business Physical Address.
Address3 *For UK merchants, use to provide the Building Name
BusinessAddress{ String Optional The District associated with the business address.
District *For use by UK merchants

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 10
BusinessAddress{ String Optional The post town that is associated with the business address.
PostTown *Mandatory for UK merchants
BusinessAddress{ String Optional The county associated with the business address.
County *Mandatory for UK merchants
BusinessAddress{ Optional The length of time the business has been at the current address represented in whole months (i.e.
TimeAtBusinessAddress Integer 5, 10, etc.).
*Required for UK merchants if business has been at current address less than 24 months
LegalAddress{ String Optional The registered office address, which can differ from where the business is actually run. Legal
Address 100
physical address. PO Boxes are not allowed. Alphanumeric. **Required for the UK**
LegalAddress{ String Optional Legal physical address. PO Boxes are not allowed. Alphanumeric. **For the UK, use to provide the
Address2 100
Flat or Suite #. For example: Flat B | Suite 103**
LegalAddress{ String Optional Legal physical address. PO Boxes are not allowed. Alphanumeric. **For the UK, use to provide the
Address3 100
Building Name**
LegalAddress{ String Optional
City 30 Legal physical address: City **Requried for the UK**

LegalAddress{ String Optional

County 50 Legal physical address: County. **For use in the UK**

LegalAddress{ String Optional

District 50 Legal Physical Address: Disctrict. **For use in the UK**

LegalAddress{ String Optional

PostTown 100 Legal Physical Address: Post Town. **Required for the UK**

LegalAddress{ String Optional

State 3 Legal Physical Address: State. **Does not apply to UK**

LegalAddress{ String Optional Legal Physical Address: Zip Code. For USA: 5 or 9 characters without dash. For CAN: 6 character
Zip postal code with a space”XXX XXX”. For AUS and NZ 4 character code. For the UK: Zip Code is 6-8
9
characters in length with the first character being alphabetic: A9 9AA (6 Char.), A99 9AA (7 Char.),
AA9A 9AA (8 Char.). **Requried for the UK**
LegalAddress{ String Optional
Country 3 Must be ISO standard 3 character country code. **Requried for the UK**

EstimatedCardUsageData{ String Required Estimate. This is the percentage of merchant’s transactions that are card present, (Chip, Touch,
CardPresent 3 Swipe, etc). This is a percentage value of all expected processing. Values must be between 0 and
100. Total of all estimated values must equal 100.
EstimatedCardUsageData{ String Required Depreceiated – no longer valid. Place a ‘0’ here unless otherwise known. Estimate. This is the
CardNotPresentKeyed 3 percentage of merchant’s transactions that are card not present - keyed processing. Values must
be between 0 and 100. Total of all estimated values must equal 100.
EstimatedCardUsageData{ String Required Estimate. This is the percentage of merchant’s transactions that are card not present –
CardNotPresentEcommerce 3 ecommerce. (ex. online store purchasing, etc.). Values must be between 0 and 100. Total of all
estimated values must equal 100.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 11
Business Previous Address – Optional
Element Type Max Required Notes
BusinessPreviousAddress{ String Optional Business physical address. PO Boxes are not allowed. Alphanumeric.
100
PreviousAddress *Required for UK merchants if Merchant has been at current business address less than 24 months
BusinessPreviousAddress{ String Optional
100 Business physical address. PO Boxes are not allowed. Alphanumeric.
PreviousAddress2
BusinessPreviousAddress{ String Optional Business physical address. PO Boxes are not allowed. Alphanumeric.
100
PreviousAddress3 *For UK merchants, use to provide the Building Name
BusinessPreviousAddress{ String Optional Business Physical Address: City.
30
PreviousCity *Required for UK merchants if Merchant has been at current business address less than 24 months
BusinessPreviousAddress{ String Optional The county associated with the business previous address.
50
PreviousCounty *Required for UK merchants if Merchant has been at current business address less than 24 months
BusinessPreviousAddress{ String Optional The District associated with the business previous address.
50
PreviousDistrict *For use by UK merchants
BusinessPreviousAddress{ String Optional The post town that is associated with the business previous address.
100
PreviousPostTown *Required for UK merchants if Merchant has been at current business address less than 24 months
BusinessPreviousAddress{ String Optional Business Physical Address: State. Standard 2 character abbreviation for state, province,
PreviousState 3 prefecture, etc.
*Does not apply to UK merchants
BusinessPreviousAddress{ String Optional Business physical address zip/postal code. For the USA: 5 or 9 characters without a dash. For CAN:
PrevoiusZip 6 character postal code with a space “XXX XXX” For the UK: 6 - 8 alphanumeric character postal
9
code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
*Required for UK merchants if Merchant has been at current business address less than 24 months
BusinessPreviousAddress{ String Optional Must be ISO standard 3 character country code.
3
PreviousCountry *Required for UK merchants if Merchant has been at current business address less than 24 months

International Signup Data – Frequently Required for partners who sign up international merchants
Element Type Max Required Notes
PersonalData{
InternationalData{ String 1 Optional* Values 1( Driver’s license), 2(Passport), 3( Australia Medicare)
DocumentType
PersonalData{
InternationalData{ String Optional* Corresponds to the document number provided by DocumentType.
InternationalId
PersonalData{
Corresponds to the Expiry date of the document provided by DocumentType. Should be a valid
InternationalData{ String Optional*
date. mm-dd-yyyy
DocumentExpDate
PersonalData{
InternationalData{ String 3 Optional* Required if the DocumentType is 1 (Driver’s license). The driver’s license issuing state.
DocumentIssuingState
PersonalData{
Required if the DocumentType is 1 (Driver’s license) and Country is NZL. This is driver’s license
InternationalData{ String Optional*
version number.
DriversLicenseVersion

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 12
 PersonalData{
Required if the DocumentType is 3 (Australia Medicare) and Country is AUS. The data should be
InternationalData{ String 1 Optional*
parsed to Number.
MedicareReferenceNumber
Required if the DocumentType is 3 (Australia Medicare) and Country is AUS.
PersonalData{  Yellow
InternationalData{ String Optional*
 Green
MedicareCardColor
 Blue

Account Payment (Credit Card) Information – A payment method is required if an account fee is set and not paid for by partner
Element Type Max Required Notes
CreditCardData{
String Required Card holder’s name as it appears on card.
NameOnCard
CreditCardData{ Must pass Luhn check. Used to pay for an account if ProPay has not set account type up as free
String 16 Required
CreditCardNumber to users.
CreditCardData{ Used to pay for an account if ProPay has not set account type up as free to users. Submitted as
String 4 Required
ExpDate mmyy.
CreditCardData{
String Required The credit card CVV code
CVV

Account Payment (ACH) Information – A payment method is required if an account fee is set and not paid for by partner
Element Type Max Required Notes
PaymentBank{
String Required Used to pay for an account via ACH and monthly renewal. Financial institution account number.
AccountNumber
PaymentBank{ Used to pay for an account via ACH and monthly renewal. Financial institution routing number.
String Required
RoutingNumber Must be a valid ACH routing number.
PaymentBank{ Used to pay for an account via ACH and monthly renewal. Valid values are: Checking, Savings,
String Required
AccountType and GeneralLedger

Account Payment (ProtectPay) Information – A payment method is required if account fee not paid for by partner
Element Type Max Required Notes
PaymentMethodId String Required Used to pay for an account via a ProtectPay Payment Method ID. Valid value is a GUID.

Mailing Address – Optional. Used if mailed correspondence from Propay should be sent to separate address
Element Type Max Required Notes
MailAddress{
String 100 Optional Merchant/Individual mailing address if different than physical address.
Address1
MailAddress{
String Optional Merchant/Individual mailing address if different than physical address.
Address2
MailAddress{ Merchant/Individual mailing address if different than physical address.
String 100 Optional
Address3 *For UK merchants, use to provide the Building / Home Name. For Example: Primrose Cottage
MailAddress{
String 30 Optional Merchant/Individual mailing city if different than physical address.
City

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 13
 Merchant/Individual mailing state if different than physical address. *Standard 2 character abbreviation for state,
MailAddress{
String 3 Optional province, prefecture, etc.
State
*Does not apply to UK merchants
MailAddress{
String 3 Optional ISO 3166 standard 3 character country codes. Required if creating an account in a country other than USA.
Country
Merchant/Individual mailing zip/postal code if different than physical address. For the USA: 5 or 9 characters without a
MailAddress{
String Optional dash. For CAN: 6 characters postal code with a space “XXX XXX” For AUS and NZ 4 character code. For the UK: 6 - 8
Zip
alphanumeric character postal code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
MailAddress{ String Optional The District associated with the mailing address.
50
District *For use by UK merchants
MailAddress{ String Optional The Post town associated with the mailing address.
100
PostTown *For use by UK merchants
MailAddress{ String Optional The county associated with the mailing address.
50
County *For use by UK merchants

Primary Bank Account Information – Optional. Used to add a bank account to which funds can be settled
Element Type Max Required Notes
BankAccount{
String 3 Required ISO 3166 standard 3-character country code.
AccountCountryCode
BankAccount{
String 32 Required Merchant/Individual Name.
AccountName
BankAccount{
String 25 Required Financial institution account number.
BankAccountNumber
BankAccount{
String 15 Required Valid values are: Personal and Business
AccountOwnershipType
Valid values are:
BankAccount{  C – Checking
String 1 Required
AccountType  S – Savings
 G – General Ledger
BankAccount{
String 50 Required Name of financial institution.
BankName
Financial institution routing number. Must be a
BankAccount{
String 9 Required valid ACH routing number.
RoutingNumber
*For UK merchants, use for the 6 digit bank sort code (xx-xx-xx or xxxxxx)

Secondary Bank Account Information – Optional. Used to add an account from which fees are pulled. Only works when Primary bank added
Element Type Max Required Notes
SecondaryBankAccount{ Required if adding secondary bank account. Must be ISO standard 3 character code. This will
String 3 Required
AccountCountryCode become the account to which proceeds of transactions are sent in split sweep functionality.
SecondaryBankAccount{ Required if adding secondary bank account info as part of the signup. This will become the
String 32 Required
AccountName account to which proceeds of transactions are sent in split sweep functionality.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 14
 SecondaryBankAccount{ Required if adding secondary bank account info as part of the signup. This will become the
String 25 Required
BankAccountNumber 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
SecondaryBankAccount{
String 15 Required ‘Business’ If accountType is G, then this value is always overwritten as ‘Business’ This will become
AccountOwnershipType
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:
SecondaryBankAccount{  C – Checking
String 1 Required
AccountType  S – Savings
 G – General Ledger
SecondaryBankAccount{ Required if adding secondary bank account info as part of the signup. This will become the
String 50 Required
BankName account to which proceeds of transactions are sent in split sweep functionality.
Required if adding secondary bank account info as part of the signup, must be a valid Fedwire
SecondaryBankAccount{
String 9 Required ACH participant routing number. This will become the account to which proceeds of
RoutingNumber
transactions are sent in split sweep functionality.

Bank Account Ownership Details – Optional. Needed for Canadian merchants, to comply with banking rule. If missing in Canada, transfers fail.
XML Element Type Max Required Notes
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 25 Required Required if adding ownership info.
FirstName
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 25 Required Required if adding ownership info.
LastName
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 50 Required Required if adding ownership info.
Address1
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 50 Required Required if adding ownership info.
City
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 3 Required Required if adding ownership info. 2-3 character abbreviation.
StateProvince
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 10 Required Required if adding ownership info.
PostalCode
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 3 Required Required if adding ownership info. 3 character ISO standard country abbreviation.
Country
BankAccountOwnerData{
PrimaryBankAccountOwner{ String 25 Required Required if adding ownership info.
Phone

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 15
Gross Billing Information – Optional. Used with prior approval to automatically bill fees to separate account
Element Type Max Required Notes
GrossBillingInformation{
GrossSettleAddress{ String 25 Optional Gross Settle credit card billing address.
Address1
GrossBillingInformation{
GrossSettleAddress{ String 25 Optional Gross Settle credit card billing address.
City
GrossBillingInformation{
GrossSettleAddress{ String 3 Optional Gross Settle credit card billing address. Must be 3 character ISO standard country code.
Country
GrossBillingInformation{
Gross Settle credit card billing address. Must be 2 character standard US State or Canadian
GrossSettleAddress{ String 2 Optional
province code.
State
GrossBillingInformation{ Gross Settle credit card billing address. For USA: 5 or 9 characters without dash. For CAN: 6
GrossSettleAddress{ String 9 Optional* characters postal code with a space “XXX XXX” Do not use if not USA or CAN. *Required if
Zip payment method is a credit card.
GrossBillingInformation{
GrossSettleAddress{ String 3 Optional* ISO standard 3 character country code. *Required if payment method is a bank account.
CountryCode
GrossBillingInformation{
GrossSettleBankAccount{ String Optional* Bank account-holder’s name. *Required if payment method is a bank account.
AccountName
*Required if Gross Settle billing info is bank account. Valid values are:
GrossBillingInformation{  C – Checking
GrossSettleBankAccount{ String 10 Optional*
 S – Savings
AccountType
 G – General Ledger
GrossBillingInformation{
GrossSettleBankAccount{ String 25 Optional* Bank account number. *Required if payment method is a bank account.
BankAccountNumber
GrossBillingInformation{
Routing number of valid Fedwire ACH participant. *Required if payment method is a bank
GrossSettleBankAccount{ String 9 Optional*
account.
RoutingNumber
GrossBillingInformation{
GrossSettleBankAccount{ String 3 Optional* ISO 3166 standard 3-character country code.
AccountCountryCode
GrossBillingInformation{
GrossSettleCardData{ String 16 Optional* Valid credit card number. *Required if payment method is a credit card.
CreditCardNumber
GrossBillingInformation{
GrossSettleCardData{ String 4 Optional* Credit card expiration date. *Required if payment method is a credit card.
ExpirationDate
GrossBillingInformation{
GrossSettleCardData{ String 25 Optional* Name on credit card. *Required if payment method is a credit card.
NameOnCard

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 16
Merchant Beneficiary Owner Information – Required for all merchants validating KYC based off of personal data
Element Type Max Required Notes
BeneficialOwnerData{
String 1 Required Number of Beneficiary Owners, should be maximum 5.
OwnerCount
BeneficialOwnerData{
Owners{
String 55 Required This field contains the Title.
Owner{
Title
BeneficialOwnerData{
Owners{
String 20 Required Owner First Name.
Owner{
FirstName
BeneficialOwnerData{
Owners{
String 25 Required Owner Last Name.
Owner{
LastName
BeneficialOwnerData{
Owners{
String 55 Required Owner Email ID.
Owner{
Email
BeneficialOwnerData{
Owners{
String 10 Required Date of Birth of the Owner. Must be in ‘mm-dd-yyyy’ format.
Owner{
DateOfBirth
BeneficialOwnerData{
Owners{
String 3 Required Percentage stake in company by owner. Must be whole number between 0 and 100.
Owner{
Percentage
BeneficialOwnerData{
Owners{ Street address where Owner resides. *Required if passing Merchant Beneficiary Owner
String 100 Required
Owner{ Information.
Address
BeneficialOwnerData{
Owners{ Street address where Owner resides. *For UK merchants, use for the Apt or Flat number. For
String 100 Optional
Owner{ Example: Apt 102 | Flat A
Address2
BeneficialOwnerData{
Owners{
String 9 Required Social Security Number of the Owner. Should be 9 digits. *Does not apply to UK merchants
Owner{
SSN
BeneficialOwnerData{
Owners{
String 55 Required The name of the city where the Owner resides.
Owner{
City
BeneficialOwnerData{ The postal code where the Owner resides. For the UK: 6 - 8 alphanumeric character postal
String 10 Required
Owners{ code with a space. The first part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 17
Owner{
Zip
BeneficialOwnerData{
Owners{ The region code that corresponds to the state where the Owner resides. *Does not apply to
String 3 Required
Owner{ UK merchants
State
BeneficialOwnerData{
Owners{
String 3 Required The three-character, alpha country code for where the Owner resides.
Owner{
Country
BeneficialOwnerData{
This is the building / home number for the street address. For Example: 501a Halfway Street.
Owners{
String 50 Optional The value for this tag would be 501a.
Owner{
*Mandatory for UK merchants
BuildingNumber
BeneficialOwnerData{
Owners{ The District associated with the address.
String 50 Optional
Owner{ *For use by UK merchants**
District
BeneficialOwnerData{
Owners{ The Post town associated with the address.
String 100 Optional
Owner{ *Mandatory for UK merchants**
PostTown
BeneficialOwnerData{
Owners{ The county associated with the address.
String 50 Optional
Owner{ *Mandatory for UK merchants**
County
BeneficialOwnerData{
This represents the country in which the merchant was born. ISO 3166 3 Digit alpha code
Owners{
String 3 Optional applies. For Example: GBR, USA, etc.
Owner{
*Mandatory for UK merchants**
Nationality
BeneficialOwnerData{
Owners{ This is a unique address identification number assigned to each address returned by Equifax.
String 20 Optional
Owner{ **The value for this tag is provided in the Address Lookup API response**
AddressId
BeneficialOwnerData{
Owners{ Merchant/Individual physical Address. Alphanumeric.
String 100 Optional
Owner{ **In the UK, use to provide the Building / Home Name**
Address3
BeneficialOwnerData{
The length of time the individual has lived in their current address, represented in whole
Owners{
Integer 3 Optional months (i.e. 5, 10, etc.).
Owner{
**Mandatory for the UK**
TimeAtAddress
BeneficialOwnerData{
This is the building / home number for the previous street address. For Example: 501a Halfway
Owners{
String 50 Optional Street. Value for this tag would be 501a.
Owner{
**Required in the UK if time at current address less than 24 months**
PreviousBuildingNumber

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 18
BeneficialOwnerData{ Merchant/Individual physical previous street Address without the building / house number.
Owners{ For Example: 501a Halfway Street. Value for this tag would be Halfway Street. PO Boxes are
String 100 Optional
Owner{ not allowed. Alphanumeric.
PreviousAddress **Required in the UK if time at current address less than 24 months**
BeneficialOwnerData{
Owners{ Merchant/Individual previous physical Address. Use for 2nd Address Lin.
String 100 Optional
Owner{ **For the UK, use to provide the flat number".
PreviousAptNumber
BeneficialOwnerData{
Owners{ Merchant/Individual previous physical Address. Alphanumeric.
String 100 Optional
Owner{ **For the UK, use to provide the Building / Home Name**
PreviousAddress3
BeneficialOwnerData{
Owners{ Merchant/Individual previous physical Address city.
String 30 Optional
Owner{ **Required in the UK if time at current address less than 24 months**
PreviousCity
BeneficialOwnerData{
Owners{
String 50 Optional The county associated with the Merchant's previous address. **For use in the UK**
Owner{
PreviousCounty
BeneficialOwnerData{
Owners{
String 50 Optional The District associated with the previous address. **For use in the UK**
Owner{
PreviousDistrict
BeneficialOwnerData{
Owners{ The post town associated with the Merchant's previous address.
String 100 Optional
Owner{ **Required in the UK if time at current address less than 24 months**
PreviousPostTown
BeneficialOwnerData{
Merchant/Individual previous physical Address state. *Standard 2 character abbreviation for
Owners{
String 3 Optional state, province, prefecture, etc.
Owner{
**Does not apply to UK addresses**
PreviousState
Merchant/Individual previous physical Address zip/postal code. For USA: 5 or 9 characters
BeneficialOwnerData{
without dash. For CAN: 6 character postal code with a space “XXX XXX” For AUS and NZ 4
Owners{
String 9 Optional character code. For the UK: Zip Code is 6 - 8 characters in length with the first character
Owner{
being Alphabetic: A9 9AA (6 character), A99 9AA (7 character), AA9A 9AA (8 character).
PreviousZip
**Required in the UK if time at current address less than 24 months**
ISO 3166 standard 3 character country codes. Required if creating an account in a country
BeneficialOwnerData{
other than USA.
Owners{
String 3 Optional *Country must be an approved country to create a ProPay account. US Territories should use
Owner{
'USA'.
PreviousCountry
**Required in the UK if time at current address less than 24 months**
Address{ This is a unique address identification number assigned to each address returned by Equifax.
String 20 Optional
PreviousAddressId **The value for this tag is provided in the Address Lookup API response**

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 19
Devices – Optional. Used for Portico device ordering.
Element Type Max Required Notes
Devices.Device.Name String 20 Required Unique name of the device being ordered.
Devices{ Quantity Integer 2 Required Number of devices ordered. Defaults to 0.
Devices { Attributes Optional List of attributes
Name of the attribute item. For example, “Heartland.AMD.OfficeKey” which is specific to
Devices { Attributes [{Name String 20 Required Portico devices for AMD. The value of this item is passed to Heartland for equipment
boarding.
Devices { Attributes {[ Value String 20 Required Value of the attribute item. In the above example, the value of “Heartland.AMD.OfficeKey”.

Significant Owner Information – May be required for some partners based on ProPay Risk decision
Element Type Max Required Notes
AuthorizedSigner{
String 20 Required Seller’s Authorized Signer First Name. By default Merchant’s First name is saved*.
FirstName
AuthorizedSigner{
String 25 Required Seller’s Authorized Signer Last Name. By default Merchant’s Last name is saved*.
LastName
AuthorizedSigner{ This field contains the Seller’s Authorized Signer Title*. Commonly used Authorized Signer Titles
String 20
Title Optional include:
SignificantOwner{ For US: Seller’s Significant Owner First Name.
String 20 Required
FirstName For CAN: Seller’s Significant Owner or Authorized Signer First Name.
SignificantOwner{ For US: Seller’s Significant Owner Last Name.
String 20 Required
LastName For CAN: Seller’s Significant Owner or Authorized Signer Last Name.
SignificantOwner{
String 9 Required Social Security Number of the Seller’s Significant Owner. Should be 9 digits.
SSN
SignificantOwner{
Date Required Date of Birth of the Seller’s Significant Owner. Must be in ‘mm-dd-yyyy’ format.
DateOfBirth
SignificantOwner{
String 40 Required Street address where Seller’s Significant Owner resides.
Address1
SignificantOwner{
String 40 Required The name of the city where the Seller’s Significant Owner resides.
City
SignificantOwner{
String 6 Required The region code that corresponds to the state where the Seller’s Significant Owner resides.
RegionCode
SignificantOwner{
String 9 Required The postal code for where the Seller's Significant Owner resides.
Zip
SignificantOwner{
String 2 Required The two-character, alpha country code for where the Seller's Significant Owner resides.
CountryCode
SignificantOwner{
String 50 Required This field contains the Seller’s Significant Signer Title.
Title
SignificantOwner{
Byte Required Percentage for Significant Owner. Percentage should be in between 0 and 100.
Percentage

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 20
Threat Risk Assessment Information – May be required based on ProPay Risk Decision
Element Type Max Required Notes
FraudDetectionData{
String 64 Required SourceIp of Merchant, see ProPay Fraud Detection Solutions Manual.
MerchantSourceIp
FraudDetectionData{
String 32 Required Threat Metrix Policy, see ProPay Fraud Detection Solutions Manual.
ThreatMetrixPolicy
FraudDetectionData{
String 128 Required SessionId for Threat Metrix, see ProPay Fraud Detection Solutions Manual.
ThreatMetrixSessionId

Response Elements
Element Type Notes
Status String Result of the transaction request. See ProPay Appendix B for result code definitions
Password String Temporary password
AccountNumber Integer Primary identifier for new ProPay account
Tier String Type of account created

KYCResponse Parent tag for KYC Response

Signer Parent tag for Signer Data
Decision String KYC Decision of Signer (Can be 00 for "Validated" or 66 for "Not Validated")
DataEcho Parent tag for Data Echo of Signer Data
FirstName String Merchant/Individual first name
LastName String Merchant/Individual last name
DateOfBirth String Merchant/Individual Date of birth. Must be in ‘mm-dd-yyyy’ format. *
SSN String Merchant/Individual social security number
Address String Merchant/Individual physical street Address
City String Merchant/Individual physical Address city
State String Merchant/Individual physical Address state
Zip String Merchant/Individual physical Address zip/postal code
Country String Merchant/Individual country
BeneficialOwners Parent tag for all Beneficial Owners
BeneficialOwner Parent tag for Beneficial Owner Data
Decision String KYC Decision of Beneficial Owner (Can be 00 for "Validated" or 66 for "Not Validated")
DataEcho Parent tag for Data Echo of Beneficial Owner Data
FirstName String Owner First Name
LastName String Owner Last Name.
DateOfBirth String Date of Birth of the Owner. Must be in ‘mm-dd-yyyy’ format
SSN String Social Security Number of the Owner. *Does not apply to UK merchants

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 21
Address String Street address where Owner resides.
City String The name of the city where the Owner resides.
State String The region code that corresponds to the state where the Owner resides. *Does not apply to UK merchants
The postal code where the Owner resides. For the UK: 6 - 8 alphanumeric character postal code with a space. The first
Zip String part is 2 - 4 digits. The 2nd half is 3 digits “YYYY YYY”.
Country String The three-character, alpha country code for where the Owner resides.
Business Parent tag for Business Data
Decision String KYC Decision of Business (Can be 00 for "Validated" or 66 for "Not Validated")
DataEcho Parent tag for Data Echo of Business Data
LegalName String The legal name of the business as registered.
EIN String Employer Identification Number of a ProPay account.
BusinessAddress String Business Physical Address

How to call this method

HTTP Element Value
Resource URI /propayapi/signup
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"PersonalData": { "AccountNumber": 718041048,
"FirstName": "First", "Status": "00",
"MiddleInitial": "X", "BeneficialOwnerDataResult": [
"LastName": "Last", {
"DateOfBirth": "01-01-1981", "FirstName": "Pritpal",
"SocialSecurityNumber": "123456789", "LastName": "STALLONE",
"SourceEmail": "[email protected]", "Status": "Validated"
"PhoneInformation": { }
"DayPhone": "8888888888", ],
"EveningPhone": "8888888888" "CreditCheckConsent": null,
}, "GatewayBoardingResultData": [
"IPSignup" : "101.101.101.101", ],
"USCitizen":true, "KYCResponse": {
"BOAttestation":true, "Signer": {
"TermsAcceptanceIP" : "4.14.150.145", "Decision": "00",
"TermsAcceptanceTimeStamp" : "2022-12-20 12:57:08.2021237", "DataEcho": {
"TermsVersion": "1", "FirstName": "Donald",
"NotificationEmail": "[email protected]", "LastName": "Trump",
"TimeZone": "UTC" "DateOfBirth": "02/07/2005",
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 22
}, "SSN": "333224445",
"SignupAccountData": { "Address": "12 WEST FEN ROAD",
"CurrencyCode": "USD", "City": "New York",
"Tier": "Test" "State": "NY",
}, "Zip": "10007",
"BusinessData": { "Country": "USA"
"BusinessLegalName": "Merchantile Parent, Inc.", }
"DoingBusinessAs": "Merchantile ABC", },
"EIN": "121232343", "BeneficialOwners": [
"MerchantCategoryCode": "5999", {
"BusinessType": "D", "Decision": "00",
"WebsiteURL": "http://www.merchantwebsite.com", "DataEcho": {
"BusinessDescription": "Add Merchant Description Here", "FirstName": "Pritpal",
"MonthlyBankCardVolume": 10000, "LastName": "STALLONE",
"AverageTicket": 100, "DateOfBirth": "02/07/2005",
"HighestTicket": 250, "SSN": "333224445",
"BusinessPhoneNumber": "8888888888", "Address": "123 Main Street Disneyland",
"EstimatedCardUsageData": { "City": "Orlando",
"CardPresent": 0, "State": "FL",
"CardNotPresentKeyed": 0, "Zip": "32379",
"CardNotPresentEcommerce": 100 "Country": "USA"
} }
}, }
"CreditCardData":{ ],
"NameOnCard": "First X Last", "Business": {
"CreditCardNumber": "4321432143214321", "Decision": "00",
"ExpirationDate": "0122", "DataEcho": {
"CVV": "999" "LegalName": "America",
}, "EIN": "460364448",
"Address": { "BusinessAddress": "1600 Pennsylvania Ave"
"ApartmentNumber": "1", }
"Address1": "3400 N Ashton Blvd", }
"Address2": "Suite 200", },
"City": "Lehi", "Password": "D#w#9CZ94S",
"State": "UT", "SourceEmail": "[email protected]",
"Country": "USA", "Tier": "e0b0469a-bddb-40aa-8"
"Zip": "84043" }
},
"BusinessAddress": {
"ApartmentNumber": "200",
"Address1": "RR 123445",
"Address2": "SW",
"City": "Tooele",
"State": "UT",
"Country": "USA",
"Zip": "84074"
},

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 23
"BankAccount": {
"AccountCountryCode": "USA",
"BankAccountNumber": "123456789",
"RoutingNumber": "011306829",
"AccountOwnershipType": "Business",
"BankName": "MERCHANTILE BANK UT",
"AccountType": "Checking",
"AccountName": null,
"Description": null
},
"BeneficialOwnerData": {
"OwnerCount": "1",
"Owners": [{
"FirstName": "First1",
"LastName": "Last1",
"SSN": "123456789",
"DateOfBirth": "01-01-1981",
"Email": "[email protected]",
"Address": "Address",
"Address2": "Main Street",
"City": "Lehi",
"State": "UT",
"Zip": "84010",
"Country": "USA",
"Title": "CEO",
"Percentage": "100"
}
]
},
"Devices": [{
"Name": "Nimbus2000",
"Quantity": 1,
"Attributes": [{
"Name": "Heartland.AMD.OfficeKey",
"Value": "aQ9l3U7c4Dccf"
}
]
}
]
}
Back to Contents

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 24
4.2 Edit a ProPay Account
These methods will update the information associated with a ProPay account by updating specific groups of information as denoted in each sub-
section.

Please understand special rules for use of this method:

- This transaction type requires an X.509 certificate as additional authentication
- Allowance to perform an edit of each sub-section is subject to approval. If you try to perform an edit for a disallowed group, your request will fail.

4.21 Edit Merchant Contact Info

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
PersonalData{
String 20 Required Merchant/Individual first names.
FirstName
PersonalData{
String 2 Required Merchant/Individual middle initial.
MiddleInitial
PersonalData{
String 25 Required Merchant/Individual last name.
LastName
PersonalData{
string 55 Required Merchant/Individual email address. Must be unique in ProPay system.
SourceEmail
PersonalData{
Merchant/Individual day phone number. *For USA, CAN, NZL and AUS value must be 10 characters with
PhoneInformation{ integer Required
no dashes
DayPhone
PeronsalData{
Merchant/Individual evening phone number. *For USA, CAN, NZL and AUS value must be 10 characters
PhoneInformation{ integer Required
with no dashes
EveningPhone
ExternalId String 20 Optional This is a partner’s own unique identifier. Typically used as the distributor or consultant ID.

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantContactInfo/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 25
Sample
Sample JSON request Response
{ {
"AccountNumber":718045567, "AccountNumber":718045567,
"PersonalData":{ "Status":"00"
"FirstName":"Bob", }
"MiddleInitial":"N",
"LastName":"Takanawa",
"SourceEmail":"[email protected]",
"PhoneInformation":{
"DayPhone":8015555555,
"EveningPhone":8015555555
}
},
"ExternalId":"200514042252"
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 26
4.22 Edit Merchant Account Address
Home Address and Mail Address can be edited independently. You only need to include the elements for the address you are updating.
*If updating Home Address all fields marked are required to pass

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
Merchant Street Address *For UK merchants, this is Merchant/Individual physical street Address without
Address{
string 100 Optional* the building / house number. For Example: 501a Halfway Street – Value for this tag would be Halfway
Address1
Street.
Address{ Merchant Street Address 2 *For UK merchants, use this to provide the Building or House name. For
string 100 Optional
Address2 Example: Primrose cottage
Address{
string 100 Optional Merchant Street Address Apartment Number
ApartmentNumber
Address{
string 30 Optional* Merchant Address city
City
Address{
string 3 Optional* Merchant Address state. MUST be one of the standard 2 character abbreviations for US or Canada.
State
Address{ Merchant Address zip. If domestic this value must be either 5 or 9 characters with no dash. For Canada
string Optional*
Zip this value must be 6 characters.
Address{
string 3 Optional* See Appendix B for possible country codes.
Country
Address{ Optional This is the building / home number for the street address. For example: 501a Halfway Street. Vlaue fo rthie
string 50
BldgNumber tag would be “501a” **Mandatory for UK Merchants**
Address{ string Optional
50 The Disctrict associated with the merchant’s address. **For use by UK Merchants**
District
Address{ string Optional
100 The post town that is associated with the merchant’s address **For use by UK Merchants**
PostTown
Address{ string Optional
50 The County associated with the Merchant’s address **For use by UK Merchants**
County
MailAddress{
string 100 Optional Merchant Mailing Street Address
Address1
MailAddress{
string 100 Optional Merchant Mailing address line 2
Address2
MailAddress{
string 100 Optional Merchant Mailing Address Apartment Number
ApartmentNumber
MailAddress{
string 30 Optional Merchant Mailing Address City
City
MailAddress{ Merchant Mailing Address state MUST be one of the standard 2 character abbreviations for US or
string 3 Optional
State Canada.
Merchant Mailing Address zip. For US, it should be 5 or 9 characters with no dash. For CAN: 6 character
MailAddress{
string Optional postal code with a space “xxx xxx”. For the UK: 6-8 alphanumeric charcter postal code with a space. The
Zip
first part is 2-4 digits. The second have is 3 digits “YYYY YYY”
MailAddress{
string 3 Optional Merchant Mailing Address country See Appendix B for possible country codes.
Country
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 27
 MailAddress{ string Optional
50 The District associated with the Mailing address. **For use by UK Merchants**
District
MailAddress{ string Optional
100 The Post town associated with the mailing address. **For use by UK Merchants**
PostTown
MailAddress{ string Optional
50 The county associated with the mailing address. **For use by UK Merchants**
County

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantAddress/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045657, "AccountNumber":718045657,
"Address":{ "Status":"00"
"ApartmentNumber":"K", }
"Address1":"123 New Street",
"Address2":"Some address2",
"City":"LA",
"State":"CA",
"Country":"USA",
"Zip":"90210"
},
"MailAddress":{
"ApartmentNumber":null,
"Address1":"PO Box 111",
"Address2":"Some street",
"City":"LA",
"State":"CA",
"Country":"USA",
"Zip":"90210"
}
}
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 28
4.23 Edit Merchant Renewal Payment Method
Updates the bank account, credit card or ProPay account on file for account renewals.
*Depending on which type of payment method you are adding you should add all relevant fields.

Request Elements
Ma
Element Type Required Notes
x
AccountNumber Int(32) Required Assigned to each account by ProPay.
CreditCardData{
String Optional Card holder’s name as it appears on card.
NameOnCard
CreditCardData{
String Optional* Credit Card number of the Credit Card for editing Monthly Renewal data.
CreditCardNumber
CreditCardData{
String Optional* Expiration Date of the Credit Card for editing Monthly Renewal data. mmyy
ExpDate
PaymentBank{
String Optional* Bank account number of the bank account used for editing Monthly Renewal data.
AccountNumber
PaymentBank{
String Optional* Routing number of the bank account used for editing Monthly Renewal data.
RoutingNumber
PaymentBank{
String Optional* Valid values are: Checking, Savings, GeneralLedger
AccountType

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantPaymentInformation/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045862, "AccountNumber":718045862,
"CreditCardData":null, "Status":"00"
"PaymentBank":{ }
"AccountNumber":"7654321",
"RoutingNumber":"324079555",
"AccountType":"Savings"

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 29
 }
}

4.24 Edit Merchant Business Info

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
AuthorizedSignerFirstName string 20 Optional Authorized Signer First Name
AuthorizedSignerLastName string 25 Optional Authorized Signer Last Name
AuthorizedSignerTitle string 20 Optional Authorized Signer Title
BusinessData{
string 255 Optional Business Legal Name
BusinessLegalName
BusinessData{
string 40 Optional DoingBusinessAs
DoingBusinessAs
BusinessData{
string Optional EIN *For UK, do not pass
EIN
BusinessData{
string 255 Optional WebsiteURL
WebsiteURL
BusinessData{
string 255 Optional BusinessDescription
BusinessDescription
BusinessData{
Int(64) Optional MonthlyBankCardVolume
MonthlyBankCardVolume
BusinessData{
Int(64) Optional HighestTicket
HighestTicket
BusinessAddress{
string 100 Optional Business Address
Address1
BusinessAddress{
string 100 Optional Business Address2
Address2
BusinessAddress{
string 100 Optional Apartment Number
ApartmentNumber
BusinessAddress{
string 30 Optional BusinessCity
City
BusinessAddress{
string 3 Optional Business State
State
BusinessAddress{
string 3 Optional Business Country
Country
BusinessAddress{
string Optional Business Zip
Zip
BusinessAddress{ string
50 Optional The District associated with the business address **For use by UK merchants**
Disctrict
BusinessAddress{ string
100 Optional The Post Town that is associated with the business address **For use by UK merchants**
PostTown

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 30
 BusinessAddress{ string
50 Optional The county associated with the business address **For use by UK merchants**
County
BusinessAddress{ string
100 Optional Business Physical Address **For UK merchants, use to provide the Building Name**
Address3

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantBusinessInfo/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045777, "AccountNumber":718045777,
"AuthorizedSignerFirstName":"TestFirstName", "Status":"00"
"AuthorizedSignerLastName":"TestLastName", }
"AuthorizedSignerTitle":"TestTitle",
"BusinessData":{
"BusinessLegalName":"Testlegalname",
"DoingBusinessAs":"TestDBA",
"EIN":"584384656",
"WebsiteURL":"www.test.com",
"BusinessDescription":"Test description",
"MonthlyBankCardVolume":9000,
"HighestTicket":1000
},
"BusinessAddress":{
"ApartmentNumber":null,
"Address1":"AddressLine1",
"Address2":"AddressLine2",
"City":"TestCity",
"State":"CA",
"Country":null,
"Zip":"13245"
}
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 31
4.25 Edit Merchant Bank Account
Can edit Primary or Secondary Bank Account with this method.

Request Elements
Ma
Element Type Required Notes
x
AccountNumber Int(32) Required Assigned to each account by ProPay.
true or false; true if editing Secondary Bank Account. false if editing Primary Bank Account. If you don’t
IsSecondaryBankAccount
pass this field it will default to primary
BankAccount{
string 25 Required ISO 3166 standard 3 character country codes. Current allowed values are: USA and CAN
AccountCountryCode
BankAccount{
integer 20 Required Bank Account Number
BankAccountNumber
BankAccount{
Integer 20 Required Valid ABA routing number or CPA EFT code.
RoutingNumber
BankAccount{
string 15 Optional Valid values are: Personal or Business
AccountOwnershipType
BankAccount{
string 50 Required Bank Name
BankName
BankAccount{
string Required Valid values are: Checking, Savings, and GeneralLedger
AccountType

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantBankAccount/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045678, "AccountNumber":718045678,
"IsSecondaryBankAccount":false, "Status":"00"
"BankAccount":{ }
"AccountCountryCode":"USA",

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 32
 "BankAccountNumber":111111111,
"RoutingNumber":091000019,
"AccountOwnershipType":"Business",
"BankName":"Bank Name",
"AccountType":"Checking"
}
}

4.26 Edit Merchant Gross Settle Payment Info

*It is necessary to pass all fields for the payment type you choose to add.

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
GrossBillingInformation{
GrossSettleAddress{ String 25 Required Gross Settle credit card billing address.
Address1
GrossBillingInformation{
GrossSettleAddress{ String 25 Required Gross Settle credit card billing address.
City
GrossBillingInformation{
Gross Settle credit card billing address. Must be 2 character standard US State or Canadian province
GrossSettleAddress{ String 2 Required
code.
State
GrossBillingInformation{ Gross Settle credit card billing address. For USA: 5 or 9 characters without dash. For CAN: 6 characters
GrossSettleAddress{ String 9 Required postal code with a space “XXX XXX” Do not use if not USA or CAN. *Required if payment method is a
Zip credit card.
GrossBillingInformation{
GrossSettleAddress{ String 3 Required Gross Settle credit card billing address. Must be 3 character ISO standard country code.
Country
GrossBillingInformation{
GrossSettleBankAccount{ String Required* Bank account-holder’s name. *Required if payment method is a bank account.
AccountName
*Required if Gross Settle billing info is bank account. Valid values are:
GrossBillingInformation{  C – Checking
GrossSettleBankAccount{ String 10 Required*
 S – Savings
AccountType
 G – General Ledger
GrossBillingInformation{
GrossSettleBankAccount{ String 25 Required* Bank account number. *Required if payment method is a bank account.
BankAccountNumber
GrossBillingInformation{
GrossSettleBankAccount{ String 9 Required* Routing number of valid Fedwire ACH participant. *Required if payment method is a bank account.
RoutingNumber

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 33
 GrossBillingInformation{ ISO 3166 standard 3 character country codes. Current allowed values are:
GrossSettleBankAccount{ string 3 Required*  USA
AccountCountryCode  CAN
GrossBillingInformation{
GrossSettleCardData{ String 16 Required* Valid credit card number. *Required if payment method is a credit card.
CreditCardNumber
GrossBillingInformation{
GrossSettleCardData{ String 4 Required* Credit card expiration date. *Required if payment method is a credit card.
ExpirationDate
GrossBillingInformation{
GrossSettleCardData{ String 25 Required* Name on credit card. *Required if payment method is a credit card.
NameOnCard

GrossSettlePropayAccount{
Required* ProPay Account Number
AccountNum

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantGrossSettleBilling/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045607, "AccountNumber":718045607,
"GrossBillingInformation":{ "Status":"00"
"GrossSettleBankAccount":null, }
"GrossSettleAddress":{
"Address1":"123 Main Stree",
"City":"LA",
"State":"CA",
"Country":"USA",
"Zip":"90210"
},
"GrossSettleCardData":{
"NameOnCard":"Bo Diddley",
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 34
 "CreditCardNumber":"<credit card number>",
"ExpirationDate":"0522"
},
"GrossSettlePropayAccount":null
}
}

4.27 Edit Merchant Services

Requires additional approval to be able to perform this method

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
ACHIn Boolean Required Account permitted to load funds via ACH. Valid values are: true and false
Account balance allowed to be pushed to on-file DDA. Affects automatic sweeps. Valid values
ACHOut Boolean Required
are: true and false
CcProcessing Boolean Required Valid values are: true and false
ProPayIn Boolean Required Valid values are: true and false
ProPayOut Boolean Required Valid values are: true and false
Valid values between 0 and 999999999. Expressed as number of pennies in USD or number of
CreditCardMonthLimit String Optional
account’s currency without decimals.
Valid values between 0 and 999999999. Expressed as number of pennies in USD or number of
CreditCardTransactionLimit String Optional
account’s currency without decimals.
SoftLimitEnabled Char Optional Valid values are y or n. Please work with ProPay for more information about soft limits feature
AchPaymentSoftLimitEnabled Char Optional Valid values are y or n. Please work with ProPay for more information about soft limits feature
Valid values between 0 and 499. Please work with ProPay for more information about soft limits
SoftLimitAchOffPercent String Optional
feature
Valid values between 0 and 499. Please work with ProPay for more information about soft limits
AchPaymentAchOffPercent String Optional
feature
Valid values between 0 and 999999999999999. Expressed as number of pennies in USD or number
ACHPaymentMonthLimit String Optional
of account’s currency without decimals
Valid values between 0 and 9999999. Expressed as number of pennies in USD or number of
ACHPaymentPerTranLimit String Optional
account’s currency without decimals

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 35
HTTP Element Value
Resource URI /propayAPI/MerchantServices/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045822, "AccountNumber":718045822,
"CcProcessing":true, "Status":"00"
"ACHOut":true, }
"ACHIn":true,
"ProPayOut":true,
"ProPayIn":true,
"SoftLimitEnabled":"y",
"AchPaymentSoftLimitEnabled":"y",
"CreditCardMonthLimit":0,
"CreditCardTransactionLimit":0,
"SoftLimitAchOffPercent":0,
"AchPaymentAchOffPercent":0
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 36
4.28 Edit Merchant Status
Requires additional approval to be able to perform this method

Request Elements
Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
Used to update status of ProPay account. Note: the ONLY value that will allow an account to
process transactions is ‘ReadyToProcess’ Valid values are:
 ReadyToProcess
 FraudAccount
 RiskwiseDeclined
MerchantStatus String Optional  Hold
 Canceled
 FraudVictim
 ClosedEULA
 ClosedExcessiveChargeback

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantStatus/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045837, "AccountNumber":718045837,
"MerchantStatus":"Canceled" "Status":"00"
} }

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 37
4.29 Edit Merchant Credit Limit
Requires additional approval to be able to perform this method

Group: Negative Limit

Element Type Max Required Notes
AccountNumber Int(32) Required Assigned to each account by ProPay.
CreditLimit Int(64) Required Amount must be greater than zero

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantCreditLimit/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"AccountNumber":718045806, "AccountNumber":718045806,
"CreditLimit":1000 "Status":"00"
} }

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 38
4.30 Order a New Device
This method is used to order a new device.
Note: This method is currently restricted to partners using the Propay-Portico solution and using Portico Devices.

Request Elements
Element Type Max Required Notes
AccntNum String Required Assigned to each account by ProPay
ShipTo String Required The name of the company that is receiving the device
ShipToContact String 30 Required The name of the person who would be receiving the device.
ShipToAddress String Required The address where the device should be shipped
ShipToCity String Required The City where the device should be shipped
ShipToState String Required The State where the device should be shipped *For UK: do not pass.
ShipToZip String Required The Zip Code where the device should be shipped
ShipToPhone String Required Phone number of the contact. Must be 10 characters
CardholderName String Required The name that appears on the credit card used for purchase. Optional if the price of the device
is $0.00
CcNum String Required The credit card number of the card used for purchase. Optional if the price of the device is $0.00
ExpDate String Required The expiration date of the card used for purchase. Optional if the price of the device is $0.00
CVV2 String Required The CVV of the card used for purchase. Optional if the price of the device is $0.00
BillingZip String Required The billing zip code. Optional if the price of the device is $0.00
Devices.Device.Name String 20 Required Unique name of the device being ordered.
Devices.Device.Quantity String INT Required The number of devices to charge for and order.
Devices.Device.Attributes String Required List of Attributes
Attributes.Attribute.Name String 20 Required Name of the attribute item. For example, “Heartland.AMD.OfficeKey” which is specific to Portico
devices for AMD. The value of this item is passed to Heartland for equipment boarding
Attributes.Attribute.Value String 20 Required Value of the attribute item. In the above example, the value of “Heartland.AMD.OfficeKey”.

Response Elements
Element Type Notes
AccountNumber ProPay account number
Status Result of the transaction request. See ProPay Appendix for result codes.
Total amount that was charged to the credit card. If tax calculating conditions are met, the total amount will show the
TotalPrice
device's amount with tax included (gross amount).
CurrencyCode Currency that the Price and TotalAmount are represented in.
Devices.Device.Name Name of the device ordered
Devices.Device.Quantity Quantity ordered
Devices.Device.Price Price per unit

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 39
 Devices.Device.CurrencyCode Currency for device per unit price.

How to call this method

HTTP Element Value
Resource URI /propayAPI/OrderDevices
Method PUT
Basic CertStr:TermId(Base 64 Encoded)
Authorization
Example: Basic TXlUZXJtSWQ6TXlDZXJ0U3Ry
Content-Type application/json

Sample
Sample JSON request Response
{ {
"AccntNum": "12345", "AccountNumber": 12345,
"ShipTo": "Test Company", "Status": "00",
"ShipToContact": "John Q. Public", "TotalPrice": 1250.0,
"ShipToAddress": "2675 W 600 N", "CurrencyCode": "USD",
"ShipToAddress2": "Test Second Address", "Devices": [
"ShipToCity": "Lindon", {
"ShipToState": "UT", "Name": "Nimbus2000",
"ShipToZip": "84043", "Quantity": 1,
"ShipToPhone": "8010262626", "Price": 1250.0,
"CardholderName": "John Doe", "CurrencyCode": "USD"
"CCNum": "4111111111111111", }
"ExpDate": "0425", ]
"CVV2": "989", }
"BillingZip": "78956",
"Devices": [{
"Name": "Nimbus2000",
"Quantity": 1,
"TimeZone": "UTC",
"Attributes": [{
"Name": "Key1",
"Value": "Data"
}
]
}
]
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 40
4.31 Device order Tax Calculation
Use this method to calculate tax on device order. Given the shipping address and the devices that you want to order, this endpoint will provide tax
information with the help of third-party provider Avalara.

Address Information – Required

Element Type Max Required Notes
ShipToAddress string 100 Yes The address line 1 where the device should be shipped.
ShipToAddress2 string 100 No The address line 2 where the device should be shipped.
ShipToCity string 30 Yes The city where the device should be shipped.
ShipToZip string 10 Yes The zip code where the device should be shipped.
ShipToState string 3 Yes The state where the device should be shipped.
ShipToCountry string 3 Yes The country where the device should be shipped.

Devices - Required
Element Type Max Required Notes
Name string 50 Yes Unique name of the device being ordered.
Quantity int(32) Int32 Yes Number of devices ordered.

Tier Information - Optional

Element Type Max Required Notes
Tier string 20 No The name of the tier where the devices are settled (eg. Premium).

Response Elements
Element Type Notes
The account number, in this case will be always 0 (default value), because we are not returning
AccountNumber long
account number in the response with this request.
TransType int(32) The transaction type. Will always return as 431.
Status string Result of the transaction request. See the ProPay Appendix for result code definitions.
Name string The name of the device being ordered.
CurrencyCode string The currency code, will return null if not available.
Quantity int(32) Number of devices ordered.
Price decimal The price of each device.
TotalDevicePrice decimal The total device price (net amount).
TotalTaxRate decimal The total tax rate calculated on the total device price (in percents).
TotalTax decimal The tax amount that needs to be added on total device price.
TotalAmount decimal The devices amount with tax included (gross amount).

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 41
How to call this method
HTTP Element Value
Resource URI /propayAPI/CalculateTax
Method POST
Basic CertStr:TermId(Base 64 Encoded)
Authorization
Example: Basic TXlUZXJtSWQ6TXlDZXJ0U3Ry
Content-Type application/json

Sample
Sample JSON request Response
{ {
"Tier”: “Premium”, "AccountNumber": 0,
“ShipToAddress”: “Address Line 1”, "Status":"00",
“ShipToAddress2”: “Address Line 2”, “TransType”: 431,
“ShipToCity”: “Denver”, “Devices”: [
“ShipToZip”: “840014”, {
“ShipToState”: “CO”, “CurrencyCode”: null,
“ShipToCountry”: “USA”, “Name”: “Test Device #122807f5d”,
“Devices”: [ “Quantity”: 1
{ },
“Name”:Test Device #122807f5d”, {
“Quantity”: 1 “CurrencyCode”: null,
}, “Name”: “Test Device #29e1ebc140”,
{ “Quantity”: 4
“Name”:Test Device ##29e1ebc40”, }
“Quantity”: 4 ],
} “TotalDevicePrice”: 8935.80,
] “TotalTaxRate”: 10.000,
} “TotalTax:” 893.58,
“TotalAmount”: 9829.38
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 42
4.32 Edit Merchant Transfer Funds Configuration
Use this method to exclude or include a merchant from a sweep job.

Request Elements
Element Type Max Required Notes
AccountNumber String Required Assigned to each account by ProPay
ExcludeFromSweep Char Required Valid values are: Y and N

Response Elements
Element Type Notes
The account number, in this case will be always 0 (default value), because we are not returning
AccountNumber long
account number in the response with this request.
Status string Result of the transaction request. See the ProPay Appendix for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantTransferFundsConfiguration/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
{ "AccountNumber": 718043354,
"AccountNumber": 718043354, "Status": "00"
"ExcludeFromSweep": "Y" }
}
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 43
4.3 Address Lookup (Equifax)
This method is for use outside of the United States and will return several details associated with the merchant and/or beneficiary owner address. This
call is specific to Equifax.

Request Elements - Required

Element Type Max Required Notes
BuildingName String 50 Optional Include if the address represents a building that has been given a name OR is important to the
location of the merchant or beneficiary owner address.
*Mandatory if the Building Number is not provided.
BuildingNumber String 50 Optional The building number for the merchant or beneficiary owner address.
*Mandatory if Building Name is not provided.
BuildingPostalCode String 10 Required The postal code related to the building for the merchant or beneficiary owner address.

Response Elements
Element Type Notes
AddressTransId String This is a "transaction" id assigned by Equifax to identify the address listings returned against
each API call to their Address Lookup service.
AddressTransIdCreate String This is the date the Equifax "transaction" id was created.
dDate
Address Array
AddressId String This is a unique address identity number assigned to each distinct address returned by
Equifax.
BuildingName String The name of the building associated with the address.
BuildingNumber String The building number for the address.
BuildingAddress1 String The street address.
BuildingDistrict String District associated with the address.
BuildingTown String Town associated with the address.
BuildingCounty String County associated with the address.
BuildingCountry String Country associated with the address.
BuildingPostalCode String Postal code associated with the address.

How to call this method

HTTP Element Value
Resource URI /propayapi/addresslookup
Method Put
Authorization Refer to the "General Information about the ProPay REST Interface" section, API Authorization on page 4.

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 44
Sample
Sample JSON request data: Sample JSON response data:
{ {
"BuildingName": "221 B", "AddressTransId": "ff12a9f2-0002-4deb-8495-e95c048efb36",
"BuildingNumber": "4148", "AddressTransIdCreatedDate": "2022-07-07T07:16:56.751+00:00",
"Addresses": [
"BuildingPostalCode": "CB6 1AS"
{
} "AddressId": "28030106476",
"BuildingAddress1": "BAKER STREET",
"BuildingCountry": "United Kingdom",
"BuildingCounty": "CAMBS",
"BuildingDistrict": "Harrow",
"BuildingName": "221 B",
"BuildingNumber": "2649",
"BuildingPostalCode": "CB6 1AS",
"BuildingTown": "ELY"
},
{
"AddressId": "28030108290",
"BuildingAddress1": "CROMWELL ROAD",
"BuildingCountry": "United Kingdom",
"BuildingCounty": "CAMBS",
"BuildingDistrict": "Harrow",
"BuildingName": "221 B",
"BuildingNumber": "4278",
"BuildingPostalCode": "CB6 1AS",
"BuildingTown": "ELY"
}
],
"Status": "00"
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 45
4.4 Renew ProPay Account
This method will extend the expiration date of a ProPay account by one year. This may also be used to change the tier of an existing account.

Renewal Fees
ProPay account renewals require the collection of the account renewal fee. This method will attempt to collect the fee as follows:
1. If the API request includes on of the optional payment groups below, it will be used in an attempt to collect renewal fees.
2. Then, if either no payment group is passed, or if payment fails, ProPay will check to see if the account is set up to be paid for by the partner. If
such is the case, the account will simply be renewed.
3. Finally, ProPay will attempt to collect renewal fees from the account’s available balance.
If all of these attempts to collect the renewal fees fails the renewal request will return denied.

Account Identification - Required

Element Type Max Required Notes
accountNum Int(32) Required Assigned to each account by ProPay.
Supplying a value will change the accounts tier under the affiliation upon renewal.
tier String Optional
If not passed the tier will not be changed.

Group: Payment Information (Credit Card) - Optional

Element Type Max Required Notes
CVV2 String 4 Required The credit card CVV code.
ccNum String 16 Required The credit card number used to pay for the renewal. *Required if using credit card to pay renewal fee.
expDate String 4 Required The credit card expiration date in ‘mmdd’ format. *Required if using credit card to pay renewal fee.
The US zip code of the credit card. 5 or 9 digits without a dash for US cards. Omit for international credit
zip String 9 Required
cards.

Group: Payment Information (Bank Account) - Optional

Element Type Max Required Notes
Used to pay for an account via ACH and monthly renewal. Financial institution account number.
PaymentBankAccountNumber String Required
*Required if using ACH to pay renewal fee.
Used to pay for an account via ACH and monthly renewal. Financial institution routing number.
PaymentBankRoutingNumber String Required
Must be a valid ACH routing number. *Required if using ACH to pay renewal fee.
Used to pay for an account via ACH and monthly renewal. Valid values are: Checking and
PaymentBankAccountType String Required
Savings

Response Elements
Element Type Notes
Status string Result of the transaction request. See Appendix B for result code definitions.
Tier string The tier the account was renewed under.

How to call this method

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 46
HTTP Element Value
Resource URI /propayAPI/renewal
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"accountNum": 123456, "AccountNumber": 123456,
"CVV2": 999, "Status": "00",
"tier" : "194e4047-69b5-4e7c-b", "Tier": "194e4047-69b5-4e7c-b"
"ccNum": "4111111111111111", }
"expDate":"1221",
"zip": "12345"
}
Back to Contents

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 47
4.8 Upload a Chargeback Document to ProPay
This method can be used to send an image file to ProPay. The ProPay Risk team may request that you perform this action to dispute a credit card
chargeback.

Request Elements - Required

Element Type Max Required Notes
accountNum Int(32) Required Assigned to each account by ProPay
DocumentName String 100 Required Name the document according to instructions provided to you by ProPay’s Risk team.
TransactionReference String 40 Required The transaction number of the chargeback you need to dispute.
DocType String 4 Required File format. Valid types: tif, tiff, bmp, jpg, jpeg, gif, png, pdf
Document String (10mb) Required The document data in base64 format.
Identification String Required For JSON requests, use a “Null Identification

Response Elements
Element Type Notes
status string Result of the transaction request. See Propay Appendix for result code definitions

How to call this method

HTTP Element Value
Resource URI /propayAPI/DocumentUpload
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request data: Sample JSON response data:
{ {
"accountNum": 123456, "Status": "00",
"DocumentName": “Chargeback 1234”, }
"TransactionReference": “100”,
"Document": “JVBERi0xLjUNCiW1tbWdQAAAAAAA”,
“DocType”: “jpg”,
“Identification”: “Null”
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 48
5.6 Flash Funds – Add or Change Card Assigned to a ProPay Account
This method is used to add a card as a destination for ProPay’s Flash Funds solution. It can also be used to change the card already attached to an
account.
- Only debit cards are supported. Funds transfer to a credit card takes as long as standard ACH out.
- Only Visa and MasterCard cards are supported.

Request – Elements Required

Element Type Max Required Notes
accountNum Int(32) Required Assigned to each account by ProPay.
ccNum String 19 Required Standard cc numbers which must pass Luhn check.
expDate String 4 Required The expiration date in MMYY format.
CVV2 String 4 Required The Card CVV2 Code. *Accepts both 3 and 4 character types.
cardholderName String 25 Required Name on card.
addr String 20 Required Card holder’s address.
city String 30 Required Card holder’s City
state String 2 Required ISO standard 2 character US State code.
zip String 9 Required Valid-format US zip code 5 or 9 digits.

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/FlashFundsCard/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"ccNum":"<card number>", "AccountNumber":718045866,
"expDate":"1020", "Status":"00"
"accountNum":718045866, }
"CVV2":"022",
"cardholderName":"Clint Eastwood",
"addr":"900 Metro Center Blv",

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 49
 "zip":"94404",
"state":"CA",
"city":"San Fransisco"
}

5.7 Flash Funds – Push Funds to On-File Card

This method is used to push money from a ProPay account out to the on-file payment instrument set up for Flash Funds.

Request – Elements Required

Element Type Max Required Notes
accountNum Int(32) Required Assigned to each account by ProPay.
amount Int(32) Required The value representing the number of pennies in USD, or the number of [currency] without decimals.

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.

How to call this method

HTTP Element Value
Resource URI /propayAPI/PushFundsToFlashFundsCard/{AccountNumber}
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
{ {
"amount":"1000", "AccountNumber":718045866,
"accountNum":718045866 "Status":"00"
} }

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 50
7.1 ProPay Account Payment Disbursement
This method will immediately disburse funds from a specifically designated ProPay source account into another.
- Minimum amount is $1.00 USD
- Rather than using the normal affiliate certStr, this method uses a certStr directly tied to the source account for funds disbursement
- Please see 3.2.1 for more information on the authorization element where this value needs to be set.

Request Elements - Required

Element Type Max Required Notes
amount Int(64) Required The value representing the number of pennies in USD, or the number of [currency] without decimals.
recAccntNum Int(32) Required ProPay assigned account identifier. The receiving account.
comment1 String 120 Optional Optional Comment Line 1
comment2 String 120 Optional Optional Comment Line 2
invNum String 50 Optional Optional Invoice Number for external tracking

Response Elements
Element Type Notes
Status string Result of the transaction request. See ProPay Appendix B for result code definitions
TransactionNumber Int(32) The ProPay transaction identifier

How to call this method

HTTP Element Value
Resource URI /propayAPI/ProPayToProPay
Method PUT
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Sample JSON response data:
{ {
"amount": 100, "AccountNumber": 123456,
"invNum": "Test Invoice Number", "Status": "00",
"comment1":"Test Comment 1", "TransactionNumber": 1
"comment2":"Test Comment 2", }
"recAccntNum": "123456"

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 51
 }
Back to Contents

7.5 Split Funds from a ProPay Transaction (Timed Pull)

This method will split a portion of funds from a transaction on an affiliated account and put them into a designated ProPay account. It can perform
a Splitpay transaction either on underlying credit card transaction or ach transaction.

Credit Card: This method will create placeholder transaction that stays in a pending state until the credit card transaction upon which it is base
settles into the ProPay account. This method cannot be performed against an auth-only transaction; the charge must be captured.
 Ach: This method will create placeholder transaction that stays in a pending state until the ACH transaction upon which it is base funds into
the ProPay account.

Request Elements - Required

Element Type Max Required Notes
ProPay account identifier. This is the ‘from’ account and the account upon which the cc transaction or ach
accountNum Integer Required
transaction was initially performed.
recAccntNum Integer Required ProPay account identifier. This is the account to which the split will be sent when the transaction settles.
amount Integer Required The amount (in cents, USD) to be split off to the recAccntNum when the transaction settles.
transNum Integer Required ProPay transaction identifier. It is when this transaction settles that the timed pull will occur.
invNum String 50 Optional Optional Invoice Number for external tracking
comment1 String 120 Optional Optional Comment Line 1
comment2 String 120 Optional Optional Comment Line 2

Response Elements
Element Type Notes
AccountNumber Integer The accountNum of the original merchant
Status String See section ProPay Appendix B for explanation of each status code returned
TransactionNumber Integer Transaction identifier for the recipient’s account.

How to call this method

HTTP Element Value
Resource URI /propayAPI/TimedPull
Method PUT
Authorization See section 3.2.1 REST Interface

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 52
Sample
Sample JSON request data: Sample JSON response data:
{ {
"accountNum": 123456, "AccountNumber": 987654,
"recAccntNum": 987654, "Status": "00",
"TransactionNumber": 1
"amount": 100,
}
"transNum": 2,
"invNum": "Invoice",
"comment1": "Test Comments",
"comment2": "Test Comments2"
}

Back to Contents

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 53
8.2 Get current ProPay Account Balance
This method retrieves the ProPay account’s current available and pending balances. It also returns a number of data points about the use of
available funds as a transfer out of the ProPay account.

Response Elements
Element Type Notes
AccountNumber string Primary identifier for ProPay Account
Status string Result of the transaction request. See Appendix B for result code definitions.
AvailableBalance Int(64) The account’s available balance specified in the currency’s lowest denomination (100 = $1.00)
The account’s pending balance specified in the currency’s lowest denomination (100 = $1.00) The affiliate credential must be
PendingBalance Int(64)
enabled for Enhanced Spendback in order to receive this element in the response.
ReserveBalance Int(64) The accont’s reserve balance specified in the currency’s lowest denomintation (100 = $1.00)
EmailId String Source email on the ProPay account
AccountLastFour String Member of both achOut and flashFunds. Obfuscated account details for recipient
Enabled Boolean Member of both achOut and flashFunds. Describes wether ability to transfer funds in specified manner is currently allowed.
FeeType String Member of both achOut and flashFunds. Describes whether trasnferFee is a flat amount or a percentage. (Specified as $ or %.)
Member of both achOut and flashFunds. Describes remaining limit for funds transfer. Note: flashFunds imposes a daily transfer fee,
LimitRemaining Long
while achOut does not. (The limitRemaining for achOut will essentially be the current available balance on the account.)
TransferFee Decimal Member of both achOut and flashFunds. Cost to transfer money using the specified method.

How to call this method

HTTP Element Value
Resource URI /propayAPI/MerchantBalanceDetails/{AccountNumber}
Method GET
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
URI Only {
"AccountNumber":718046006,
"Status":"00",
"AchOut":{
"AccountLastFour":"6789",
"Enabled":"Y",
"FeeType":"$",
©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 54
 "LimitRemaining":100000,
"TransferFee":100
},
"AvailableBalance":10000,
"EmailId":"[email protected]",
"FlashFunds":{
"AccountLastFour":"0006",
"Enabled":"Y",
"FeeType":"%",
"LimitRemaining":1000000,
"TransferFee":15.59
},
"PendingBalance":930,
"ReserveBalance":0
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 55
8.4 Enhanced Account Details
This method retrieves a vast amount of information for the requested ProPay account, including: Personal Information, Account Data, Addresses,
Business Information and Bank Account Information.

Please understand special rules for use of this method:

- This transaction type requires that an additional permission is enabled for the credentials

Response Elements
Element Type Notes
transType string 19 constant value
status string Result of the transaction request. See ProPay appendix for result code definitions.
AccountNumber string Primary identifier for ProPay Account
PersonalData{SourceEmail string Source email on the ProPay account
PersonalData{FirstName string Account owner first name
PersonalData{MiddleInitial string Account owner middle initial
PersonalData{LastName string Account owner last name
PersonalData{PhoneInformation{DayPhone string Account owner day phone
PersonalData{PhoneInformation{EveningPhone string Account owner evening phone
AccountData{ExternalId string Account external identifier
AccountData{AccntStatus string Current status of account
AccountData{Expiration string Account expiration date
AccountData{SignupDate string Account signup date
AccountData{Affiliation string Affiliation associated with the account
AccountData{Tier string Tier associated with the account
AccountData{apiReady string Indicates if the account is api ready
AccountData{MasterPassCheckoutMasterId string Checkout ID for MasterPass (SRC)
AccountData{AchOutEnabled string Indicates if the account is enabled for ACH transfers to on-file DDA
AccountData{CurrencyCode string Account currency code
Communication Email Address. *ProPay’s system will send automated emails to the email address on
AccountData{NotificationEmail string
file rather than the Source Email.
Address{HomeAddress1 string Account owner home address 1
Address{HomeAddress2 string Account owner home address 2
Address{HomeAddress3 string Account owner home address 3
Address{HomeCity string Account owner home city
Address{HomeState string Account owner home state
Address{HomeZip string Account owner home zip

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 56
Address{HomeCountry string Account owner home country
MailAddress{MailAddress1 string Account owner mail address 1
MailAddress{MailAddress2 string Account owner mail address 2
MailAddress{MailAddress3 string Account owner mail address 3
MailAddress{MailCity string Account owner mail city
MailAddress{MailState string Account owner mail state
MailAddress{MailZip string Account owner mail zip code
MailAddress{MailCountry string Account owner mail country
BusinessData{BusinessLegalName string The business’ legal name
BusinessData{DoingBusinessAs string The business’ “doing business as” name (DBA)
BusinessData{EIN string The business’ “Employer Identification Number” (EIN) *does not apply to UK merchants
BusinessData{BusinessAddress string Business address
BusinessData{BusinessAddress2 string Business address 2
BusinessData{BusinessCity string Business city
BusinessData{BusinessState string Business state
BusinessData{BusinessZip string Business zip code
BusinessData{WebsiteURL string The Business’ website URL
The average amount of an individual transaction; Value representing the number of pennies in
BusinessData{AverageTicket string
USD, or the number of [currency] without decimals. Defaults to null if not sent.
The highest transaction amount; Value representing the number of pennies in USD, or the number of
BusinessData{AverageTicket string
[currency] without decimals. Defaults to null if not sent.
AccountLimits{CreditCardTransactionLimit string Merchant credit card transaction limit
AccountLimits{CreditCardMonthLimit string Merchant credit card monthly limit
AccountLimits{CreditCardMonthlyVolume string Merchant credit card monthly volume
AccountLimits{NegativeLimit string Merchant negative limit
AccountLimits{ACHPaymentPerTranLimit string Merchant ach payment per transaction limit
AccountLimits{ACHPaymentMonthLimit string Merchant ach payment month limit
AccountLimits{ACHPaymentMonthlyVolume string Merchant ach payment monthly volume
AccountLimits{AchPaymentSoftLimitEnabled string Merchant ach payment soft payment soft limit enabled
AccountLimits{AchPaymentAchOffPercent string Merchant ach payment ach payment ach off percent
AccountLimits{SoftLimitEnabled string Merchant soft limit enabled
AccountLimits{SoftLimitAchOffPercent string Merchant soft limit ach limit ach off percent
AccountBalance{AvailableBalance string The account’s available balance specified in the currency’s lowest denomination (100 = $1.00)
AccountBalance{PendingBalance string The account’s pending balance specified in the currency’s lowest denomination (100 = $1.00)
AccountBalance{ReserveBalance string The account’s reserve balance specified in the currency’s lowest denomination (100 = $1.00)

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 57
BankAccount{PrimaryBankAccount{PrimaryAcc
string Primary bank account country code
ountCountryCode
BankAccount{PrimaryBankAccount{PrimaryAcc
string Primary bank account type
ountType
BankAccount{PrimaryBankAccount{PrimaryAcc
string Primary bank account ownership type
ountOwnershipType
BankAccount{PrimaryBankAccount{PrimaryBan
string Bank name for the primary bank account
kName
BankAccount{PrimaryBankAccount{PrimaryAcc
string Last 4 digits of the primary bank account number
ountNumberLast4
BankAccount{PrimaryBankAccount{PrimaryRout
string Routing number for the primary bank account
ingNumber
BankAccount{SecondaryBankAccount{Second
string Secondary bank account country code
aryAccountCountryCode
BankAccount{SecondaryBankAccount{Second
string Secondary bank account type
aryAccountType
BankAccount{SecondaryBankAccount{Second
string Secondary bank account ownership type
aryAccountOwnershipType
BankAccount{SecondaryBankAccount{Second
string Bank name for the secondary bank account
aryBankName
BankAccount{SecondaryBankAccount{Second
string Last 4 digits of the secondary bank account number
aryAccountNumberLast4
BankAccount{SecondaryBankAccount{Second
string Routing number for the secondary bank account
aryRountingNumber
GrossBillingInformation{GrossSettleBankAccount
string Account holder name for the gross settle account on file
{GrossSettleAccountHolderName
GrossBillingInformation{GrossSettleBankAccount Last 4 digits of account number for the gross settle account on file
string
{GrossSettleAccountNumberLast4
GrossBillingInformation{GrossSettleBankAccount Routing number for the gross settle account on file
string
{GrossSetlleRoutingNumber
GrossBillingInformation{GrossSettleBankAccount Account type (ACH, Card or ProPay) for gross settlement
string
{GrossSettleAccountType
GrossBillingInformation{GrossSettleAddress{Gross Address for the gross settle account on file
string
SettleAccountAddress
GrossBillingInformation{GrossSettleAddress{Gross City for the gross settle account on file
string
SettleAccountCity
GrossBillingInformation{GrossSettleAddress{Gross State for the gross settle account on file
string
SettleAccountState
GrossBillingInformation{GrossSettleAddress{Gross Country code for the gross settle account on file
string
SettleAccountCountryCode
GrossBillingInformation{GrossSettleAddress{Gross Zip code for the gross settle account on file
string
SettleAccountZipCode
AdditionalSignupReportInformation{AffiliateID string Unique Id for the owning affiliate
AdditionalSignupReportInformation{AffiliateNam string Name of the owning affiliate
e

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 58
AdditionalSignupReportInformation{ACHToManu string Indicates if a manual hold has been placed on ACH transfers
alHold
AdditionalSignupReportInformation{ACHToAPIH string Indicates if a manual hold has been placed on ACH API transfers
old
AdditionalSignupReportInformation{CKOutRejec string Indicates if a hold has been placed on outbound
tHold
AdditionalSignupReportInformation{CCSoftLimits string Indicates if a hold has been triggered by exceeding soft limits for credit card processing
Hold
AdditionalSignupReportInformation{ACHSoftLimi string Indicates if a hold has been triggered by exceeding soft limits for ACH transactions
tHold
AdditionalSignupReportInformation{ACHFromM string Indicates if a hold has been manually placed on ACHFrom transfers
anualHold
AdditionalSignupReportInformation{ACHFromAP string Indicates if a hold has been placed on ACHFrom API transfers
IHold
AdditionalSignupReportInformation{CKInRejectH string Indicates if a hold has been placed
old
AdditionalSignupReportInformation{ACHToBank string The functionality that allows the merchant to be paid has been disabled due to the UK BACS
ValidationHold Mandate. The BACS Mandate has not been completed
AdditionalSignupReportInformation{ACHFromBa string The functionality that allows ProPay to collect funds from the merchant bank account has been
nkValidationHold disabled due to the UK BACS Mandate. The BACS Mandate has not been completed

AdditionalSignupReportInformation{NonExpiring string The account is set to not expire

AdditionalSignupReportInformation{SweepCanA string Whether the account is enabled to use outbound sweeps
CHOut
AdditionalSignupReportInformation{SweepCanA string Whether the account can receive ACH sweeps
CHIn
AdditionalSignupReportInformation{SweepBank string Whether the bank account listed has been validated
AccountValidated
AdditionalSignupReportInformation{SweepInTra string The limit for sweep transactions
nsactionLimit
AdditionalSignupReportInformation{SweepInMo string The limit for monthly sweep amounts
nthlyLimit
AdditionalSignupReportInformation{SweepInMo string The actual volume for sweeps on this account
nthlyVolume
AdditionalSignupReportInformation{CCAllowed string Whether the account has rights to process credit card payments
AdditionalSignupReportInformation{CCFunding string The account's configured hold days for credit card payments
HoldDays
AdditionalSignupReportInformation{CCRefundLi string The amount of a line of credit for refunding credit card processing
neOfCredit
AdditionalSignupReportInformation{ACHPayme string Whether the Account can receive ACH Payments
ntsAllowed
AdditionalSignupReportInformation{ACHPayme string How many hours ACH payments are configured to be held
ntsFundingHoldHours
AdditionalSignupReportInformation{ACHPayme string Rates for ACH Payments
ntsRatePerTran

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 59
AdditionalSignupReportInformation{ACHPayme string The discount for ACH payments (if any)
ntsRateDiscount
AdditionalSignupReportInformation{ACHPayme string The fee for returning ACH payments
ntsReturnFee
AdditionalSignupReportInformation{AchPaymen string The fee for a notice of change for ACH payments
tsNOCFee
AdditionalSignupReportInformation{GrossSettleA string Whether the account is set to use gross settlement billing
ccountPresent
AdditionalSignupReportInformation{MerchantDe string Descriptor for credit card statements. (Usually DBA)
scriptor
AdditionalSignupReportInformation{VoidCaptur string Whether the accounts has the right to void captured transactions
ed
AdditionalSignupReportInformation{MCC string The Merchant Category Code for the merchant in the ProPay system

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 60
How to call this method
HTTP Element Value
Resource URI propayapi/EnhancedAccountPing/{accountNum}
Method GET
Authorization See section 3.2.1 REST Interface

Sample
Sample JSON request Response
URI Only {
"AccountNumber": 718180093,
"Status": "00",
"PersonalData": {
"SourceEmail":
"[email protected]",
"FirstName": "Clint",
"MiddleInitial": "m",
"LastName": "Eastwood",
"PhoneInformation": {
"DayPhone": "9876543211",
"EveningPhone": "9876543211"
}
},
"AccountData": {
"ExternalId": "affiliate750c",
"AccntStatus": "6",
"Expiration": "6/22/2021 12:00:00 AM",
"SignupDate": "6/22/2020 7:46:31 PM",
"Affiliation": "7E20F006",
"Tier": "b2da83af-5f5e-4474-9",
"ApiReady": "Y",
"MasterPassCheckoutMerchantId": "cb5c609bec3d44b899e45611a2d03d95",
"AchOutEnabled": "Y",
"CurrencyCode": "USD",
"NotificationEmail": [email protected]
“ExcludedFromSweep”: “Y”
},
"Address": {
"HomeAddress1": "3400 N Ashton Blvd",
"HomeAddress2": " apt num",
"HomeAddress3": "3 road",
"HomeCity": "Lehi",
"HomeState": "UT",
"HomeZip": "84043",

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 61
 "HomeCountry": "USA"
},
"MailAddress": {
"MailAddress1": "3400 N Ashton Blvd",
"MailAddress2": "Suite 200",
"MailAddress3": "Bhai ki galli",
"MailCity": "Lehi",
"MailState": "UT",
"MailZip": "84043",
"MailCountry": "USA"
},
"BusinessData": {
"BusinessLegalName": "ProPay Test",
"DoingBusinessAs": "ProPay Inc.",
"EIN": "123456789",
"BusinessAddress": "34, street",
"BusinessAddress2": "Business address 2",
"BusinessCity": "Lehi",
"BusinessState": "UT",
"BusinessZip": "84043",
"WebsiteURL": "www.businesssite.com",
"AverageTicket": 400,
"HighestTicket": 1000
},
"AccountLimits": {
"CreditCardTransactionLimit": "100000",
"CreditCardMonthLimit": "500000",
"CreditCardMonthlyVolume": "0",
"NegativeLimit": "5000",
"ACHPaymentPerTranLimit": "0",
"ACHPaymentMonthLimit": "0",
"ACHPaymentMonthlyVolume": "0",
"AchPaymentSoftLimitEnabled": "Y",
"AchPaymentAchOffPercent": "120",
"SoftLimitEnabled": "Y",
"SoftLimitAchOffPercent": "150”
},
"AccountBalance": {
"AvailableBalance": "50000",
"PendingBalance": "0",
"ReserveBalance": "0"
},
"BankAccount": {
"PrimaryBankAccount": {
"PrimaryAccountCountryCode": "USA",
"PrimaryAccountType": "Checking",
"PrimaryAccountOwnershipType": "1",

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 62
 "PrimaryBankName": "Zions",
"PrimaryAccountNumberLast4": "6789",
"PrimaryRoutingNumber": "011000015”
},
"SecondaryBankAccount": {
"SecondaryAccountCountryCode": "USA",
"SecondaryAccountType": "Savings",
"SecondaryAccountOwnershipType": "1",
"SecondaryBankName": "ZionsSecondary",
"SecondaryAccountNumberLast4": "4321",
"SecondaryRoutingNumber": "011000015”
}
}
"GrossBillingInformation": {
"GrossSettleAccount": {
"GrossSettleAccountHolderName": "Gross Test",
"GrossSettleAccountNumberLast4": "3456",
"GrossSettleRoutingNumber": "124002971",
"GrossSettleAccountType": "ACH"
},
"GrossSettleAddress": {
"GrossSettleAccountAddress": "3400 N Apt St",
"GrossSettleAccountCity": "Lehi",
"GrossSettleAccountState": "UT",
"GrossSettleAccountCountryCode": "USA",
"GrossSettleAccountZipCode": "84043"
},
"AdditionalSignupReportInformation": {
"AffiliateID": "982542",
"AffiliateName": "55a1fd5c-f674-4797-a086-2b9a00",
"ACHToManualHold": "Y",
"ACHToAPIHold": "N",
"CKOutRejectHold": "N",
"CCSoftLimitsHold": "Y",
"ACHSoftLimitHold": "N",
"ACHFromManualHold": "Y",
"ACHFromAPIHold": "N",
"CKInRejectHold": "N",
"ACHToBankValidationHold": "Y",
"ACHFromBankValidationHold": "N",
"NonExpiring": "N",
"SweepCanACHOut": "N",
"SweepCanACHIn": "N",
"SweepBankAccountValidated": "N",
"SweepInTransactionLimit": "25000",
"SweepInMonthlyLimit": "100000",
"SweepInMonthlyVolume": "50000",

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 63
 "CCAllowed": "N",
"CCFundingHoldDays": "2",
"CCRefundLineOfCredit": "0",
"ACHPaymentsAllowed": "N",
"ACHPaymentsFundingHoldHours": "24",
"ACHPaymentsRatePerTran": "0",
"ACHPaymentsRateDiscount": "0",
"ACHPaymentsReturnFee": "1000",
"AchPaymentsNOCFee": "0",
"GrossSettleAccountPresent": "N",
"MerchantDescriptor": "DBA",
"VoidCaptured": "N",
"MCC": "5999"
}
}

©2023 – ProPay® Inc. All rights reserved. Reproduction, adaptation, or translation of this document without ProPay® Inc.’s prior written permission is prohibited except as allowed under copyright laws. Page 64