Country:
/v1/merchants
Crear Comercio
El endpoint permite dar de alta un nuevo comercio en el sistema. Este proceso incluye la creación de una nueva entidad merchant asociada a un cliente y organización específicos, con la información detallada de la ubicación y dirección de facturación. A través de este endpoint, se pueden incluir datos como el nombre del comercio, el tipo de actividad, y detalles de contacto. Además, se pueden especificar
id
Si no se proporciona, se generará un ID único automáticamente. Útil para integraciones que requieran un ID específico.
parent_id
Campo válido únicamente para la creación de Submerchants asociados a un Merchant. Corresponde al ID del comercio principal.
type
Tipo de comercio.
name
Nombre legal o comercial del comercio.
alias
Alias para búsquedas rápidas.
organization_id
ID de la organización a la que pertenece el comercio.
supported_currencies
Lista de monedas soportadas por el comercio (código ISO 4217).
Moneda soportada (código ISO 4217).
default_currency
Moneda principal del comercio (código ISO 4217).
activity
Actividad principal del comercio.
phone
Teléfono de contacto del comercio.
Correo electrónico de contacto del comercio.
billing_address
Dirección de facturación del comercio.
street
Calle de la dirección de facturación.
number
Número de la dirección de facturación.
city
Ciudad de la dirección de facturación.
state
Provincia o estado de la dirección de facturación.
zip_code
Código postal de la dirección de facturación.
country
País de la dirección de facturación (código ISO 3166-1 alpha-3).
location_address
Dirección física donde opera el comercio.
street
Calle de la dirección.
number
Número de la dirección.
city
Ciudad de la dirección.
state
Provincia o estado de la dirección.
zip_code
Código postal de la dirección.
country
País (código ISO 3166-1 alpha-3).
rails
Configuración de rieles de pago (VISA, MASTERCARD, etc).
RAIL_KEY
Ejemplo: VISA, MASTERCARD, etc.
mcc
Código MCC del riel.
mvv
Sólo aplica para VISA.
payfac_id
ID del PayFac para el riel. Aplica para comercios agregadores.
rail_merchant_external_id
ID externo del comercio en el riel.
annual_volume
Volumen anual estimado por moneda.
currency
Moneda (código ISO 4217).
value
Valor estimado anual.
products
Productos habilitados en el riel.
PRODUCT_KEY
Ejemplo: DEBIT, CREDIT o NETWORK_TOKEN
enabled
Indica si el producto está habilitado.
fee
fee_type
transaction_fee
withdrawal_fee
currency
Moneda en código ISO 4217.
product_type
custom_data
Datos personalizados del comercio.
some_data_key
Un campo personalizado para almacenar información adicional.
website
Sitio web del comercio. Obligatorio para comercios de tipo ECOMMERCE.
tax_information
Información fiscal del comercio. Para ver los posibles valores y obtener más información visitá [aquí](https://docs.akua.la/reference/informaci%C3%B3n-impositiva#valores-posibles-para-tax_id_type).
tax_id
Número de identificación fiscal del comercio.
tax_id_type
Tipo de identificación fiscal (RUT, CUIT, NIT, etc.)
legal_name
Nombre legal del comercio.
legal_representative
Información del representante legal del comercio.
full_name
Nombre completo del representante legal.
Correo electrónico del representante legal.
role
Rol del representante legal.
phone
Número de teléfono del representante legal.
identification_type
Tipo de identificación del representante legal.
identification_number
Número de identificación del representante legal.
retention_rules
Reglas de retención fiscal aplicables al comercio.
tax_type
Tipo de impuesto.
retention_applicable
Indica si la retención es aplicable.
percentage
fiscal_responsibilities
Responsabilidades fiscales del comercio.
code
Código de responsabilidad fiscal.
tax_id
tax_id_type
level
location
applicable_laws
Leyes aplicables al comercio. Solo se permiten números, puntos, guiones y barras.
Ley aplicable (formato: números, puntos, guiones y barras únicamente).
tax_categories
Categorias o actividades a las que corresponde. Validá acá para ver los [posibles valores](https://docs.akua.la/reference/informaci%C3%B3n-impositiva#valores-posibles-para-tax_categories).
code
description
Éste atributo es solo informativo.
payout_information
Información de pago del comercio.
bank_name
Nombre del banco donde se realizarán los pagos.
bank_account_number
Número de cuenta bancaria.
bank_account_holder_name
Nombre del titular de la cuenta bancaria.
bank_account_type
Tipo de cuenta bancaria.
bank_swift_code
Código SWIFT del banco.
bank_country
País del banco.
currency
Moneda de la cuenta bancaria (código ISO 4217).
contract_information
Información del contrato del comercio.
type
Tipo de contrato.
start_date
Fecha de inicio del contrato.
end_date
Fecha de finalización del contrato.
financial_fees
Configuración de fees.
BIN
Ejemplo: 123456
installments
Fees por cuotas
value
Cuota a configurar. Ejemplo: 2
percentage
notes
Notas adicionales sobre el comercio
Response Examples
201
Comercio creado exitosamente.
{
"id": "example_string",
"organization_id": "example_string",
"name": "example_string",
"type": "ECOMMERCE",
"alias": "example_string",
"billing_address": {
"country": "example_string",
"street": "example_string",
"number": "example_string",
"city": "example_string",
"state": "example_string",
"zip_code": "example_string"
},
"location_address": {
"country": "example_string",
"street": "example_string",
"number": "example_string",
"state": "example_string",
"city": "example_string",
"zip_code": "example_string"
},
"email": "example_string",
"phone": "example_string",
"status": "example_string",
"activity": "example_string",
"default_currency": "example_string",
"supported_currencies": [
"example_string"
],
"rails": {
"VISA": {
"mcc": "example_string",
"rail_merchant_external_id": "example_string",
"payfac_id": "example_string",
"annual_volume": [
{
"currency": "example_string",
"value": 123
}
],
"products": {
"DEBIT": {
"enabled": true,
"merchant_network_id": "example_string",
"fee": {
"fee_type": "example_string",
"transaction_fee": 123,
"withdrawal_fee": 123,
"currency": "example_string"
},
"settlement": {
"frequency": "example_string"
}
}
}
}
},
"website": "example_string",
"tax_information": {
"tax_id": "example_string",
"tax_id_type": "example_string",
"legal_name": "example_string",
"fiscal_responsibilities": [
{
"code": "example_string"
}
],
"retention_rules": [
{
"tax_type": "example_string",
"retention_applicable": true
}
],
"applicable_laws": [
"example_string"
],
"legal_representative": {
"full_name": "example_string",
"email": "example_string",
"role": "example_string",
"phone_number": "example_string",
"identification_type": "example_string",
"identification_number": "example_string"
}
},
"contract_information": {
"type": "example_string",
"start_date": "2024-01-15T10:30:00Z",
"end_date": "2024-01-15T10:30:00Z"
},
"payout_information": {
"bank_name": "example_string",
"bank_account_number": "example_string",
"bank_account_holder_name": "example_string",
"bank_account_type": "example_string",
"bank_swift_code": "example_string",
"bank_country": "example_string",
"currency": "example_string"
},
"fee_configuration": {
"fee_type": "example_string",
"transaction_fee": 123,
"withdrawal_fee": 123,
"currency": "example_string"
},
"notes": "example_string",
"created_at": "example_string",
"updated_at": "example_string"
}400
400
{
"message": "example_string",
"error_type": "example_string"
}Language
Login required to test API
Code Examples
cURL
curl -X POST "https://api.akua.la/v1/merchants" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"supported_currencies": [],
"billing_address": {},
"location_address": {},
"rails": {},
"custom_data": {},
"tax_information": {},
"payout_information": {},
"contract_information": {},
"financial_fees": {}
}''