Visão Geral

Seja bem-vindo à documentação oficial da BANKISA! Aqui você encontrará todas as informações necessárias para fazer a integração com sua aplicação.

Para utilização da API, é necessário obter um TOKEN de autenticação.

São fornecidos 2 (dois) tipos de Tokens:

  • Token de Consulta
    Este token é utilizado exclusivamente para obter todas as consultas do tipo GET
  • Token de Transação
    Este token é utilizado exclusivamente realizar transações financeiras.

Comprovação

Após gerar seu token é necessario informa-lo em toda solicitação.

O token deve ser informado no cabeçalho, header, da requisição.

Defina o nome da chave como (Authorization) e o valor como (Bearer + 'seu token'):

$ch = curl_init();

                                                                curl_setopt($ch, CURLOPT_URL,"http://www.example.com/process.php");

                                                                curl_setopt($ch, CURLOPT_POST, 1);

                                                                curl_setopt($ch, CURLOPT_POSTFIELDS,$vars);  //Post Fields

                                                                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

                                                                
                                                                $headers = [

                                                                    'X-Apple-Tz: 0',

                                                                    'X-Apple-Store-Front: 143444,12',
                                                                    'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
                                                                    'Accept-Encoding: gzip, deflate',
                                                                    'Accept-Language: en-US,en;q=0.5',
                                                                    'Cache-Control: no-cache',
                                                                    'Content-Type: application/x-www-form-urlencoded; charset=utf-8',
                                                                    'Host: www.example.com',
                                                                    'Referer: http://www.example.com/index.php', //Your referrer address
                                                                    'User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:28.0) Gecko/20100101 Firefox/28.0',
                                                                    'X-MicrosoftAjax: Delta=true'
                                                                ];

Retorno

Todas as respostas da API são em formato JSON, compostas dos seguintes campos:

  • Status
    Sempre vai retornar 'true' para uma ação bem sucedida ou 'false' para uma ação malsucedida.
  • Mensage
    Em casos de uma ação malsucedida o sistema retorna uma mensagem sobre o motivo da falha.
  • Data
    Retorna os dados resultantes de uma consulta bem sucedida.
{"status": true, "mensage": "Usuario validado com sucesso", data: []"}

Validar usuario

Esse endpoint oferece uma forma de comprovar se o usuário que esta se cadastrando em seu site é realmente um usuário bankisa. Utilizando a conta e cpf do usuario para validação.

POST Validar usuario
https://api.bankisa.com.br/validar-usuario
HEADERS

Authentication

required

string

Bearer (TOKEN CONSULTA)

Informe seu token de consulta.

Content-Type

required

string

application/json
BODY

Conta

required

string

Informe a conta que deseja validar.
(EX. 00-000000)

Cpf

required

string

Informe o cpf para cruzamento com a conta.
(EX. 999.999.999-99)
Request

                                                                curl -X POST \ 

                                                                https://api.bankisa.com.br/validar-usuario \ 

                                                                -H 'authorization: Bearer (TOKEN CONSULTA)' \ 

                                                                -H 'cache-control: no-cache' \ 

                                                                -H 'content-type: application/json' \ 

                                                                -H 'postman-token: 2891d85d-192a-220c-66fa-acbc1fc00f22' \ 

                                                                -d '{ 

                                                                    "conta" : "00-000000", 

                                                                    "cpf" : "999.999.999-99" 

                                                                }'
Resposta de sucesso
{"status":true,"message":"A conta (00-000000) foi validada com sucesso.","data":[]}