Secure Data Integration Overview
Here is the primary method to incorporate PlatformPay.io within your checkout page.
This will allow you to send data to PlatformPay.io's gateway securely from your checkout page, while meeting PCI compliance requirements.
Once installed, you will be able to see your data populating on your Live Feed Report.
Step 1
The customer sends their payment information to the merchant's web site.
Step 2
The merchant web site posts the payment data to the Payment Gateway / CRM & PlatformPay.io Here
Step 3
The Payment Gateway responds immediately with the results of the transactions.
Step 4
The merchant web site displays the appropriate message to the customer.
Payment API
The Payment API [POST] is the simplest integration method for all web-based and non web-based payment applications, however, merchants using this integration method should have passed a PCI vulnerability scan before use.
Post URL
Sample Post URL
Sample Response
https://console.platformpay.io/api3/order/import_order_post.php?
cardNumber=
&cardSecurityCode=
&cardMonth=
&cardYear=
&firstName=
&lastName=
&emailAddress=
&phoneNumber=
&country=
&postalCode=
&state=
&city=
&address1=
&product1_id=
&product1_price=
&product1_qty=
&paySource=
&custom1=
&ipAddress=
&response=
&success=
&user_id={{ user_info.User_ID }}
&secret_key={{ user_info.Secret_Key }}
https://console.platformpay.io/api3/order/import_order_post.php?
cardNumber=0000000000000000
&cardSecurityCode=100
&cardMonth=10
&cardYear=25
&firstName=James
&lastName=Smith
&emailAddress=testemail@test.com
&phoneNumber=5555555555
&country=US
&postalCode=37362
&state=AL
&city=City
&address1=Test Address
&product1_id=60
&product1_price=142.99
&product1_qty=1
&paySource=CREDITCARD
&custom1=11111111-1111-1111-1111-111111111111
&ipAddress=46.183.109.239
&response=SUCCESS
&success=1
&user_id={{ user_info.User_ID }}
&secret_key={{ user_info.Secret_Key }}
{
"success": 1,
"message": "SUCCESS",
}
| Field | Description |
|---|---|
|
cardNumber
|
Card Number entered by customer, is submitted via server-to-server post and tokenized
|
|
cardSecurityCode
|
CVV Code Submitted on initial sale
|
|
cardMonth
|
Month of Expiry date, MM format is expected, e.g. 05
|
|
cardYear
|
Year of Expiry date, YY format is expect, e.g. 28, however YYYY format is also accepted
|
|
firstName
|
First Name of the cardholder
|
|
lastName
|
Last Name of the cardholder
|
|
emailAddress
|
Email Address of the cardholder submitted on checkout
|
|
phoneNumber
|
Phone Number of the cardholder submitted on checkout
|
|
country
|
Billing Address Country
|
|
postalCode
|
Billing Address Postalcode / Zip Code
|
|
state
|
Billing Address State
|
|
city
|
Billing Address City
|
|
address1
|
Billing Address Address line 1
|
|
product1_id
|
Your product ID for initial sale - this helps PlatformPay.io optimize billing based on risk profiles of varying product IDs
|
|
product1_price
|
Your Initial Sale Price - this helps PlatformPay.io optimize based on price point profiles
|
|
product1_qty
|
Your Initial Sale Quantity - this helps PlatformPay.io optimize based on order size
|
|
paySource
|
Customers Payment Source, default is CREDITCARD
|
|
ipAddress
|
Customers IP Address - this helps PlatformPay.io optimize by geolocation
|
|
success
|
1 or 0, whether the transaction in question was successful or not
|
|
response
|
Response of the transaction, approval, decline response, etc.
|
|
user_id
|
Your user identification for PlatformPay.io - this must match your account ID in order to have you credited for the sales
|
|
secret_key
|
Secret key required for server-to-server post communication
|