Nitro API

https://docs.nitropagamentos.com
Admin
Nitro API is a secure RESTful payment processing API that enables developers to easily integrate...
Tokens:2,156
Snippets:20
Trust Score:5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Exemplo de Payload de Postback Recebido

Source: https://docs.nitropagamentos.com/index

Este exemplo demonstra a estrutura de dados de um payload de postback que sua aplicação pode receber. Ele contém informações cruciais sobre o status e detalhes de uma transação após uma atualização.

```json
{
  "transaction_hash": "abc123def456",
  "status": "paid",
  "amount": 15000,
  "payment_method": "pix",
  "paid_at": "2025-01-20T10:15:00Z"
}
```

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

### Nitro API v1.0 - Product Listing

Source: https://docs.nitropagamentos.com/index

Endpoint for listing available products.

```APIDOC
## GET /products

### Description
Retrieves a list of your products.

### Method
GET

### Endpoint
`https://api.nitropagamentos.com/api/public/v1/products`

### Parameters
#### Query Parameters
- **api_token** (string) - Required - Your unique API token for authentication.

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **id** (string) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **price** (integer) - The price of the product in cents.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_123",
      "name": "Example Product",
      "price": 5000
    },
    {
      "id": "prod_456",
      "name": "Another Product",
      "price": 10000
    }
  ]
}
```
```

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

### Nitro API v1.0 - Balance Inquiry

Source: https://docs.nitropagamentos.com/index

Endpoint for checking your current account balance.

```APIDOC
## GET /balance

### Description
Retrieves your current account balance.

### Method
GET

### Endpoint
`https://api.nitropagamentos.com/api/public/v1/balance`

### Parameters
#### Query Parameters
- **api_token** (string) - Required - Your unique API token for authentication.

### Response
#### Success Response (200)
- **available_balance** (integer) - Your available balance in cents.

#### Response Example
```json
{
  "available_balance": 150000
}
```
```

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

### Nitro API v1.0 - Bank Account Registration

Source: https://docs.nitropagamentos.com/index

Endpoint for registering your bank account details for payouts.

```APIDOC
## POST /bank-accounts

### Description
Registers your bank account information for receiving payouts.

### Method
POST

### Endpoint
`https://api.nitropagamentos.com/api/public/v1/bank-accounts`

### Parameters
#### Query Parameters
- **api_token** (string) - Required - Your unique API token for authentication.

#### Request Body
- **bank_name** (string) - Required - The name of your bank.
- **account_number** (string) - Required - Your bank account number.
- **routing_number** (string) - Required - Your bank's routing number.
- **account_type** (string) - Required - Type of account (e.g., 'checking', 'savings').
- **pix_key** (string) - Optional - Your PIX key if applicable.

### Request Example
```json
{
  "bank_name": "Example Bank",
  "account_number": "123456789",
  "routing_number": "012345678",
  "account_type": "checking",
  "pix_key": "your_pix_key@example.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful registration.

#### Response Example
```json
{
  "message": "Bank account registered successfully."
}
```
```

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

### Nitro API v1.0 - Transaction Creation

Source: https://docs.nitropagamentos.com/index

Endpoint for creating new payment transactions. All monetary values should be in cents.

```APIDOC
## POST /transactions

### Description
Creates a new payment transaction.

### Method
POST

### Endpoint
`https://api.nitropagamentos.com/api/public/v1/transactions`

### Parameters
#### Query Parameters
- **api_token** (string) - Required - Your unique API token for authentication.

#### Request Body
- **amount** (integer) - Required - The transaction amount in cents.
- **payment_method** (string) - Required - The method of payment (e.g., 'pix', 'credit_card').
- **customer_details** (object) - Optional - Information about the customer.
  - **name** (string) - Required - Customer's full name.
  - **email** (string) - Required - Customer's email address.
  - **document** (string) - Optional - Customer's document number (CPF/CNPJ).

### Request Example
```json
{
  "amount": 15000,
  "payment_method": "pix",
  "customer_details": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "document": "12345678900"
  }
}
```

### Response
#### Success Response (200)
- **transaction_hash** (string) - The unique identifier for the transaction.
- **status** (string) - The current status of the transaction (e.g., 'pending', 'paid').
- **payment_url** (string) - A URL for completing the payment (if applicable).

#### Response Example
```json
{
  "transaction_hash": "abc123def456",
  "status": "pending",
  "payment_url": "https://pay.nitropagamentos.com/pay/abc123def456"
}
```
```
Tokens:
Raw