Alias o Sub-Cuentas Virtuales

3 min

Esta API permite crear Sub-Cuentas Virtuales con información adicional de la misma que al ingresar pagos será enviado junto al mismo. Estas Cuentas permiten emitir una cuenta para el mercado como es el caso de los CVU en Argentina.

Crear Alias de una Cuenta

Permite crear un alias de una cuenta o Sub-Cuenta Virtual

POST

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

Path Parameters

accountidstringrequired
Description
Identificador de la cuenta

Header Parameters

x-api-keystring
x-access-tokenstring
Content-TypeStringrequired
Description
application/json

Body Parameters

referencestringrequired
Description
ID único que le permita reconocer su alias. Este ID no debe repetirse. Podrá acceder al alias utilizando este ID. Alfanumerico. No acepta dos puntos ":" como caracter especial.
metadataObjectrequired
Description
Objeto JSON con datos que le permitan identificar ante un cash-in a quien pertenece la cuenta. Max 20kb en datos
issueBoolean
Description
Fuerza a que el sistema emita una Cuenta Virtual. En Argentina esto obliga al servicio a generar un CVU para esta sub-cuenta

curl

curl --location -g --request POST 'https://api.sugaway.com/p/accounts/:accountid/alias/{accountid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"reference":"string","metadata":"Object","issue":"Boolean"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/accounts/:accountid/alias/{accountid}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "reference": "string",
      "metadata": "Object",
      "issue": "Boolean"
   })

};
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",
   "metadata": "Object",
   "issue": "Boolean"
});

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

fetch("https://api.sugaway.com/p/accounts/:accountid/alias/{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/alias/{accountid}"

payload = json.dumps({
   "reference": "string",
   "metadata": "Object",
   "issue": "Boolean"
})
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/:accountid/alias/{accountid}")

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",
   "metadata": "Object",
   "issue": "Boolean"
})

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

200

{
    "result": true,
    "data": {
        "uid": "ACA:GRB0XICVTKVW01MSDD",
        "reference": "12345637812"
    }
}

Obtener Alias de una Cuenta

Permite obtener un alias de una cuenta o Sub-Cuenta Virtual

GET

https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid

Path Parameters

accountidstringrequired
Description
Identificador de la cuenta
aliasidstringrequired
Description
ID del Alias devuelto en la creación o Reference utilizado en la creación.

Header Parameters

x-api-keystring
x-access-tokenstring
Content-TypeStringrequired
Description
application/json

curl

curl --location -g --request GET 'https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/{accountid}/{aliasid}' \
--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/alias/:aliasid/{accountid}/{aliasid}',
   '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/alias/:aliasid/{accountid}/{aliasid}", 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/alias/:aliasid/{accountid}/{aliasid}"

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/alias/:aliasid/{accountid}/{aliasid}")

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
}

Emitir Cuenta Virtual de un Alias

Permite emitir la Cuenta Virtual de un alias de una cuenta o Sub-Cuenta Virtual

POST

https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue

Path Parameters

accountidstringrequired
Description
Identificador de la cuenta
aliasidstringrequired
Description
ID del Alias devuelto en la creación o Reference utilizado en la creación.

Header Parameters

x-api-keystring
x-access-tokenstring
Content-TypeStringrequired
Description
application/json

curl

curl --location -g --request POST 'https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}',
   '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: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}", 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/alias/:aliasid/action/issue/{accountid}/{aliasid}"

payload={}
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/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}")

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"

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

200

{
  "result": true
}

Ejecutar Cash-in de prueba sobre un Alias

Permite ejecutar un Cash-In de prueba sobre un Alias. Sólo se permite utilizar esta funcionalidad sobre cuentas y alias de prueba. El ID de la cuenta de prueba será provisto por nuestro equipo durante el desarrollo.

GET

https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/test

Path Parameters

accountidstringrequired
Description
Identificador de la cuenta
aliasidstringrequired
Description
ID del Alias devuelto en la creación o Reference utilizado en la creación.

Header Parameters

x-api-keystring
x-access-tokenstring
Content-TypeStringrequired
Description
application/json

curl

curl --location -g --request POST 'https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}',
   '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: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sugaway.com/p/accounts/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}", 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/alias/:aliasid/action/issue/{accountid}/{aliasid}"

payload={}
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/:accountid/alias/:aliasid/action/issue/{accountid}/{aliasid}")

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"

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

200

{
  "result": true
}

Obtener todos los Alias Emitidos

Permite obtener todos los Alias emitidos para una Cuenta

GET

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

Path Parameters

accountidstringrequired
Description
Identificador de la cuenta
aliasidstringrequired
Description
ID del Alias devuelto en la creación o Reference utilizado en la creación.

Header Parameters

x-api-keystring
x-access-tokenstring
Content-TypeStringrequired
Description
application/json

curl

curl --location -g --request GET 'https://api.sugaway.com/p/accounts/:accountid/alias/{accountid}/{aliasid}' \
--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/alias/{accountid}/{aliasid}',
   '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/alias/{accountid}/{aliasid}", 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/alias/{accountid}/{aliasid}"

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/alias/{accountid}/{aliasid}")

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
}