Pix
How to use Pix to submit a payin in Brazil.
Payin by Pix
POST https://gateway-test.pagsmile.com/trade/pay
This endpoint allows you to submit a payin by Pix in Brazil.
Headers
Content-Type*
string
application/json; chartset=UTF-8
Authorization*
string
Basic Base($app_id:$security_key)
Request Body
app_id*
string
created app's id at dashboard
- Max. 32 chars -
customer.phone
string
User's phone
customer.email*
string
User's email
customer.identify.number*
string
User's identification number
- 11 digits if CPF or 14 digits if CNPJ -
method*
string
Fixed value: PIX
out_trade_no*
string
ID given by the merchant in their system - Max. 64 chars -
notify_url*
string
Where Pagsmile will send notification to
customer.identify.type*
string
User's identification type
- CPF or CNPJ -
customer.name*
string
User's name
timestamp*
string
yyyy-MM-dd HH:mm:ss - Max. 19 chars -
subject*
string
payment reason or item title
- Max. 128 chars -
order_amount*
string
payment amount - 0.1~50,000 BRL -
order_currency*
string
Fixed value: BRL
content
string
payment reason detail or item detail.
- Max. 255 chars -
buyer_id*
string
merchant user's id
address.zip_code
string
zip code
website_url
string
merchant website URL
- Max. 128 chars -
address.street
string
street
address.street_number
string
street number
address.city
string
city
address.state
string
state
return_url
string
Redirect to Merchant's url when user finished checkout
cancellation_express
string
m(minutes), h(hours), d(days). The value must be an integer. Ex: 90m Used to control the expiration of QR code
Example
Please use your own app_id and generate your own authorization token when testing.
Third-party CPF/CNPJ Validator
Last updated
Was this helpful?
