Pix

Cómo utilizar Pix para realizar un payin en Brasil.

Pix Payin

POST https://gateway-test.pagsmile.com/trade/pay

Este endpoint te permite usar Pix para realizar un payin en Brasil.

Headers

NameTypeDescription

Content-Type*

string

applicacion/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

NameTypeDescription

app_id*

string

Id de app creado en dashboard

- Max. 32 chars -

customer.phone*

string

Teléfono de usuario

customer.email*

string

Correo de usuario

customer.identify.number*

string

Número de identificación de usuario

- 11 digitos CPF o 14 digitos CNPJ -

method*

string

Valor fijo: PIX

out_trade_no*

string

ID dado por el merchant en su sistema

- Max. 64 chars -

notify_url*

string

Donde Pagsmile enviará la notificación

customer.identify.type*

string

Tipo de identificación de usuario

- CPF o CNPJ -

customer.name*

string

Nombre de usuario

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

subject*

string

Razón de pago o título

- Max. 128 chars -

order_amount*

string

Monto de pago - 0.1~50,000 BRL -

order_currency*

string

Valor fijo: BRL

content*

string

Detalle de razón de pago o título. Se mostrará en el recibo del banco.

- Max. 255 chars-

buyer_id*

string

Usuario id de merchant

address.zip_code

string

zip code

website_url

string

URL de website de merchant

- Max. 128 chars -

address.street

string

calle

address.street_number

string

Número de calle

address.city

string

ciudad

address.state

string

provincia

return_url

string

web URL de redirección al finalizar checkout

cancellation_express

string

m(minutos), h(horas), d(días). Valor debe ser integer.

Ex: 90m Usado para controlar expiración de código QR.

{
    "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"
}

Consejos de pago a usuarios

  • Los usuarios solo necesitan escanear el código QR para finalizar el pago. El código QR se puede generar con qr_code value.

  • Agregue un botón Copy QRCODE. Para los usuarios móviles, pueden copiar el string de qr_code y pegarla en su aplicación de billetera para finalizar el pago. Agregar un botón de copia podría ayudar a mejorar la experiencia de pago del usuario.

  • qr_code_url y qr_code_img son imágenes de código qr generadas por el sistema que se pueden utilizar directamente en el sitio web del merchant según las necesidades.

Ejemplo

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"
    }
}'

Nota: 162************38 es el test ID de pagsmile para prueba en sandbox, y MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== es el token de autorización asociado con el app ID de prueba.

Favor utilizar tu propio app_id y genera tu propio authorization token al realizar pruebas.

Last updated