# Pix
Como usar o Pix para criar um Payin no Brasil.
# Post
https://gateway-test.transfersmile.com/trade/pay
# Payin por Pix
Este endpoint permite submeter um pagamento por Pix no Brasil.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
Authorization* | string | Basic Base($app_id:$security_key) |
# Body
app_id* | string | App Id criado no dashboard - Max. 32 chars - |
timestamp* | string | yyyy-MM-dd HH:mm:ss - Max. 19 chars - |
out_trade_no* | string | ID fornecido pelo merchant em seu sistema - Max. 64 chars - |
method* | string | Valor fixo: Pix |
order_currency* | string | Valor fixo: BRL |
order_amount* | string | montante do pagamento - 0.1~50,000 BRL - |
subject* | string | motivo do pagamento ou título do item - Max. 128 chars - |
content | string | detalhes do motivo do pagamento ou detalhes do item. Isso será mostrado na fatura do banco. - Max. 255 chars - |
notify_url* | string | Para onde a transfersmile enviará a notificação |
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 |
buyer_id* | string | ID do usuário do comerciante |
customer.name* | string | nome do usuário |
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 - |
customer.identify.type* | string | Tipo de identificação do usuário; - CPF or CNPJ - |
address.zip_code | string | código postal |
address.state | string | estado |
address.city | string | cidade |
address.street_number | string | número da rua |
address.street | string | rua |
website_url | string | URL do site do comerciante - Max. 128 chars - |
# Responses
200 | enviado com sucesso |
{
"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 | out_trade_no duplicado |
{
"code": "40002",
"msg": "Business Failed",
"sub_code": "duplicate-out_trade_no",
"sub_msg": "out_trade_no is duplicate"
}
TIP
Dicas para pagamento
Os usuários só precisam ler o QRCode para finalizar o pagamento. O QRCode pode ser gerado com o valor qr_code.
Adicione um botão de cópia do QRCODE. Para usuários móveis, eles podem copiar a string do código qr_code e colá-lo em seu aplicativo para finalizar o pagamento. Adicionar um botão de cópia pode ajudar a melhorar a experiência de pagamento do usuário.
qr_code_url e qr_code_img são imagens geradas pelo sistema de QRCode que podem ser usadas diretamente no site do comerciante, dependendo das necessidades.
# Exemplo
curl --location --request POST 'https://gateway-test.transfersmile.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": "[email protected]"
}
}'
TIP
Importante: 162********38 é o App Id de teste da transfersmile para o ambiente sandbox, e MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== é o token de autorização associado ao App Id de teste.
WARNING
Use seu próprio app_id e gere seu próprio token de autorização ao testar.