Payevo

https://payevov2.readme.io/reference
Admin
Payevo is a REST API payment processing platform that enables secure transaction creation,...
Tokens:20,690
Snippets:47
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### SDK Installation and Initialization

Source: https://payevov2.readme.io/reference/3d-secure-tokeniza%C3%A7%C3%A3o-de-cart%C3%A3o

Instructions on how to include the Payevo SDK script in your HTML and initialize it with your public key and environment settings.

```APIDOC
## SDK Installation and Initialization

### Description
Include the Payevo SDK script in the `<head>` section of your HTML and initialize it by setting your public key and choosing the environment (test or production).

### Method
JavaScript

### Endpoint
N/A

### Parameters
#### Global Configuration
- **publicKey** (string) - Required - Your unique Payevo public key.
- **testMode** (boolean) - Optional - Set to `true` for test environment, `false` for production. Defaults to `true`.

### Request Example
```html
<head>
    <script src="https://apiv2.payevo.com.br/functions/v1/js"></script>
</head>

<script>
    document.addEventListener('DOMContentLoaded', function() {
        Payevo.setPublicKey("sua_chave_publica");
        Payevo.setTestMode(true); // Use false for production
    });
</script>
```

### Response
N/A
```

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

### GET /company

Source: https://payevov2.readme.io/reference/dados-da-empresa

Retrieves general information about the company registered on the platform.

```APIDOC
## GET /company

### Description
Retrieves general information about the company registered on the platform.

### Method
GET

### Endpoint
https://apiv2.payevo.com.br/functions/v1/company

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - An object containing company details.

#### Response Example
```json
{
  "example": "{}"
}
```

#### Error Response (400)
- **(object)** - An object indicating an error.

#### Response Example
```json
{
  "example": "{}"
}
```
```

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

### Generate Card Token with Basic and Complete Data

Source: https://payevov2.readme.io/reference/3d-secure-tokeniza%C3%A7%C3%A3o-de-cart%C3%A3o

This JavaScript code demonstrates how to generate a secure token for card details using the Payevo SDK. It includes examples for both basic and complete card data, highlighting mandatory and optional fields like amount, currency, and address.

```javascript
/**
 * Information to generate the card token
 * 
 * Mandatory Fields:
 * - number: card number (digits only)
 * - holderName: cardholder name as it appears on the card
 * - expMonth: expiration month (2 digits)
 * - expYear: expiration year (4 digits)
 * - cvv: security code (3 to 4 digits)
 * - amount: amount in cents
 * 
 * Optional Fields:
 * - currency: currency (default: 'BRL')
 * - installments: number of installments (default: '01')
 * - address: customer address information
 */

// Basic example
const cardDataBasic = {
    number: "4000000000001091",
    holderName: "JOAO SILVA",
    expMonth: "12",
    expYear: "2025",
    cvv: "123",
    amount: 5000 // R$ 50.00
};

// Complete example
const cardDataComplete = {
    // Mandatory data
    number: "4000000000001091",
    holderName: "JOAO SILVA",
    expMonth: "12",
    expYear: "2025",
    cvv: "123",
    amount: 5000,
    
    // Optional
    currency: "BRL",
    installments: "01",

    // Address (optional)
    address: {
        street: "Rua Exemplo",
        complement: "Apto 123",
        city: "São Paulo",
        state: "SP",
        zipcode: "01234567",
        country: "BR",

        // Additional customer data
        name: "João da Silva",
        email: "joao@email.com",
        phone: "11999999999"
    }
};

// Tokenization
const tokenBasic = await Payevo.encrypt(cardDataBasic);
const tokenComplete = await Payevo.encrypt(cardDataComplete);
```

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

### Example Transaction Data (JSON)

Source: https://payevov2.readme.io/reference/listar-transacoes

This JSON snippet represents a typical transaction object within the Payevov2 system. It includes details about the customer, payment method (PIX in this case), items purchased, and associated fees. This data structure is crucial for understanding transaction payloads.

```json
{
    "id": "37b48adc-761c-4b5b-8057-79c07b25d864",
    "amount": 500,
    "refundedAmount": null,
    "companyId": "8e34bece-fed7-4b45-b725-effe6ddef895",
    "installments": 1,
    "paymentMethod": "PIX",
    "status": "waiting_payment",
    "postbackUrl": "https://webhook.site/2c212b7a-8e4a-4172-aef9-865778dc50e9",
    "metadata": "{}",
    "traceable": false,
    "createdAt": "2024-08-09T10:42:13.228-03:00",
    "updatedAt": "2024-08-09T10:42:13.228-03:00",
    "paidAt": null,
    "ip": "2121.123123.1123",
    "externalRef": "ch_dYBxvR1OUxTnP9Mq",
    "customer": {
      "id": "e60597e0-a9c1-4d91-af5f-0b50a48a6383",
      "name": "Lucas",
      "email": "lucas@gmail.com",
      "phone": "11991301328",
      "birthdate": null,
      "createdAt": "2024-08-09T10:42:12.437566",
      "document": {
        "number": "49257810810",
        "type": "CPF"
      },
      "address": {
        "street": "Rua alcides cardoso treme 165",
        "streetNumber": "165",
        "complement": "casa",
        "zipCode": "15045464",
        "neighborhood": "Ana Celia",
        "city": "Sao jose do rio Preto",
        "state": "SP",
        "country": "BR"
      }
    },
    "card": null,
    "boleto": null,
    "pix": {
      "qrcode": "https://digital.mundipagg.com/pix/",
      "expirationDate": "2024-08-09T11:02:13.228-03:00",
      "end2EndId": null,
      "receiptUrl": null
    },
    "shipping": {
      "street": "Rua alcides cardoso treme 165",
      "streetNumber": "165",
      "complement": "casa",
      "zipCode": "15045464",
      "neighborhood": "Ana Celia",
      "city": "Sao jose do rio Preto",
      "state": "SP",
      "country": "BR"
    },
    "refusedReason": null,
    "items": [
      {
        "title": "Teste 2",
        "quantity": 1
      }
    ],
    "splits": [
      {
        "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
        "netAmount": 200
      }
    ],
    "fee": {
      "fixedAmount": 3,
      "spreadPercentage": 3,
      "estimatedFee": 300,
      "netAmount": 200
    }
  }
```

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

### Pix Transaction Response Example (JSON)

Source: https://payevov2.readme.io/reference/criar-transa%C3%A7%C3%A3o

This JSON object represents a successful Pix transaction response. It includes transaction details, customer information, and Pix-specific data like the QR code and expiration date. This is useful for verifying transaction status and retrieving payment details.

```json
{
  "id": "c856345e-23d6-471d-bb7e-75dfe340c26d",
  "amount": 500,
  "refundedAmount": 0,
  "companyId": "8e34bece-fed7-4b45-b725-effe6ddef895",
  "installments": 1,
  "paymentMethod": "PIX",
  "status": "waiting_payment",
  "postbackUrl": null,
  "metadata": "{}",
  "traceable": false,
  "createdAt": "2024-08-09T10:51:07.144-03:00",
  "updatedAt": "2024-08-09T10:51:07.144-03:00",
  "paidAt": null,
  "ip": "2121.123123.1123",
  "externalRef": "ch_GnOkRWjS0cN06P29",
  "customer": {
    "id": "4efd19a3-cace-4036-abee-d57fb7260f65",
    "name": "teste",
    "email": "teste@gmail.com",
    "phone": "11991301322",
    "birthdate": null,
    "createdAt": "2024-08-09T10:51:06.691107",
    "document": {
      "number": "59801246081",
      "type": "CPF"
    },
    "address": {
      "street": "Rua São Jorge",
      "streetNumber": "165",
      "complement": "casa",
      "zipCode": "65076632",
      "neighborhood": "Ilhinha",
      "city": "São Luís",
      "state": "MA",
      "country": "BR"
    }
  },
  "card": null,
  "boleto": null,
  "pix": {
    "qrcode": "https://digital.mundipagg.com/pix/",
    "expirationDate": "2024-08-09T11:11:07.144-03:00",
    "end2EndId": null,
    "receiptUrl": null
  },
  "shipping": {
    "street": "Rua São Jorge",
    "streetNumber": "165",
    "complement": "casa",
    "zipCode": "65076632",
    "neighborhood": "Ilhinha",
    "city": "São Luís",
    "state": "MA",
    "country": "BR"
  },
  "refusedReason": null,
  "items": [
    {
      "title": "Teste 2",
      "quantity": 1
    }
  ],
  "splits": [
    {
      "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
      "netAmount": 200
    }
  ],
  "fee": {
    "fixedAmount": 3,
    "spreadPercentage": 3,
    "estimatedFee": 300,
    "netAmount": 200
  }
}
```

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

### GET /transactions

Source: https://payevov2.readme.io/reference/listar-transacoes

Retrieves a list of all registered transactions. This endpoint supports filtering by status and date range, as well as pagination and sorting.

```APIDOC
## GET /transactions

### Description
Permite obter uma lista de todas as transações registradas, com possibilidade de filtragem por status e período.

### Method
GET

### Endpoint
https://apiv2.payevo.com.br/functions/v1/transactions

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items per page. Defaults to 10.
- **status** (string) - Optional - Filter transactions by their status.
- **sortOrder** (string) - Optional - The order in which to sort the results. Defaults to 'desc'.
- **startDate** (string) - Optional - Filter transactions starting from this date (ISO 8601 format).
- **endDate** (string) - Optional - Filter transactions up to this date (ISO 8601 format).

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the transaction.
- **amount** (integer) - The total amount of the transaction.
- **refundedAmount** (integer) - The amount that has been refunded.
- **companyId** (string) - The ID of the company associated with the transaction.
- **installments** (integer) - The number of installments for the payment.
- **paymentMethod** (string) - The method used for payment (e.g., 'BOLETO', 'PIX', 'CREDIT_CARD').
- **status** (string) - The current status of the transaction (e.g., 'waiting_payment', 'paid', 'refunded').
- **postbackUrl** (string) - The URL to send postback notifications to.
- **metadata** (string) - Additional metadata associated with the transaction.
- **traceable** (boolean) - Indicates if the transaction is traceable.
- **createdAt** (string) - The date and time when the transaction was created (ISO 8601 format).
- **updatedAt** (string) - The date and time when the transaction was last updated (ISO 8601 format).
- **paidAt** (string) - The date and time when the transaction was paid (ISO 8601 format).
- **ip** (string) - The IP address from which the transaction was initiated.
- **externalRef** (string) - An external reference ID for the transaction.
- **customer** (object) - Details about the customer making the transaction.
- **card** (object) - Details about the credit card used, if applicable.
- **boleto** (object) - Details about the boleto payment, if applicable.
- **pix** (object) - Details about the Pix payment, if applicable.
- **shipping** (object) - Shipping details for the transaction.
- **refusedReason** (string) - The reason why the transaction was refused, if applicable.
- **items** (array) - A list of items included in the transaction.
- **splits** (array) - Information about transaction splits, if any.
- **fee** (object) - Details about the transaction fees.

#### Response Example
```json
{
  "example": [
    {
      "id": "939085a7-2685-4750-ada7-075b5e689bf6",
      "amount": 500,
      "refundedAmount": null,
      "companyId": "8e34bece-fed7-4b45-b725-effe6ddef895",
      "installments": 1,
      "paymentMethod": "BOLETO",
      "status": "waiting_payment",
      "postbackUrl": null,
      "metadata": "{}",
      "traceable": false,
      "createdAt": "2024-08-09T10:54:16.018-03:00",
      "updatedAt": "2024-08-09T10:54:16.018-03:00",
      "paidAt": null,
      "ip": "2121.123123.1123",
      "externalRef": "ch_VObkjxCg6hXE4M7D",
      "customer": {
        "id": "25381a22-c26a-472a-9e14-1bb5c8192193",
        "name": "teste",
        "email": "teste@gmail.com",
        "phone": "11991301322",
        "birthdate": null,
        "createdAt": "2024-08-09T10:54:15.914201",
        "document": {
          "number": "59801246081",
          "type": "CPF"
        },
        "address": {
          "street": "Rua São Jorge",
          "streetNumber": "165",
          "complement": "casa",
          "zipCode": "65076632",
          "neighborhood": "Ilhinha",
          "city": "São Luís",
          "state": "MA",
          "country": "BR"
        }
      },
      "card": null,
      "boleto": {
        "bankSlipUrl": "https://pagar.me?format=pdf",
        "digitableLine": "1234 5678",
        "barcode": "https://api.pagar.me/core/v5/transactions/tran_RzOXoY8hmviML7Lo/barcode"
      },
      "pix": null,
      "shipping": {
        "street": "Rua São Jorge",
        "streetNumber": "165",
        "complement": "casa",
        "zipCode": "65076632",
        "neighborhood": "Ilhinha",
        "city": "São Luís",
        "state": "MA",
        "country": "BR"
      },
      "refusedReason": null,
      "items": [
        {
          "title": "Teste 2",
          "quantity": 1
        }
      ],
      "splits": [
        {
          "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
          "netAmount": 200
        }
      ],
      "fee": {
        "fixedAmount": 3,
        "spreadPercentage": 3,
        "estimatedFee": 300,
        "netAmount": 200
      }
    }
  ]
}
```
```

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

### OpenAPI Definition for Payevo API

Source: https://payevov2.readme.io/reference/buscar-transa%C3%A7%C3%A3o

This JSON snippet represents the OpenAPI 3.1.0 definition for the Payevo API. It includes API information, server URLs, security schemes (basic HTTP authentication), and details for the '/transactions/{id}' GET endpoint, which allows fetching transaction details.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Payevo",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://apiv2.payevo.com.br/functions/v1/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/transactions/{id}": {
      "get": {
        "summary": "Buscar transação",
        "description": "Permite recuperar informações sobre transações realizadas. Você pode listar todas as transações ou buscar uma específica informando seu ID. Também é possível filtrar por status e intervalo de datas.",
        "operationId": "buscar-transação",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID da transação.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": \"07d789c9-e25d-4201-bd22-b5fc94ac3380\",\n  \"amount\": 500,\n  \"refundedAmount\": null,\n  \"companyId\": \"8e34bece-fed7-4b45-b725-effe6ddef895\",\n  \"installments\": 1,\n  \"paymentMethod\": \"PIX\",\n  \"status\": \"paid\",\n  \"postbackUrl\": null,\n  \"metadata\": \"{}\",\n  \"traceable\": false,\n  \"createdAt\": \"2024-08-09T10:46:16.547-03:00\",\n  \"updatedAt\": \"2024-08-09T10:46:16.547-03:00\",\n  \"paidAt\": \"2024-08-09T10:46:17.361-03:00\",\n  \"ip\": \"2121.123123.1123\",\n  \"externalRef\": \"ch_GqD6RPFAWijlJ27k\",\n  \"customer\": {\n    \"id\": \"321dcfec-31a9-450b-8e3a-9a751ced577f\",\n    \"name\": \"Lucas\",\n    \"email\": \"lucas@gmail.com\",\n    \"phone\": \"11991301328\",\n    \"birthdate\": null,\n    \"createdAt\": \"2024-08-09T10:46:16.246848\",\n    \"document\": {\n      \"number\": \"49257810810\",\n      \"type\": \"CPF\"\n    },\n    \"address\": {\n      \"street\": \"Rua alcides cardoso treme 165\",\n      \"streetNumber\": \"165\",\n      \"complement\": \"casa\",\n      \"zipCode\": \"15045464\",\n      \"neighborhood\": \"Ana Celia\",\n      \"city\": \"Sao jose do rio Preto\",\n      \"state\": \"SP\",\n      \"country\": \"BR\"\n    }\n  },\n  \"card\": null,\n  \"boleto\": null,\n  \"pix\": {\n    \"qrcode\": \"https://digital.mundipagg.com/pix/\",\n    \"expirationDate\": \"2024-08-09T11:06:16.547-03:00\",\n    \"end2EndId\": \"E12345678202009091221abcdef12345\",\n    \"receiptUrl\": null\n  },\n  \"shipping\": {\n    \"street\": \"Rua alcides cardoso treme 165\",\n    \"streetNumber\": \"165\",\n    \"complement\": \"casa\",\n    \"zipCode\": \"15045464\",\n    \"neighborhood\": \"Ana Celia\",\n    \"city\": \"Sao jose do rio Preto\",\n    \"state\": \"SP\",\n    \"country\": \"BR\"\n  },\n  \"refusedReason\": null,\n  \"items\": [\n    {\n      \"title\": \"Teste 2\",\n      \"quantity\": 1\n    }\n  ],\n  \"splits\": [\n    {\n      \"recipientId\": \"909c81fe-0511-442c-b2a8-ca06b0fd8042\",\n      \"netAmount\": 200\n    }\n  ],\n  \"fee\": {\n    \"fixedAmount\": 3,\n    \"spreadPercentage\": 3,\n    \"estimatedFee\": 300,\n    \"netAmount\": 200\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "07d789c9-e25d-4201-bd22-b5fc94ac3380"
                    },
                    "amount": {
                      "type": "integer",
                      "example": 500,
                      "default": 0
                    },
                    "refundedAmount": {},
                    "companyId": {
                      "type": "string",
                      "example": "8e34bece-fed7-4b45-b725-effe6ddef895"
                    },
                    "installments": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "paymentMethod": {
                      "type": "string",
                      "example": "PIX"
                    },
                    "status": {
                      "type": "string",
                      "example": "paid"
                    },
                    "postbackUrl": {},
                    "metadata": {
                      "type": "string",
                      "example": "{}"
                    },
                    "traceable": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "createdAt": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### GET /balance

Source: https://payevov2.readme.io/reference/financeiro

Retrieves the available balance and reservation information.

```APIDOC
## GET /balance

### Description
Retrieves the available balance and reservation information.

### Method
GET

### Endpoint
/balance

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - An object containing balance and reservation details.

#### Response Example
```json
{}
```

#### Error Response (400)
- **(object)** - An object containing error details.

#### Response Example
```json
{}
```
```

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

### Configure Payevo SDK with Public Key and Environment

Source: https://payevov2.readme.io/reference/3d-secure-tokeniza%C3%A7%C3%A3o-de-cart%C3%A3o

This JavaScript code configures the Payevo SDK upon page load. It sets the public key required for client-side operations and specifies whether to use the test or production environment.

```javascript
// Execute as soon as the page is ready
document.addEventListener('DOMContentLoaded', function() {
    // Set your public key
    Payevo.setPublicKey("your_public_key");

    // Choose the environment
    Payevo.setTestMode(true); // in production, change to false
});
```

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

### POST /websites/payevov2_readme_io_reference

Source: https://payevov2.readme.io/reference/criar-transa%C3%A7%C3%A3o

This endpoint is used to create a new transaction, supporting payment methods like Pix and credit card.

```APIDOC
## POST /websites/payevov2_readme_io_reference

### Description
This endpoint allows for the creation of new transactions, with support for various payment methods such as Pix and credit card. It handles details like amount, customer information, and postback URLs.

### Method
POST

### Endpoint
/websites/payevov2_readme_io_reference

### Parameters
#### Request Body
- **amount** (integer) - Required - The transaction amount.
- **recipient_id** (string) - Required - The ID of the recipient for the transaction.
- **postbackUrl** (string) - Optional - The URL to receive transaction updates.
- **metadata** (string) - Optional - Additional information for the transaction.
- **ip** (string) - Optional - The IP address of the client. Defaults to "213.123.123.13".
- **description** (string) - Optional - A description for the transaction.
- **customer** (object) - Required - Customer details.
  - **name** (string) - Required - Customer's name.
  - **email** (string) - Required - Customer's email address.
  - **phone** (string) - Required - Customer's phone number.
  - **document** (object) - Required - Customer's document details.
    - **number** (string) - Required - Document number.
    - **type** (string) - Required - Document type (e.g., "CPF").
  - **address** (object) - Required - Customer's address details.
    - **street** (string) - Required - Street name.
    - **streetNumber** (string) - Required - Street number.
    - **complement** (string) - Optional - Complementary address information.
    - **zipCode** (string) - Required - Zip code.
    - **neighborhood** (string) - Required - Neighborhood.
    - **city** (string) - Required - City.
    - **state** (string) - Required - State.
    - **country** (string) - Required - Country.
- **items** (array) - Optional - List of items in the transaction.
  - **title** (string) - Required - Item title.
  - **quantity** (integer) - Required - Item quantity.
- **splits** (array) - Optional - Transaction splits for recipients.
  - **recipientId** (string) - Required - The ID of the recipient for the split.
  - **netAmount** (integer) - Required - The net amount for the split.

### Request Example
```json
{
  "amount": 500,
  "recipient_id": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
  "postbackUrl": "https://your-api.com/webhook",
  "metadata": "some data",
  "ip": "212.123.123.13",
  "description": "Test transaction",
  "customer": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "11991301322",
    "document": {
      "number": "59801246081",
      "type": "CPF"
    },
    "address": {
      "street": "Rua São Jorge",
      "streetNumber": "165",
      "complement": "casa",
      "zipCode": "65076632",
      "neighborhood": "Ilhinha",
      "city": "São Luís",
      "state": "MA",
      "country": "BR"
    }
  },
  "items": [
    {
      "title": "Product A",
      "quantity": 1
    }
  ],
  "splits": [
    {
      "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
      "netAmount": 200
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique transaction identifier.
- **amount** (integer) - The transaction amount.
- **refundedAmount** (integer) - The amount that has been refunded.
- **companyId** (string) - The ID of the company associated with the transaction.
- **installments** (integer) - Number of installments.
- **paymentMethod** (string) - The payment method used (e.g., "PIX").
- **status** (string) - The current status of the transaction (e.g., "waiting_payment").
- **postbackUrl** (string) - The URL for transaction updates.
- **metadata** (string) - Additional information.
- **traceable** (boolean) - Indicates if the transaction is traceable.
- **createdAt** (string) - Timestamp of creation.
- **updatedAt** (string) - Timestamp of last update.
- **paidAt** (string) - Timestamp when the payment was made.
- **ip** (string) - IP address used for the transaction.
- **externalRef** (string) - External reference ID.
- **customer** (object) - Customer details.
- **card** (object) - Card details (if applicable).
- **boleto** (object) - Boleto details (if applicable).
- **pix** (object) - Pix details (if applicable).
  - **qrcode** (string) - Pix QR code URL.
  - **expirationDate** (string) - Pix expiration date.
  - **end2EndId** (string) - Pix End-to-End ID.
  - **receiptUrl** (string) - Pix receipt URL.
- **shipping** (object) - Shipping details.
- **refusedReason** (string) - Reason for refusal (if applicable).
- **items** (array) - List of items.
- **splits** (array) - Transaction splits.
- **fee** (object) - Transaction fee details.
  - **fixedAmount** (integer) - Fixed fee amount.
  - **spreadPercentage** (integer) - Spread percentage.
  - **estimatedFee** (integer) - Estimated fee.
  - **netAmount** (integer) - Net fee amount.

#### Response Example
```json
{
  "id": "c856345e-23d6-471d-bb7e-75dfe340c26d",
  "amount": 500,
  "refundedAmount": 0,
  "companyId": "8e34bece-fed7-4b45-b725-effe6ddef895",
  "installments": 1,
  "paymentMethod": "PIX",
  "status": "waiting_payment",
  "postbackUrl": null,
  "metadata": "{}",
  "traceable": false,
  "createdAt": "2024-08-09T10:51:07.144-03:00",
  "updatedAt": "2024-08-09T10:51:07.144-03:00",
  "paidAt": null,
  "ip": "2121.123123.1123",
  "externalRef": "ch_GnOkRWjS0cN06P29",
  "customer": {
    "id": "4efd19a3-cace-4036-abee-d57fb7260f65",
    "name": "teste",
    "email": "teste@gmail.com",
    "phone": "11991301322",
    "birthdate": null,
    "createdAt": "2024-08-09T10:51:06.691107",
    "document": {
      "number": "59801246081",
      "type": "CPF"
    },
    "address": {
      "street": "Rua São Jorge",
      "streetNumber": "165",
      "complement": "casa",
      "zipCode": "65076632",
      "neighborhood": "Ilhinha",
      "city": "São Luís",
      "state": "MA",
      "country": "BR"
    }
  },
  "card": null,
  "boleto": null,
  "pix": {
    "qrcode": "https://digital.mundipagg.com/pix/",
    "expirationDate": "2024-08-09T11:11:07.144-03:00",
    "end2EndId": null,
    "receiptUrl": null
  },
  "shipping": {
    "street": "Rua São Jorge",
    "streetNumber": "165",
    "complement": "casa",
    "zipCode": "65076632",
    "neighborhood": "Ilhinha",
    "city": "São Luís",
    "state": "MA",
    "country": "BR"
  },
  "refusedReason": null,
  "items": [
    {
      "title": "Teste 2",
      "quantity": 1
    }
  ],
  "splits": [
    {
      "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
      "netAmount": 200
    }
  ],
  "fee": {
    "fixedAmount": 3,
    "spreadPercentage": 3,
    "estimatedFee": 300,
    "netAmount": 200
  }
}
```
```

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

### GET /transactions/{id}

Source: https://payevov2.readme.io/reference/buscar-transa%C3%A7%C3%A3o

Retrieve information about a specific transaction using its ID. This endpoint allows you to fetch detailed data for a single transaction.

```APIDOC
## GET /transactions/{id}

### Description
Allows retrieving information about transactions made. You can list all transactions or search for a specific one by providing its ID.

### Method
GET

### Endpoint
https://apiv2.payevo.com.br/functions/v1/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID of the transaction.

### Request Example
```json
{
  "example": "No request body needed for GET request."
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the transaction.
- **amount** (integer) - The total amount of the transaction.
- **refundedAmount** (any) - The amount that has been refunded, if applicable.
- **companyId** (string) - The identifier of the company associated with the transaction.
- **installments** (integer) - The number of installments for the payment.
- **paymentMethod** (string) - The method used for the payment (e.g., "PIX").
- **status** (string) - The current status of the transaction (e.g., "paid").
- **postbackUrl** (any) - The URL for postback notifications, if configured.
- **metadata** (string) - Additional metadata associated with the transaction.
- **traceable** (boolean) - Indicates if the transaction is traceable.
- **createdAt** (string) - The timestamp when the transaction was created.
- **updatedAt** (string) - The timestamp when the transaction was last updated.
- **paidAt** (string) - The timestamp when the transaction was paid.
- **ip** (string) - The IP address from which the transaction was initiated.
- **externalRef** (string) - An external reference identifier for the transaction.
- **customer** (object) - Details about the customer making the transaction.
  - **id** (string) - Customer's unique identifier.
  - **name** (string) - Customer's name.
  - **email** (string) - Customer's email address.
  - **phone** (string) - Customer's phone number.
  - **birthdate** (any) - Customer's date of birth.
  - **createdAt** (string) - Timestamp when the customer was created.
  - **document** (object) - Customer's identification document details.
    - **number** (string) - Document number.
    - **type** (string) - Document type (e.g., "CPF").
  - **address** (object) - Customer's address details.
    - **street** (string) - Street name.
    - **streetNumber** (string) - Street number.
    - **complement** (string) - Address complement.
    - **zipCode** (string) - Postal code.
    - **neighborhood** (string) - Neighborhood.
    - **city** (string) - City.
    - **state** (string) - State.
    - **country** (string) - Country.
- **card** (any) - Details about the card used, if applicable.
- **boleto** (any) - Details about the boleto, if applicable.
- **pix** (object) - Details about the PIX payment, if applicable.
  - **qrcode** (string) - The PIX QR code URL.
  - **expirationDate** (string) - The expiration date for the PIX payment.
  - **end2EndId** (string) - The end-to-end ID for the PIX transaction.
  - **receiptUrl** (any) - URL for the PIX receipt.
- **shipping** (object) - Shipping details for the order.
  - **street** (string) - Street name.
  - **streetNumber** (string) - Street number.
  - **complement** (string) - Address complement.
  - **zipCode** (string) - Postal code.
  - **neighborhood** (string) - Neighborhood.
  - **city** (string) - City.
  - **state** (string) - State.
  - **country** (string) - Country.
- **refusedReason** (any) - Reason for transaction refusal, if applicable.
- **items** (array) - List of items included in the transaction.
  - **title** (string) - Item title.
  - **quantity** (integer) - Quantity of the item.
- **splits** (array) - Details about transaction splits.
  - **recipientId** (string) - ID of the recipient.
  - **netAmount** (integer) - Net amount for the split.
- **fee** (object) - Fee details for the transaction.
  - **fixedAmount** (integer) - Fixed fee amount.
  - **spreadPercentage** (integer) - Percentage spread for the fee.
  - **estimatedFee** (integer) - Estimated fee amount.
  - **netAmount** (integer) - Net amount after fees.

#### Response Example
```json
{
  "id": "07d789c9-e25d-4201-bd22-b5fc94ac3380",
  "amount": 500,
  "refundedAmount": null,
  "companyId": "8e34bece-fed7-4b45-b725-effe6ddef895",
  "installments": 1,
  "paymentMethod": "PIX",
  "status": "paid",
  "postbackUrl": null,
  "metadata": "{}",
  "traceable": false,
  "createdAt": "2024-08-09T10:46:16.547-03:00",
  "updatedAt": "2024-08-09T10:46:16.547-03:00",
  "paidAt": "2024-08-09T10:46:17.361-03:00",
  "ip": "2121.123123.1123",
  "externalRef": "ch_GqD6RPFAWijlJ27k",
  "customer": {
    "id": "321dcfec-31a9-450b-8e3a-9a751ced577f",
    "name": "Lucas",
    "email": "lucas@gmail.com",
    "phone": "11991301328",
    "birthdate": null,
    "createdAt": "2024-08-09T10:46:16.246848",
    "document": {
      "number": "49257810810",
      "type": "CPF"
    },
    "address": {
      "street": "Rua alcides cardoso treme 165",
      "streetNumber": "165",
      "complement": "casa",
      "zipCode": "15045464",
      "neighborhood": "Ana Celia",
      "city": "Sao jose do rio Preto",
      "state": "SP",
      "country": "BR"
    }
  },
  "card": null,
  "boleto": null,
  "pix": {
    "qrcode": "https://digital.mundipagg.com/pix/",
    "expirationDate": "2024-08-09T11:06:16.547-03:00",
    "end2EndId": "E12345678202009091221abcdef12345",
    "receiptUrl": null
  },
  "shipping": {
    "street": "Rua alcides cardoso treme 165",
    "streetNumber": "165",
    "complement": "casa",
    "zipCode": "15045464",
    "neighborhood": "Ana Celia",
    "city": "Sao jose do rio Preto",
    "state": "SP",
    "country": "BR"
  },
  "refusedReason": null,
  "items": [
    {
      "title": "Teste 2",
      "quantity": 1
    }
  ],
  "splits": [
    {
      "recipientId": "909c81fe-0511-442c-b2a8-ca06b0fd8042",
      "netAmount": 200
    }
  ],
  "fee": {
    "fixedAmount": 3,
    "spreadPercentage": 3,
    "estimatedFee": 300,
    "netAmount": 200
  }
}
```
```
Tokens:
Raw