Payment API

Commissions

Payment Facilitator

Account Ping

DOWNLOAD

This service is used to obtain information about an existing ProPay account. It can be useful in a number of situations:

Ping can either be used as part of the preparation for a batch of commissions, or as a process initiated by users as they log in to a portal on your website. Consider how you wish to make use of this important functionality to ensure your commission runs work smoothly.

Example Requests and Responses

How to call this method:

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

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

How to call this method:

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

HTTP URL(s)
HTTP Verb GET
HTTP Header Authorization
Example Request
Example Response
Versions: | |
Method Implementation
Versions: |
Method Implementation
Versions: | |
Method Implementation
Dependencies
Versions: | |
Method Implementation Header
Method Implementation
Request Submission
Versions: | |
Method Implementation
Request Submission
Versions: |
Method Implementation
Request Submission
Versions:
Method Implementation
Request Submission
Version:
Method Implementation
Request Submission
Request Values
XML Tag Max Length Required Format Example Notes
certStr 30 Required String Supplied by ProPay
accountNum Required Integer One of the optional account identification values.
Response Values
XML Tag Typs Notes
status string Result of the transaction request.

See Appendix A for result code definitions
accntStatus string The ProPay account Status.

*See Appendix A.6 for a description of each account status type.
accountNum string Assigned to each account by ProPay
addr string Merchant/Individual physical Address.
affiliation string The Affiliation the account belongs to
apiReady string Indicates if the ProPay account may process against the Application Programing Interface. Y indicates yes, N indicates no.
city string Account physical Address.
currencyCode string The ProPay account processing currency.
expiration string The ProPay account expiration date
signupDate string The ProPay account creation dated
sourceEmail string Merchant/Individual email address. Must be unique in ProPay system.
state string Merchant/Individual physical Address.
tier string Type of ProPay account provided to user.
visaCheckoutMerchantId string The boarded Visa Checkout Merchant Id

Only returns if applicable.
zip string Merchant/Individual physical Address.
CreditCardTransactionLimit string Maximum amount for a credit card transaction.
CreditCardMonthLimit string Maximum amount for credit card transactions during a month.
ACHPaymentPerTranLimit string ACH payment limit per transaction for the associated account.
ACHPaymentMonthLimit string ACH payment transaction monthly limit for the associated account.
CreditCardMonthlyVolume string Monthly volume for credit cards payments.
ACHPaymentMonthlyVolume string Monthly volume for ACH payments for the account.
ReserveBalance string Reserve balance for the account.

What's Your Next Step?