Gestión de Cuentas

4 min

Al realizar operaciones sobre un comercio la Cuenta Corriente para la moneda principal del Comercio será creada automáticamente registrando en ella todas las transacciones realizadas de tipo Cash In, Cash Out, impuestos, ajustes, entre otros.

Obtener cuentas Comercio

Permite obtener las Cuentas Corrientes de un Comercio

GET

https://api.sugaway.com/p/operator/entity/:uid/account

Path Parameters

uidstringrequired
Description
Identificador Único del Comercio generado durante la creación

Header Parameters

x-api-keystring
x-access-tokenstring

curl

curl --location -g --request GET 'https://api.sugaway.com/p/operator/entity/:uid/account/{uid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://api.sugaway.com/p/operator/entity/:uid/account/{uid}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/operator/entity/:uid/account/{uid}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api.sugaway.com/p/operator/entity/:uid/account/{uid}"

payload={}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sugaway.com/p/operator/entity/:uid/account/{uid}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

200

404

{
      "message": "Ain't no cake like that."
    }

Crear Cuenta

Permite crear una cuenta corriente para un Comercio

POST

https://api.sugaway.com/p/accounts/

Header Parameters

x-api-keystring
Description
API Key del operador
x-access-tokenstring
Description
Access Token del operador
x-suga-entitystring
Description
ID del comercio sobre el cual se desea crear la cuenta

Body Parameters

referencestringrequired
Description
Referencia única de la cuenta
currencystringrequired
Description
Código de Moneda. Aceptados: ARS, CLP, USD, MXN, UYU

curl

curl --location --request POST 'https://api.sugaway.com/p/operator/entity/:uid/account' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"reference":"string","currency":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/operator/entity/:uid/account',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "reference": "string",
      "currency": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "reference": "string",
   "currency": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/operator/entity/:uid/account", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api.sugaway.com/p/operator/entity/:uid/account"

payload = json.dumps({
   "reference": "string",
   "currency": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sugaway.com/p/operator/entity/:uid/account")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "reference": "string",
   "currency": "string"
})

response = https.request(request)
puts response.read_body

200

{
      "name": "Cake's name",
    }

404

{
      "message": "Ain't no cake like that."
    }

Asignar CVU a una Cuenta

Permite asignar un CVU a una cuenta

POST

https://api.sugaway.com/p/accounts/:accounts/info

Path Parameters

accountidstringrequired
Description
Identificador de Cuenta Corriente

Header Parameters

x-api-keystringrequired
Description
API Key del operador
x-access-tokenstringrequired
Description
Access Token del operador
x-suga-entitystringrequired
Description
ID del comercio sobre el cual se desea agregar al CVU

Body Parameters

accountTypestringrequired
Description
Tipo de cuenta. Valor admitido "arg.cvu"
accountNumberstringrequired
Description
Número de CVU sobre el cual se desea agregar a la cuenta

Response

idstring
Description
ID of the cake retrieved

curl

curl --location --request POST 'https://api.sugaway.com/p/:accounts/info' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"accountType":"string","accountNumber":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/:accounts/info',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "accountType": "string",
      "accountNumber": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "accountType": "string",
   "accountNumber": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/:accounts/info", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api.sugaway.com/p/:accounts/info"

payload = json.dumps({
    "accountType": "string",
   "accountNumber": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sugaway.com/p/:accounts/info")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "accountType": "string",
   "accountNumber": "string"
})

response = https.request(request)
puts response.read_body

200

{
      "name": "Cake's name",
    }

404

{
      "message": "Ain't no cake like that."
    }

Obtener Cuenta

Permite obtener una cuenta corriente y el saldo de la misma

GET

https://api.sugaway.com/p/accounts/:accountid/info

Path Parameters

accountidstringrequired
Description
Identificador de Cuenta Corriente

Header Parameters

x-api-keystring
x-access-tokenstring

curl

curl --location -g --request GET 'https://api.sugaway.com/p/accounts/:accountid/info/{accountid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://api.sugaway.com/p/accounts/:accountid/info/{accountid}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/accounts/:accountid/info/{accountid}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api.sugaway.com/p/accounts/:accountid/info/{accountid}"

payload={}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sugaway.com/p/accounts/:accountid/info/{accountid}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

200

{
  "result": true,
  "data": {
    "balance": 10,
    "account_id": "EQWEQWEWQ212SSDDD"
  }
}

404

{
      "message": "Ain't no cake like that."
    }

Asociar Webhook

Permite asociar un Webhook a la cuenta mediante el cual se notificarán todas las transacciones entrantes o salientes tanto de la cuenta principal como de los Alias emitidos

POST

https://api.sugaway.com/p/accounts/:accountid/action/webhook

Path Parameters

uidstring
Description
ID del Comercio
accountidstring
Description
ID de la Cuenta

Header Parameters

x-api-keystring
x-access-tokenstring

Body Parameters

urlstringrequired
Description
URL del Webhook a asociar. Debe ser HTTPS de manera obligatoria de lo contrario no serán enviados

curl

curl --location --request POST 'https://api.sugaway.com/p/operator/entity/:uid/account' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"reference":"string","currency":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/operator/entity/:uid/account',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "reference": "string",
      "currency": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "reference": "string",
   "currency": "string"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/operator/entity/:uid/account", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api.sugaway.com/p/operator/entity/:uid/account"

payload = json.dumps({
   "reference": "string",
   "currency": "string"
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sugaway.com/p/operator/entity/:uid/account")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "reference": "string",
   "currency": "string"
})

response = https.request(request)
puts response.read_body

200

{
      "name": "Cake's name",
    }

404

{
      "message": "Ain't no cake like that."
    }

Creación de CVU

Sólo para Argentina

Emitir Cuenta CVU

Permite emitir cuenta CVU para usuarios de Argentina

GET

https://api.sugaway.com/p/operator/entity/:uid/account/:aid/issue

Path Parameters

uidstringrequired
Description
ID único de Comercio
aidstringrequired
Description
ID de la Cuenta

Header Parameters

x-api-keystring
x-access-tokenstring

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "id": "string"
});

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cakes.com", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

200

{
      "name": "Cake's name",
    }

404

{
      "message": "Ain't no cake like that."
    }