search

Vault

How to use Vault to submit a payin in China.

hashtag
Create Vault

POST https://gateway-test.pagsmile.com/vault/create

This endpoint allows you to create a vault.

hashtag
Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

hashtag
Request Body

Name
Type
Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

version*

string

Fixed value: 2.0

type*

string

Fixed value: wallet_account

wallet_account.region*

string

CHN for China

wallet_account.method*

string

Fixed value: Wallet

wallet_account.channel*

string

Fixed value: AlipayCN

wallet_account.uid*

string

Unique ID in merchant system

wallet_account.device_type*

string

WEB or WAP

wallet_account.return_url*

string

{
    "code": "10000",
    "msg": "Success",
    "auth_url": "https://demo.auth.url/",
    "token": "wa_***",
    "type": "wallet_account",
    "timestamp": "yyyy-MM-dd HH:mm:ss",
    "checkout_url": "https://demo.checkout.url"
}

hashtag
Example

hashtag
Pay Vault

POST https://gateway-test.pagsmile.com/trade/pay

This endpoint allows you to submit a payin by Vault in China.

hashtag
Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

hashtag
Request Body

Name
Type
Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

method*

string

Fixed value: Wallet

channel*

string

Wallet type - AlipayCN -

notify_url*

string

Where Pagsmile will send notification to

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

subject*

string

payment reason or item title

- Max. 128 chars -

content

string

payment reason detail or item detail

- Max. 255 chars -

order_amount*

string

payment amount - 0.04~300,000 -

order_currency*

string

Fixed value: CNY

buyer_id*

string

merchant user's id

vault_token*

string

Token get from Create Vault

return_url

string

Redirect to Merchant's url when user finished checkout

hashtag
Example

hashtag
Refresh Vault

POST https://gateway-test.pagsmile.com/vault/refresh

This endpoint allows you to refresh a vault.

hashtag
Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

hashtag
Request Body

Name
Type
Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

version*

string

Fixed value: 2.0

type*

string

Fixed value: wallet_account

vault_token*

string

hashtag
Void Vault

POST https://gateway-test.pagsmile.com/vault/void

This endpoint allows you to void a vault.

hashtag
Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

hashtag
Request Body

Name
Type
Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

version*

string

Fixed value: 2.0

type*

string

Fixed value: wallet_account

vault_token*

string

circle-info

Note: 162************38 is pagsmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

triangle-exclamation

Please use your own app_id and generate your own authorization token when testing.

PreviousWalletNextHongkong

Last updated