Boleto

Como usar o Boleto para criar um Payin no Brasil.

Payin por Boleto

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

Este endpoint permite submeter um pagamento por Boleto no Brasil.

Headers

NameTypeDescription

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

NameTypeDescription

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: Boleto

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 - 4~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 usuario do comerciante

address.zip_code*

string

código postal

website_url

string

URL do site do comerciante

- Max. 128 chars -

address.street

string

rua

- Necessário se o código postal não for fornecido -

address.street_number

string

número da rua

- Necessário se o código postal não for fornecido -

address.city

string

cidade

- Necessário se o código postal não for fornecido -

address.state

string

estado - Necessário se o código postal não for fornecido -

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 O valor deve ser maior do que o timeout_express.

Utilizado para controlar o tempo de expiração do Boleto.

timeout_express

strng

Usado para controlar o tempo de expiração do envio de um pedido (do início ao processamento). (90m no padrão, máximo 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"
}

Dicas de pagamento

  • O valor do bank_code é o número do boleto que o usuário precisa usar para o pagamento

  • Usar o valor do código de barras para gerar um código de barras digitalizável pode ajudar os usuários a fazer o pagamento mais rápido

  • O fornecimento de uma versão PDF para download poderia ajudar os usuários a ter seus boletos em seus telefones sem manter o navegador aberto.

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

Importante: 162************38 é o App Id de teste da pagsmile para o ambiente sandbox, e MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== é o token de autorização associado ao App Id de teste.

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

Last updated