SDK - Sale

Test Card

Card number	Expiration date	cvv
4242424242424242	12 2027	123	success
4000000000001018	12 2027	123	failed
4141414141414141	12 2027	123	redirect

Request parameters

Parameter Name	Type	Required	Sign(Y OR N)	Parameter Description
pay_memberid	String	Y	Y	The platform assigns merchant ID
pay_orderid	String	Y	Y	Merchant order number
pay_applydate	String	Y	Y	Order submission time, format：2016-12- 26 18:18:18
pay_bankcode	String	Y	Y	Bank code, see table below
pay_notifyurl	String	Y	Y	Asynchronous notification address. (POST return data)
pay_callbackurl	String	Y	Y	Synchronization notification address (POST return data)
pay_amount	String	Y	Y	Amount of the transaction
pay_md5sign	String	Y	N	Please see MD5 signature field method
pay_currency	String	Y	N	Currency code, uppercase letters (USD)
pay_url	String	Y	N	Website URL(Subject to review), needs to include http(s)://
pay_cardno	String	N	N	Card No.
pay_cardmonth	String	N	N	Two digits of month (02)
pay_cardyear	String	N	N	Four digits of year (2023)
pay_cardcvv	String	N	N	cvv
+pay_productname	String	Y	N	Product information parameters are composed of the following set of data in JSON format. Please note that parameter names are case-sensitive. This field is filled with a JSON array. Example：[{"sku":"123456789","productName":"Mac Book Pro","productImage":"url","attributes":"Size:US8 Color:blue","price":"11000.00","quantity":" 1"},{"sku":"9876543231","productName":"IPhone 12","productImage":"url","attributes":"Size:US8 Color:blue","price":"11000.00","quantity":" 1"}]
「sku	String	Y	N	Product number (unique)
「productName	String	Y	N	Product name
「productImage	String	Y	N	Product image URL
「attributes	String	Y	N	Product attributes
「price	String	Y	N	Product price
「quantity	String	Y	N	Product quantity
pay_firstname	String	Y	N	Bill name
pay_lastname	String	Y	N	Billing last name
pay_street_address1	String	Y	N	Billing address 1
pay_street_address2	String	Y	N	Billing address 2
pay_city	String	Y	N	Billing city
pay_postcode	String	Y	N	Billing zip code
pay_state	String	Y	N	Billing State/Province
pay_country_iso_code_2	String	Y	N	Billing country
pay_email_address	String	Y	N	Billing email
pay_telephone	String	Y	N	Billing telephone
shipping_firstname	String	Y	N	Shipping name
shipping_lastname	String	Y	N	Shipping last name
shipping_street_address1	String	Y	N	Shipping address 1
shipping_street_address2	String	Y	N	Shipping address 2
shipping_city	String	Y	N	Shipping city
shipping_state	String	Y	N	Shipping State/Province
shipping_postcode	String	Y	N	Shipping zip code
shipping_country_iso_code_2	String	Y	N	Shipping country
shipping_telephone	String	Y	N	Shipping telephone
pay_ip	String	Y	N	User IP address
pay_useragent	String	Y	N	User browser information
pay_language	String	Y	N	Language
system	String	Y	N	Website system name（Shopyy,Shopline ）

Return parameters

Parameter Name	Type	Parameter Description
status	Int	status = 0：SUCCESS status = 1：3d payment status = 2：failed
msg	String	Order placed successfully or order failed
url	String	3D redirectUrl

Return example

Transaction successful : {
    "status": 0,
    "msg": "transaction success"
}
Transaction failed : {
    "status": 2,
    "msg": "transaction failed"
}
Redirect/3ds payment successful : {
    "status": 1,
    "url": "redirectUrl"
}

3DS verification

Jump payment and direct credit card payment require 3DS verification

Synchronous notification parameters：(application/x-www-form-urlencoded)

Parameter Name	Type	Required(Y or N)	Parameter Description
paymentStatus	String	Y	Succeeded: success Fail:fail Processing:processing
orderID	String	Y	Merchant order number

Example

https://www.xxxx.com/callback.html?paymentStatus=succeeded&orderID=1001

Asynchronous notification parameters：(application/x-www-form-urlencoded)

Parameter Name	Type	Required(Y or N)	Parameter Description
memberid	String	Y	Merchant ID
orderid	String	Y	Merchant order number
amount	String	Y	Submitted order amount
true_amount	String	Y	The amount actually paid by the buyer
currency	String	Y	Payment currency
transaction_id	String	Y	Transaction order number
returncode	String	Y	"00": success "2"：fail
datetime	String	Y	Format：20220419000114
sign	String	N	Please see the verification signature field format
attach	String

Demo

require_once 'vendor/autoload.php';
    use Jpay\PaymentSDK\JpayPaymentSDK;
    $sdk = new JpayPaymentSDK(
        'your_merchant_id',
        'your_secret_key',
        'entity',     // entity
        'true'                     // true or false, define true(dev environment)
    );
//.The request parameters should be passed in according to the above requirements.
// There are mandatory and optional parameters to be passed in,
// depending on the document specifications.
      $paymentData = [
        'pay_orderid' => 'your pay orderid',
        'pay_notifyurl' => 'https://your-domain.com/notify',
        'pay_callbackurl' => 'https://your-domain.com/callback',
        'pay_amount' => '100.00',
        'pay_currency' => 'USD',
        'pay_firstname' => 'John',
        'pay_lastname' => 'Doe',
        'pay_email_address' => '[email protected]',
        'pay_telephone' => '1234567890',
        'pay_country_iso_code_2' => 'US',
        'pay_productname' => 'Test Product'
    ];

    $result = $sdk->payment($paymentData);