SecurePay API

This endpoint is used to generate payment links/QR codes directing customers to Pockyt's hosted page to receive payments.

Body Params
string
Defaults to 302156

The user's ID in Pockyt System; include this parameter if you wish to map a customer with the payment and request a secure checkout

string
required
Defaults to 200043

Merchant ID in Pockyt's system. A unique value generated by Pockyt during the onboarding process.

string
required
Defaults to 300014

Store Number in Pockyt's system. A unique value created and assigned by Pockyt's systems when a new store is created under a merchant

string
required
Defaults to 13

The transaction amount

string
required
Defaults to PHP

The supported transaction currencies are "USD", "CNY", "PHP", "IDR", "KRW", "HKD", "THB", "MYR", "GBP", "BDT", "PKR"

string
required
Defaults to USD

When the currency is "GBP", the settlement currency is "GBP". All other currencies settle with "USD"

string
required
Defaults to alipay
string
Defaults to http://zk-tys.yunkeguan.com/ttest/test

The asynchronous notification address. The IPN URL must be secure. For more information, visit the IPN section

string
required
Defaults to http://zk-tys.yunkeguan.com/ttest/test2?status={status}

The synchronous callback HTTP address to receive notification messages for events. The callback URL follows macro substitution rules like xxxcallback_url?trans_no={transactionNo}&amount={amount}. Then Pockyt automatically replaces the values of {} for a list of parameters

string
required
Defaults to test202001011303

The Invoice Number of the transaction in the merchant's system

string
required
Defaults to ONLINE

The possible values are: "ONLINE" for desktop/web app and "WAP" for mobile, YIP for Braintree

string
Defaults to test+description

The description of the transaction will be displayed on the payment

string
Defaults to test note

Additional internal notes on the particular transaction

string
required
Defaults to IOS

When terminal is WAP or APP, the possible values are "IOS" and "ANDROID"

string
Defaults to 120

The timeout in minutes. The default value is 120

string
Defaults to [ { "goods_name": "name1", "quantity": "quantity1" } ]

JSON encoded string of an array of items that the customer purchases from the merchant; Special characters are not supported. e.g.: [{"goods_name":"name1", "quantity":"quantity1"}, {"goods_name":"name2", "quantity":"quantity2"}]

string

The payment type. This is only required when vendor = creditcard. The values are "normal" or "CIT". The default is "normal"

string
required
Defaults to 72a2c6ce8497adc8a03a78135618e666

The parameter signature. It is the calculated MD5 hash value of the API token used to encrypt the request message and authorize transaction requests. For more information, visit Signing API Parameters

string
Defaults to ca_af748cc62c334c75b83844e53b76e9b3

The unique payment ID for payment methods stored in the PPMP vault. This is only necessary for recurring payments workflows with PPMP.

Response

Language
Response
Choose an example:
application/json