Simulación

Permite simular cuánto dinero un destinatario recibirá.

Endpoint

    
GET /api/v3/transfers/simulate HTTP/1.1
Authorization: Bearer token
Content-Type: application/json

{
  "source_amount_cents": 250,
  "source_amount_currency": "CLP",
  "country_id": 10,
  "destination_amount_currency": "COP"
}

    
  

Parametros

Parametro	Detalles
source_amount_cents	Valor en "centavos" que se enviará
source_amount_currency	Código de la moneda de origen
country_id	ID del país donde se recibirá el dinero
destination_amount_currency	Código de la moneda a recibir

Ejemplo de respuestas

Respuesta 200

    
{
  "source_currency": "CLP",
  "destination_currency": "VES",
  "rate": "0.0398742",
  "source_amount_cents": 1000,
  "destination_amount_cents": 3987,
  "country": {
    "id": 1,
    "name": "Venezuela",
    "code": "VE",
    "is_asset": false
  }
}

    
  

Explicación de parametros

Parametro	Detalles
source_currency	Moneda de origen
destination_currency	Moneda de destino
rate	Tipo de cambio hacia moneda de destino
source_amount_cents	Dinero de origen en centavos
destination_amount_cents	Dinero calculado hacia destinatario en centavos
country	Datos de pais
country.id	ID del país
country.name	Nombre del país
country.code	Codigo del país
is_asset	Booleano identificador si el país es un activo (Crypto moneda u otro)

Respuesta 404

    
{
  "message": "exchange rate not available"
}

    
  

Crear envío

Endpoint

    
POST /api/v3/transfers HTTP/1.1
Authorization: Bearer token
Content-Type: application/json

{
  "destination_account_id": 10,
  "source_amount_cents": 1000,
  "source_amount_currency": "CLP",
  "destination_amount_currency": "COP"
}

    
  

Parametros

Parametro	Detalles
destination_account_id	ID de la cuenta de destino
source_amount_cents	Dinero de origen en centavos
source_amount_currency	Moneda de origen
destination_amount_currency	Moneda de destino

Ejemplo de respuestas

Respuesta 200

    
{
  "id": 1675,
  "source_amount_cents": 1000,
  "source_amount_currency": "CLP",
  "destination_amount_cents": 3987,
  "destination_amount_currency": "VES",
  "state": "pending",
  "destination_account_id": 182
}

    
  

Parametros

Parametro	Detalles
id	Código identificador del envío
source_amount_cents	Dinero de origen en centavos
source_amount_currency	Moneda de origen
destination_amount_cents	Dinero hacia el destinatario en centavos
destination_amount_currency	Moneda de destino
state	Estado del envío [pending, assigned, executed, rejected]
destination_account_id	ID de la cuenta de destino

Respuesta 404

    
{
  "message": "destination_account not found"
}

    
  

Revisar envío

Endpoint

    
GET /api/v3/transfers/:id HTTP/1.1
Authorization: Bearer token

    
  

Parametros

Parametro	Detalles
id	ID/Código del envío. El parámetro debe estar en la url reemplazando ":id". Ejemplo: /api/v3/transfers/123123

Ejemplo de respuestas

Respuesta 200

    
{
	"id": 1674,
	"source_amount_cents": 2456,
	"source_amount_currency": "CLP",
	"destination_amount_cents": 9793,
	"destination_amount_currency": "VES",
	"state": "executed",
	"destination_account_id": 182
}

    
  

Parametros

Parametro	Detalles
id	Código identificador del envío
source_amount_cents	Dinero de origen en centavos
source_amount_currency	Moneda de origen
destination_amount_cents	Dinero hacia el destinatario en centavos
destination_amount_currency	Moneda de destino
state	Estado del envío [pending, assigned, executed, rejected]
destination_account_id	ID de la cuenta de destino

Respuesta 400

    
{
  "message": "record_not_found"
}

    
  

Listar envios

Endpoint

    
GET /api/v3/transfers HTTP/1.1
Authorization: Bearer token

    
  

Ejemplo de respuestas

Respuesta 200

    
[
	{
		"id": 1671,
		"source_amount_cents": 2456,
		"source_amount_currency": "CLP",
		"destination_amount_cents": 964228,
		"destination_amount_currency": "COP",
		"state": "assigned",
		"destination_account_id": 118
	},
	{
		"id": 1670,
		"source_amount_cents": 2456,
		"source_amount_currency": "CLP",
		"destination_amount_cents": 964228,
		"destination_amount_currency": "COP",
		"state": "assigned",
		"destination_account_id": 118
	},
	{
		"id": 1669,
		"source_amount_cents": 2456,
		"source_amount_currency": "CLP",
		"destination_amount_cents": 964228,
		"destination_amount_currency": "COP",
		"state": "assigned",
		"destination_account_id": 118
	},
]

    
  

Parametros

Parametro	Detalles
id	Código identificador del envío
source_amount_cents	Dinero de origen en centavos
source_amount_currency	Moneda de origen
destination_amount_cents	Dinero hacia el destinatario en centavos
destination_amount_currency	Moneda de destino
state	Estado del envío [pending, assigned, executed, rejected]
destination_account_id	ID de la cuenta de destino