Payment API

Commissions

Payment Facilitator

Merchant Profile ID Creation

DOWNLOAD

Use this service to create the link ProtectPay® and an existing merchant account. This service sets up a reference to credential systems used by all supported gateways, and the data elements you must provide differ by processing platform. Only ProPay's credential system will be described in detail. To obtain information about creating a Merchant Profile ID that points to another gateway, click here to see the ProtectPay Appendix.

How to call this method:

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

HTTP URL(s) https://xmltest.propay.com/api/protectpay/MerchantProfiles/
HTTP Verb PUT
HTTP Header Authorization
Example Request
Example Response

How to call this method:

SOAP Action CreateMerchantProfile
WSDL URL https://protectpaytest.propay.com/API/SPS.svc?wsdl
WSDL Operation SPSService.CreateMerchantProfile (Identification, MerchantProfile)
Example Request
Example Response
Method Implementation
Request Submission
Method Implementation
Request Submission
Method Implementation
Request Submission
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
AuthenticationToken String 100 Authorization Valid value is a GUID. Value supplied by ProPay. Used to access the API.
BillerAccountId String 16 Authorization Value supplied by ProPay. Used to identify the correct collection of tokens.
PaymentProcessor String - Required Used to tell the ProtectPay system which type of link to a gateway should be created.

See Protectpay API Appendix for valid supported processors.
ProcessorData[] Object - -
ProcessorData[].ProcessorField String - Required Used in conjunction with value to describe the various fields necessary to create a link to a payment processor.

See <Protectpay API Appendix for valid supported processors.
ProcessorData[].Value String 20 Required Used in conjunction with value to describe the various fields necessary to create a link to a payment processor.
ProfileName String 50 Required A name for the profile.

Response Values

Response Element Type Notes
RequestResult.ResultValue String The ProtectPay API 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 See Protectpay API Appendix for possible returned Values.
RequestResult.ResultMessage String The ProtectPay API Method Response Message.
ProfileId String The MerchantProfileId that was created using the supplied credentials for the supplied Gateway that is used to process against this particular gateway.
Data from ProPay, Inc PCI documentation.