Skip to main content

Sale APM

Request address​

POST​

https://sandbox.j-pay.net/pay_index

Test account​

Merchant ID：10172

ApiKey: prx5d81g2ytb1mmokl9mohjsmsb09do3

Request parameters​

Parameter NameTypeRequiredSign(Y OR N)Parameter Description
pay_memberidStringYYThe platform assigns merchant ID
pay_orderidStringYYMerchant order number
pay_applydateStringYYOrder submission time, format：2016-12- 26 18:18:18
pay_bankcodeStringYYBank code, see table below
pay_notifyurlStringYYAsynchronous notification address. (POST return data)
pay_callbackurlStringYYSynchronization notification address (POST return data)
pay_amountStringYYAmount of the transaction
pay_md5signStringYNPlease see MD5 signature field method
pay_currencyStringYNCurrency code, uppercase letters (USD)
pay_urlStringYNWebsite URL(Subject to review), needs to include http(s)://
pay_typeStringYNFixed value:apm
pay_methodStringNNList of payment methods, If it is empty, the payment list page is returned. Such as: alipay
+pay_productnameStringNNProduct 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"}]
「skuStringNNProduct number (unique)
「productNameStringYNProduct name
「productImageStringNNProduct image URL
「attributesStringNNProduct attributes
「priceStringYNProduct attributes
「quantityStringYNProduct quantity
pay_firstnameStringYNBill name
pay_lastnameStringYNBilling last name
pay_street_address1StringNNBilling address 1
pay_street_address2StringNNBilling address 2
pay_cityStringNNBilling city
pay_postcodeStringNNBilling zip code
pay_stateStringNNBilling State/Province
pay_country_iso_code_2StringYNBilling country
pay_email_addressStringYNBilling email
pay_telephoneStringYNBilling telephone
shipping_firstnameStringNNShipping name
shipping_lastnameStringNNShipping last name
shipping_street_address1StringNNShipping address 1
shipping_street_address2StringNNShipping address 2
shipping_cityStringNNShipping city
shipping_stateStringNNShipping State/Province
shipping_postcodeStringNNShipping zip code
shipping_country_iso_code_2StringNNShipping country
shipping_telephoneStringNNShipping telephone
pay_ipStringYNUser IP address
pay_useragentStringYNUser browser information
pay_languageStringYNLanguage
systemStringYNWebsite system name（Shopyy,Shopline ）

Return parameters​

Parameter NameTypeParameter Description
statusIntstatus = 0：SUCCESS
status = 1：3d payment
status = 2：failed
msgStringOrder placed successfully or order failed
urlString3D 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 NameTypeRequired(Y or N)Parameter Description
paymentStatusStringYSucceeded: success
Fail:fail
Processing:processing
orderIDStringYMerchant order number

Notification example：​

Synchronous notification

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

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

Parameter NameTypeRequired(Y or N)Parameter Description
memberidStringYMerchant ID
orderidStringYMerchant order number
amountStringYSubmitted order amount
true_amountStringYThe amount actually paid by the buyer
transaction_idStringYTransaction order number
returncodeStringY"00": success
"2"：fail
datetimeStringYFormat：20220419000114
signStringNPlease see the verification signature field format
attachString
Array{
    ["memberid"]=>
    string(5) "10012"
    ["orderid"]=>
    string(7) "7758292"
    ["transaction_id"]=>
    string(20) "20230117104641499957"
    ["amount"]=>
    string(5) "85.95"
    ["true_amount"]=>
    string(5) "85.95"
    ["datetime"]=>
    string(14) "20230117111809"
    ["returncode"]=>
    string(2) "00"
    ["sign"]=>
    string(32) "48CF5D99A2ADE25DCEF73BC1B1136B9E"
    ["attach"]=>
    string(0) ""
}

Demo​

import { md5 } from "js-md5";
import axios from "axios";

const KEY = "prx5d81g2ytb1mmokl9mohjsmsb09do3";
const MEMBER_ID = "10172";
let query = {
  pay_memberid: MEMBER_ID,
  pay_orderid: "O" + Date.now().valueOf(),
  pay_applydate: "2024-12-02 16:48:42",
  pay_bankcode: "901",
  pay_notifyurl: "https://www.google.com",
  pay_callbackurl: "https://www.google.com",
  pay_amount: "10.00",
};
let signData = [];
Object.keys(query)
  .sort()
  .forEach((key) => signData.push(`${key}=${query[key]}`));

signData.push(`key=${KEY}`);
Object.assign(query, {
  pay_md5sign: md5(signData.join("&")).toUpperCase(),
  pay_url: "https://www.google.com",
  pay_currency: "USD",
  pay_firstname: "Rodrigo",
  pay_lastname: "lopez",
  pay_country_iso_code_2: "CL",
  pay_email_address: "[email protected]",
  pay_telephone: "920508435",
  pay_ip: "186.156.221.158",
  pay_useragent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36 Edg/111.0.1661.43",
  pay_language: "en",
  system: "shopyy",
});

axios
  .request({
    url: "https://sandbox.j-pay.net/pay_index",
    method: "post",
    headers: {
      "Content-Type": "application/x-www-form-urlencoded",
    },
    data: query,
  })
  .then(({ data }) => {
    console.log("success", data);
  })
  .catch((error) => {
    console.log("error", error);
  });