Pix

How to use Pix to submit a payin in Brazil.

Post

https://gateway-test.transfersmile.com/trade/pay

Payin by Pix

This endpoint allows you to submit a payin by Pix in Brazil.

Parameters


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

Body


app_id*	string	created app's id at dashboard - Max. 32 chars -
timestamp*	string	yyyy-MM-dd HH:mm:ss - Max. 19 chars -
out_trade_no*	string	ID given by the merchant in their system - Max. 64 chars -
method*	string	Fixed value: Pix
order_currency*	string	Fixed value: BRL
order_amount*	string	payment amount - 0.1~50,000 BRL -
subject*	string	payment reason or item title - Max. 128 chars -
content	string	payment reason detail or item detail. - Max. 255 chars -
notify_url*	string	Where transfersmile will send notification to
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
buyer_id*	string	merchant user's id
customer.name*	string	User's name
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 -
customer.identify.type*	string	User's identification type; - CPF or CNPJ -
address.zip_code	string	zip code
address.state	string	state
address.city	string	city
address.street_number	string	street number
address.street	string	street
website_url	string	merchant website URL - Max. 128 chars -

Responses


200	submit successfully

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "pay_url": "https://checkout.transfersmile.com/checkout?prepay_id=TTd5Y1JJbDhKbi9Rd1NPNkZTUVIyNGNsOEFyRWZ4SWw1czd2UE00bmszOD0=-79697e50",
    "trade_status": "PROCESSING",
    "qr_code": "00020126580014br.gov.bcb.pix013627a44d0a-0736-4bbf-a4a4-6e11063973315204000053039865406100.005802BR5908transfersmile6008So Paulo62230519mpqrinter123742074363049E0B",
    "qr_code_url": "https://gateway.transfersmile.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"
}


400	duplicate out_trade_no

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

Tip

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.
qr_code_url and qr_code_img are system generated images of qr code which can be used directly on merchant website depending on needs.

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

Warning

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

Pix