Pay with Vault

How to use Vault to submit a payin.

Create Vault

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

This endpoint allows you to create a vault.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
Authorization*	string	Basic Base($app_id:$security_key)

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	Card or pix
card_token.method	string	Required when type=Card - Fixed value: CreditCard -
card_token.uid	string	Required when type=Card
card_token.token	string	Required when type=Card - Get from here -
card_token.notify_url	string	Required when type=Card
card_token.region	string	regions of the payment. Required when type=Card and using Global App. The format is ISO 3166-1 alpha-3 - USA, BRA, etc. Check here -
pix.region	string	Required when type=pix - Fixed value: BRA -
pix.method	string	Required when type=pix - Fixed value: PIXAutomatic -
pix.uid	string	Required when type=pix - merchant user's id -
pix.plan.internal	string	Required when type=pix - One of 1W,1M,3M,6M,1Y -
pix.plan.start_date	string	Required when type=pix - yyyy-MM-dd -
pix.plan.end_date	string	Required when type=pix - yyyy-MM-dd -
pix.plan.minimum_amount	number	Required when type=pix
pix.plan.maximum_amount	number	Required when type=pix
pix.customer.identification.type	string	User's identification type. Required when type=pix - CPF or CNPJ -
pix.customer.identification.number	string	User's identification number. Required when type=pix - 11 digits if CPF or 14 digits if CNPJ -
pix.customer.name	string	User's name. Required when type=pix

200 submit successfully

{
    "code": "10000",
    "msg": "Success",
    "token": "*****",
    "type": "Card",
    "card_token": {
        "region": "",
        "method": "",
        "uid": "",
        "token": "psct_*",
        "notify_url": ""
    },
    "timestamp": "yyyy-MM-dd HH:mm:ss",
    "checkout_url": "https://demo.checkout.url"
}

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/vault/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "162************38",,
    "timestamp": "2022-01-01 03:54:01",
    "version": "2.0",
    "type": "", //One of Card or pix
    //When type=Card
    "card_token": {
        "region": "BRA",
        "method": "CreditCard",
        "uid": "123",
        "token": "",
        "notify_url": "https://demo.return.url"
    }
    //When type=pix
    "pix": {
        "region": "BRA",
        "method": "PIXAutomatic",
        "uid": "{{$guid}}",
        "plan": {
            "internal": "1M",
            "start_date": "2026-03-15",
            "end_date": "2036-03-31",
            "minimum_amount": 1,
            "maximum_amount": 1
        },
        "customer": {
            "identification": {
                "number": "502****4727",
                "type": "CPF"
            },
            "name": "Test User Name"
        }
    }
}'

---

Pay Vault

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

This endpoint allows you to submit a payin by Vault.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
Authorization*	string	Basic Base($app_id:$security_key)

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	CreditCard or PIXAutomatic
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.1~9,999,999 -
order_currency*	string	order currency - check here -
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
scheduled_date	string	Required when method=PIXAutomatic - yyyy-MM-dd -
region	string	region of the payment. The format is ISO 3166-1 alpha-3 - USA, BRA etc. Check here. Required if using Global app -

200 submit successfully

{
    "code": "10000",
    "msg": "Success",
    "prepay_id":"Q3pDNzRT****************VT0=-De8BDeB3",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354006",
    "trade_status": "PROCESSING"
}

400 duplicate out_trade_no

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "162************38",
    "out_trade_no": "202201010354006",
    "method": "CreditCard",
    "order_amount": "300",
    "order_currency": "BRL",
    "subject": "trade pay test",
    "content": "trade pay test conent",
    "notify_url": "http://merchant/callback/success",
    "return_url": "https://www.merchant.com",
    "buyer_id": "buyer_0101_0001",
    "timestamp": "2022-01-01 03:54:01",
    "vault_token": "wa_***",
    "region": "BRA"
    }'

---

Void Vault

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

This endpoint allows you to void a vault.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
Authorization*	string	Basic Base($app_id:$security_key)

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: Card
vault_token*	string

200 submit successfully

{
    "code": "10000",
    "msg": "Success",
    "token": "wa_***",
    "type": ""Card",
    "timestamp": "yyyy-MM-dd HH:mm:ss"
}

---

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

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