Crear cuenta de destino

Endpoint

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

{
  "alias": "funny name",
  "category": "bank",
  "dni": "123123123",
  "dni_type": "passport",
  "first_name": "John",
  "last_name": "Doe",
  "email": "John@doe.com",
  "bank_type": "current",
  "bank_number": "000111000231230"
  "bank_id": 4,
  "address": "Grandma's house",
  "city": "Grandma's city",
  "state": "Grandma's state",
  "phone": "99899080",
  "birthdate": "30/01/1997",
  "additional_data": "Grandma's swift code is: 123123",
  "aba_number": null,
  "iban_number": null,
  "cpf_number": null
}

    
  

Parametros

Parametro	Detalles
alias	Nombre para la cuenta de destino, puede ser cualquier nombre pero debe ser unico
category	Tipo de cuenta de destino [bank, wallet]
dni	DNI de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
dni_type	Tipo de DNI: [cc, ce, passport, company_dni]. cc = Cedula del pais ce = Cedula de extranjero Opcional si se usa una wallet
first_name	Nombres de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
last_name	Apellidos de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
email	Email de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
bank_type	Tipo de banco: [current, savings] esas son las únicas opciones disponibles. Current = cuenta corriente
bank_number	Número de cuenta bancaria de la cuenta de destino
bank_id	ID del banco de la cuenta de destino
address	Dirección de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
city	Ciudad de la persona dueña de la cuenta de destino. Opcional si se usa una wallet
state	Estado, província, departamento de la persona dueña de la cuenta de destino. Opcional
phone	Número de celular de la persona dueña de la cuenta de destino. Opcional
birthdate	Fecha de nacimiento de la persona dueña de la cuenta de destino. Opcional
additional_data	Información extra en caso de que se requiera algo más para realizar el envío. NOTA, si se usa una wallet aquí se coloca la dirección de la wallet
aba_number	Solo requerido para cuentas de España
iban_number	Solo requerido para cuentas de USA
cpf_number	Solo requerido para cuentas de Brasil

Ejemplo de respuesta

Respuesta 200

    
{
	"id": 183,
	"alias": "34124sdfdfs",
	"first_name": "Destino",
	"last_name": "Colombia Aprobado",
	"dni_type": "ce",
	"dni": "321232123267677",
	"bank_type": "current",
	"bank_number": "5442111454622",
	"bank_id": 1,
	"email": "a3211@a231.com",
	"city": "Bogota",
	"state": "test",
	"address": "Calle principal 123",
	"phone": "test",
	"birthdate": "1995-06-20",
	"aba_number": "test",
	"iban_number": "test",
	"cpf_number": "test",
	"additional_data": "test",
	"category": "bank",
	"country": {
		"id": 1,
		"name": "Venezuela",
		"code": "VE",
		"is_asset": false
	}
}

    
  

Respuesta 400

    
{
  "message": "error creating destination account",
  "errors": {
    "bank_type": [
      "is not included in the list"
    ],
    "destination_account_bank": [
      "must exist"
    ]
  }
}

    
  

Editar cuenta de destino

Es posible editar cuentas de destino, sin embargo, las cuentas de destinos que posean un envío de remesas exitoso no se podrán editar.

Endpoint

    
PUT /api/v3/destination_accounts/:id HTTP/1.1
Authorization: Bearer token
Contet-Type: application/json

    
  

Parametros

Los parametros para editar son los mismos que al crear

Ejemplo de respuestas

Respuesta 200

    
{
	"id": 183,
	"alias": "test",
	"first_name": "Destino",
	"last_name": "Colombia Aprobado",
	"dni_type": "ce",
	"dni": "321232123267677",
	"bank_type": "current",
	"bank_number": "5442111454622",
	"bank_id": 1,
	"email": "a3211@a231.com",
	"city": "Bogota",
	"state": "test",
	"address": "Calle principal 123",
	"phone": "test",
	"birthdate": "1995-06-20",
	"aba_number": "test",
	"iban_number": "test",
	"cpf_number": "test",
	"additional_data": "test",
	"category": "bank",
	"country": {
		"id": 1,
		"name": "Venezuela",
		"code": "VE",
		"is_asset": false
	}
}

    
  

Respuesta 400

    
{
  "message": "error creating destination account",
  "errors": {
    "alias": [
      "has already been taken"
    ]
  }
}

    
  

Detalles de cuenta de destino

Endpoint

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

    
  

Parametros

Parametro	Detalles
id	ID de la cuenta de destino, el id debe estar en el url. Ejemplo: /api/v3/destination_account/111

Ejemplo de respuestas

Respuesta 200

    
{
	"id": 183,
	"alias": "test",
	"first_name": "Destino",
	"last_name": "Colombia Aprobado",
	"dni_type": "ce",
	"dni": "321232123267677",
	"bank_type": "current",
	"bank_number": "5442111454622",
	"bank_id": 1,
	"email": "a3211@a231.com",
	"city": "Bogota",
	"state": "test",
	"address": "Calle principal 123",
	"phone": "test",
	"birthdate": "1995-06-20",
	"aba_number": "test",
	"iban_number": "test",
	"cpf_number": "test",
	"additional_data": "test",
	"category": "bank",
	"country": {
		"id": 1,
		"name": "Venezuela",
		"code": "VE",
		"is_asset": false
	}
}

    
  

Respuesta 404

    
{
  "message": "record_not_found"
}

    
  

Listado de cuentas de destino

Endpoint

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

    
  

Ejemplo de respuesta

Respuesta 200

    
[
	{
		"id": 182,
		"alias": "6tggh6t6",
		"first_name": "Destino",
		"last_name": "Colombia Aprobado",
		"dni_type": "ce",
		"dni": "321232123267677",
		"bank_type": "current",
		"bank_number": "2341221545674",
		"bank_id": 1,
		"email": "a3211@a231.com",
		"city": "Bogota",
		"state": "test",
		"address": "Calle principal 123",
		"phone": "test",
		"birthdate": null,
		"aba_number": "test",
		"iban_number": "test",
		"cpf_number": "test",
		"additional_data": "test",
		"category": "bank",
		"country": {
			"id": 1,
			"name": "Venezuela",
			"code": "VE"
		}
	}
]