Boleto Bancário
Entenda o processo de gerenciamento de pagamentos via Boleto Bancario através da API da Preme Pay.
Para efetuar uma cobrança via Cartão de Crédito ou Boleto Bancário, você deve criar uma ordem de pagamento. Esta seção mostrará as principais ações necessárias para o bons gerenciamento de seus pagamentos por Boleto Bancário.
Você não pode realizar estornos com Boleto Bancário, apenas estornos com Cartão de Crédito são possíveis.

Adicionar Ordem de Pagamento

https://api.premepay.com/v1/stores/{storeId}/orders
Utilizando a rota acima você pode adicionar uma ordem de pagamento com Boleto Bancário.
Parâmetro
Tipo
Descrição
Obrigatório
customerId
integer
Identificador do consumidor
Sim
fingerprint
string
Identificador único da sessão do usuário
Não
includeFeeTransfer
boolean
Indica se taxas devem ser repassadas ao consumidor
Não
amount
decimal
Valor total a ser cobrado
Sim
description
string
Descrição da venda
Sim
payment
object
Informações do pagamento
Sim
type
string
Tipo do pagamento
Sim
boleto
Boleto Bancário
dueDate
date
Data de vencimento
Sim
lateFee
object
Cobrança de multa por atraso
Não
amount
decimal
Valor fixo
Quando Mode for Daily_Amount ou Fixed
percentage
decimal
Percentual
Quando Mode for DailyPercentage, Monthly_Percentage ou Percentage
mode
string
Tipo de cobrança
Sim
daily_Percentage
Percentual por dia
daily_Amount
Valor fixo por dia
monthly_Percentage
Percentual por mês
fixed
Valor fixo
percentage
Valor percentual
interestOrFine
object
Cobrança de juros por atraso
Não
amount
decimal
Valor fixo
Quando Mode for Daily_Amount ou Fixed
percentage
decimal
Percentual
Quando Mode for DailyPercentage, Monthly_Percentage ou Percentage
mode
string
Tipo de cobrança
Sim
daily_Percentage
Percentual por dia
Daily_Amount
Valor fixo por dia
monthly_Percentage
Percentual por mês
fixed
Valor fixo
percentage
Valor percentual
discount
object
Desconto
Não
amount
decimal
Valor fixo
Quando Mode for Daily_Amount ou Fixed
percentage
decimal
Percentual
Quando Mode for DailyPercentage, Monthly_Percentage ou Percentage
limitDate
Date
Data limite para concessão do desconto
Sim
mode
string
Tipo de cobrança
Sim
daily_Percentage
Percentual por dia
daily_Amount
Valor fixo por dia
monthly_Percentage
Percentual por mês
fixed
Valor fixo
percentage
Valor percentual
splits
objeto
Divisões
Não
splitRuleId
int
Identificador
Sim
warrantyDays
int
Tempo em Dias de Garantia do Serviço
Não
whenShouldIssueNfe
object
Quando emitir a NFe
Sim, se a propridade sendNfeToCustomer for utilizada
0
int
No ato da venda
1
int
Após a garantia
2
int
Não emitir
sendNfeToCustomer
boolean
Enviar nota fiscal ao consumidor
Sim, se a propridade whenShouldIssueNfe for utilizada

Exemplo de Requisição

Este é um exemplo de como a sua requisição para adicionar uma ordem de pagamento com Boleto Bancário deve parecer.
{
"customerId": 2345,
"fingerPrint": "db69792c-3b10-11eb-adc1-0242ac120002",
"includeFeeTransfer": false,
"amount": 275.50,
"description": "Descrição da venda",
"payment": {
"type": "boleto",
"dueDate": "2020-07-26"
},
warrantyDays: 30,
whenShouldIssueNfe: 0,
sendNfeToCustomer: true
}

Respostas

200: Created

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
Status
Significado
new
Novo
succeded
Criado
canceled
Cancelado
failed
Falhou
pending
Pendente
blocked
Bloqueado
{
"id": 198564,
"storeId": 7591,
"number": "P278050",
"includeFeeTransfer": false,
"amount": 275.50,
"netAmount": 270.00,
"fee": 5.50,
"description": "Descrição da venda",
"status": "Succeded",
"createdOn": "2020-07-24T13:35:03.145Z",
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"birthdate": "1975-10-10",
"identificationNumber": "90202017940",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"payment": {
"id": 197485,
"number": "b10da7c0347b40cc8c34664cb60445c0",
"amount": 275.50,
"type": "Boleto",
"dueDate": "2020-07-26",
"barcode": "31191090502267566891031339210002383010001008490",
"boletoUrl": "https://preme.s3.us-east-2.amazonaws.com/boletos/P278050.html"
"fraudScore": {
"score": 37.06
},
"createdOn": "2020-07-24T13:35:03.145Z",
"status": "Pending"
}
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
],
"status": 400,
"detail": "Error details"
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Listar Ordem de Pagamento

https://api.premepay.com/v1/stores/{storeId}/orders
Parâmetro
Tipo
Descrição
Obrigatório
name
string
Nome do consumidor
Não
identificationNumber
string
Cpf ou CNPJ do consumidor
Não
number
string
Número da ordem
Não
pageSize
integer
Número de registros por página
Não
pageIndex
integer
Número da página
Não
Através da rota acima você poderá visualizar uma lista de todas as ordens de pagamento com Boleto. Confira abaixo as respostas possíveis da API da Preme Pay para essa requisição.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"results": [
{
"id": 198564,
"storeId": 7591,
"number": "P278050",
"includeFeeTransfer": false,
"amount": 275.50,
"netAmount": 270.00,
"fee": 5.50,
"description": "Descrição da venda",
"status": "Succeded",
"createdOn": "2020-07-24T13:35:03.145Z",
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"birthdate": "1975-10-10",
"identificationNumber": "90202017940",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"payment": {
"id": 197485,
"number": "b10da7c0347b40cc8c34664cb60445c0",
"amount": 275.50,
"type": "Boleto",
"dueDate": "2020-07-26",
"barcode": "31191090502267566891031339210002383010001008490",
"boletoUrl": "https://preme.s3.us-east-2.amazonaws.com/boletos/P278050.html"
"fraudScore": {
"score": 37.06
},
"createdOn": "2020-07-24T13:35:03.145Z",
"status": "Pending"
}
}],
"totalNumber": 1
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Detalhes da Ordem de Pagamento

https://api.premepay.com/v1/stores/{storeId}/orders/{orderNumber}
Com a API da Preme Pay e a rota acima você pode visualizar os detalhes de uma ordem de pagamento com Boleto.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 198564,
"storeId": 7591,
"number": "P278050",
"includeFeeTransfer": false,
"amount": 275.50,
"netAmount": 270.00,
"fee": 5.50,
"description": "Descrição da venda",
"status": "Succeded",
"createdOn": "2020-07-24T13:35:03.145Z",
"customer": {
"id": 2345,
"firstName": "Jorge Noah",
"surname": "Barbosa",
"birthdate": "1975-10-10",
"identificationNumber": "90202017940",
"email": "[email protected]",
"phone": "(48) 998711234"
},
"payment": {
"id": 197485,
"number": "b10da7c0347b40cc8c34664cb60445c0",
"amount": 275.50,
"type": "Boleto",
"dueDate": "2020-07-26",
"barcode": "31191090502267566891031339210002383010001008490",
"boletoUrl": "https://preme.s3.us-east-2.amazonaws.com/boletos/P278050.html"
"fraudScore": {
"score": 37.06
},
"createdOn": "2020-07-24T13:35:03.145Z",
"status": "Pending"
}
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Excluir Ordem de Pagamento

https://api.premepay.com/v1/stores/{storeId}/orders/{orderNumber}
Você tem a possibilidade de excluir permanentemente uma ordem de pagamento com Boleto. Tenha atenção ao realizar essa requisição já que a ação não pode ser revertida.
A ação de excluir uma ordem de pagamento é permanente e não pode ser revertida.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"message": "Order deleted"
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
],
"status": 400,
"detail": "Error details"
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}
Copy link
Outline
Adicionar Ordem de Pagamento
Listar Ordem de Pagamento
Detalhes da Ordem de Pagamento
Excluir Ordem de Pagamento