PIXnoPDV API

https://pixpdv.com.br/api/
Admin
PIXnoPDV API facilitates Pix payment integration for point-of-sale systems, providing endpoints for...
Tokens:11,086
Snippets:55
Trust Score:6.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Extrato Response Example

Source: https://pixpdv.com.br/api/index.html

Example of a successful 200 OK response for the account statement endpoint.

```json
{
  "data": {
    "extrato": [
      {
        "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
        "transacaoTipo": "PAYMENTINSTANTPAYMENT",
        "descricao": "CREDITO DE PAGAMENTO VIA PIX",
        "data": "2021-10-14T09:53:35.000Z",
        "valor": 0.9,
        "tipo": "C"
      }
    ]
  }
}
```

--------------------------------

### Webhook Error Response Example

Source: https://pixpdv.com.br/api/index.html

Example of a 400 Bad Request response when registering a webhook.

```json
{
  "error": {
    "code": 400,
    "description": "JSON mal formado !"
  }
}
```

--------------------------------

### GET /cliente - 200 Response Sample (application/json)

Source: https://pixpdv.com.br/api/index.html

Sample JSON response for a successful client data request. Contains client details such as name, trade name, status, token, secret key, and logo in Base64.

```json
{
  "data": {
    "nome": "SUPERMERCADO DA ESQUINA",
    "fantasia": "SUPERMERCADO DA ESQUINA",
    "status": "Conta operacional.",
    "token": "tk-123...456",
    "secretKey": "sk-123...456",
    "logo": "iVBOR..."
  }
}
```

--------------------------------

### Retrieve QRCode Status Response

Source: https://pixpdv.com.br/api/index.html

Example JSON response for a successful (200 OK) status check of a QRCode.

```json
{
  "data": {
    "emissao": "2025-02-01T12:34:56.000Z",
    "valor": 12.34,
    "taxa": 0.3,
    "validade": "2025-02-10T12:34:56.000Z",
    "tipo": "cob",
    "status": "APPROVED",
    "identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
    "txId": "QRS1TXRLPI...IOHQ0EHVWT",
    "endToEndId": "E040131722...svm6Dgabyg",
    "e2eId": "E040131722...svm6Dgabyg",
    "sender": {
      "nome": "Jose Nilton Pace",
      "cpf_cnpj": "12378945600",
      "data": "2021-08-01T12:34:56.000Z",
      "valor": 12.34
    }
  }
}
```

--------------------------------

### GET /qrresumo

Source: https://pixpdv.com.br/api/index.html

Solicita um resumo dos QRCodes de um período pelo tipo de data. Requer autenticação básica e parâmetros de query obrigatórios: inicio, fim e tipo.

```APIDOC
## GET /qrresumo

### Description
Solicita um RESUMO dos QRCodes de um período pelo Tipo de data.

### Method
GET

### Endpoint
https://pixnopdv.com.br/api/v1/qrresumo

### Parameters
#### Query Parameters
- **inicio** (string, date) - Required - Data Inicial do resumo. Example: inicio=ddmmaaaa
- **fim** (string, date) - Required - Data Final do resumo. Example: fim=ddmmaaaa
- **tipo** (string, enum) - Required - Tipo de Data do resumo. Enum: "emissao", "recebimento", "vencimento". Example: tipo=emissao

### Authorizations
BasicAuthentication

### Responses
#### Success Response (200)
- **data.resumo** (array) - Lista de resumos de QRCodes.
  - **status** (string) - Status da transação (ex: APPROVED).
  - **transacaoId** (string) - Identificador da transação.
  - **transacaoTipo** (string) - Tipo da transação (ex: Pix Recebimento).
  - **mensagem** (string) - Mensagem associada.
  - **endToEndId** (string) - Identificador end-to-end.
  - **identificadorId** (string) - Identificador do QRCode.
  - **sender** (object) - Dados do remetente.
    - **nome** (string) - Nome do remetente.
    - **cpf_cnpj** (string) - CPF/CNPJ do remetente.
    - **data** (string, date-time) - Data da transação.
    - **valor** (number) - Valor da transação.

#### Response Example
{
  "data": {
    "resumo": [
      {
        "status": "APPROVED",
        "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
        "transacaoTipo": "Pix Recebimento",
        "mensagem": "...",
        "endToEndId": "E040131722...svm6Dgabyg",
        "identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
        "sender": {
          "nome": "Jose Nilton Pace",
          "cpf_cnpj": "***.532.728-**",
          "data": "2021-08-01T12:34:56.000Z",
          "valor": 12.34
        }
      }
    ]
  }
}

#### Error Responses
- **401** - Unauthorized.
- **405** - Method Not Allowed.
- **406** - Not Acceptable.
- **500** - Internal Server Error.

### Server URLs
- Produção: https://pixnopdv.com.br/api/v1/qrresumo
- Homologação (SandBox): https://pixnopdv.com.br/api-h/v1/qrresumo
```

--------------------------------

### Error Response for Unauthorized Access

Source: https://pixpdv.com.br/api/index.html

Example JSON response returned when Basic Authentication fails.

```json
{
  "error": {
    "code": 401,
    "description": "Basic Authentication (CNPJ/Token) não encontrado !"
  }
}
```

--------------------------------

### Successful Webhook Retrieval Response

Source: https://pixpdv.com.br/api/index.html

Example JSON response showing a list of registered webhook URLs.

```json
{
  "data": [
    {
      "pix": "recebimento",
      "url": "https://pix.com.br/webhook/recebimento/"
    }
  ]
}
```

--------------------------------

### Webhook Registration Payload

Source: https://pixpdv.com.br/api/index.html

Example JSON payload for registering a webhook URL.

```json
{
  "url": "https://pix.com.br/webhook/recebimento/"
}
```

--------------------------------

### GET /saldo

Source: https://pixpdv.com.br/api/index.html

Solicita o saldo disponível na conta. Requer autenticação básica e retorna o total, disponível e bloqueado.

```APIDOC
## GET /saldo

### Description
Solicita o SALDO disponível na conta.

### Method
GET

### Endpoint
https://pixnopdv.com.br/api/v1/saldo

### Parameters
Nenhum parâmetro documentado.

### Authorizations
BasicAuthentication

### Responses
#### Success Response (200)
- **data.total** (number) - Saldo total.
- **data.disponivel** (number) - Saldo disponível.
- **data.bloqueado** (number) - Valor bloqueado.

#### Response Example
{
  "data": {
    "total": 12.34,
    "disponivel": 11.34,
    "bloqueado": 1
  }
}

#### Error Responses
- **400** - Bad Request.
- **401** - Unauthorized.
- **405** - Method Not Allowed.
- **500** - Internal Server Error.

### Server URLs
- Produção: https://pixnopdv.com.br/api/v1/saldo
- Homologação (SandBox): https://pixnopdv.com.br/api-h/v1/saldo
```

--------------------------------

### GET /cliente

Source: https://pixpdv.com.br/api/index.html

Retrieves data for a specific client by CNPJ. Requires Basic Authentication and a CNPJ query parameter.

```APIDOC
## GET /cliente

### Description
Solicita os dados de um cliente específico.

### Method
GET

### Endpoint
https://pixnopdv.com.br/api/v1/cliente

### Parameters
#### Query Parameters
- **cnpj** (string) - Required - CNPJ a ser consultado.

### Authorizations
BasicAuthentication

### Responses
- **200** - OK
- **404** - Not Found.
- **405** - Method Not Allowed.
- **406** - Parameter Not Found.
- **500** - Internal Server Error.

### Response Example (200)
```json
{
  "data": {
    "nome": "SUPERMERCADO DA ESQUINA",
    "fantasia": "SUPERMERCADO DA ESQUINA",
    "status": "Conta operacional.",
    "token": "tk-123...456",
    "secretKey": "sk-123...456",
    "logo": "iVBOR..."
  }
}
```
```

--------------------------------

### GET /extrato

Source: https://pixpdv.com.br/api/index.html

Solicita o Extrato do período. Returns the account statement for the specified date range.

```APIDOC
## GET /extrato

### Description
Solicita o Extrato do período. Returns the account statement for the specified date range.

### Method
GET

### Endpoint
https://pixnopdv.com.br/api/v1/extrato

### Parameters
#### Query Parameters
- **inicio** (string <date>) - Required - Data Inicial do extrato. Example: inicio=ddmmaaaa
- **fim** (string <date>) - Required - Data Final do extrato. Example: fim=ddmmaaaa

### Responses
- **200** - OK
- **400** - Bad Request.
- **401** - Unauthorized.
- **403** - Forbidden.
- **405** - Method Not Allowed.
- **406** - Not Acceptable.
- **500** - Internal Server Error.

### Response Example (200)
```json
{
  "data": {
    "extrato": [
      {
        "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
        "transacaoTipo": "PAYMENTINSTANTPAYMENT",
        "descricao": "CREDITO DE PAGAMENTO VIA PIX",
        "data": "2021-10-14T09:53:35.000Z",
        "valor": 0.9,
        "tipo": "C"
      }
    ]
  }
}
```

### Authorizations
BasicAuthentication
```

--------------------------------

### GET /webhook

Source: https://pixpdv.com.br/api/index.html

Returns all registered webhook URLs. Requires Basic Authentication and returns a 200 status with the list of webhook URLs on success.

```APIDOC
## GET /webhook

### Description
Devolve todas as URLs cadastradas.

### Method
GET

### Endpoint
/webhook

### Responses
#### Success Response (200)
OK

#### Error Response (401)
Unauthorized.

#### Error Response (500)
Internal Server Error.

### Servers
- Produção: https://pixnopdv.com.br/api/v1/webhook
- Homologação (SandBox): https://pixnopdv.com.br/api-h/v1/webhook

### Response Samples
#### 200
Content type: application/json
```json
{
  "data": [
    {
      "pix": "recebimento",
      "url": "https://pix.com.br/webhook/recebimento/"
    }
  ]
}
```
```

--------------------------------

### GET /qrstatus

Source: https://pixpdv.com.br/api/index.html

Solicita o STATUS de um QRCode específico. Requer autenticação básica e um parâmetro de consulta obrigatório 'qrcodeid'.

```APIDOC
## GET /qrstatus

### Description
Solicita o STATUS de um QRCode específico.

### Method
GET

### Endpoint
https://pixnopdv.com.br/api/v1/qrstatus (Produção)
https://pixnopdv.com.br/api-h/v1/qrstatus (Homologação/SandBox)

### Parameters
#### Query Parameters
- **qrcodeid** (string <uuid>) - Required - UUID (Identificador único do QRCode).

### Authorizations
BasicAuthentication

### Responses
#### 200
OK

#### 401
Unauthorized.

#### 405
Method Not Allowed.

#### 406
Not Acceptable.

#### 500
Internal Server Error.

### Response Example (200)
```json
{
  "data": {
    "emissao": "2025-02-01T12:34:56.000Z",
    "valor": 12.34,
    "taxa": 0.3,
    "validade": "2025-02-10T12:34:56.000Z",
    "tipo": "cob",
    "status": "APPROVED",
    "identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
    "txId": "QRS1TXRLPI...IOHQ0EHVWT",
    "endToEndId": "E040131722...svm6Dgabyg",
    "e2eId": "E040131722...svm6Dgabyg",
    "sender": {
      "nome": "Jose Nilton Pace",
      "cpf_cnpj": "12378945600",
      "data": "2021-08-01T12:34:56.000Z",
      "valor": 12.34
    }
  }
}
```
```

--------------------------------

### Request Payload for qrcobranca

Source: https://pixpdv.com.br/api/index.html

Example JSON payload for the POST /qrcobranca request, including payment details, payer information, and optional financial settings like interest and fines.

```json
{
  "valor": 1.23,
  "vencimento": "19/03/2022",
  "expira": 5,
  "mensagem": "Cobrança referente a mensalidade...",
  "imagem": false,
  "tarifaValor": 1.23,
  "tarifaPercentual": 0.99,
  "documento": "123456/1",
  "pagador": {
    "nome": "Jose Nilton Pace",
    "fantasia": "",
    "cpf_cnpj": "12345678901",
    "endereco": "Rua Emilio Bertoni, 1645",
    "bairro": "Vila Totoli",
    "cidade": "Franca",
    "estado": "SP",
    "cep": "14409108",
    "email": "demo@jnp.com.br",
    "telefone": "(16) 3727-5688"
},
  "juros": {
    "tipo": 3,
    "valor": 10
},
  "multa": {
    "tipo": 2,
    "valor": 5
},
  "desconto": {
    "tipo": 2,
    "valor": 10,
    "data": "01/03/2022"
}

}
```

--------------------------------

### Response Sample for 200 OK

Source: https://pixpdv.com.br/api/index.html

Successful response containing the qrcodeId, the raw Pix string, the Base64 image representation, and the direct URL for the collection.

```json
{
  "data": {
    "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9",
    "qrcode": "00020101021226990014br.gov.bcb.pix...",
    "qrcodeBase64": "iVBOR...",
    "url": "https://pixnopdv.com.br/cobv/55598279...9054BF5ECE9F"
}

}
```

--------------------------------

### POST /qrdinamico

Source: https://pixpdv.com.br/api/index.html

Solicita um QRCode Dinâmico com valor e duração específicos. Requires Basic Authentication and a Json-Hash header.

```APIDOC
## POST /qrdinamico

### Description
Solicita um QRCode Dinâmico com valor e duração específicos.

### Method
POST

### Endpoint
https://pixnopdv.com.br/api/v1/qrdinamico

### Parameters
#### Header Parameters
- **Json-Hash** (string) - Required - Aplicar o HMAC (keyed-hash message authentication code), SHA256 variant, no JSon do request body, utilizando a SecretKey fornecida (Homologação: _sk-e0JBNTFGRTY0LTczMkYtNDYxNC1CQ0Q1LUI0OTVDODgxOTUwRX0_). O resultado obtido deverá estar em Hexadecimal.

#### Request Body (application/json)
- **valor** (number <float>) - Required - O valor deve ser maior que a tarifa.
- **minutos** (integer <int>) - Optional - Tempo de expiração do QRCode (Se não informado, será utilizado o tempo default de 5 minutos).
- **mensagem** (string) - Optional - Se informada, esta mensagem será apresentada na tela do pagador.
- **imagem** (boolean) - Optional - Se `true`, devolve a imagem (image/png) em Base64.
- **tarifaValor** (number <float>) - Optional - Se informado, será cobrado este valor de tarifa e não o informado no cadastro do cliente.
- **tarifaPercentual** (number <float>) - Optional - Se informado, irá calcular o valor de tarifa usando este percentual e não o informado no cadastro do cliente.

### Authorizations
BasicAuthentication

### Request Example
```json
{
  "valor": 1.23,
  "minutos": 5,
  "mensagem": "caixa: 01, operador(a): Maria",
  "imagem": false,
  "tarifaValor": 1.23,
  "tarifaPercentual": 0.99
}
```

### Responses
- **200** - OK
- **400** - Bad Request.
- **401** - Unauthorized.
- **403** - Forbidden.
- **405** - Method Not Allowed.
- **406** - Not Acceptable.
- **500** - Internal Server Error.

### Response Example (200)
```json
{
  "data": {
    "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9",
    "qrcode": "00020101021226990014br.gov.bcb.pix...",
    "qrcodeBase64": "iVBOR...",
    "url": "https://pixnopdv.com.br/cob/55598279...9054BF5ECE9F"
  }
}
```
```

--------------------------------

### POST /qrdinamico - 200 Response Sample (application/json)

Source: https://pixpdv.com.br/api/index.html

Sample JSON response for a successful dynamic QR code request. Contains the QR code ID, the QR code string, Base64 image, and payment URL.

```json
{
  "data": {
    "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9",
    "qrcode": "00020101021226990014br.gov.bcb.pix...",
    "qrcodeBase64": "iVBOR...",
    "url": "https://pixnopdv.com.br/cob/55598279...9054BF5ECE9F"
  }
}
```

--------------------------------

### POST /qrrefund

Source: https://pixpdv.com.br/api/index.html

Solicita a devolução de um QRCode Dinâmico recebido anteriormente. Requer autenticação básica, cabeçalho Json-Hash e corpo JSON com o ID do QRCode.

```APIDOC
## POST /qrrefund

### Description
Solicita a devolução de um QRCode Dinâmico recebido anteriormente.

### Method
POST

### Endpoint
https://pixnopdv.com.br/api/v1/qrrefund (Produção)
https://pixnopdv.com.br/api-h/v1/qrrefund (Homologação/SandBox)

### Parameters
#### Header Parameters
- **Json-Hash** (string) - Required - Aplicar o HMAC (keyed-hash message authentication code), SHA256 variant, no JSon do request body, utilizando a SecretKey fornecida (Homologação: _sk-e0JBNTFGRTY0LTczMkYtNDYxNC1CQ0Q1LUI0OTVDODgxOTUwRX0_). O resultado obtido deverá estar em Hexadecimal.

#### Request Body (application/json)
- **qrcodeId** (string <uuid>) - Required - Id do QRCode que deseja devolver ao pagador.

### Authorizations
BasicAuthentication

### Request Example
```json
{
  "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9"
}
```

### Responses
#### 200
OK

#### 400
Bad Request.

#### 401
Unauthorized.

#### 403
Forbidden.

#### 404
Not Found.

#### 405
Method Not Allowed.

#### 500
Internal Server Error.

### Response Example (200)
```json
{
  "data": {
    "refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521"
  }
}
```
```

--------------------------------

### Response sample for /qrresumo

Source: https://pixpdv.com.br/api/index.html

JSON response structure for a successful QRCode summary request.

```json
{
  "data": {
    "resumo": [
      {
        "status": "APPROVED",
        "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
        "transacaoTipo": "Pix Recebimento",
        "mensagem": "...",
        "endToEndId": "E040131722...svm6Dgabyg",
        "identificadorId": "QRS1TXRLPI...IOHQ0EHVWT",
        "sender": {
          "nome": "Jose Nilton Pace",
          "cpf_cnpj": "***.532.728-**",
          "data": "2021-08-01T12:34:56.000Z",
          "valor": 12.34
        }
      }
    ]
  }
}
```

--------------------------------

### POST /qrdinamico - Request Payload Sample (application/json)

Source: https://pixpdv.com.br/api/index.html

Sample JSON request body for creating a dynamic QR code. Includes value, expiration minutes, message, image flag, and optional tariff overrides.

```json
{
  "valor": 1.23,
  "minutos": 5,
  "mensagem": "caixa: 01, operador(a): Maria",
  "imagem": false,
  "tarifaValor": 1.23,
  "tarifaPercentual": 0.99
}
```

--------------------------------

### Response sample for /saldo

Source: https://pixpdv.com.br/api/index.html

JSON response structure for a successful account balance request.

```json
{
  "data": {
    "total": 12.34,
    "disponivel": 11.34,
    "bloqueado": 1
  }
}
```

--------------------------------

### POST /cliente

Source: https://pixpdv.com.br/api/index.html

Envia um JSON com os dados básicos para o cadastro do cliente. Requer autenticação básica e header Json-Hash com HMAC-SHA256.

```APIDOC
## POST /cliente

### Description
Envia um JSON com os dados básicos para o cadastro do cliente.

### Method
POST

### Endpoint
Produção: https://pixnopdv.com.br/api/v1/cliente
Homologação: https://pixnopdv.com.br/api-h/v1/cliente

### Authorizations
BasicAuthentication

### Header Parameters
- **Json-Hash** (string) - Required - Aplicar o HMAC (keyed-hash message authentication code), SHA256 variant, no JSON do request body, utilizando a SecretKey fornecida (Homologação: _sk-e0JBNTFGRTY0LTczMkYtNDYxNC1CQ0Q1LUI0OTVDODgxOTUwRX0_). O resultado obtido deverá estar em Hexadecimal.

### Request Body
application/json
- **cliente** (object) - Required - Dados do cliente.
- **grid** (object) - Informar o cnpj do grid (filiação).
- **tarifaRecebimento** (object) - Required - Tarifas de recebimento.
- **tarifaCobranca** (number <float>) - Required - Valor da tarifa em R$ para a cobrança por vencimento (cobV).
- **tarifaDevolucao** (number <float>) - Required - Valor da tarifa em R$ para a devolução.
- **tarifaRetirada** (number <float>) - Required - Valor da tarifa em R$ para a retirada.

### Request Example
{
  "cliente": {
    "cpf_cnpj": "12345678901234",
    "email": "demo@jnp.com.br",
    "telefone": "16999991234"
  },
  "grid": {
    "cpf_cnpj": "12345678901234"
  },
  "tarifaRecebimento": {
    "tipo": "P",
    "tarifa": 0.99,
    "tarifaMinima": 0.3,
    "tarifaMaxima": 3
  },
  "tarifaCobranca": 0.3,
  "tarifaDevolucao": 0.3,
  "tarifaRetirada": 0.3
}

### Response
#### Success Response (200)
- **data** (object) - Contém o link para aceite.

#### Response Example
{
  "data": {
    "link": "https://pixnopdv.com.br/aceite.html?token=MS43ODY0Mi42Lg"
  }
}

### Error Responses
- **400** - Bad Request.
- **401** - Unauthorized.
- **403** - Forbidden.
- **404** - Not Acceptable.
- **405** - Method Not Allowed.
- **406** - Not Acceptable.
- **409** - Conflict.
- **500** - Internal Server Error.
```

--------------------------------

### POST /webhook/{pix}

Source: https://pixpdv.com.br/api/index.html

Cadastra uma URL de webhook. Envia um JSON com a URL a ser cadastrada.

```APIDOC
## POST /webhook/{pix}

### Description
Cadastra uma URL de webhook. Envia um JSON com a URL a ser cadastrada.

### Method
POST

### Endpoint
https://pixnopdv.com.br/api/v1/webhook/{pix}

### Parameters
#### Path Parameters
- **pix** (string) - Required - Enum: "recebimento" "cobranca" "deposito" "devolucao" "retirada"

#### Request Body
- **url** (string, <= 200 characters) - Required - Informar a URL do webhook.

### Request Example
```json
{
  "url": "https://pix.com.br/webhook/recebimento/"
}
```

### Responses
- **200** - Cadastrado.
- **400** - Bad Request.
- **401** - Unauthorized.
- **403** - Path inválido ou não informado.
- **405** - Method Not Allowed.
- **406** - Not Acceptable.
- **409** - Conflict.
- **500** - Internal Server Error.

### Response Example (400)
```json
{
  "error": {
    "code": 400,
    "description": "JSON mal formado !"
  }
}
```

### Authorizations
BasicAuthentication
```

--------------------------------

### POST /qrcobranca

Source: https://pixpdv.com.br/api/index.html

Solicita um QRCode cobrança com data de Vencimento, valor, juros, multa, desconto e data de expiração específicos.

```APIDOC
## POST /qrcobranca

### Description
Solicita um QRCode cobrança com data de Vencimento, valor, juros, multa, desconto e data de expiração específicos.

### Method
POST

### Endpoint
https://pixnopdv.com.br/api/v1/qrcobranca

### Parameters
#### Header Parameters
- **Json-Hash** (string) - Required - Aplicar o HMAC (keyed-hash message authentication code), SHA256 variant, no JSon do request body, utilizando a SecretKey fornecida.

#### Request Body
- **valor** (number) - Required - O valor deve ser maior que a tarifa.
- **vencimento** (string) - Required - Data de vencimento.
- **expira** (integer) - Required - Dias pra expirar "após" o vencimento.
- **mensagem** (string) - Required - Está mensagem será apresentada na tela do pagador (<= 200 characters).
- **imagem** (boolean) - Optional - Se `true`, devolve a imagem (image/png) em Base64.
- **tarifaValor** (number) - Optional - Se informado, será cobrado este valor de tarifa.
- **tarifaPercentual** (number) - Optional - Se informado, irá calcular o valor de tarifa usando este percentual.
- **documento** (string) - Optional - Número do Documento (<= 10 characters).
- **pagador** (object) - Required - Informações do pagador.
- **juros** (object) - Optional - Informação dos juros.
- **multa** (object) - Optional - Informação da multa.
- **desconto** (object) - Optional - Informação do desconto.

### Request Example
{
  "valor": 1.23,
  "vencimento": "19/03/2022",
  "expira": 5,
  "mensagem": "Cobrança referente a mensalidade...",
  "imagem": false,
  "pagador": {
    "nome": "Jose Nilton Pace",
    "cpf_cnpj": "12345678901"
  }
}

### Response
#### Success Response (200)
- **data** (object) - Contém qrcodeId, qrcode, qrcodeBase64 e url.

#### Response Example
{
  "data": {
    "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9",
    "qrcode": "00020101021226990014br.gov.bcb.pix...",
    "url": "https://pixnopdv.com.br/cobv/55598279..."
  }
}
```

--------------------------------

### POST /cliente 200 OK Response

Source: https://pixpdv.com.br/api/index.html

The successful response structure containing the acceptance link token.

```json
{
  "data": {
    "link": "https://pixnopdv.com.br/aceite.html?token=MS43ODY0Mi42Lg"
}

}
```

--------------------------------

### Resposta de Sucesso 200 para Retirada

Source: https://pixpdv.com.br/api/index.html

Exemplo de resposta JSON retornada pelo servidor após uma solicitação de retirada bem-sucedida, contendo os detalhes da transação.

```json
{
  "data": {
    "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
    "endToEndId": "E231144472...KOYDkjOtrT",
    "pspId": "04013172",
    "pspNome": "CC SICOOB CRED-ACIF",
    "agencia": "4321",
    "conta": "20211831",
    "contaNome": "JNP Software de Franca Ltda",
    "contaTipo": "CC"
  }
}
```

--------------------------------

### POST /retirada

Source: https://pixpdv.com.br/api/index.html

Retira qualquer valor da conta e envia para a instituição onde está a chave pix do cnpj. Requer autenticação básica e um header Json-Hash com HMAC SHA256 do corpo da requisição.

```APIDOC
## POST /retirada

### Description
Retira qualquer valor da conta e envia para a instituição onde está a chave pix do cnpj.

### Method
POST

### Endpoint
Produção: https://pixnopdv.com.br/api/v1/retirada
Homologação (SandBox): https://pixnopdv.com.br/api-h/v1/retirada

### Authorizations
BasicAuthentication

### Header Parameters
- **Json-Hash** (string) - Required - Aplicar o HMAC (keyed-hash message authentication code), SHA256 variant, no JSON do request body, utilizando a SecretKey fornecida (Homologação: _sk-e0JBNTFGRTY0LTczMkYtNDYxNC1CQ0Q1LUI0OTVDODgxOTUwRX0_). O resultado obtido deverá estar em Hexadecimal.

### Request Body
application/json
- **valor** (number <float>) - Required - Valor que deseja transferir. Mínimo: 0.01
- **tarifaValor** (number <float>) - Optional - Se informado, será cobrado este valor de tarifa e não o informado no cadastro do cliente. Mínimo: 0

### Request Example
{
  "valor": 1.23,
  "tarifaValor": 1.23
}

### Responses

#### 200 OK
Response body:
{
  "data": {
    "transacaoId": "e411865e-cd8b-4b6f-ad1a-67016e6e27d3",
    "endToEndId": "E231144472...KOYDkjOtrT",
    "pspId": "04013172",
    "pspNome": "CC SICOOB CRED-ACIF",
    "agencia": "4321",
    "conta": "20211831",
    "contaNome": "JNP Software de Franca Ltda",
    "contaTipo": "CC"
  }
}

#### 400 Bad Request
#### 401 Unauthorized
#### 403 Forbidden
#### 405 Method Not Allowed
#### 406 Not Acceptable
#### 500 Internal Server Error
```

--------------------------------

### POST /cliente Request Payload

Source: https://pixpdv.com.br/api/index.html

The JSON structure required for the client pre-registration request, including client details, grid information, and tariff configurations.

```json
{
  "cliente": {
    "cpf_cnpj": "12345678901234",
    "email": "demo@jnp.com.br",
    "telefone": "16999991234"
},
  "grid": {
    "cpf_cnpj": "12345678901234"
},
  "tarifaRecebimento": {
    "tipo": "P",
    "tarifa": 0.99,
    "tarifaMinima": 0.3,
    "tarifaMaxima": 3
},
  "tarifaCobranca": 0.3,
  "tarifaDevolucao": 0.3,
  "tarifaRetirada": 0.3

}
```

--------------------------------

### Request Refund Payload

Source: https://pixpdv.com.br/api/index.html

JSON payload required to initiate a refund for a specific QRCode ID.

```json
{
  "qrcodeId": "2d2bf7b7-24fc-4431-9cb8-460ea14ee9e9"
}
```

--------------------------------

### Payload de Requisição para Retirada

Source: https://pixpdv.com.br/api/index.html

Exemplo de corpo de requisição JSON para o endpoint de retirada, contendo o valor a ser transferido e a tarifa opcional.

```json
{
  "valor": 1.23,
  "tarifaValor": 1.23
}
```

--------------------------------

### DELETE /webhook/{pix}

Source: https://pixpdv.com.br/api/index.html

Removes a specific webhook URL identified by the pix parameter. Requires Basic Authentication and returns a 200 status on success.

```APIDOC
## DELETE /webhook/{pix}

### Description
Remove uma URL específica.

### Method
DELETE

### Endpoint
/webhook/{pix}

### Parameters
#### Path Parameters
- **pix** (string) - Required - Enum: "recebimento", "cobranca", "deposito", "devolucao", "retirada"

### Responses
#### Success Response (200)
Deleted

#### Error Response (401)
Unauthorized.

#### Error Response (500)
Internal Server Error.

### Servers
- Produção: https://pixnopdv.com.br/api/v1/webhook/{pix}
- Homologação (SandBox): https://pixnopdv.com.br/api-h/v1/webhook/{pix}

### Response Samples
#### 401
Content type: application/json
```json
{
  "error": {
    "code": 401,
    "description": "Basic Authentication (CNPJ/Token) não encontrado !"
  }
}
```
```

--------------------------------

### Refund Response

Source: https://pixpdv.com.br/api/index.html

JSON response returned upon a successful refund request, containing the refund identifier.

```json
{
  "data": {
    "refundId": "3324897f-393a-4bf6-b3af-0b999cbc2521"
  }
}
```
Tokens:
Raw