Criar transação de saída (Venezuela)
curl --request POST \
--url https://hg.cash/api/v1/ve/transactions/outbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "YOUR_ACCOUNT_UUID",
"amount": "25.5",
"firstName": "Ada",
"lastName": "Example",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V",
"prefijoTelefono": "+58",
"numeroTelefono": "0000000000",
"direccion": "Example street",
"ciudad": "Example city",
"pais": "VE",
"banco": "BANK_VALUE",
"tipoCuenta": "ACCOUNT_TYPE_VALUE",
"numeroCuenta": "00000000000000000000",
"nombreTitular": "Ada",
"apellidoTitular": "Example"
}
'import requests
url = "https://hg.cash/api/v1/ve/transactions/outbound"
payload = {
"accountId": "YOUR_ACCOUNT_UUID",
"amount": "25.5",
"firstName": "Ada",
"lastName": "Example",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V",
"prefijoTelefono": "+58",
"numeroTelefono": "0000000000",
"direccion": "Example street",
"ciudad": "Example city",
"pais": "VE",
"banco": "BANK_VALUE",
"tipoCuenta": "ACCOUNT_TYPE_VALUE",
"numeroCuenta": "00000000000000000000",
"nombreTitular": "Ada",
"apellidoTitular": "Example"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: 'YOUR_ACCOUNT_UUID',
amount: '25.5',
firstName: 'Ada',
lastName: 'Example',
email: 'payer@example.com',
documentoIdentidad: '00000000',
tipoDocumento: 'V',
prefijoTelefono: '+58',
numeroTelefono: '0000000000',
direccion: 'Example street',
ciudad: 'Example city',
pais: 'VE',
banco: 'BANK_VALUE',
tipoCuenta: 'ACCOUNT_TYPE_VALUE',
numeroCuenta: '00000000000000000000',
nombreTitular: 'Ada',
apellidoTitular: 'Example'
})
};
fetch('https://hg.cash/api/v1/ve/transactions/outbound', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hg.cash/api/v1/ve/transactions/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => 'YOUR_ACCOUNT_UUID',
'amount' => '25.5',
'firstName' => 'Ada',
'lastName' => 'Example',
'email' => 'payer@example.com',
'documentoIdentidad' => '00000000',
'tipoDocumento' => 'V',
'prefijoTelefono' => '+58',
'numeroTelefono' => '0000000000',
'direccion' => 'Example street',
'ciudad' => 'Example city',
'pais' => 'VE',
'banco' => 'BANK_VALUE',
'tipoCuenta' => 'ACCOUNT_TYPE_VALUE',
'numeroCuenta' => '00000000000000000000',
'nombreTitular' => 'Ada',
'apellidoTitular' => 'Example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hg.cash/api/v1/ve/transactions/outbound"
payload := strings.NewReader("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hg.cash/api/v1/ve/transactions/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hg.cash/api/v1/ve/transactions/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "processing"
}
Venezuela
Criar transação de saída (Venezuela)
Cria um payout em USDT. amount é uma string decimal positiva, não um número JSON. Até 8 dígitos fracionários podem aparecer.
Obrigatórios: accountId, amount, firstName, lastName, email, documentoIdentidad, tipoDocumento,
prefijoTelefono, numeroTelefono, direccion, ciudad, pais (VE), banco, tipoCuenta, numeroCuenta,
nombreTitular, apellidoTitular.
Opcionais: celular, webhookUrl. celular é obrigatório quando tipoCuenta é Pago Móvil (13, Pago Móvil ou pago_movil).
Envie banco, tipoCuenta e tipoDocumento como o value do catálogo de GET /ve/banks. Rótulos em texto são aceitos.
BANK_VALUE e ACCOUNT_TYPE_VALUE no exemplo são marcadores desses valores.
documentoIdentidad é somente dígitos. A letra fica em tipoDocumento (V, J, P ou E). Um prefixo correspondente é removido.
Saldo insuficiente retorna 409 com code: INSUFFICIENT_NET_BALANCE.
Se o destinatário ainda precisa de verificação de identidade, a resposta é 201 com status: pending_kyc, kyc_url quando uma URL foi armazenada,
e kyc_expires_at (24 horas a partir da criação). Esse valor e a taxa de saída ficam reservados. O saldo da conta não é debitado.
Nenhuma ordem de payout é criada até a verificação ser aprovada.
Verificação aprovada com uma conta bancária utilizável retorna 201 com status: processing.
Verificação recusada, verificação que terminou sem aprovação, um e-mail cujo documento não corresponde, um documento rejeitado
ou uma conta bancária rejeitada não cria uma transação e retorna 400 com code
KOLLAT_KYC_DECLINED, KOLLAT_KYC_NOT_APPROVED, KOLLAT_IDENTITY_UNCONFIRMED, KOLLAT_INVALID_DOCUMENT,
KOLLAT_INVALID_BANK, missing_cuenta_id ou missing_terms.
A string error diz o que corrigir em uma falha de conta bancária ou de documento.
Uma conta inexistente retorna 404. Sem acesso retorna 403. Bloqueada ou Cerrada retorna 403 com code: ACCOUNT_NOT_OPERATIVE.
Uma conta incompatível ou uma moeda diferente de USDT retorna 400.
POST
/
ve
/
transactions
/
outbound
Criar transação de saída (Venezuela)
curl --request POST \
--url https://hg.cash/api/v1/ve/transactions/outbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "YOUR_ACCOUNT_UUID",
"amount": "25.5",
"firstName": "Ada",
"lastName": "Example",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V",
"prefijoTelefono": "+58",
"numeroTelefono": "0000000000",
"direccion": "Example street",
"ciudad": "Example city",
"pais": "VE",
"banco": "BANK_VALUE",
"tipoCuenta": "ACCOUNT_TYPE_VALUE",
"numeroCuenta": "00000000000000000000",
"nombreTitular": "Ada",
"apellidoTitular": "Example"
}
'import requests
url = "https://hg.cash/api/v1/ve/transactions/outbound"
payload = {
"accountId": "YOUR_ACCOUNT_UUID",
"amount": "25.5",
"firstName": "Ada",
"lastName": "Example",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V",
"prefijoTelefono": "+58",
"numeroTelefono": "0000000000",
"direccion": "Example street",
"ciudad": "Example city",
"pais": "VE",
"banco": "BANK_VALUE",
"tipoCuenta": "ACCOUNT_TYPE_VALUE",
"numeroCuenta": "00000000000000000000",
"nombreTitular": "Ada",
"apellidoTitular": "Example"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: 'YOUR_ACCOUNT_UUID',
amount: '25.5',
firstName: 'Ada',
lastName: 'Example',
email: 'payer@example.com',
documentoIdentidad: '00000000',
tipoDocumento: 'V',
prefijoTelefono: '+58',
numeroTelefono: '0000000000',
direccion: 'Example street',
ciudad: 'Example city',
pais: 'VE',
banco: 'BANK_VALUE',
tipoCuenta: 'ACCOUNT_TYPE_VALUE',
numeroCuenta: '00000000000000000000',
nombreTitular: 'Ada',
apellidoTitular: 'Example'
})
};
fetch('https://hg.cash/api/v1/ve/transactions/outbound', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hg.cash/api/v1/ve/transactions/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => 'YOUR_ACCOUNT_UUID',
'amount' => '25.5',
'firstName' => 'Ada',
'lastName' => 'Example',
'email' => 'payer@example.com',
'documentoIdentidad' => '00000000',
'tipoDocumento' => 'V',
'prefijoTelefono' => '+58',
'numeroTelefono' => '0000000000',
'direccion' => 'Example street',
'ciudad' => 'Example city',
'pais' => 'VE',
'banco' => 'BANK_VALUE',
'tipoCuenta' => 'ACCOUNT_TYPE_VALUE',
'numeroCuenta' => '00000000000000000000',
'nombreTitular' => 'Ada',
'apellidoTitular' => 'Example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hg.cash/api/v1/ve/transactions/outbound"
payload := strings.NewReader("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hg.cash/api/v1/ve/transactions/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hg.cash/api/v1/ve/transactions/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"amount\": \"25.5\",\n \"firstName\": \"Ada\",\n \"lastName\": \"Example\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\",\n \"prefijoTelefono\": \"+58\",\n \"numeroTelefono\": \"0000000000\",\n \"direccion\": \"Example street\",\n \"ciudad\": \"Example city\",\n \"pais\": \"VE\",\n \"banco\": \"BANK_VALUE\",\n \"tipoCuenta\": \"ACCOUNT_TYPE_VALUE\",\n \"numeroCuenta\": \"00000000000000000000\",\n \"nombreTitular\": \"Ada\",\n \"apellidoTitular\": \"Example\"\n}"
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "processing"
}
Autorizações
Token de autenticação da API do usuário com o formato cash_<64-char-hex>. Valor de exemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.
Corpo
application/json
Exemplo:
"YOUR_ACCOUNT_UUID"
String decimal USDT positiva. Não é um número JSON. Até 8 dígitos fracionários podem aparecer. Valores em VES não são este campo.
Pattern:
^\d+(\.\d+)?$Exemplo:
"100.5"
Exemplo:
"Ada"
Exemplo:
"Example"
Exemplo:
"payer@example.com"
Exemplo:
"00000000"
value do catálogo em country.documentTypes.
Exemplo:
"V"
Exemplo:
"+58"
Exemplo:
"0000000000"
Exemplo:
"Example street"
Exemplo:
"Example city"
Opções disponíveis:
VE value do catálogo em country.banks. Marcador BANK_VALUE.
Exemplo:
"BANK_VALUE"
value do catálogo em country.accountTypes. Marcador ACCOUNT_TYPE_VALUE. celular é obrigatório para Pago Móvil (13, Pago Móvil ou pago_movil).
Exemplo:
"ACCOUNT_TYPE_VALUE"
Exemplo:
"00000000000000000000"
Exemplo:
"Ada"
Exemplo:
"Example"
Obrigatório para Pago Móvil. Marcador +580000000000.
Exemplo:
"+580000000000"
Resposta
processing quando a verificação está aprovada e há uma conta bancária utilizável. pending_kyc quando a verificação ainda é necessária. O valor e a taxa de saída ficam reservados. O saldo não é debitado e nenhuma ordem de payout é criada até a verificação ser aprovada. kyc_expires_at é 24 horas a partir da criação.