Transfeera

https://docs.transfeera.dev
Admin
Transfeera provides an API for managing financial operations, including payments, receipts (Pix,...
Tokens:247,726
Snippets:709
Trust Score:4.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Go SDK Example for Querying Validations

Source: https://docs.transfeera.dev/reference/valida%C3%A7%C3%A3o

This Go code snippet shows how to perform a GET request to the Transfeera API for validations. It requires the 'net/http' package and demonstrates setting up the request URL and headers.

```Go
// Go example would go here
```

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

### List Payout Recurrences - Go Example

Source: https://docs.transfeera.dev/reference/recorr%C3%AAncia

Example of how to list payout recurrences using Go. This code snippet demonstrates making a GET request to the Transfeera API using the standard 'net/http' package and handling the JSON response. Replace 'YOUR_BEARER_TOKEN' with your actual authentication token.

```go
package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
)

func main() {
	url := "https://api.transfeera.com/payout_recurrences"
	userAgent := "YourCompanyName (your.email@example.com)"
	bearerToken := "YOUR_BEARER_TOKEN"

	client := &http.Client{}

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error creating request: %v\n", err)
		return
	}

	req.Header.Set("User-Agent", userAgent)
	req.Header.Set("Authorization", "Bearer "+bearerToken)
	req.Header.Set("Accept", "application/json")

	res, err := client.Do(req)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error sending request: %v\n", err)
		return
	}

	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error reading response body: %v\n", err)
		return
	}

	fmt.Println(string(body))
}
```

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

### Example Bank Transfer Request

Source: https://docs.transfeera.dev/reference/post_batch-id-transfer

An example of a complete bank transfer request payload. It includes integration details, idempotency key, Pix description, payment date, and the destination bank account information. This example demonstrates how to structure the data for a standard bank transfer.

```json
{
  "value": 25,
  "integration_id": "2",
  "idempotency_key": "id-2",
  "pix_description": "Descrição",
  "payment_date": "2030-04-16",
  "destination_bank_account": {
    "name": "Fulano de souza",
    "cpf_cnpj": "12863843893",
    "bank_code": 1,
    "email": "",
    "agency": "3333",
    "account": "12345",
    "account_digit": "1",
    "account_type": "CONTA_CORRENTE"
  }
}
```

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

### Consultar bancos (Node.js)

Source: https://docs.transfeera.dev/reference/bancos

Exemplo de como consultar a API de Bancos utilizando Node.js com a biblioteca 'axios'. Demonstra a configuração da URL, o método GET e o header 'accept'. É necessário ter o 'axios' instalado (`npm install axios`).

```JavaScript
const axios = require('axios');

const getBanks = async () => {
  try {
    const response = await axios.get('https://api.transfeera.com/bank', {
      headers: {
        'accept': 'application/json',
        'User-Agent': 'YourCompanyName youremail@example.com'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching banks:', error);
    throw error;
  }
};

getBanks().then(data => console.log(data)).catch(err => console.error(err));
```

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

### Example Pix Transfer Request

Source: https://docs.transfeera.dev/reference/post_batch-id-transfer

An example of a Pix transfer request payload. It includes transfer value, integration ID, idempotency key, Pix description, Pix end-to-end ID, and destination bank account details specific to Pix, such as Pix key type and Pix key. It also shows Pix key validation.

```json
{
  "value": 15,
  "integration_id": "2",
  "idempotency_key": "id-2",
  "pix_description": "Descrição",
  "pix_end2end_id": "E2708409820220624122301423783996",
  "destination_bank_account": {
    "pix_key_type": "CHAVE_ALEATORIA",
    "pix_key": "0ac4d7a7-7fc7-4cf6-9df6-e0b9307d1f5f",
    "email": "teste@transfeera.com"
  },
  "pix_key_validation": {
    "cpf_cnpj": "12863843893"
  }
}
```

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

### Transaction Entry Data Structure Example

Source: https://docs.transfeera.dev/reference/get_pix-cashin

This example demonstrates the structure of a single transaction entry, detailing payer and receiver information, account types, bank details, and associated metadata. It's crucial for understanding the format of financial transactions within the system.

```json
{
  "agency": "1",
  "bank": {
    "name": "Banco ltda",
    "code": null,
    "ispb": "234567"
  }
},
"receiver": {
  "name": "EMPRESA LTDA",
  "document": "24189547000142",
  "account_type": "CONTA_CORRENTE",
  "account": "573016",
  "account_digit": "0",
  "agency": "1",
  "bank": {
    "name": "Empresa ltda",
    "code": null,
    "ispb": "1235446"
  }
}
},
"metadata": {
  "pagination": {
    "itemsPerPage": 100,
    "totalItems": 1024
  }
}
}
```

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

### Cash-in Success Example

Source: https://docs.transfeera.dev/reference/get_pix-cashin-end2endid

Provides a concrete example of a successful cash-in transaction response. It illustrates the expected format and values for a successful operation, including all payer and receiver details.

```json
{
  "id": "7109aea8-4883-4385-84f7-9b6e2743d521",
  "value": 20,
  "type": "DEPOSIT",
  "end2end_id": "E1819904720211103133500491873821",
  "txid": "",
  "integration_id": "abc123",
  "receipt_file_url": "https://api.transfeera.com/pub/receipt/abc",
  "pix_key": "83f176d4-8640-4b3c-a5f2-c242775f8714",
  "pix_description": "Texto escrito pelo pagador no pagamento",
  "payer": {
    "name": "João da Silva",
    "document": "53690886082",
    "account_type": "CONTA_CORRENTE",
    "account": "383019",
    "account_digit": "0",
    "agency": "1",
    "bank": {
      "name": "Banco ltda",
      "code": "01",
      "ispb": "234567"
    }
  },
  "receiver": {
    "name": "EMPRESA LTDA",
    "document": "24189547000142",
    "account_type": "CONTA_CORRENTE",
    "account": "573016",
    "account_digit": "0",
    "agency": "1',
    "bank": {
      "name": "Empresa ltda",
      "code": "01",
      "ispb": "1235446"
    }
  }
}
```

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

### Transaction Example with Split Payment

Source: https://docs.transfeera.dev/reference/post_pix-qrcode-collection-immediate

An example of a transaction payload that includes split payment details. This shows how to define a primary transaction with an original value and optionally include one or more split payments.

```json
{
  "txid": "AAAAAABBBBBBBCCCCCCDDDDDabc123",
  "integration_id": "123456",
  "pix_key": "email@email.com",
  "original_value": 1,
  "payer_question": "Pagamento referente a X produto/serviço",
  "additional_info": [
    {
      "key": "NF XXXXX",
      "value": "19/07"
    }
  ],
  "payer": {
    "name": "Fulano de Souza",
    "document": "01234567899"
  },
  "reject_unknown_payer": true,
  "split_payment": [
    {
      "mode": "FIXADO",
      "amount": 3.5
    }
  ]
}
```

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

### Webhook Endpoint Example

Source: https://docs.transfeera.dev/reference/get_webhook-event-2

This section provides an example of a webhook request and its corresponding response, illustrating how Transfeera sends notifications about payment validations and delivery status.

```APIDOC
## Webhook Notification Example

### Description
This example shows a typical webhook payload received when a payment validation occurs and is delivered. It includes details about the validation, the date, and any requests made.

### Method
POST

### Endpoint
`/webhook` (Assumed endpoint for receiving webhooks)

### Parameters
#### Request Body
- **data** (object) - Required - Contains details about the event triggering the webhook.
  - **validation** (object) - Details of the payment validation.
    - **valid** (boolean) - Indicates if the validation was successful.
    - **errors** (array) - List of errors, if any.
    - **created_at** (string) - Timestamp of validation creation.
    - **receipt_url** (string) - URL to the receipt, if available.
    - **integration_id** (string) - ID of the integration.
    - **pix_description** (string) - Description for Pix payment.
    - **bank_receipt_url** (string) - URL to the bank receipt, if available.
    - **micro_deposit_method** (string) - Method used for micro-deposit.
    - **micro_deposit_status** (string) - Status of the micro-deposit.
  - **date** (string) - Timestamp of the event.
  - **object** (string) - Type of object (e.g., "Validation").
  - **version** (string) - API version.
- **delivered** (boolean) - Indicates if the notification was delivered.
- **requests** (array) - List of requests made as part of this notification.
  - **id** (string) - Unique identifier for the request.
  - **url** (string) - URL of the request.
  - **request_date** (string) - Timestamp when the request was made.
  - **response_date** (string) - Timestamp when the response was received.
  - **response_code** (integer) - HTTP status code of the response.
  - **response_payload** (string) - Payload of the response.
- **metadata** (object) - Metadata for the webhook event.
  - **pagination** (object) - Pagination details.
    - **itemsPerPage** (integer) - Number of items per page.
    - **totalItems** (integer) - Total number of items.

### Request Example
```json
{
  "data": {
    "validation": {
      "valid": true,
      "errors": [],
      "created_at": "2021-11-03T12:49:49.000Z",
      "receipt_url": null,
      "integration_id": null,
      "pix_description": null,
      "bank_receipt_url": null,
      "micro_deposit_method": "TRANSFERENCIA",
      "micro_deposit_status": "VALIDADO"
    },
    "date": "2021-11-03T09:51:40-03:00",
    "object": "Validation",
    "version": "v1"
  },
  "delivered": true,
  "requests": [
    {
      "id": "17678b94-fd8c-4b91-b27d-428d34b84862",
      "url": "https://webhook.url",
      "request_date": "2021-11-03T12:51:43.000Z",
      "response_date": "2021-11-03T12:51:44.000Z",
      "response_code": 200,
      "response_payload": ""
    }
  ],
  "metadata": {
    "pagination": {
      "itemsPerPage": 100,
      "totalItems": 1
    }
  }
}
```

### Response
#### Success Response (200)
Typically, a webhook endpoint would return a 200 OK status to acknowledge receipt of the notification. The payload might be simple, confirming receipt.
- **status** (string) - Confirmation message.

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

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

### Payment Creation and Configuration

Source: https://docs.transfeera.dev/reference/post_pix-qrcode-collection-immediate

This section details the parameters and structure for creating a new payment, including split payment configurations.

```APIDOC
## POST /payments

### Description
Creates a new payment transaction with various configuration options, including payer information, split payments, and additional details.

### Method
POST

### Endpoint
/payments

#### Query Parameters
None

#### Request Body
- **pix_key** (string) - Required - The Pix key for the payment.
- **original_value** (number) - Required - The original value of the payment.
- **txid** (string) - Optional - Transaction ID.
- **integration_id** (string) - Optional - Integration ID.
- **payer_question** (string) - Optional - A question for the payer.
- **additional_info** (array of objects) - Optional - Additional information for the payment.
  - **key** (string) - Required - Key for additional info.
  - **value** (string) - Required - Value for additional info.
- **payer** (object) - Optional - Payer details.
  - **name** (string) - Required - Payer's name.
  - **document** (string) - Required - Payer's document number.
- **reject_unknown_payer** (boolean) - Optional - Whether to reject payments from unknown payers.
- **split_payment** (array of objects) - Optional - Configuration for split payments.
  - **mode** (string) - Required - Mode of split ('FIXADO' or 'PERCENTUAL').
  - **amount** (number) - Required - The amount for the split.
  - **destination_bank_account** (object) - Required - Bank account details for the destination.
    - **pix_key_type** (string) - Required - Type of Pix key (CNPJ, TELEFONE, EMAIL, CHAVE_ALEATORIA, CPF).
    - **pix_key** (string) - Required - The Pix key.
  - **payment_date** (string) - Optional - Date for scheduled split payment.
  - **split_days_after_settled** (integer) - Optional - Number of days after settlement for scheduled split.

### Request Example
```json
{
  "txid": "AAAAAABBBBBBBCCCCCCDDDDDabc123",
  "integration_id": "123456",
  "pix_key": "email@email.com",
  "original_value": 1,
  "payer_question": "Pagamento referente a X produto/serviço",
  "additional_info": [
    {
      "key": "NF XXXXX",
      "value": "19/07"
    }
  ],
  "payer": {
    "name": "Fulano de Souza",
    "document": "01234567899"
  },
  "reject_unknown_payer": true,
  "split_payment": [
    {
      "mode": "FIXADO",
      "amount": 3.5,
      "destination_bank_account": {
        "pix_key_type": "EMAIL",
        "pix_key": "logistics@logistics.com"
      },
      "payment_date": "2023-03-30",
      "split_days_after_settled": 30
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the payment.
- **message** (string) - Message indicating success.

#### Response Example
```json
{
  "status": "success",
  "message": "Payment created successfully."
}
```

### Error Handling
- **400 Bad Request**: Invalid input data.
- **500 Internal Server Error**: Server error.
```

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

### List Payout Recurrences - PHP Example

Source: https://docs.transfeera.dev/reference/recorr%C3%AAncia

Example of how to list payout recurrences using PHP with cURL. This script makes a GET request to the Transfeera API and outputs the JSON response. Ensure you replace 'YOUR_BEARER_TOKEN' with your actual authentication token.

```php
<?php

$url = 'https://api.transfeera.com/payout_recurrences';
$user_agent = 'YourCompanyName (your.email@example.com)';
$bearer_token = 'YOUR_BEARER_TOKEN';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array(
    'User-Agent: ' . $user_agent,
    'Authorization: Bearer ' . $bearer_token,
    'Accept: application/json'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>
```

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

### List Payout Recurrences - Node.js Example

Source: https://docs.transfeera.dev/reference/recorr%C3%AAncia

Example of how to list payout recurrences using Node.js with the 'axios' library. This code makes a GET request to the Transfeera API and handles the JSON response. Replace 'YOUR_BEARER_TOKEN' with your actual authentication token.

```javascript
const axios = require('axios');

const listPayoutRecurrences = async () => {
  try {
    const response = await axios.get('https://api.transfeera.com/payout_recurrences', {
      headers: {
        'User-Agent': 'YourCompanyName (your.email@example.com)',
        'Authorization': 'Bearer YOUR_BEARER_TOKEN'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error listing payout recurrences:', error);
  }
};

listPayoutRecurrences();
```

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

### Split Payment Configuration Example

Source: https://docs.transfeera.dev/reference/post_pix-qrcode-collection-immediate

Demonstrates the structure for configuring split payments within a transaction. This includes setting the mode (fixed or percentage), amount, destination bank account details (pix key type and value), and payment scheduling.

```json
{
  "mode": "FIXADO",
  "amount": 3.5,
  "destination_bank_account": {
    "pix_key_type": "EMAIL",
    "pix_key": "logistics@logistics.com"
  },
  "payment_date": "2023-03-30",
  "split_days_after_settled": 30
}
```

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

### List Payout Recurrences - JavaScript Example

Source: https://docs.transfeera.dev/reference/recorr%C3%AAncia

Example of how to list payout recurrences using JavaScript's Fetch API. This code sends a GET request to the Transfeera API and processes the JSON response. Remember to replace 'YOUR_BEARER_TOKEN' with your actual authentication token.

```javascript
const listPayoutRecurrences = async () => {
  try {
    const response = await fetch('https://api.transfeera.com/payout_recurrences', {
      method: 'GET',
      headers: {
        'User-Agent': 'YourCompanyName (your.email@example.com)',
        'Authorization': 'Bearer YOUR_BEARER_TOKEN',
        'Accept': 'application/json'
      }
    });
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error('Error listing payout recurrences:', error);
  }
};

listPayoutRecurrences();
```

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

### Consultar Pix recebidos - Go SDK

Source: https://docs.transfeera.dev/reference/recebimentos-pix

Exemplo de código em Go para consultar Pix recebidos utilizando a API da Transfeera. Demonstra como configurar a requisição e processar a resposta.

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

### Webhook Endpoint Definition (OpenAPI)

Source: https://docs.transfeera.dev/reference/get_webhook-2

Defines the GET endpoint for consulting webhook URLs. It specifies request headers, response schemas, and example responses. This endpoint requires a 'User-Agent' header for identification.

```json
{
  "openapi": "3.1.0",
  "x-stoplight": {
    "id": "i1hs95wwzuffp"
  },
  "info": {
    "title": "ContaCerta",
    "version": "1.0",
    "contact": {
      "email": "dev@transfeera.com"
    }
  },
  "servers": [
    {
      "url": "https://contacerta-api.transfeera.com",
      "description": "Produção"
    },
    {
      "url": "https://contacerta-api-sandbox.transfeera.com",
      "description": "Sandbox"
    }
  ],
  "paths": {
    "/webhook": {
      "get": {
        "tags": [
          "Webhook"
        ],
        "summary": "Consultar URLs",
        "parameters": [
          {
            "name": "User-Agent",
            "in": "header",
            "description": "Todas as requests para a API da Transfeera deve conter o Header \"User-Agent\". Use este Header para nos dizer qual o nome da sua empresa e um e-mail para contato",
            "schema": {
              "type": "string",
              "example": "Empresa X (contato@empresax.com)"
            },
            "examples": {
              "default": {
                "value": "Empresa X (contato@empresax.com)"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "company_id": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "object_types": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "schema_version": {
                        "type": "string"
                      },
                      "signature_secret": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "updated_at": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "deleted_at": {
                        "type": "string",
                        "nullable": true,
                        "format": "date-time"
                      }
                    }
                  },
                  "x-examples": {
                    "Example 1": [
                      {
                        "id": "05fedf85-6425-4ed1-a397-1817b7fa3760",
                        "company_id": "4c0c8cf2-25d1-4deb-bb05-3f64789c3761",
                        "url": "https://your-webhook-url",
                        "object_types": [
                          "Transfer"
                        ],
                        "schema_version": "v1",
                        "signature_secret": "5d55729305b197168018fcff2a18e99f78ab8dd4efd03b6e895cf08bf104bca204944e45",
                        "created_at": "2019-09-30T20:38:11.000Z",
                        "updated_at": "2019-09-30T20:38:11.069Z",
                        "deleted_at": null
                      }
                    ]
                  }
                },
                "examples": {
                  "Success": {
                    "value": [
                      {
                        "id": "05fedf85-6425-4ed1-a397-1817b7fa3760",
                        "company_id": "4c0c8cf2-25d1-4deb-bb05-3f64789c3761",
                        "url": "https://your-webhook-url",
                        "object_types": [
                          "Transfer"
                        ],
                        "schema_version": "v1",
                        "signature_secret": "5d55729305b197168018fcff2a18e99f78ab8dd4efd03b6e895cf08bf104bca204944e45",
                        "created_at": "2019-09-30T20:38:11.000Z",
                        "updated_at": "2019-09-30T20:38:11.069Z",
                        "deleted_at": null
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "basic": []
          }
        ],
        "servers": [
          {
            "url": "https://api.transfeera.com",
            "description": "Produção"
          },
          {
            "url": "https://api-sandbox.transfeera.com",
            "description": "Sandbox"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basic": {
        "type": "http"
      }
    }
  }
}
```

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

### Consultar Saldo - API Transfeera (Go)

Source: https://docs.transfeera.dev/reference/saldo

Exemplo de requisição em Go para consultar o saldo da conta na API da Transfeera. O header 'User-Agent' é essencial para a identificação da sua aplicação.

```Go
package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	url := "https://api.transfeera.com/statement/balance"

	client := &http.Client{}
	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println("Erro ao criar requisição:", err)
		return
	}

	req.Header.Set("User-Agent", "NomeDaSuaEmpresa / seu.email@contato.com")
	req.Header.Set("Accept", "application/json")

	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Erro ao fazer requisição:", err)
		return
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		fmt.Printf("Erro: Código HTTP %d\n", resp.StatusCode)
		return
	}

	var result map[string]interface{}
	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
		fmt.Println("Erro ao decodificar resposta:", err)
		return
	}

	fmt.Printf("Saldo: %.2f\n", result["value"])
	fmt.Printf("Saldo em espera: %.2f\n", result["waiting_value"])
}
```

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

### Buscar bancos API Request (cURL)

Source: https://docs.transfeera.dev/reference/bancos-1

Example cURL request to the 'Buscar bancos' endpoint. This demonstrates how to make a GET request to retrieve bank information, including specifying the 'accept' header for JSON responses.

```shell
curl --request GET \
     --url https://contacerta-api.transfeera.com/bank \
     --header 'accept: application/json'
```

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

### cURL Request Example for Querying Validations

Source: https://docs.transfeera.dev/reference/valida%C3%A7%C3%A3o

This snippet demonstrates how to make a GET request to the Transfeera API to consult validations using cURL. It includes the base URL and necessary headers.

```Shell
curl --request GET \
     --url https://contacerta-api.transfeera.com/validation \
     --header 'accept: application/json'
```

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

### PHP Example for Querying Validations

Source: https://docs.transfeera.dev/reference/valida%C3%A7%C3%A3o

This PHP code snippet shows how to make a GET request to the Transfeera API to retrieve validation information. It uses cURL functions to set up and execute the HTTP request.

```PHP
// PHP example would go here
```

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

### Transfeera API Environments

Source: https://docs.transfeera.dev/reference/post_webhook

This section details the available environments for the Transfeera API, including production and sandbox URLs.

```APIDOC
## Transfeera API Environments

### Description
This section outlines the different environments available for interacting with the Transfeera API. Each environment has a specific base URL.

### Environments

#### Production
- **URL**: `https://api.transfeera.com`
- **Description**: Use this URL for production-level API requests.

#### Sandbox
- **URL**: `https://api-sandbox.transfeera.com`
- **Description**: Use this URL for testing and development purposes in a sandbox environment.
```

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

### Buscar bancos API Request (Shell, Go, Node.js, JavaScript, PHP)

Source: https://docs.transfeera.dev/reference/bancos-1

Code examples for making requests to the 'Buscar bancos' endpoint in various programming languages. These snippets show how to construct the GET request and handle the JSON response.

```shell
# To be implemented based on user's preference or common usage
```

```go
package main

import (
	"fmt"
	"net/http"
)

func main() {

	url := "https://contacerta-api.transfeera.com/bank"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("accept", "application/json")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println("Error making request:", err)
		return
	}
	defer res.Body.Close()

	fmt.Println("Status Code:", res.StatusCode)
	// Further processing of the response body can be done here
}
```

```node
const https = require('https');

const options = {
  hostname: 'contacerta-api.transfeera.com',
  port: 443,
  path: '/bank',
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
};

const req = https.request(options, (res) => {
  console.log(`statusCode: ${res.statusCode}`);

  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    console.log(JSON.parse(data));
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.end();
```

```javascript
fetch('https://contacerta-api.transfeera.com/bank', {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
.then(response => {
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return response.json();
})
.then(data => {
  console.log(data);
})
.catch(error => {
  console.error('Error fetching data:', error);
});
```

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://contacerta-api.transfeera.com/bank');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'accept: application/json'
));

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
```

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

### Transfeera Project Explorer and Proxy Settings

Source: https://docs.transfeera.dev/reference/get_pix-cashin

Configuration settings for the Transfeera developer project, including options to enable or disable an explorer interface and a proxy. It also specifies the programming languages supported for sample requests. These settings control how developers interact with and test the API.

```json
{
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "go",
      "node",
      "javascript",
      "php",
      "python",
      "ruby",
      "kotlin",
      "java"
    ],
    "proxy-enabled": true
  }
}
```

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

### Consultar bancos (Go)

Source: https://docs.transfeera.dev/reference/bancos

Exemplo de consulta à API de Bancos em Go utilizando o pacote `net/http`. Realiza uma requisição GET para a URL especificada, configurando o header `accept`. A resposta JSON é decodificada em uma struct Go.

```Go
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

type Bank struct {
	id int `json:"id"`
	code string `json:"code"`
	name string `json:"name"`
	ispb string `json:"ispb"`
	spiParticipantType string `json:"spi_participant_type"`
	image string `json:"image"`
}

func main() {
	url := "https://api.transfeera.com/bank"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		log.Fatalf("Error creating request: %v", err)
	}

	req.Header.Add("accept", "application/json")
	req.Header.Add("User-Agent", "YourCompanyName youremail@example.com")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		log.Fatalf("Error sending request: %v", err)
	}
	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		log.Fatalf("Error reading response body: %v", err)
	}


	var banks []Bank
	err = json.Unmarshal(body, &banks)
	if err != nil {
		log.Fatalf("Error unmarshalling JSON: %v", err)
	}

	for _, bank := range banks {
		fmt.Printf("ID: %d, Code: %s, Name: %s\n", bank.id, bank.code, bank.name)
	}
}
```

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

### Transaction Example Data

Source: https://docs.transfeera.dev/reference/get_pix-cashin

An example of a single transaction entry, showcasing all relevant fields including unique identifiers, monetary value, transaction type, and detailed payer/receiver information with bank specifics. This example is useful for understanding data population and expected values.

```json
{
  "id": "7109aea8-4883-4385-84f7-9b6e2743d521",
  "value": 20,
  "type": "DEPOSIT",
  "end2end_id": "E1819904720211103133500491873821",
  "txid": null,
  "integration_id": null,
  "receipt_file_url": "https://api.transfeera.com/pub/receipt/abc",
  "pix_key": "83f176d4-8640-4b3c-a5f2-c242775f8714",
  "pix_description": "Texto escrito pelo pagador no pagamento",
  "payer": {
    "name": "João da Silva",
    "document": "53690886082",
    "account_type": "CONTA_CORRENTE",
    "account": "383019",
    "account_digit": "0",
    "agency": "1",
    "bank": {
      "name": "Banco ltda",
      "code": null,
      "ispb": "234567"
    }
  },
  "receiver": {
    "name": "EMPRESA LTDA",
    "document": "24189547000142",
    "account_type": "CONTA_CORRENTE",
    "account": "573016",
    "account_digit": "0",
    "agency": "1",
    "bank": {
      "name": "Empresa ltda",
      "code": null,
      "ispb": "1235446"
    }
  }
}
```

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

### Consultar Saldo - API Transfeera (Node.js)

Source: https://docs.transfeera.dev/reference/saldo

Exemplo de requisição em Node.js utilizando a biblioteca 'node-fetch' para consultar o saldo da conta na API da Transfeera. O header 'User-Agent' é obrigatório.

```JavaScript
import fetch from 'node-fetch';

const url = 'https://api.transfeera.com/statement/balance';
const headers = {
  'User-Agent': 'NomeDaSuaEmpresa / seu.email@contato.com',
  'Accept': 'application/json'
};

async function getBalance() {
  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: headers
    });
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const data = await response.json();
    console.log('Saldo:', data.value);
    console.log('Saldo em espera:', data.waiting_value);
  } catch (error) {
    console.error('Erro ao consultar saldo:', error);
  }
}

getBalance();
```

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

### GET /accounts/{id}

Source: https://docs.transfeera.dev/reference/get-accounts-id

Retrieves details of a specific account by its ID. This endpoint is used to get information about an existing account.

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

### Description
Retrieves details of a specific account by its ID. This endpoint is used to get information about an existing account.

### Method
GET

### Endpoint
`/accounts/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - Id da conta

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - Identificador único da conta.
- **customer_id** (string) - Identificador do Customer.
- **status** (string) - Status da conta. Enum: `pending`, `active`, `blocked`, `closed`.
- **branch_number** (string) - Número da agência.
- **account_number** (string) - Número da conta.
- **activated_at** (string) - Data de ativação da conta.
- **blocked_at** (string) - Data de bloqueio da conta.
- **closed_at** (string) - Data de fechamento da conta.
- **created_at** (string) - Data de criação da conta.
- **updated_at** (string) - Data da última atualização da conta .

#### Response Example
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "customer_id": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
  "status": "active",
  "branch_number": "0001",
  "account_number": "12345-6",
  "activated_at": "2023-01-15T10:30:00Z",
  "blocked_at": null,
  "closed_at": null,
  "created_at": "2023-01-14T09:00:00Z",
  "updated_at": "2023-01-15T11:00:00Z"
}
```
Tokens:
Raw