Pix
Saiba mais sobre o gerenciamento de ordens de pagamento via Pix processadas pela Preme Pay.
Para efetuar uma cobrança via Pix, você deve criar uma ordem de pagamento. Nesta seção você encontrará informações detalhadas relacionadas ao método de pagamento com cartão.
Você pode recuperar e estornar cobranças individuais seguindo os paramentros apresentados em Reembolso. Você também pode listar todas as ordem de pagamento, visualizar os detalhes ou excluir uma ordem de pagamento de acordo com as especificações apresentadas.

Adicionar Ordem de Pagamento

https://api.premepay.com/v1/stores/{storeId}/orders
Utilizando a rota acima você pode adicionar uma ordem de pagamento com Pix.
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
pix
Pix
installments
integer
Quantidade de prestações
Sim
warrantyDays
integer
Tempo em Dias de Garantia do Serviço
Não
whenShouldIssueNfe
object
Quando emitir a NFe
Sim, se propriedade sendNfeToCustomer for utilizada
0
integer
No ato da Venda
1
integer
Após a garantia
2
integer
Não emitir
sendNfeToCustomer
boolean
Enviar nota fiscal ao consumidor
Sim, se propriedade whenShouldIssueNfe for utilizada

Exemplo de Requisição

Este é um exemplo de como a sua requisição para adicionar uma ordem de pagamento com Pix deve parecer.
{
"amount": 29.90,
"customerId": 14024,
"description": "Some description",
"payment": {
"type": "Pix",
"installments": 1
},
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": 187397,
"storeId": 27359,
"storeName": "Store Name LTDA",
"number": "P796394",
"includeFeeTransfer": false,
"amount": 29.90,
"fxAmount": 0.0,
"netAmount": 0.0,
"fxRate": 1.0,
"fee": 0.0,
"splits": [],
"description": "Some description",
"status": "Succeded",
"createdOn": "2021-09-28T15:33:43.0295038Z",
"customer": {
"id": 14024,
"firstName": "Fernando",
"surname": "Alexandre Pereira",
"identificationNumber": "68463853714",
"birthdate": null,
"email": "[email protected]",
"phone": "6635085862",
"address": {
"street": "Joseph Sabeh",
"number": "11",
"zipCode": "14800000",
"reference": null,
"district": "Roseiras",
"city": "Sao Paulo",
"state": "SP",
"country": "BR"
}
},
"payment": {
"id": 187390,
"number": null,
"amount": 29.90,
"type": "Pix",
"installments": 1,
"pix": {
"id": 247828,
"amount": 29.90,
"copyPaste": "00020126330014br.gov.bcb.pix011134286842304520400005303986540529.905802BR5909PREME PAY6008Blumenau61088903736062110507P79639463049DDC",
"url": "https://ebiwiv8veu.s3.us-east-2.amazonaws.com/pix/qrcodes/P796394.svg",
"initializationType": "StaticQrCode"
},
"lateFee": null,
"createdOn": "2021-09-28T15:33:43.0308033Z",
"status": "Pending"
},
"payments": [],
"receivables": [],
"isMultiplePayments": false,
"paymentLink": null,
"currency": "BRL",
"metadata": {},
"chargeDaysBefore": null,
"tax": null,
"warrantyDays": 30,
"whenShouldIssueNfe": null,
"sendNfeToCustomer": null,
"printableLink": null,
"xmlLink": null
}

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. 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": 187397,
"storeId": 359,
"storeName": "Store Name LTDA",
"number": "P796394",
"includeFeeTransfer": false,
"amount": 29.90,
"fxAmount": 0.0,
"netAmount": 0.00,
"fxRate": 1.0000,
"fee": 0.00,
"splits": [],
"description": "Some description",
"status": "Succeded",
"createdOn": "2021-09-28T15:33:43",
"customer": {
"id": 14024,
"firstName": "Fernando",
"surname": "Alexandre Pereira",
"identificationNumber": "68463853714",
"birthdate": null,
"email": "[email protected]",
"phone": "6635085862",
"address": {
"street": "Joseph Sabeh",
"number": "11",
"zipCode": "14800000",
"reference": null,
"district": "Roseiras",
"city": "Sao Paulo",
"state": "SP",
"country": "BR"
}
},
"payment": {
"id": 187390,
"number": null,
"amount": 29.90,
"type": "Pix",
"installments": 1,
"pix": {
"id": 28,
"amount": 29.90,
"copyPaste": "00020126330014br.gov.bcb.pix011134286842304520400005303986540529.905802BR5909PREME PAY6008Blumenau61088903736062110507P79639463049DDC",
"url": "https://ebiwiv8veu.s3.us-east-2.amazonaws.com/pix/qrcodes/P796394.svg",
"initializationType": "StaticQrCode"
},
"lateFee": null,
"createdOn": "2021-09-28T15:33:43",
"status": "Pending"
},
"payments": [],
"receivables": [],
"isMultiplePayments": false,
"paymentLink": null,
"currency": "BRL",
"metadata": {},
"chargeDaysBefore": null,
"tax": null,
"warrantyDays": 30,
"whenShouldIssueNfe": null,
"sendNfeToCustomer": null,
"printableLink": null,
"xmlLink": null
}
],
"totalNumber": 127
}

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.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 187395,
"storeId": 359,
"storeName": "Store Name LTDA",
"number": "P818751",
"includeFeeTransfer": false,
"amount": 29.90,
"fxAmount": 0.0,
"netAmount": 0.00,
"fxRate": 1.0000,
"fee": 0.00,
"splits": [],
"description": "Some description",
"status": "Succeded",
"createdOn": "2021-09-28T09:58:56",
"customer": {
"id": 14024,
"firstName": "Fernando",
"surname": "Alexandre Pereira",
"identificationNumber": "68463853714",
"birthdate": null,
"email": "[email protected]",
"phone": "6635085862",
"address": {
"street": "Joseph Sabeh",
"number": "11",
"zipCode": "14800000",
"reference": null,
"district": "Roseiras",
"city": "Sao Paulo",
"state": "SP",
"country": "BR"
}
},
"payment": {
"id": 187388,
"number": null,
"amount": 29.90,
"type": "Pix",
"installments": 1,
"pix": {
"id": 26,
"amount": 29.90,
"decodedValue": "00020126330014br.gov.bcb.pix011134286842304520400005303986540529.905802BR5909PREME PAY6008Blumenau61088903736062110507P818751630495F1",
"url": "https://ebiwiv8veu.s3.us-east-2.amazonaws.com/pix/qrcodes/P818751.svg",
"initializationType": "StaticQrCode"
},
"lateFee": null,
"createdOn": "2021-09-28T09:58:56",
"status": "Pending"
},
"payments": [],
"receivables": [],
"isMultiplePayments": false,
"paymentLink": null,
"currency": "BRL",
"metadata": {},
"chargeDaysBefore": null,
"tax": null,
"warrantyDays": 30,
"whenShouldIssueNfe": null,
"sendNfeToCustomer": null,
"printableLink": null,
"xmlLink": null
}

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