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
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 | 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) |
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
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