Pix
Como usar o Pix para criar um Payin no Brasil.
Payin por Pix
POST
https://gateway-test.pagsmile.com/trade/pay
Este endpoint permite submeter um pagamento por Pix no Brasil.
Headers
Content-Type*
string
application/json; chartset=UTF-8
Authorization*
string
Basic Base($app_id:$security_key)
Request Body
app_id*
string
App Id criado no dashboard
- Max. 32 chars -
customer.phone*
string
Telefone do usuário
customer.email*
string
E-mail do usuário
customer.identify.number*
string
Número de identificação do usuário
- 11 dígitos se CPF ou 14 dígitos se CNPJ -
method*
string
Valor fixo: PIX
out_trade_no*
string
ID fornecido pelo merchant em seu sistema - Max. 64 chars -
notify_url*
string
Para onde a Pagsmile enviará a notificação
customer.identify.type*
string
Tipo de identificação do usuário
- CPF ou CNPJ -
customer.name*
string
Nome do usuário
timestamp*
string
yyyy-MM-dd HH:mm:ss - Max. 19 chars -
subject*
string
motivo do pagamento ou título do item
- Max. 128 chars -
order_amount*
string
montante do pagamento - 0.1~50,000 BRL -
order_currency*
string
Valor fixo: BRL
content*
string
detalhes do motivo do pagamento ou detalhes do item. Isso será mostrado na fatura do banco.
- Max. 255 chars -
buyer_id*
string
ID do usuário do merchant
address.zip_code
string
código postal
website_url
string
URL do site do comerciante
- Max. 128 chars -
address.street
string
rua
address.street_number
string
número da rua
address.city
string
cidade
address.state
string
estado
return_url
string
Redireccionar para a url do Merchant quando o usuário terminar o checkout
cancellation_express
string
m(minutos), h(horas), d(dias). O valor deve ser um número inteiro. Ex: 90m Utilizado para controlar a expiração de QR code
{
"code": "10000",
"msg": "Success",
"trade_no": "2022010110293900083",
"out_trade_no": "202201010354003",
"web_url": "",
"pay_url": "https://checkout.pagsmile.com/checkout?prepay_id=TTd5Y1JJbDhKbi9Rd1NPNkZTUVIyNGNsOEFyRWZ4SWw1czd2UE00bmszOD0=-79697e50",
"trade_status": "PROCESSING",
"qr_code": "00020126580014br.gov.bcb.pix013627a44d0a-0736-4bbf-a4a4-6e11063973315204000053039865406100.005802BR5908PAGSMILE6008So Paulo62230519mpqrinter123742074363049E0B",
"qr_code_url": "https://gateway.pagsmile.com/api/trade/qrcode-img?prepay_id=Y1N5dHVPOFJ4Ky9lZVVKVXBrdFFieWttVlhwSGZWMnJYRXBkWW9OaE8wRT0=-9036acF1",
"qr_code_img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAACwUlEQVR42u2XPc7jIBCGx6Kgsy+AxDXouFJyAf9cIL4SHdewxAXsjgJ59p2sFPsrtlhodqVEkQs/UcDz8zAm/tOHvuRL/hkSqOM0O375tLttiES6gUQ+ouky76RWpoe2uNNA6IkbntdQiNKpTddIglpyOr3ibHrfTDKf3s5kd+KVGwliUKasFjYT4wl+RudvCfITzfP6/sjcXxN88jY6i3UelN6LNJBAD8JOcVXMZaT08g0kq5cncrzm8gyld6qJBLtkM2q7e1SiGeKVnxqSFbY8ZPtyW68RA+p1Awlbxxa1c8T0Dqrdm4g6tV0RV512jXDa2TcQ5pm2Ea0mG8c6/KnEGpKRYYW9P6hIwjOvLQQyIJoQ1IAtl1Gro4VEmoLdYT69PXxa81U7NQT7deLRI0gM0HNDbCAiA6wAKxsxn6OBWwjvkpx0hHRw6aK9YlBBsl3f5ns5XvImBe4bSICcTMdqFh+YZ7hFp4JAn0Ht6BLxMfqvNBE4Xm7ApsgzbiNFDSRvKEO4Cu37ZBR1uUxRQcJG2r7PH6xjukBjE+FTo5ztEjco4dQ40BpI5vcxa6Vxc3m4W+1UEDY9mQE5l14po1OXqyoIKpqxcRyzcsV88cl2DWFp3En6WHpuDTcnVpDIs5eEwwq7Q6rhrQbC+G8FuzA6OIpE1yaidpcWZIkhPzl/Zt1AcnoRH4wr+gM/KR9X1RBG725w1RLTu3Zu9q8gQbp29HYJCG3p/W12qSDy9DRxQmhhwdnfqqqG4Nw2MosFaC8tIX1msRqCo0wGOiJSJ85Got43EIHmt6vkFNJlbCGYYQOOa2gASoBTb1NaBcF8DX3CVQwxpx+OryF4k8BOZfY/3TYFerYShVkMj35keQP7OL6WWARywDjAmGSvab2KYDZRiCXiitqZ8eYUG4jkR2pniHCVIXSJbiDfN/4v+T/JL/qJUR2nh9cdAAAAAElFTkSuQmCC"
}
Exemplo
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": "202201010354002",
"method": "PIX",
"order_amount": "12.01",
"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",
"timeout_express":"1c",
"customer" : {
"identify": {
"type": "CPF",
"number": "50284414727"
},
"name": "Test User Name",
"email": "test@pagsmile.com",
"phone": "75991435892"
},
"address" : {
"zip_code": "38082365"
}
}'

Use seu próprio app_id e gere seu próprio token de autorização ao testar.
Last updated