Country:
/v1/merchants/{id}
Actualizar Comercio
Permite modificar la información de un comercio ya registrado en el sistema. Esta operación se realiza proporcionando el ID del comercio y los datos actualizados que se desean modificar, tales como la ubicación, dirección de facturación, estado del comercio o información de contacto.
URL Parameters
id
Identificador único del comercio a actualizar
example
organization_id
ID de la organización a la que pertenece el comercio.
name
Nombre legal o comercial del comercio.
type
Tipo de comercio.
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 alfa-3).
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 alfa-3).
default_currency
Moneda principal del comercio (código ISO 4217).
supported_currencies
Lista de monedas soportadas por el comercio.
Moneda soportada (código ISO 4217).
phone
Teléfono de contacto del comercio.
Correo electrónico de contacto del comercio.
activity
Actividad principal del comercio.
parent_id
Campo válido únicamente para la creación de Submerchants asociados a un Merchant. Corresponde al ID del comercio principal.
rails
Configuración de rieles de pago (VISA, MASTERCARD, etc).
RAIL_KEY
mcc
Código MCC del riel.
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
enabled
Indica si el producto está habilitado.
fee
fee_type
transaction_fee
withdrawal_fee
currency
settlement
frequency
custom_data
Datos personalizados del comercio.
some_data_key
Un campo personalizado para almacenar información adicional.
id
Si no se proporciona, se generará un ID único automáticamente. Útil para integraciones que requieran un ID específico.
alias
Alias para búsquedas rápidas.
website
Sitio web del comercio. Obligatorio para comercios de tipo ECOMMERCE.
tax_information
Información fiscal del comercio.
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_number
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.
fiscal_responsibilities
Responsabilidades fiscales del comercio.
code
Código de responsabilidad fiscal.
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).
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).
fee_configuration
Configuración de tarifas del comercio.
fee_type
Tipo de tarifa aplicada al comercio.
transaction_fee
Tarifa por transacción.
withdrawal_fee
Tarifa por retiro.
currency
Moneda de la tarifa (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.
notes
Notas adicionales sobre el comercio
Response Examples
200
Comercio actualizado 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
Error de validación o solicitud incorrecta
{
"message": "example_string",
"error_type": "example_string"
}404
Comercio no encontrado
{
"message": "example_string",
"error_type": "example_string"
}Language
Login required to test API
Code Examples
cURL
curl -X PUT "https://api.akua.la/v1/merchants/example_value" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"location_address": {},
"billing_address": {},
"supported_currencies": [],
"rails": {},
"custom_data": {},
"tax_information": {},
"payout_information": {},
"fee_configuration": {},
"contract_information": {}
}''