Create Virtual PIX Account

How to create virtual PIX account to submit a payin in Brazil.

Payin by Virtual Pix

POST https://gateway-test.pagsmile.com/virtual-account/create

This endpoint allows you to create virtual PIX account number in Brazil.

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 -
notify_url*	string	Where Pagsmile will send notification to
customer.buyer_id*	string	User's buyer id
customer.name	string	User's name
customer.email	string	User's email
customer.identify.type	string	User's identification type - CPF or CNPJ -
customer.identify.number	string	User's identification number - 11 digits if CPF or 14 digits if CNPJ -

200 submit successfully

{
    "code": "10000",
    "msg": "Success",
    "account_id": "QG9MAQFPLTT0BTY0",
    "buyer_id": "buyer_0101_0001",
    "status": "ACTIVE",
    "notify_url": "http://merchant/callback/success",
    "qr_code": "00020126580014br.gov.bcb.pix013627a44d0a-0736-4bbf-a4a4-6e11063973315204000053039865406100.005802BR5908PAGSMILE6008So Paulo62230519mpqrinter123742074363049E0B"
}

400 duplicate out_trade_no

{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

User payment tips

• Users only need to scan the QR code to finish the payment. QR code can be generated with qr_code value.

• Add a Copy QRCODE button. For mobile users, they can copy the string of qr_code and paste it into their wallet app to finish the payment. Adding a copy button could help to improve the user's payment experience.

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/virtual-account/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "timestamp": "2022-01-01 03:54:01",
    * "notify_url": "http://merchant/callback/success",
    * "customer" : {
    *     "buyer_id": "buyer_0101_0001",
          "name": "Test User Name",
          "email": "[e-mail]",
          "identify": {
              "type": "CPF",
              "number": "11032341882"
          }
      }
      }'

Example of payment page

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.