Payment API

Commissions

Payment Facilitator

Create A Payer ID

Merchants must create a PayerId for each of their customers. Organizing each PaymentMethodId (tokenized card number) by payer allows a merchant to make a subset of cards available to his or her customer upon login. (Consider the example that occurs when you log in to the website of a pizza parlor and it remembers more than one of your credit cards. The Pizza joint queries your "Payer" to get back a list of cards.) Not all merchants use ProtectPay® to organize their tokens, and in fact most use their own system to map tokens to users. ProtectPay, however, requires this field to proceed.

Payer ID Naming Convention Differs by ProtectPay® Method

Various ProtectPay® methods refer to the Payer ID as either PayerId or PayerAccountId. This method, to get a Payer ID, returns it as ExternalAccountId.

Example Requests and Responses

How to call this method:

SOAP Action CreatePayerWithData
WSDL URL https://xmltestapi.propay.com/protectpay/sps.svc?wsdl
WSDL Operation SPSService.CreatePayerWithData(ID, PayerData)
Example Request
Example Response

How to call this method:

HTTP URL(s)
HTTP Verb PUT
HTTP Header Authorization
Example Request
Example Response
Method Implementation
Method Implementation
Method Implementation
Dependencies
Method Implementation Header
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
Request Values
Request Element Type Max Required Notes
AuthorizationToken String 100 Authorization Valid value is a GUID. Values supplied by ProPay. Used to access the PCI.
BillerAccountID String 16 Authorization Value supplied by ProPay. Used to identify the correct collection of tokens.
EmailAddress String 100 Optional Used to identify a payer.
ExternalId1 String 50 Optional Used to identify a payer. This is a custom identifier rather than ProtectPay's. If more than 50 characters are supplied the value will be truncated to 50.
ExternalId2 String 50 Optional Used to identify a payer. This is a custom identifier rather than ProtectPay's. If more than 50 characters are supplied the value will be truncated to 50.
Name String 50 Required Used to identify a payer.
Response Values
Response Attribute Type Notes
RequestResult.RequestValue String The Method Response Value;
SUCCESS indicates the method completed;
FAILURE indicates the method call failed and the reason is indicated in the ResultCode and ResultMessage
RequestResult.ResultCode String The Method Result Code. See Protectpay Appendix for possible returned messages.
RequestResult.ResultMessage String The Method Result Message. See Protectpay Appendix for possible returned messages.
ExternalAccountID String This is the ProtectPay® ID for the Payer Created and belongs to the BillerID that created it
* This is referenced in other methods as 'PayerAccountID' or 'PayerId'
Data from ProPay, Inc PCI documentation.