### Webhook Implementation Example

Source: https://app.valorion.com.br/documentacao

This example illustrates how to set up a webhook to receive and process transaction notifications.

```APIDOC
## Webhook Implementation Example

### Description
This PHP script demonstrates how to receive and process incoming webhook data for transaction notifications. It identifies transaction types (deposit or withdrawal) based on the presence of specific fields in the JSON payload.

### Method
POST

### Endpoint
`/webhook` (This is a conceptual endpoint for the script)

### Parameters
#### Request Body
- **`data`** (string) - The raw JSON payload received from the webhook.

### Request Example (Deposit)
```json
{
  "id": "5437946",
  "user_id": "userName",
  "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
  "amount": 7,
  "client_name": "Isaias da Fonseca Quintanilha",
  "client_document": "29048225850",
  "client_email": "isaiasquintanilha@gmail.com",
  "data_registro": "2025-11-17 12:55:04",
  "status": "PAID_OUT",
  "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
  "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
  "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
  "deposito_liquido": "6.16",
  "data_med": null,
  "urlcallback": "https://seusite.com/webhook",
  "endToEnd": "E10573521202511171854PqYZrNJIkMg",
  "provider": "syefy"
}
```

### Request Example (Withdrawal)
```json
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "COMPLETED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}
```

### Response
#### Success Response (200)
- **`status`** (string) - Indicates the processing status ('success' or 'error').
- **`message`** (string) - A message describing the outcome of the webhook processing.

#### Response Example
```json
{
  "status": "success",
  "message": "Depósito recebido com sucesso."
}
```

#### Error Response (400)
- **`status`** (string) - Indicates the processing status ('error').
- **`message`** (string) - A message describing the error.

#### Error Response Example
```json
{
  "status": "error",
  "message": "Dados inválidos."
}
```
```

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

### Query Postback Examples API

Source: https://app.valorion.com.br/documentacao

This endpoint allows you to query examples of webhooks sent by Valorion.

```APIDOC
## GET /api/s1/getPostBackExamples/

### Description
This endpoint allows you to query examples of webhooks sent by Valorion. It is used to retrieve sample data for various transaction statuses and types.

### Method
GET

### Endpoint
`https://app.valorion.com.br/api/s1/getPostBackExamples/`

### Parameters
#### Query Parameters
None

#### Path Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET \
  https://app.valorion.com.br/api/s1/getPostBackExamples/ \
  -H 'Authorization: Basic {API_KEY}' \
  -H 'content-type: application/json'
```

### Authentication
Requires an `Authorization` header with your API key encoded in Base64.

- **Header**: `Authorization: Basic {API_KEY}`
- **Header**: `content-type: application/json`

Replace `{API_KEY}` with your actual Base64 encoded API key.

### Response
#### Success Response (200)
Returns a JSON object containing examples of postback data. The structure of the examples may vary depending on the transaction type and status.

#### Response Example (Illustrative - actual response may contain different examples)
```json
{
  "cash_in_paid": {
    "id": "5437946",
    "user_id": "userName",
    "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
    "amount": 7,
    "client_name": "Isaias da Fonseca Quintanilha",
    "client_document": "29048225850",
    "client_email": "isaiasquintanilha@gmail.com",
    "data_registro": "2025-11-17 12:55:04",
    "status": "PAID_OUT",
    "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
    "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
    "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
    "deposito_liquido": "6.16",
    "data_med": null,
    "urlcallback": "https://seusite.com/webhook",
    "endToEnd": "E10573521202511171854PqYZrNJIkMg",
    "provider": "syefy"
  },
  "cash_in_refund": {
    "id": "5437946",
    "user_id": "userName",
    "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
    "amount": 7,
    "client_name": "Isaias da Fonseca Quintanilha",
    "client_document": "29048225850",
    "client_email": "isaiasquintanilha@gmail.com",
    "data_registro": "2025-11-17 12:55:04",
    "status": "MED",
    "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
    "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
    "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
    "deposito_liquido": "6.16",
    "data_med": null,
    "urlcallback": "https://seusite.com/webhook",
    "endToEnd": "E10573521202511171854PqYZrNJIkMg",
    "provider": "syefy"
  },
  "cash_out_completed": {
    "id": "14517",
    "user_id": "userName",
    "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
    "amount": 10.03,
    "beneficiary_name": "Lucas",
    "beneficiary_document": "12345678900",
    "data_registro": "2025-11-17 12:58:15",
    "status": "COMPLETED",
    "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
    "deposito_liquido": "5.03",
    "taxa_cash_out": 5,
    "urlcallback": "https://seusite.com/webhook",
    "provider": "syefy_valorion",
    "kind": "cash_out"
  },
  "cash_out_failed": {
    "id": "14517",
    "user_id": "userName",
    "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
    "amount": 10.03,
    "beneficiary_name": "Lucas",
    "beneficiary_document": "12345678900",
    "data_registro": "2025-11-17 12:58:15",
    "status": "FAILED",
    "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
    "deposito_liquido": "5.03",
    "taxa_cash_out": 5,
    "urlcallback": "https://seusite.com/webhook",
    "provider": "syefy_valorion",
    "kind": "cash_out"
  }
}
```

#### Error Response (401)
- **`error`** (string) - Description of the authentication error.

#### Error Response Example
```json
{
  "error": "Authentication failed. Invalid API Key."
}
```
```

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

### CashIn Webhook Examples (PAID, REFUND)

Source: https://app.valorion.com.br/documentacao

These JSON examples illustrate the structure of webhook payloads for CashIn transactions. The 'PAID' example includes details for a successful deposit with a payment code, while the 'REFUND' example shows a transaction status indicating a refund or processing.

```json
{
  "id": "5437946",
  "user_id": "userName",
  "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
  "amount": 7,
  "client_name": "Isaias da Fonseca Quintanilha",
  "client_document": "29048225850",
  "client_email": "isaiasquintanilha@gmail.com",
  "data_registro": "2025-11-17 12:55:04",
  "status": "PAID_OUT",
  "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
  "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
  "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
  "deposito_liquido": "6.16",
  "data_med": null,
  "urlcallback": "https://seusite.com/webhook",
  "endToEnd": "E10573521202511171854PqYZrNJIkMg",
  "provider": "syefy"
}

```

```json
{
  "id": "5437946",
  "user_id": "userName",
  "externalreference": "eed9977b-027d-4dd1-87b7-cd4cbde00605",
  "amount": 7,
  "client_name": "Isaias da Fonseca Quintanilha",
  "client_document": "29048225850",
  "client_email": "isaiasquintanilha@gmail.com",
  "data_registro": "2025-11-17 12:55:04",
  "status": "MED",
  "idtransaction": "9dec1400-530c-4b31-a659-dc276a020761",
  "paymentcode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/a424b66b-f69d-4b9d-9f06-d038aec896945204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***6304B9B7",
  "paymentCodeBase64": "MDAwMjAxMDEwMjEyMjY4MjAwMTRici5nb3YuYmNiLnBpeDI1NjBxcmNvZGUucGFnc20uY29tLmJyL3BpeC9hNDI0YjY2Yi1mNjlkLTRiOWQtOWYwNi1kMDM4YWVjODk2OTQ1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTE0NTUuMjAyLjg1NUxUREE2MDA4U2FvUGF1bG82MjA3MDUwMyoqKjYzMDRCOUI3",
  "deposito_liquido": "6.16",
  "data_med": null,
  "urlcallback": "https://seusite.com/webhook",
  "endToEnd": "E10573521202511171854PqYZrNJIkMg",
  "provider": "syefy"
}

```

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

### CashOut Webhook Examples (COMPLETED, FAILED, CANCELED)

Source: https://app.valorion.com.br/documentacao

These JSON examples demonstrate the webhook payload structure for CashOut transactions. They cover successful completion ('COMPLETED') and failure scenarios ('FAILED', 'CANCELED'), including details about the beneficiary and transaction amounts.

```json
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "COMPLETED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}

```

```json
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "FAILED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}

```

```json
{
  "id": "14517",
  "user_id": "userName",
  "externalreference": "96df6b40-9ecb-4094-83a2-7235832041fb",
  "amount": 10.03,
  "beneficiary_name": "Lucas",
  "beneficiary_document": "12345678900",
  "data_registro": "2025-11-17 12:58:15",
  "status": "CANCELED",
  "idtransaction": "49696632-51c7-4764-9b8c-966cf3bbd87b",
  "deposito_liquido": "5.03",
  "taxa_cash_out": 5,
  "urlcallback": "https://seusite.com/webhook",
  "provider": "syefy_valorion",
  "kind": "cash_out"
}

```

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

### Example JSON Response for Valorion BR API

Source: https://app.valorion.com.br/documentacao

Provides example JSON payloads for different webhook events in the Valorion BR API. These examples illustrate the structure and data fields for CashIn, CashOut, and Refund operations, including transaction details, amounts, and status.

```json
{
    "CashIn": {
        "description": "Webhook enviado quando um depósito via Pix é realizado.",
        "example": {
            "id": 12345,
            "user_id": "Bruno_dev",
            "externalreference": "GWuXrEH6oIaEg094WUDVz235xPAJ49Zf",
            "amount": 50,
            "client_name": "João Silva",
            "client_document": "{PIX_KEY}",
            "client_email": "joao@email.com",
            "data_registro": "2024-03-01 14:30:00",
            "adquirente_ref": "voluti",
            "status": "PAID_OUT",
            "idtransaction": "029d53e0454d0d9804babbf2f01195",
            "paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/abfef891-41b2-45d6-b9ba-66d442b290b65204000053039865802BR5924SYNC_PAY_PAGAMENTOS_LTDA6009NOVO_GAMA62070503***6304DC16",
            "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9hYmZlZjg5MS00MWIyLTQ1ZDYtYjliYS02NmQ0NDJiMjkwYjY1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI0U1lOQ19QQVlfUEFHQU1FTlRPU19MVERBNjAwOU5PVk9fR0FNQTYyMDcwNTAzKioqNjMwNERDMTY=",
            "taxa_deposito": 7,
            "taxa_adquirente": 0.49,
            "deposito_liquido": 46.5
        }
    },
    "CashOut": {
        "description": "Webhook enviado quando uma retirada via Pix é realizada.",
        "example": {
            "id": 54321,
            "user_id": "Bruno_dev",
            "externalreference": "SJW1SoDDNnwvTOPzwGzIctXvK6hnX5vt",
            "amount": 200.75,
            "beneficiaryname": "Maria Oliveira",
            "beneficiarydocument": "98765432100",
            "pix": "maria@email.com",
            "type": "",
            "pixkey": "maria@email.com",
            "date": "2024-03-02 10:15:00",
            "status": "COMPLETED",
            "idtransaction": "E3038525920250122232856607a71d96",
            "taxa_cash_out": 2,
            "cash_out_liquido": 196.73,
            "dt_atualizacao": "2024-03-02 10:16:00"
        }
    },
    "Refund": {
        "description": "Webhook enviado quando um reembolso via Pix é processado.",
        "example": {
            "id": 12345,
            "user_id": "Bruno_dev",
            "externalreference": "GWuXrEH6oIaEg094WUDVz235xPAJ49Zf",
            "amount": 50,
            "client_name": "João Silva",
            "client_document": "{PIX_KEY}",
            "client_email": "joao@email.com",
            "data_registro": "2024-03-01 14:30:00",
            "adquirente_ref": "voluti",
            "status": "MED",
            "idtransaction": "029d53e0454d0d9804babbf2f01195",
            "paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/abfef891-41b2-45d6-b9ba-66d442b290b65204000053039865802BR5924SYNC_PAY_PAGAMENTOS_LTDA6009NOVO_GAMA62070503***6304DC16",
            "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9hYmZlZjg5MS00MWIyLTQ1ZDYtYjliYS02NmQ0NDJiMjkwYjY1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI0U1lOQ19QQVlfUEFHQU1FTlRPU19MVERBNjAwOU5PVk9fR0FNQTYyMDcwNTAzKioqNjMwNERDMTY=",
            "taxa_deposito": 7,
            "taxa_adquirente": 0.49,
            "deposito_liquido": 46.5
        }
    }
}
```

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

### Example JSON for Payment Submission

Source: https://app.valorion.com.br/documentacao

This JSON object demonstrates the structure and required fields for submitting a payment request. It includes customer details, address information, payment amount, item specifics, and postback URL.

```json
{
	"amount": 10,
	"customer": {
		"name": "Paulo Queiroz",
		"email": "cliente@email.com",
		"cpf": "02965847521",
		"phone": "(99) 98765-4321",
		"externaRef": "",
		"address": {
			"street": "Rua Exemplo",    
			"streetNumber": "123",
			"complement": "Complemento",
			"zipCode": "73070713",
			"neighborhood": "Bairro",
			"city": "Cidade",
			"state": "SP",
			"country": "br"
		}
	},
    "checkout" : {
          "utm_source": "exemplo utm_source",
          "utm_medium": "exemplo utm_medium",
          "utm_campaign": "exemplo utm_campaign",
          "utm_term": "exemplo utm_term",
          "utm_content": "exemplo utm_content"
    },
	"pix": {
		"expiresInDays": 2
	},
	"items": [
		{
			"title": "Produto Exemplo",
			"quantity": 1,
			"unitPrice": 10,
			"tangible": true
		}
	],
	"postbackUrl": "https://exemple/webhook/",
	"metadata": "metadata",
	"traceable": true
}
```

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

### GET /api/s1/getCompany/

Source: https://app.valorion.com.br/documentacao

This endpoint retrieves information about the seller (company) associated with the provided API key. It requires authentication via an API key in the header.

```APIDOC
## GET /api/s1/getCompany/

### Description
This endpoint retrieves information about the seller (company) associated with the provided API key. It requires authentication via an API key in the header.

### Method
GET

### Endpoint
`https://app.valorion.com.br/api/s1/getCompany/`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Headers
- **Authorization** (string) - Required - `Basic {API_KEY}` (API_KEY encoded in Base64)
- **content-type** (string) - Required - `application/json`

### Request Example
None

### Response
#### Success Response (200 OK)
- **dados_seller** (object) - Contains seller and address information.
  - **empresa** (object) - Company details.
    - **id** (number) - Company ID.
    - **user_id** (string) - User ID associated with the company.
    - **nome** (string) - Company name.
    - **email** (string) - Company email address.
    - **cpf_cnpj** (string) - Company's CPF or CNPJ.
    - **data_nascimento** (string) - Company's date of birth (if applicable).
    - **telefone** (string) - Company's phone number.
    - **data_cadastro** (string) - Date of company registration.
    - **ip_user** (string) - IP addresses associated with the user.
    - **taxa_cash_in** (string) - Cash-in tax rate.
  - **endereco** (object) - Company address details.
    - **cep** (string) - Postal code.
    - **estado** (string) - State.
    - **cidade** (string) - City.
    - **bairro** (string) - Neighborhood.
    - **numero** (string) - Street number.
    - **complemento** (string) - Address complement.

#### Response Example
```json
{
    "dados_seller": {
        "empresa": {
            "id": 18777723,
            "user_id": "Bruno_dev",
            "nome": "Bruno Rogério",
            "email": "felipe@gmail.com.com",
            "cpf_cnpj": "65214585423",
            "data_nascimento": "1994-10-20",
            "telefone": "61987669422",
            "data_cadastro": "2024-12-06 22:07:20",
            "ip_user": "201.14.83.1,189.49.141.176,2804:d59:aa07:4700",
            "taxa_cash_in": "7.00"
        },
        "endereco": {
            "cep": "73097514",
            "estado": "Distrito Federal",
            "cidade": "Brasilia",
            "bairro": "Sobradinho",
            "numero": "01",
            "complemento": "SH Contagem"
        }
    }
}
```

#### Error Responses
- **401**: API Key not provided or incorrect.
```

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

### Example JSON for API Success Response

Source: https://app.valorion.com.br/documentacao

This JSON object represents a successful API response for a transaction. It includes transaction status, client ID, payment details, and webhook URL.

```json
{
  "status": "success",
  "status_transaction": "WAITING_FOR_APPROVAL",
  "message": "ok",
  "client_id": "e3f8ad47-3cb7-4129-9fad-bh891c42c493",
  "paymentCode": "00020126860014br.gov.bcb.pix2563pix.bankn.com.br/qr/v3/at/fa68393e-d775-415a-9336-244c020194605204000053039865802BR5925PAGPIX_SOLUCAO_EM_PAGAMEN6014SAO_BERNARDO_D62070503***630426F7",
  "idTransaction": "28564976-75v5-427c-a693-5e89e8849b76",
  "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRicdafd34afqa3mNvbS5ici9xci92My9hdC9mYTY4MzkzZS1kMjc1LTQxNWEtOTIyNi0yNDRjMDIwMTk0NjA1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI1UEFHUElYX1NPTFVDQU9fRU1fUEFHQU1FTjYwMTRTQU9fQkVSTkFSRE9fRDYyMDcwNTAzKi
  oqNjMwNDI2Rjc=",
  "urlWebHook": "https://exemple/webhook/"
}
```

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

### GET /api/s1/getsaldo/api/

Source: https://app.valorion.com.br/documentacao

This endpoint allows users to query their account balance. It requires an API key for authentication and is restricted to authorized IP addresses.

```APIDOC
## GET /api/s1/getsaldo/api/

### Description
This endpoint allows users to query their account balance. It requires an API key for authentication and is restricted to authorized IP addresses.

### Method
GET

### Endpoint
`https://app.valorion.com.br/api/s1/getsaldo/api/`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Headers
- **Authorization** (string) - Required - `Basic {API_KEY}` (API_KEY encoded in Base64)
- **content-type** (string) - Required - `application/json`

### Request Example
None

### Response
#### Success Response (200 OK)
- **data** (object) - Contains user information and transaction summaries.
  - **usuario** (string) - User identifier.
  - **nome** (string) - User's name.
  - **saldo_liquido** (number) - User's net balance.
  - **transacoes** (object) - Transaction summary.
    - **entrada** (object) - Details for incoming transactions.
      - **quantidade** (number) - Number of incoming transactions.
      - **bruto** (string) - Gross amount of incoming transactions.
      - **liquido** (string) - Net amount of incoming transactions.
    - **saida** (object) - Details for outgoing transactions.
      - **quantidade** (number) - Number of outgoing transactions.
      - **bruto** (string) - Gross amount of outgoing transactions.
      - **liquido** (string) - Net amount of outgoing transactions.
- **status** (number) - API response status code (200 for success).
- **message** (string) - A message indicating the result of the operation.
- **error** (string) - An empty string if the operation was successful.

#### Response Example
```json
{
    "data": {
        "usuario": "gustavo",
        "nome": "gustavo",
        "saldo_liquido": 0,
        "transacoes": {
            "entrada": {
                "quantidade": 1,
                "bruto": "1151.00",
                "liquido": "1146.00"
            },
            "saida": {
                "quantidade": 4,
                "bruto": "889.00",
                "liquido": "880.00"
            }
        }
    },
    "status": 200,
    "message": "Sucesso ao consultar saldo!",
    "error": ""
}
```

#### Error Responses
- **401**: API Key not provided or incorrect.
- **403**: IP address not authorized.
```

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

### Webhook de Retirada Pix

Source: https://app.valorion.com.br/documentacao

Este endpoint recebe notificações de webhook quando uma retirada via Pix é realizada na plataforma.

```APIDOC
## POST /webhooks/cashout

### Description
Webhook enviado quando uma retirada via Pix é realizada.

### Method
POST

### Endpoint
/webhooks/cashout

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Chave de autenticação da API.

#### Request Body
- **id** (integer) - Required - Identificador único da transação.
- **user_id** (string) - Required - Identificador do usuário.
- **externalreference** (string) - Required - Referência externa da transação.
- **amount** (number) - Required - Valor da retirada.
- **beneficiaryname** (string) - Required - Nome do beneficiário.
- **beneficiarydocument** (string) - Required - Documento do beneficiário.
- **pix** (string) - Required - Chave Pix do beneficiário.
- **type** (string) - Optional - Tipo da chave Pix.
- **pixkey** (string) - Required - Chave Pix do beneficiário.
- **date** (string) - Required - Data e hora da transação (YYYY-MM-DD HH:MM:SS).
- **status** (string) - Required - Status da transação (e.g., COMPLETED).
- **idtransaction** (string) - Required - Identificador da transação no sistema.
- **taxa_cash_out** (number) - Required - Taxa de retirada.
- **cash_out_liquido** (number) - Required - Valor líquido da retirada.
- **dt_atualizacao** (string) - Required - Data e hora da atualização da transação (YYYY-MM-DD HH:MM:SS).

### Request Example
```json
{
    "id": 54321,
    "user_id": "Bruno_dev",
    "externalreference": "SJW1SoDDNnwvTOPzwGzIctXvK6hnX5vt",
    "amount": 200.75,
    "beneficiaryname": "Maria Oliveira",
    "beneficiarydocument": "98765432100",
    "pix": "maria@email.com",
    "type": "",
    "pixkey": "maria@email.com",
    "date": "2024-03-02 10:15:00",
    "status": "COMPLETED",
    "idtransaction": "E3038525920250122232856607a71d96",
    "taxa_cash_out": 2,
    "cash_out_liquido": 196.73,
    "dt_atualizacao": "2024-03-02 10:16:00"
}
```

### Response
#### Success Response (200)
- **message** (string) - Mensagem de confirmação do recebimento do webhook.

#### Response Example
```json
{
    "message": "Webhook received successfully."
}
```

### Errors
- **401** - API Key não fornecida ou incorreta.
```

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

### GET /api/s1/getTransaction/api/getTransactionStatus.php

Source: https://app.valorion.com.br/documentacao

This endpoint retrieves information about a specific transaction (cashIn or cashOut) using its transaction ID. Authentication is handled via an API key in the header.

```APIDOC
## GET /api/s1/getTransaction/api/getTransactionStatus.php

### Description
This endpoint retrieves information about a specific transaction (cashIn or cashOut) using its transaction ID. Authentication is handled via an API key in the header.

### Method
GET

### Endpoint
`https://app.valorion.com.br/api/s1/getTransaction/api/getTransactionStatus.php?id_transaction={id_transaction}`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **id_transaction** (string) - Required - The ID of the transaction to query.

#### Request Body
None

### Headers
- **Authorization** (string) - Required - `Basic {API_KEY}` (API_KEY encoded in Base64)
- **content-type** (string) - Required - `application/json`

### Request Example
None

### Response
#### Success Response (200 OK)
- **id_transaction** (string) - The ID of the transaction.
- **situacao** (string) - The current status of the transaction (e.g., "AGUARDANDO_PAGAMENTO").
- **tipo** (string) - The type of transaction (e.g., "CASH IN").
- **data_transacao** (string) - The date and time of the transaction.
- **nome** (string) - The name associated with the transaction.
- **documento** (string|null) - Document number, if applicable.
- **valor_bruto** (string) - The gross value of the transaction.
- **valor_liquido** (string) - The net value of the transaction.
- **referencia_externa** (string) - External reference ID.
- **status** (number) - API response status code (200 for success).
- **error** (string) - An empty string if the operation was successful.

#### Response Example
```json
{
    "id_transaction": "5ef620fa304421ab5bdb6b48c6ded6",
    "situacao": "AGUARDANDO_PAGAMENTO",
    "tipo": "CASH IN",
    "data_transacao": "2025-01-25 21:42:01",
    "nome": "Bechara Jalkh",
    "documento": null,
    "valor_bruto": "1.60",
    "valor_liquido": "1",
    "referencia_externa": "ov0kXOhAZadCrEI9hPPC5VkzddKfn7qG",
    "status": 200,
    "error": ""
}
```

#### Error Responses
- **401**: API Key not provided or incorrect.
- **403**: IP address not authorized.
- **404**: Transaction ID not found.
```

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

### Webhook de Depósito Pix

Source: https://app.valorion.com.br/documentacao

Este endpoint recebe notificações de webhook quando um depósito via Pix é realizado na plataforma.

```APIDOC
## POST /webhooks/cashin

### Description
Webhook enviado quando um depósito via Pix é realizado.

### Method
POST

### Endpoint
/webhooks/cashin

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Chave de autenticação da API.

#### Request Body
- **id** (integer) - Required - Identificador único da transação.
- **user_id** (string) - Required - Identificador do usuário.
- **externalreference** (string) - Required - Referência externa da transação.
- **amount** (number) - Required - Valor do depósito.
- **client_name** (string) - Required - Nome do cliente.
- **client_document** (string) - Required - Documento do cliente (chave Pix).
- **client_email** (string) - Required - Email do cliente.
- **data_registro** (string) - Required - Data e hora do registro da transação (YYYY-MM-DD HH:MM:SS).
- **adquirente_ref** (string) - Required - Referência do adquirente.
- **status** (string) - Required - Status da transação (e.g., PAID_OUT).
- **idtransaction** (string) - Required - Identificador da transação no sistema.
- **paymentcode** (string) - Required - Código de pagamento Pix.
- **paymentCodeBase64** (string) - Required - Código de pagamento Pix em Base64.
- **taxa_deposito** (number) - Required - Taxa de depósito.
- **taxa_adquirente** (number) - Required - Taxa do adquirente.
- **deposito_liquido** (number) - Required - Valor líquido do depósito.

### Request Example
```json
{
    "id": 12345,
    "user_id": "Bruno_dev",
    "externalreference": "GWuXrEH6oIaEg094WUDVz235xPAJ49Zf",
    "amount": 50,
    "client_name": "João Silva",
    "client_document": "{PIX_KEY}",
    "client_email": "joao@email.com",
    "data_registro": "2024-03-01 14:30:00",
    "adquirente_ref": "voluti",
    "status": "PAID_OUT",
    "idtransaction": "029d53e0454d0d9804babbf2f01195",
    "paymentcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/abfef891-41b2-45d6-b9ba-66d442b290b65204000053039865802BR5924SYNC_PAY_PAGAMENTOS_LTDA6009NOVO_GAMA62070503***6304DC16",
    "paymentCodeBase64": "MDAwMjAxMjY4NTAwMTRici5nb3YuYmNiLnBpeDI1NjNwaXgudm9sdXRpLmNvbS5ici9xci92My9hdC9hYmZlZjg5MS00MWIyLTQ1ZDYtYjliYS02NmQ0NDJiMjkwYjY1MjA0MDAwMDUzMDM5ODY1ODAyQlI1OTI0U1lOQ19QQVlfUEFHQU1FTlRPU19MVERBNjAwOU5PVk9fR0FNQTYyMDcwNTAzKioqNjMwNERDMTY=",
    "taxa_deposito": 7,
    "taxa_adquirente": 0.49,
    "deposito_liquido": 46.5
}
```

### Response
#### Success Response (200)
- **message** (string) - Mensagem de confirmação do recebimento do webhook.

#### Response Example
```json
{
    "message": "Webhook received successfully."
}
```

### Errors
- **401** - API Key não fornecida ou incorreta.
```