Boleto

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

Payin por Boleto

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

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

Headers

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

Name

Type

Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name	Type	Description
app_id*	string	Id de app creado en dashboard - Max. 32 chars -
customer.phone*	string	User's phone
customer.email*	string	Teléfono de usuario
customer.identify.number*	string	Número de identificación de usuario- 11 digitos CPF o 14 digitos CNPJ -
method*	string	Valor fijo: Boleto
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 - 4~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 - Requerido si no hay zip_code -
address.street_number	string	Número de calle - Requerido si no hay zip_code -
address.city	string	ciudad - Requerido si no hay zip_code -
address.state	string	provincia - Requerido si no hay zip_code -
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 El valor debe ser mayor que el timeout express. Usado para controlar expiración del Boleto voucher.
timeout_express	strng	Usado para controlar tiempo de expiración de enviar una orden (desde initial a processing). (90m defecto, max 15d)

Name

Type

Description

app_id*

string

Id de app creado en dashboard

- Max. 32 chars -

customer.phone*

string

User's phone

customer.email*

string

Teléfono de usuario

customer.identify.number*

string

Número de identificación de usuario- 11 digitos CPF o 14 digitos CNPJ -

method*

string

Valor fijo: Boleto

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 - 4~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

- Requerido si no hay zip_code -

address.street_number

string

Número de calle

- Requerido si no hay zip_code -

address.city

string

ciudad

- Requerido si no hay zip_code -

address.state

string

provincia - Requerido si no hay zip_code -

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 El valor debe ser mayor que el timeout express. Usado para controlar expiración del Boleto voucher.

timeout_express

strng

Usado para controlar tiempo de expiración de enviar una orden (desde initial a processing). (90m defecto, max 15d)

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110481300091",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "barcode": "23793864800029999003380260980157275200633330",
    "bank_code": "21890010070215182080679309377384187050000001125",
    "pay_url": "https://checkout-testv2.pagsmile.com/checkout?prepay_id=bkYvNytBMkN2dnFaVVhXTSs0ckJPaHBBVnkyT3J1M2tyekNzZ3RMZ05ubz0=-3872aF67",
    "trade_status": "PROCESSING"
}

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

Consejos de pago para el usuario

El valor de bank_code es el número de billete que el usuario necesita utilizar para el pago
Usar el valor del barcode para generar un código de barras escaneable puede ayudar a los usuarios a realizar el pago más rápido
Proporcionar una versión PDF descargable podría ayudar a los usuarios móviles a tener sus tickets en sus teléfonos sin mantener el navegador abierto

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": "202201010354003",
    "method": "Boleto",
    "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

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

PreviousLottery NextDepósito Express

Last updated 1 year ago