A API V3 JÁ ESTÁ DISPONÍVEL
A API v2 foi descontinuada e não receberá mais atualizações.
Acesse a documentação da API v3
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. Realize a migração para a nova versão o mais breve possível. Consulte o calendário
|
Obtém as formas de pagamento
Recupera todos as formas de pagamento cadastrados no sistema.
cURL |
curl -X GET "https://bling.com.br/Api/v2/formaspagamento/json/" \ -G \ -d "apikey={apikey}"
|
PHP |
/** * @param [string] $uri Recurso * @param [string] $outputType Formato de retorno (json / xml) * @param [array] $params Parametros da requisição * @return [mixed] $response Retorno da requisição */ function executeGet($uri, $outputType, $params) { $curlHandle = curl_init();
$url = 'https://bling.com.br/Api/v2/' . $uri . '/' . $outputType; curl_setopt_array($curlHandle, [ CURLOPT_URL => $url . '?' . http_build_query($params), CURLOPT_RETURNTRANSFER => true ]);
$response = curl_exec($curlHandle);
if ($errorNumber = curl_errno($curlHandle)) { $response = 'cURL error (' . $errorNumber . '): ' . curl_strerror($errorNumber); }
curl_close($curlHandle);
return $response; }
echo executeGet('formaspagamento', 'json', [ 'apikey' => '{apikey}' ]);
|
C#
|
public static void ExecuteGet() { var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/formaspagamento/json&apikey={apikey}"); request.ContentType = "application/json"; request.Method = "GET"; using (HttpWebResponse response = request.GetResponse() as HttpWebResponse) { if (response.StatusCode != HttpStatusCode.OK) Console.Out.WriteLine("Error. Server returned status code: {0}", response.StatusCode); using (StreamReader reader = new StreamReader(response.GetResponseStream())) { var content = reader.ReadToEnd(); if(string.IsNullOrWhiteSpace(content)) Console.Out.WriteLine("Empty Response"); else Console.Out.WriteLine("Response Body: \r\n {0}", content); } } }
|
Parâmetro |
Descrição |
Tipo |
apikey |
apikey gerada no sistema |
string |
Filtros
Pode-se utilizar filtros para restringir o retorno de dados. Observe a tabela de possíveis filtros abaixo.
Filtro |
Descrição |
Tipo |
Predicate |
descricao |
Descrição da forma de pagamento |
string |
|
codigoFiscal |
Código fiscal vinculado à forma de pagamento |
integer |
|
situacao |
Situação da forma de pagamento |
integer |
|
cURL |
curl -X GET "https://bling.com.br/Api/v2/formaspagamento/json/" \
-G \
-d "filters=descricao[Cartão%20de%20crédito];codigoFiscal[3]" \
-d "apikey={apikey}"
|
PHP |
/** * @param [string] $uri Recurso * @param [string] $outputType Formato de retorno (json / xml) * @param [array] $params Parametros da requisição * @return [mixed] $response Retorno da requisição */ function executeGet($uri, $outputType, $params) { $curlHandle = curl_init();
$url = 'https://bling.com.br/Api/v2/' . $uri . '/' . $outputType; curl_setopt_array($curlHandle, [ CURLOPT_URL => $url . '?' . http_build_query($params), CURLOPT_RETURNTRANSFER => true ]);
$response = curl_exec($curlHandle);
if ($errorNumber = curl_errno($curlHandle)) { $response = 'cURL error (' . $errorNumber . '): ' . curl_strerror($errorNumber); } curl_close($curlHandle);
return $response; }
echo executeGet('formaspagamento', 'json', [ 'apikey' => '{apikey}', 'filters' => 'descricao[Cartão de crédito];codigoFiscal[3]' ]);
|
Retorno
Em caso de sucesso, retornará todas as formas de pagamento, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Exemplo de Retorno
{
"retorno": {
"formaspagamento": [{
"formapagamento": {
"id": "1",
"descricao": "Dinheiro",
"codigoFiscal": "1",
"padrao": "0",
"situacao": 1
}
}]
}
}