Developers

Public parameters

Request URL

• https://baseUrl/v3/2020/pay/{mchid}/{appid}

Request Path parameter

• example
• https://baseUrl/v3/2020/pay/MCH88888/APP100

Method

• POST

Header

• Content-type: application/x-www-form-urlencoded; charset=UTF-8

Signature string

payment signature

SHA1(action_type+out_trade_no+amt+currency+ip+nonce_str+key)

retrieve signature

SHA1(action_type+out_trade_no+nonce_str+key)

refund signature

SHA1(action_type+txid+refund_amt+refund_reason+nonce_str+key)

Request Parameters

Payment parameters

Example

<?php
$request = new HttpRequest();
$request->setUrl('https://baseUrl/v3/2020/pay/MCH88888/APP100');
$request->setMethod(HTTP_METH_POST);
$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields([
  'out_trade_no' => '4086d438-f2b1-eb59-7943',
  'amt' => '1111.00',
  'currency' => 'USD',
  'ip' => '1.1.1.1',
  'nonce_str' => '58k5EZTmB5ZnSTPn',
  'sign' => '40b00f6898f66ee74d1d12a8228019f00508665a',
  'card.num' => '4242424242424242',
  'card.year' => '2023',
  'card.month' => '12',
  'card.cvv' => '123',
  'customer.first_name' => 'Alex',
  'customer.last_name' => 'Bob',
  'customer.country' => 'US',
  'customer.state' => 'NY',
  'customer.city' => 'New York',
  'customer.address' => 'Address 123',
  'customer.postcode' => '313222',
  'customer.email' => 'alexx@gmail.com',
  'customer.mobile' => '45671345',
  'shipping.first_name' => 'Alex',
  'shipping.last_name' => 'Bob',
  'shipping.country' => 'US',
  'shipping.state' => 'NY',
  'shipping.city' => 'New York',
  'shipping.address' => 'Address 123',
  'shipping.postcode' => '313222',
  'shipping.email' => 'alexx@gmail.com',
  'shipping.mobile' => '45671345',
  'goods[0].name' => 'cap',
  'goods[0].quantity' => '1',
  'goods[0].price' => '100.00',
  'action_type' => 'PAY',
  'callback_url' => 'https://www.shop.com/callback',
  'redirect_url' => 'https://www.shop.com/redirect'
]);
try {
  $response = $request->send();
  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Payment Response example

{
    "out_trade_no": "acb5c930-5a77-74a6-48d0",
    "txid": "S1578594295660978176",
    "amt": "100.00",
    "ccy": "USD",
    "code": "0000",
    "msg": "Payment Success",
    "bill": "yourwebsite.com",
    "form_url": "https://www.3ds.com/to"
}

Payment Response parameter

3D Secure notification parameters/Redirect for transaction parameters

Returning an HTTP status of 200 indicates successful receipt of the notification

Retrieve parameters

Example

<?php
$request = new HttpRequest();
$request->setUrl('https://baseUrl/v3/2020/pay/MCH88888/APP100');
$request->setMethod(HTTP_METH_POST);
$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields([
  'out_trade_no' => '4086d438-f2b1-eb59-7943',
  'nonce_str' => '58k5EZTmB5ZnSTPn',
  'sign' => '40b00f6898f66ee74d1d12a8228019f00508665a',
  'action_type' => 'RETRIEVE'
]);
try {
  $response = $request->send();
  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Retrieve Response example

{
    "out_trade_no": "2f9876bb-ee66-2de3-4ef4",
    "txid": "S1578617547481456640",
    "amt": "100.00",
    "ccy": "USD",
    "code": "0000",
    "msg": "Payment Success"
}

Retrieve Response parameter

Refund parameters

Example

<?php
$request = new HttpRequest();
$request->setUrl('https://baseUrl/v3/2020/pay/MCH88888/APP100');
$request->setMethod(HTTP_METH_POST);
$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields([
  'nonce_str' => '58k5EZTmB5ZnSTPn',
  'sign' => '40b00f6898f66ee74d1d12a8228019f00508665a',
  'action_type' => 'REFUND',
  'txid' => 'S1578568969333547008',
  'refund_amt' => '100.00',
  'refund_reason' => 'test'
]);
try {
  $response = $request->send();
  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Refund Response example

{
    "out_trade_no": "b2948e87-3b4b-8774-7aa3",
    "txid": "S1578568969333547008",
    "code": "2007",
    "msg": "Refund apply success"
}

Refund Response parameter

Appendix

Country Code