Listagem de Pagamentos

Requisição para consultar os dados de pagamentos.

Método GET

https://{api_address}/payments/

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";
    $params["sort"] = "id_desc";

    $url = "https://{api_address}/payments/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    
queryParameters.Add("sort", "id_desc");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
			

String url = "https://{api_address}/payments/";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");
mapToConvert.put("sort", "id_desc");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}
			

Parâmetro

Campo Tipo Descrição
access_token String

Token de acesso

attrs String

Atributos do pagamento

limit Number

Limite de registros

page Number

Página corrente

sort String

Ordenação ex.: [campo]_[asc/desc]

Success 200

Campo Tipo Descrição
paging Object

Dados de paginação

  total Number

Total de registros

  page Number

Página corrente

  offset Number

Registro inicial da página

  limit Number

Limite de registros

  maxLimit Number

Máximo de registros

sort Object[]

Ordenação

availableFilters String[]

Filtros disponíveis

appliedFilters String[]

Filtros utilizados

Payments Object

Lista de pagamentos

  Payment Object

Dados do pagamento

    id Number

Código do pagamento

    order_id Number

Código do pedido

    payment_method_id Number

Código do meio de pagamento

    payment_place String

Local de pagamento

    value Decimal

Valor pago

    note String

Informações adicionais do pagamento

    created Date

Data de criação

    modified Date

Data de modificação

HTTP/1.1 200 OK
{
    "paging": {
        "total": 39,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
            "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "order_id",
        "created",
        "modified"
    ],
    "appliedFilters": [],
    "Payments": [
        {
            "Payment": {
                "id": "1",
                "order_id": "123",
                "payment_method_id": "12",
                "payment_place": "",
                "value": "50.85",
                "note": "",
                "created": "2016-08-16 16:17:38",
                "modified": "2016-08-16 16:17:38"
            }
        }
    ]
}

 

Consultar Dados de Pagamento

Requisição para consultar os dados de um pagamento do pedido.

Método GET

https://{api_address}/payments/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/payments/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
			

String url = "https://{api_address}/payments/123";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}
			

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id String

Código do pagamento

Success 200

Campo Tipo Descrição
Payment Object

Dados do pagamento

  id Number

Código do pagamento

  order_id Number

Código do pedido

  payment_method_id Number

Código do meio de pagamento

  method String

Descrição do meio de pagamento

  payment_place String

Local de pagamento

  value Decimal

Valor pago

  date Date

Data do pagamento

  note String

Informações adicionais do pagamento

  created Date

Data de criação

  modified Date

Data de modificação

HTTP/1.1 200 OK
{
    "Payment": {
        "id": "1",
        "order_id": "123",
        "payment_method_id": "12",
        "method": "Boleto Bancário",
        "payment_place": "",
        "value": "50.85",
        "date": "2016-08-15",
        "note": "",
        "created": "2016-08-16 16:17:38",
        "modified": "2016-08-16 16:17:38"
    }
}
 

Cadastrar Pagamento

Requisição para cadastro de um pagamento do pedido. Deverá enviar o JSON com os dados do pagamento para o cadastro.

Método POST

https://{api_address}/payments/

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $data["Payment"]["order_id"] = "123";
    $data["Payment"]["method"] = "Cartão de Crédito";
    $data["Payment"]["value"] = "50.85";
    $data["Payment"]["date"] = "2016-08-15";
    $data["Payment"]["note"] = "Pagamento realizado com sucesso";

    $url = "https://{api_address}/payments/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "201"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

string postString  = "{";
       postString += "  \"Payment\": {";
       postString += "      \"order_id\": \"123\",";
       postString += "      \"method\": \"Cartão de Crédito\",";
       postString += "      \"value\": \"50.85\",";
       postString += "      \"date\": \"2016-08-15\",";
       postString += "      \"note\": \"Pagamento realizado com sucesso\"";
       postString += "  }";
       postString += "}";

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "POST";
webRequest.ContentType = "application/json";

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(postString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
						

String url = "https://{api_address}/payments/";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("POST");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    String postString  = "{";
           postString += "  \"Payment\": {";
           postString += "      \"order_id\": \"123\",";
           postString += "      \"method\": \"Cartão de Crédito\",";
           postString += "      \"value\": \"50.85\",";
           postString += "      \"date\": \"2016-08-15\",";
           postString += "      \"note\": \"Pagamento realizado com sucesso\"";
           postString += "  }";
           postString += "}";
           
    // Send post request
    con.setDoOutput(true);
    DataOutputStream wr = new DataOutputStream(con.getOutputStream());
    wr.writeBytes(postString);
    wr.flush();
    wr.close();

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

Payment JSON

Dados do pagamento

  order_id Number

Código do pedido

  method String

Descrição da forma de pagamento

  value Decimal

Valor pago

  date Date

Data do pagamento

  note String

Informações adicionais do pagamento

POST /payments/?access_token=abc96fb7b1defd2496b9a9d81071fa12319b12306465e057d0ebca9bd9ab19
{
    "Payment": {
        "order_id": "123", 
        "method": "Cartão de Crédito", 
        "value": "50.85",
        "date": "2016-08-15"
        "note": "Pagamento realizado com sucesso"
    }
}

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

Código do pagamento

code Number

Código do retorno (201)

HTTP/1.1 201 OK
{
    "message": "Created",
    "id": "123",
    "code": 201
}
 

Atualizar Dados de Pagamento

Requisição para alterar os dados de pagamento de um pedido. Deverá enviar o JSON com os dados do pagamento para a alteração.

Método PUT

https://{api_address}/payments/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $data["Payment"]["order_id"] = "123";
    $data["Payment"]["method"] = "Cartão de Crédito";
    $data["Payment"]["value"] = "50.85";
    $data["Payment"]["date"] = "2016-08-15";
    $data["Payment"]["note"] = "Pagamento realizado com sucesso";

    $url = "https://{api_address}/payments/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

string putString  = "{";
       putString += "  \"Payment\": {";
       putString += "      \"order_id\": \"123\",";
       putString += "      \"method\": \"Cartão de Crédito\",";
       putString += "      \"value\": \"50.85\",";
       putString += "      \"date\": \"2016-08-15\",";
       putString += "      \"note\": \"Pagamento realizado com sucesso\"";
       putString += "  }";
       putString += "}";

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "PUT";
webRequest.ContentType = "application/json";

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(putString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
						

String url = "https://{api_address}/payments/123";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("PUT");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    String putString  = "{";
           putString += "  \"Payment\": {";
           putString += "      \"order_id\": \"123\",";
           putString += "      \"method\": \"Cartão de Crédito\",";
           putString += "      \"value\": \"50.85\",";
           putString += "      \"date\": \"2016-08-15\",";
           putString += "      \"note\": \"Pagamento realizado com sucesso\"";
           putString += "  }";
           putString += "}";
           
    // Send put request
    con.setDoOutput(true);
    DataOutputStream wr = new DataOutputStream(con.getOutputStream());
    wr.writeBytes(putString);
    wr.flush();
    wr.close();

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode == 200){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}
						

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id Number

Código do pagamento

Payment JSON

Dados do pagamento

  order_id Number

Código do pedido

  method String

Descrição da forma de pagamento

  value Decimal

Valor pago

  date Date

Data do pagamento

  note String

Informações adicionais do pagamento

PUT /payments/123?access_token=abc96fb7b1defd2496b9a9d81071fa12319b12306465e057d0ebca9bd9ab19
{
    "Payment": {
        "order_id": "123", 
        "method": "Cartão de Crédito", 
        "value": "50.85",
        "date": "2016-08-15"
        "note": "Pagamento realizado com sucesso"
    }
}

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

Código do pagamento

code Number

Código do retorno (200)

HTTP/1.1 200 OK
{
    "message": "Saved",
    "id": "123",
    "code": 200
}

 

Excluir Pagamento

Requisição para excluir um pagamento do pedido.

Método DELETE

https://{api_address}/payments/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/payments/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "DELETE";
webRequest.ContentType = "application/json";

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
								 

String url = "https://{api_address}/payments/123";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("DELETE");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode == 200){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}
								 

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id String

Código do pagamento

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id String

Código do pagamento

code Number

Código do retorno (200)

HTTP/1.1 200 OK
{
    "message": "Deleted",
    "id": "123",
    "code": 200
}
 

Opções de Pagamentos

Requisição para consultar as opções de pagamentos para um carrinho de compra / pedido.

Método GET

https://{api_address}/payments/options

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";
    $params["order_id"] = "123";

    $url = "https://{api_address}/payments/options/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/options/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    
queryParameters.Add("order_id", "123");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
														

String url = "https://{api_address}/payments/options/";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");
mapToConvert.put("order_id", "123");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}
														

Parâmetro

Campo Tipo Descrição
access_token String

Token de acesso

cart_session_id String

Código da sessão do carrinho

order_id Number

Código do pedido

Success 200

Campo Tipo Descrição
PaymentOptions Object[]

Lista de opções de pagamento

  id Number

Código da opção de pagamento

  integrator_id Number

Código do integrador

  facilitator_id Number

Código do facilitador

  name String

Nome

  image String

Imagem

  thumbnail String

Ícone

  additional Number

Informações adicionais

  min_splot Number

Número máximo de parcelas

  max_splot Number

Número mínimo de parcelas

  application_value Decimal

Valor de

  integration_code Number

Referência do integrador

  facilitator Number

facilitador (Veja Tabela A)

  text String

Texto

  text_pag String

Texto do pagamaento

  finalize_action String

Ação de finalização

  card Number

Cartão de crédito (Veja Tabela B)

  discount_value Decimal

Valor de desconto

  increase_value Decimal

Valor adicional

  plots Object

Parcelamentos

    :id Number

Código da parcelamento

      value Decimal

Valor de parcelamento

      interest Number

Informações de acréscimo / taxa

      interest_value Decimal

Valor de acréscimo / taxa

      discount_value Decimal

Valor de desconto

      base_value Decimal

Valor base

      order_total Decimal

Valor total

  increase Number

Acréscimo no pagamento (Veja Tabela C)

  display_increase Number

Exibir valor de acréscimo (Veja Tabela D)

  deactivate Number

Opção de pagamento desativada (Veja Tabela E)

  total_base Decimal

Valor total base

  tax_value Decimal

Valor da taxa

  is_intermediator Number

Intermediador de Pagamento (Veja Tabela F)

  interest_formula String

Formulá do calculo de acréscimo

  equivalent Number[]

Opções de pagamento equivalentes

HTTP/1.1200 OK
{"PaymentOptions":[{"id":"1","integrator_id":"123","facilitator_id":"","name":"Cartão de Crédito","image":"pag_cartacredito.png","thumbnail":"pag_peqcartacredito.png","additional":"0","min_splot":"12","max_splot":"0","application_value":"1","integration_code":"3","facilitator":"0","text":"Cartão de Crédito","text_pag":"Cartão de Crédito","finalize_action":"","card":"1","discount_value":"50.85","increase_value":"0","plots":{"1":{"value":"50.85","interest":"0","interest_value":"0","discount_value":"0","base_value":"50.85","order_total":"5"}},"increase":"1","display_increase":"1","deactivate":"1","total_base":"50.85","tax_value":"0.00","is_intermediator":"1","interest_formula":"price","equivalent":["4","2","5","16","18"]},}}

 

Configurações de Pagamento

Requisição para consultar as configurações da forma de pagamentos para um carrinho de compra / pedido.

Método GET

https://{api_address}/payments/methods/settings/:1d

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/payments/methods/settings/12/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/payments/methods/settings/12/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
																

String url = "https://{api_address}/payments/methods/settings/12/";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}
Parâmetro
																

Parâmetro

Campo Tipo Descrição
access_token String

Token de acesso

:id Number

Código da forma de pagamento

Success 200

Campo Tipo Descrição
Settings Object

Dados da configuração da forma de pagamento

  sub_store String

Nome da loja

  reseller_token String

Token de revendedor

  seller_code String

Token de vendedor

  secure_url String

URL de ambiente seguro da loja

HTTP/1.1 200 OK
{
    "Settings": {
        "sub_store": "Nome da Loja",
        "reseller_token": "123abc456def789",
        "seller_code": "123abc456def7890123abc456def7890",
        "secure_url": "https://loja.commercesuite.com.br"
    }
}

 

Tabelas Auxiliares

Tabelas Auxiliares de Categorias

Tabela A - Identificar se é um facilitador (campo facilitator)

Valor Descrição
0 Não é um facilitador
1 É um facilitador

Tabela B - Disponibilidade de cartão de crédito (campo card)

Valor Descrição
0 Pagamento sem cartão de crédito
1 Pagamento com cartão de crédito

Tabela C - Disponibilidade de acréscimo no pagamento (campo increase)

Valor Descrição
0 Pagamento sem acréscimo
1 Pagamento com acréscimo

Tabela D - Exibir valor de acréscimo (campo display_increase)

Valor Descrição
0 Ocultar valor de acréscimo
1 Exibir valor de acréscimo

Tabela E - Opção de pagamento desativada (campo deactivate)

Valor Descrição
0 Pagamento ativo
1 Pagamento desativado

Tabela F - Intermediador de Pagamento (campo is_intermediator)

Valor Descrição
0 Não é um intermediador de pagamento
1 É um intermediador de pagamento
Frontend - Agencia 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk