API Tegge v1
  1. Sandbox
API Tegge v1
  • Tegge FGTS
    • Inicio
    • Aplicação
    • Web
    • API
    • Formalização
    • Suporte
  • Introdução a API
    • Casos de uso
    • Ambientes
    • Autenticação
  • Endpoints
    • Sandbox
      • Token
        POST
      • Consulta de saldo
        POST
      • Consulta de taxas
        GET
      • Simulação
        POST
      • Inserir proposta
        POST
      • Consulta de propostas
        GET
  1. Sandbox

Consulta de saldo

Testing
POST
https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/availablebalance
token

Request

Header Params
x-api-key
string 
required
Example:
PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==
Content-Type
string 
required
Example:
application/json
x-api-token
string 
required
Example:
{{token}}
Body Params application/json
cpf
string 
required
CPF
birthday
string 
required
Data de nascimento
Example
{
    "cpf": "cpf",
    "birthday": "yyyy-mm-dd"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/availablebalance' \
--header 'x-api-key: PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==' \
--header 'x-api-token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "cpf",
    "birthday": "yyyy-mm-dd"
}'

Responses

🟢200OK
application/json
Body
cpf
string 
required
key
string 
required
status
string 
required
event_datetime
string 
required
Example
{
    "cpf": "66702118805",
    "key": "6c3cb7d3-e586-485c-a28b-bc595981f34a",
    "status": "pending",
    "event_datetime": "2024-08-12T17:43:48"
}
🟠401Unauthorized
🔴500Server Error
Modified at 2024-08-15 12:20:52
Previous
Token
Next
Consulta de taxas
Built with