Cyber Payment API

https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest
Admin
Cyber Payment API is a complete payment processing platform supporting PIX, Boleto, and credit card...
Tokens:17,910
Snippets:46
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Process Card Transaction with Token

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Example payload for processing a card transaction using a previously generated card token. Includes customer details and installment information.

```json
{
  "amount": 1000,
  "customerName": "Ana Silva",
  "customerEmail": "ana@example.com",
  "card": {
    "card_token": "tok_xxxxx",
    "cvv": "456",
    "installments": 3
  },
  "description": "Pagamento parcelado"
}
```

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

### GET /organizations/balance

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Retrieves the current available balance for the organization.

```APIDOC
## GET /organizations/balance

### Description
Returns the available balance for the organization.

### Method
GET

### Endpoint
/organizations/balance

### Response
#### Success Response (200)
- **balance** (number) - Available balance
- **currency** (string) - Currency code (e.g., BRL)

#### Response Example
{
  "success": true,
  "data": {
    "balance": 1500.5,
    "currency": "BRL"
  }
}
```

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

### PIX Outbound Webhook: Withdrawal Processing Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX withdrawal is requested and is currently being processed. It contains details about the withdrawal request.

```json
{
  "id": "evt_7a8b9c1d2e3f4a",
  "type": "pix.out.processing",
  "created_at": "2026-01-15T14:32:18-03:00",
  "data": {
    "withdrawalId": "wd_7a8b9c1d2e3f4b5c6d7e8f",
    "transactionId": "trf_7a8b9c1d2e3f4b5c6d7e8f9a0b1c2d",
    "status": "pending",
    "type": "CHARGE",
    "internalStatus": "pending",
    "amount": 1500,
    "totalAmount": 1500,
    "createdAt": "2026-01-15 14:32:18",
    "pixKey": "11987654321",
    "pixKeyType": "cpf",
    "description": "Saque para conta pessoal",
    "currency": "BRL"
  }
}
```

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

### PIX Outbound Webhook: Withdrawal Confirmation Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX withdrawal is successfully confirmed and processed. It includes details of the completed withdrawal.

```json
{
  "id": "evt_7a8b9c1d2e3f5b",
  "type": "pix.out.confirmation",
  "created_at": "2026-01-15T14:35:22-03:00",
  "data": {
    "endToEndId": "E20260115202415000000001234567890",
    "withdrawalId": "wd_7a8b9c1d2e3f4b5c6d7e8f",
    "status": "paid",
    "type": "CHARGE",
    "internalStatus": "approved",
    "amount": 1500,
    "createdAt": "2026-01-15 14:32:18",
    "paymentAt": "2026-01-15 14:35:20",
    "pixKey": "11987654321",
    "pixKeyType": "cpf",
    "currency": "BRL"
  }
}
```

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

### GET /webhooks/{id}

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Retrieves the details of a specific webhook by its unique identifier.

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

### Description
Retorna os detalhes de um webhook específico.

### Method
GET

### Endpoint
/webhooks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID do webhook

### Response
#### Success Response (200)
- **id** (string) - ID do webhook
- **name** (string) - Nome do webhook
- **url** (string) - URL configurada
```

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

### PIX Inbound Webhook: Refunded Payment Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX payment is reversed or refunded. It includes details about the refunded transaction.

```json
{
  "id": "evt_6912567890789",
  "type": "pix.in.reversal.confirmation",
  "created_at": "2025-11-10T20:00:00-03:00",
  "data": {
    "id": "31c7a7bd-e115-42be-bc69-adc7698b5ef7",
    "transactionId": "txn_691255f8eb4a844a394848df7e4db",
    "status": "REFUNDED",
    "type": "CHARGE",
    "internalStatus": "refunded",
    "amount": 100,
    "currency": "BRL",
    "reason": "Estorno solicitado pelo cliente",
    "createdAt": "2025-11-10T18:15:37-03:00"
  }
}
```

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

### PIX Inbound Webhook: Failed Payment Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX payment is rejected or fails. It provides information about the failed transaction and the reason for failure.

```json
{
  "id": "evt_6912567890456",
  "type": "pix.in.failed",
  "created_at": "2025-11-10T19:05:00-03:00",
  "data": {
    "id": "31c7a7bd-e115-42be-bc69-adc7698b5ef7",
    "transactionId": "txn_691255f8eb4a844a394848df7e4db",
    "status": "FAILED",
    "type": "CHARGE",
    "internalStatus": "failed",
    "amount": 100,
    "currency": "BRL",
    "reason": "Pagamento rejeitado",
    "customerName": "João Silva",
    "customerEmail": "joao@example.com",
    "createdAt": "2025-11-10T18:15:37-03:00"
  }
}
```

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

### PIX Outbound Webhook: Withdrawal Failure Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX withdrawal fails during processing. It provides the reason for the failure.

```json
{
  "id": "evt_6912567890890",
  "type": "pix.out.failure",
  "created_at": "2025-11-10T19:40:00-03:00",
  "data": {
    "id": "wd_6912567890124",
    "withdrawalId": "wd_6912567890124",
    "transactionId": "trf_6912567890124",
    "status": "FAILED",
    "type": "SEND",
    "internalStatus": "failed",
    "amount": 100,
    "currency": "BRL",
    "pixKey": "teste@example.com",
    "pixKeyType": "EMAIL",
    "description": "Saque para conta pessoal",
    "reason": "Chave PIX inválida",
    "createdAt": "2025-11-10T19:30:00-03:00"
  }
}
```

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

### PIX Inbound Webhook: Expired Payment Example

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

This webhook is triggered when a PIX QR Code expires without a payment. It includes details about the expired transaction.

```json
{
  "id": "evt_6912567890123",
  "type": "pix.in.expired",
  "created_at": "2025-11-10T19:00:00-03:00",
  "data": {
    "id": "31c7a7bd-e115-42be-bc69-adc7698b5ef7",
    "transactionId": "txn_691255f8eb4a844a394848df7e4db",
    "status": "EXPIRED",
    "type": "CHARGE",
    "internalStatus": "expired",
    "amount": 100,
    "currency": "BRL",
    "customerName": "João Silva",
    "customerEmail": "joao@example.com",
    "createdAt": "2025-11-10T18:15:37-03:00"
  }
}
```

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

### Create Credit Card Transaction - Cyber Payment API

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates and processes a credit card transaction immediately. This method supports installment payments and allows for various ways to submit card details, including `card_id`, `card_token`, or direct card information. It requires customer details and transaction amount.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cyber Payment API",
    "description": "API completa para processamento de pagamentos (PIX, Boleto e Cartão de Crédito), gerenciamento de webhooks e operações financeiras.\n\n## Autenticação\nTodas as requisições requerem autenticação via API Key no header `X-API-Key`.\n\n## Base URL\n`https://api.escalecyber.com/v1`\n\n## Métodos de Pagamento\n\nA API suporta três métodos de pagamento:\n- **PIX**: Pagamento instantâneo via QR Code\n- **Boleto**: Boleto bancário com configurações de vencimento, juros e multa\n- **Cartão de Crédito**: Pagamento com cartão, suportando parcelamento",
    "version": "1.5.0",
    "contact": {
      "name": "Cyber Support",
      "email": "support@escalecyber.com"
    }
  },
  "servers": [
    {
      "url": "https://api.escalecyber.com/v1",
      "description": "Produção"
    }
  ],
  "tags": [
    {
      "name": "Transactions",
      "description": "Operações de pagamento (PIX, Boleto e Cartão de Crédito)"
    },
    {
      "name": "Withdrawals",
      "description": "Operações de saque (Cash Out) e consulta de saldo"
    },
    {
      "name": "Webhooks",
      "description": "Gerenciamento de webhooks e eventos de notificação"
    }
  ],
  "paths": {
    "/payments/transactions/card": {
      "post": {
        "tags": [
          "Transactions"
        ],
        "summary": "Criar transação Cartão de Crédito",
        "description": "Cria uma nova transação com cartão de crédito e processa o pagamento imediatamente.\n\nSuporta parcelamento e múltiplas formas de envio dos dados do cartão (card_id, card_token ou dados diretos).\n",
        "operationId": "createCardTransaction",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PostCardTransactionRequest"
              },
              "examples": {
                "with_card_id": {
                  "summary": "Usando card_id (recomendado)",
                  "value": {
                    "amount": 500,
                    "customerName": "Pedro Oliveira",
                    "customerEmail": "pedro@example.com",
                    "customerPhone": "5511999999999",
                    "customerDocument": "12345678901",
                    "customerAddress": {
                      "line_1": "Rua Exemplo, 123",
                      "zip_code": "01234567",
                      "city": "São Paulo",
                      "state": "SP"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### POST /payments/transactions

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates a new PIX transaction and returns the QR Code for instant payment processing.

```APIDOC
## POST /payments/transactions

### Description
Creates a new PIX transaction and returns the QR Code for the customer to complete the payment instantly.

### Method
POST

### Endpoint
`https://api.escalecyber.com/v1/payments/transactions`

### Request Body
- **amount** (number) - Required - The transaction value.
- **customerName** (string) - Required - Name of the customer.
- **customerEmail** (string) - Required - Email of the customer.
- **customerDocument** (string) - Required - CPF or CNPJ of the customer.

### Request Example
{
  "amount": 100,
  "customerName": "João Silva",
  "customerEmail": "joao@example.com",
  "customerDocument": "179.539.020-44"
}

### Response
#### Success Response (201)
- **qr_code** (string) - The PIX QR code string.
- **transaction_id** (string) - Unique identifier for the transaction.
```

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

### POST /webhooks

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates a new webhook to receive event notifications. Includes a signature header for security validation.

```APIDOC
## POST /webhooks

### Description
Cria um novo webhook para receber notificações de eventos. O webhook será chamado via POST sempre que um evento configurado ocorrer. Um header `X-Webhook-Signature` será incluído para validação.

### Method
POST

### Endpoint
/webhooks

### Request Body
- **name** (string) - Required - Nome do webhook
- **url** (string) - Required - URL de destino
- **events** (array) - Required - Lista de eventos (ex: pix.in.confirmation)
- **isActive** (boolean) - Required - Status do webhook

### Request Example
{
  "name": "Meu Webhook",
  "url": "https://example.com/webhook",
  "events": ["pix.in.confirmation", "pix.out.confirmation"],
  "isActive": true
}

### Response
#### Success Response (201)
- **id** (string) - ID do webhook criado
- **secret** (string) - Chave secreta para validação de assinatura
```

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

### GET /payments/transactions/{id}

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Retrieves the details of a specific transaction by its unique identifier.

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

### Description
Returns the details of a specific transaction.

### Method
GET

### Endpoint
/payments/transactions/{id}

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

### Response
#### Success Response (200)
- **id** (string) - Transaction ID
- **amount** (number) - Transaction amount

#### Response Example
{
  "id": "trans_123",
  "amount": 1000
}
```

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

### POST /transactions/pix

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Initiates a new PIX payment transaction and returns the necessary QR code data for the customer.

```APIDOC
## POST /transactions/pix

### Description
Creates a new PIX transaction, returning the EMV code and base64 QR code image for payment completion.

### Method
POST

### Endpoint
/transactions/pix

### Request Body
- **amount** (number) - Required - Transaction value
- **customerName** (string) - Required - Name of the payer
- **customerEmail** (string) - Required - Email of the payer

### Request Example
{
  "amount": 100,
  "customerName": "João Silva",
  "customerEmail": "joao@example.com"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (object) - Transaction details including pix.qrCode.emv and pix.qrCode.image

#### Response Example
{
  "success": true,
  "data": {
    "id": "txn_690aaf8f9acbae5e44e465af817e5",
    "status": "PENDING",
    "pix": {
      "qrCode": {
        "emv": "00020126860014br.gov.bcb.pix..."
      }
    }
  }
}
```

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

### GET /transactions/{id}

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Retrieves the details of a specific transaction using its unique ID.

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

### Description
Retrieves the details of a specific transaction using its unique ID.

### Method
GET

### Endpoint
/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the transaction details (structure is the same as the `data` object in the POST /transactions response).

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "txn_690aaf8f9acbae5e44e465af817e5",
    "external_id": "eb13a725-3105-4c43-9d7d-64ce2840f24e",
    "referenceCode": "REF101130",
    "status": "APPROVED",
    "amount": 500,
    "currency": "BRL",
    "paymentMethod": "credit_card",
    "card": {
      "installments": 1,
      "last_four_digits": "0010",
      "brand": "visa",
      "authorization_code": "123456",
      "acquirer": "pagarme"
    },
    "customerName": "Pedro Oliveira",
    "customerEmail": "pedro@example.com",
    "feeDetails": {
      "totalFee": 5,
      "userFeeAmount": 2.5,
      "calculationType": "percentage"
    },
    "netAmount": 495,
    "createdAt": "2025-11-06T15:20:14Z"
  }
}
```
```

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

### POST /transactions

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Initiates a new payment transaction, such as a credit card payment. It returns details of the created transaction.

```APIDOC
## POST /transactions

### Description
Initiates a new payment transaction, such as a credit card payment. It returns details of the created transaction.

### Method
POST

### Endpoint
/transactions

### Parameters
#### Request Body
- **customerName** (string) - Required - The name of the customer.
- **customerEmail** (string) - Required - The email of the customer.
- **paymentMethod** (string) - Required - The method of payment (e.g., "credit_card").
- **amount** (number) - Required - The total amount of the transaction.
- **currency** (string) - Required - The currency of the transaction (e.g., "BRL").
- **card** (object) - Required for credit card payments - Card details.
  - **number** (string) - Required - The credit card number.
  - **expiryMonth** (integer) - Required - The expiration month of the card.
  - **expiryYear** (integer) - Required - The expiration year of the card.
  - **cvv** (string) - Required - The CVV of the card.
  - **installments** (integer) - Optional - The number of installments for the payment.

### Request Example
```json
{
  "customerName": "Maria Silva",
  "customerEmail": "maria@example.com",
  "paymentMethod": "credit_card",
  "amount": 500,
  "currency": "BRL",
  "card": {
    "number": "1111222233334444",
    "expiryMonth": 12,
    "expiryYear": 2025,
    "cvv": "123",
    "installments": 1
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the transaction details.
  - **id** (string) - Internal transaction ID.
  - **external_id** (string) - External transaction ID (e.g., from payment gateway).
  - **referenceCode** (string) - Reference code for the transaction.
  - **status** (string) - Current status of the transaction (e.g., "PENDING", "APPROVED", "FAILED").
  - **amount** (number) - Transaction amount.
  - **currency** (string) - Transaction currency.
  - **paymentMethod** (string) - Payment method used.
  - **card** (object) - Details of the card used (if applicable).
    - **installments** (integer) - Number of installments.
    - **last_four_digits** (string) - Last four digits of the card.
    - **brand** (string) - Card brand (e.g., "visa").
    - **authorization_code** (string) - Authorization code from the acquirer.
    - **acquirer** (string) - The acquirer responsible for the transaction.
  - **customerName** (string) - Customer's name.
  - **customerEmail** (string) - Customer's email.
  - **feeDetails** (object) - Details about transaction fees.
    - **totalFee** (number) - Total fee amount.
    - **userFeeAmount** (number) - Fee amount charged to the user.
    - **calculationType** (string) - Method of fee calculation (e.g., "percentage").
  - **netAmount** (number) - The net amount after fees.
  - **createdAt** (string) - Timestamp when the transaction was created.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "txn_690aaf8f9acbae5e44e465af817e5",
    "external_id": "eb13a725-3105-4c43-9d7d-64ce2840f24e",
    "referenceCode": "REF101130",
    "status": "APPROVED",
    "amount": 500,
    "currency": "BRL",
    "paymentMethod": "credit_card",
    "card": {
      "installments": 1,
      "last_four_digits": "0010",
      "brand": "visa",
      "authorization_code": "123456",
      "acquirer": "pagarme"
    },
    "customerName": "Pedro Oliveira",
    "customerEmail": "pedro@example.com",
    "feeDetails": {
      "totalFee": 5,
      "userFeeAmount": 2.5,
      "calculationType": "percentage"
    },
    "netAmount": 495,
    "createdAt": "2025-11-06T15:20:14Z"
  }
}
```
```

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

### POST /webhooks/pix.out.processing

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Webhook triggered when a withdrawal is requested and is being processed.

```APIDOC
## POST /webhooks/pix.out.processing

### Description
Webhook triggered when a withdrawal is requested and is being processed.

### Method
POST

### Endpoint
/webhooks/pix.out.processing

### Request Body
- **id** (string) - Required - Unique identifier for the event.
- **type** (string) - Required - Type of the event, should be 'pix.out.processing'.
- **created_at** (string) - Required - Timestamp of when the event was created.
- **data** (object) - Required - Contains details about the withdrawal.
  - **withdrawalId** (string) - Required - Unique identifier for the withdrawal.
  - **transactionId** (string) - Required - The transaction ID associated with the withdrawal.
  - **status** (string) - Required - The status of the withdrawal, should be 'pending'.
  - **type** (string) - Required - The type of the transaction.
  - **internalStatus** (string) - Required - Internal status of the withdrawal, should be 'pending'.
  - **amount** (number) - Required - The amount of the withdrawal.
  - **totalAmount** (number) - Required - The total amount including fees.
  - **createdAt** (string) - Required - Timestamp of when the withdrawal was created.
  - **pixKey** (string) - Required - The PIX key for the withdrawal.
  - **pixKeyType** (string) - Required - The type of the PIX key (e.g., 'cpf', 'email').
  - **description** (string) - Optional - A description for the withdrawal.
  - **currency** (string) - Required - The currency of the withdrawal (e.g., 'BRL').

### Request Example
```json
{
  "id": "evt_7a8b9c1d2e3f4a",
  "type": "pix.out.processing",
  "created_at": "2026-01-15T14:32:18-03:00",
  "data": {
    "withdrawalId": "wd_7a8b9c1d2e3f4b5c6d7e8f",
    "transactionId": "trf_7a8b9c1d2e3f4b5c6d7e8f",
    "status": "pending",
    "type": "CHARGE",
    "internalStatus": "pending",
    "amount": 1500,
    "totalAmount": 1500,
    "createdAt": "2026-01-15 14:32:18",
    "pixKey": "11987654321",
    "pixKeyType": "cpf",
    "description": "Saque para conta pessoal",
    "currency": "BRL"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message, e.g., "Webhook recebido com sucesso".

#### Response Example
```json
{
  "message": "Webhook recebido com sucesso"
}
```
```

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

### POST /webhooks/pix.out.confirmation

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Webhook triggered when a withdrawal is confirmed and successfully processed.

```APIDOC
## POST /webhooks/pix.out.confirmation

### Description
Webhook triggered when a withdrawal is confirmed and successfully processed.

### Method
POST

### Endpoint
/webhooks/pix.out.confirmation

### Request Body
- **id** (string) - Required - Unique identifier for the event.
- **type** (string) - Required - Type of the event, should be 'pix.out.confirmation'.
- **created_at** (string) - Required - Timestamp of when the event was created.
- **data** (object) - Required - Contains details about the confirmed withdrawal.
  - **endToEndId** (string) - Required - The end-to-end ID of the transaction.
  - **withdrawalId** (string) - Required - Unique identifier for the withdrawal.
  - **status** (string) - Required - The status of the withdrawal, should be 'paid'.
  - **type** (string) - Required - The type of the transaction.
  - **internalStatus** (string) - Required - Internal status of the withdrawal, should be 'approved'.
  - **amount** (number) - Required - The amount of the withdrawal.
  - **createdAt** (string) - Required - Timestamp of when the withdrawal was created.
  - **paymentAt** (string) - Required - Timestamp of when the payment was made.
  - **pixKey** (string) - Required - The PIX key for the withdrawal.
  - **pixKeyType** (string) - Required - The type of the PIX key (e.g., 'cpf', 'email').
  - **currency** (string) - Required - The currency of the withdrawal (e.g., 'BRL').

### Request Example
```json
{
  "id": "evt_7a8b9c1d2e3f5b",
  "type": "pix.out.confirmation",
  "created_at": "2026-01-15T14:35:22-03:00",
  "data": {
    "endToEndId": "E20260115202415000000001234567890",
    "withdrawalId": "wd_7a8b9c1d2e3f4b5c6d7e8f",
    "status": "paid",
    "type": "CHARGE",
    "internalStatus": "approved",
    "amount": 1500,
    "createdAt": "2026-01-15 14:32:18",
    "paymentAt": "2026-01-15 14:35:20",
    "pixKey": "11987654321",
    "pixKeyType": "cpf",
    "currency": "BRL"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message, e.g., "Webhook recebido com sucesso".

#### Response Example
```json
{
  "message": "Webhook recebido com sucesso"
}
```
```

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

### Retrieve Organization Balance

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Fetches the current available balance for the organization, returned in BRL. Requires API Key authentication.

```json
{
  "success": true,
  "data": {
    "balance": 1500.5,
    "currency": "BRL"
  }
}
```

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

### POST /payments/transactions/card

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Processes a credit card payment immediately, supporting card tokens or direct card data.

```APIDOC
## POST /payments/transactions/card

### Description
Processes a credit card transaction. Supports installment plans and secure card tokenization.

### Method
POST

### Endpoint
`https://api.escalecyber.com/v1/payments/transactions/card`

### Request Body
- **amount** (number) - Required - Transaction value.
- **card_id** (string) - Optional - Use a previously saved card ID.

### Request Example
{
  "amount": 500,
  "customerName": "Pedro Oliveira",
  "card_id": "card_12345"
}

### Response
#### Success Response (201)
- **status** (string) - The status of the payment (e.g., 'authorized', 'captured').
```

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

### Create PIX Transaction - Cyber Payment API

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates a new PIX transaction and returns a QR Code for payment. This method is for instant payments. It requires customer details and transaction amount. Optional fields include customer document type and metadata.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cyber Payment API",
    "description": "API completa para processamento de pagamentos (PIX, Boleto e Cartão de Crédito), gerenciamento de webhooks e operações financeiras.\n\n## Autenticação\nTodas as requisições requerem autenticação via API Key no header `X-API-Key`.\n\n## Base URL\n`https://api.escalecyber.com/v1`\n\n## Métodos de Pagamento\n\nA API suporta três métodos de pagamento:\n- **PIX**: Pagamento instantâneo via QR Code\n- **Boleto**: Boleto bancário com configurações de vencimento, juros e multa\n- **Cartão de Crédito**: Pagamento com cartão, suportando parcelamento",
    "version": "1.5.0",
    "contact": {
      "name": "Cyber Support",
      "email": "support@escalecyber.com"
    }
  },
  "servers": [
    {
      "url": "https://api.escalecyber.com/v1",
      "description": "Produção"
    }
  ],
  "tags": [
    {
      "name": "Transactions",
      "description": "Operações de pagamento (PIX, Boleto e Cartão de Crédito)"
    },
    {
      "name": "Withdrawals",
      "description": "Operações de saque (Cash Out) e consulta de saldo"
    },
    {
      "name": "Webhooks",
      "description": "Gerenciamento de webhooks e eventos de notificação"
    }
  ],
  "paths": {
    "/payments/transactions": {
      "post": {
        "tags": [
          "Transactions"
        ],
        "summary": "Criar transação PIX",
        "description": "Cria uma nova transação PIX e retorna o código QR Code para pagamento.\n\nO QR Code retornado deve ser exibido para o cliente realizar o pagamento instantâneo.\n",
        "operationId": "createPixTransaction",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PostPixTransactionRequest"
              },
              "examples": {
                "basic": {
                  "summary": "Transação PIX básica",
                  "value": {
                    "amount": 100,
                    "customerName": "João Silva",
                    "customerPhone": "119853646233",
                    "customerDocument": "179.539.020-44",
                    "customerEmail": "joao@example.com",
                    "description": "Pagamento de serviço"
                  }
                },
                "complete": {
                  "summary": "Transação PIX completa",
                  "value": {
                    "amount": 250.5,
                    "customerName": "Maria Santos",
                    "customerEmail": "maria@example.com",
                    "customerPhone": "5511999999999",
                    "customerDocument": "12345678901",
                    "customerDocumentType": "cpf",
                    "description": "Pagamento de produto",
                    "metadata": {
                      "product_id": "123",
                      "order_id": "ORD-456"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Transação PIX criada com sucesso",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PostPixTransactionResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  }
}
```

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

### POST /webhooks/pix.in.confirmation

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Webhook event triggered when a PIX payment is confirmed and credited to the account.

```APIDOC
## POST /webhooks/pix.in.confirmation

### Description
Webhook disparado quando um pagamento PIX é confirmado e creditado na conta. Este é o evento mais importante para confirmação de pagamentos.

### Method
POST

### Endpoint
/webhooks/pix.in.confirmation

### Request Body
- **id** (string) - ID do evento
- **type** (string) - Tipo do evento (pix.in.confirmation)
- **data** (object) - Dados detalhados da transação

### Request Example
{
  "id": "evt_6912564189161",
  "type": "pix.in.confirmation",
  "data": {
    "status": "APPROVED",
    "amount": 100,
    "currency": "BRL"
  }
}

### Response
#### Success Response (200)
- **message** (string) - Webhook recebido com sucesso
```

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

### POST /webhooks/pix.in.failed

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Webhook triggered when a PIX payment is rejected or fails.

```APIDOC
## POST /webhooks/pix.in.failed

### Description
Webhook triggered when a PIX payment is rejected or fails.

### Method
POST

### Endpoint
/webhooks/pix.in.failed

### Request Body
- **id** (string) - Required - Unique identifier for the event.
- **type** (string) - Required - Type of the event, should be 'pix.in.failed'.
- **created_at** (string) - Required - Timestamp of when the event was created.
- **data** (object) - Required - Contains details about the failed PIX payment.
  - **id** (string) - Required - Unique identifier for the PIX charge.
  - **transactionId** (string) - Required - The transaction ID associated with the PIX.
  - **status** (string) - Required - The status of the PIX, should be 'FAILED'.
  - **type** (string) - Required - The type of the PIX transaction.
  - **internalStatus** (string) - Required - Internal status of the PIX, should be 'failed'.
  - **amount** (number) - Required - The amount of the PIX transaction.
  - **currency** (string) - Required - The currency of the PIX transaction (e.g., 'BRL').
  - **reason** (string) - Optional - The reason for the payment failure.
  - **customerName** (string) - Optional - The name of the customer.
  - **customerEmail** (string) - Optional - The email of the customer.
  - **createdAt** (string) - Required - Timestamp of when the PIX was created.

### Request Example
```json
{
  "id": "evt_6912567890456",
  "type": "pix.in.failed",
  "created_at": "2025-11-10T19:05:00-03:00",
  "data": {
    "id": "31c7a7bd-e115-42be-bc69-adc7698b5ef7",
    "transactionId": "txn_691255f8eb4a844a394848df7e4db",
    "status": "FAILED",
    "type": "CHARGE",
    "internalStatus": "failed",
    "amount": 100,
    "currency": "BRL",
    "reason": "Pagamento rejeitado",
    "customerName": "João Silva",
    "customerEmail": "joao@example.com",
    "createdAt": "2025-11-10T18:15:37-03:00"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message, e.g., "Webhook recebido com sucesso".

#### Response Example
```json
{
  "message": "Webhook recebido com sucesso"
}
```
```

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

### POST /webhooks/pix.out.failure

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Webhook triggered when a withdrawal fails during processing.

```APIDOC
## POST /webhooks/pix.out.failure

### Description
Webhook triggered when a withdrawal fails during processing.

### Method
POST

### Endpoint
/webhooks/pix.out.failure

### Request Body
- **id** (string) - Required - Unique identifier for the event.
- **type** (string) - Required - Type of the event, should be 'pix.out.failure'.
- **created_at** (string) - Required - Timestamp of when the event was created.
- **data** (object) - Required - Contains details about the failed withdrawal.
  - **id** (string) - Required - Unique identifier for the withdrawal.
  - **withdrawalId** (string) - Required - Unique identifier for the withdrawal.
  - **transactionId** (string) - Required - The transaction ID associated with the withdrawal.
  - **status** (string) - Required - The status of the withdrawal, should be 'FAILED'.
  - **type** (string) - Required - The type of the transaction.
  - **internalStatus** (string) - Required - Internal status of the withdrawal, should be 'failed'.
  - **amount** (number) - Required - The amount of the withdrawal.
  - **currency** (string) - Required - The currency of the withdrawal (e.g., 'BRL').
  - **pixKey** (string) - Required - The PIX key for the withdrawal.
  - **pixKeyType** (string) - Required - The type of the PIX key (e.g., 'cpf', 'email').
  - **description** (string) - Optional - A description for the withdrawal.
  - **reason** (string) - Optional - The reason for the withdrawal failure.
  - **createdAt** (string) - Required - Timestamp of when the withdrawal was created.

### Request Example
```json
{
  "id": "evt_6912567890890",
  "type": "pix.out.failure",
  "created_at": "2025-11-10T19:40:00-03:00",
  "data": {
    "id": "wd_6912567890124",
    "withdrawalId": "wd_6912567890124",
    "transactionId": "trf_6912567890124",
    "status": "FAILED",
    "type": "SEND",
    "internalStatus": "failed",
    "amount": 100,
    "currency": "BRL",
    "pixKey": "teste@example.com",
    "pixKeyType": "EMAIL",
    "description": "Saque para conta pessoal",
    "reason": "Chave PIX inválida",
    "createdAt": "2025-11-10T19:30:00-03:00"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message, e.g., "Webhook recebido com sucesso".

#### Response Example
```json
{
  "message": "Webhook recebido com sucesso"
}
```
```

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

### Create PIX Withdrawal Request

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates a new PIX withdrawal request. Requires an amount in BRL, a valid PIX key, and the corresponding key type.

```json
{
  "amount": 100.0,
  "pixKey": "teste@example.com",
  "pixKeyType": "EMAIL",
  "description": "Saque para conta pessoal"
}
```

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

### POST /payments/withdrawals

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Creates a new PIX withdrawal request for the organization.

```APIDOC
## POST /payments/withdrawals

### Description
Creates a new PIX withdrawal request. The amount must be in BRL.

### Method
POST

### Endpoint
/payments/withdrawals

### Request Body
- **amount** (number) - Required - Amount in BRL
- **pixKey** (string) - Required - PIX key identifier
- **pixKeyType** (string) - Required - Type of PIX key (CPF, CNPJ, EMAIL, PHONE, RANDOM)

### Request Example
{
  "amount": 100,
  "pixKey": "teste@example.com",
  "pixKeyType": "EMAIL"
}

### Response
#### Success Response (201)
- **success** (boolean) - Operation status
- **data** (object) - Withdrawal details
```

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

### POST /transactions/boleto

Source: https://registry.scalar.com/@default-team-37y1v/apis/cyber-payment-api/latest?format=preview

Initiates a new Boleto payment transaction and returns the generated barcode and document URLs.

```APIDOC
## POST /transactions/boleto

### Description
Generates a new Boleto payment slip, providing the digitizable line, barcode, and links to view or download the PDF.

### Method
POST

### Endpoint
/transactions/boleto

### Request Body
- **amount** (number) - Required - Transaction value
- **customerName** (string) - Required - Name of the payer

### Request Example
{
  "amount": 250.5,
  "customerName": "Maria Santos"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (object) - Boleto details including line, barcode, url, and pdf

#### Response Example
{
  "success": true,
  "data": {
    "id": "txn_690aaf8f9acbae5e44e465af817e5",
    "boleto": {
      "line": "34191.09008 01234.567890 12345.678901 2 12345678901234",
      "url": "https://api.example.com/boleto/view/12345"
    }
  }
}
```
Tokens:
Raw