Features

Refunds

Tokenization

Recurring Payments

Processor

Acquirer

POST/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

Request Body

21 parameters

string

Si no se proporciona, se generará un ID único automáticamente. Útil para integraciones que requieran un ID específico.

parent_id

string

Campo válido únicamente para la creación de Submerchants asociados a un Merchant. Corresponde al ID del comercio principal.

type

stringrequired

Tipo de comercio.

name

stringrequired

Nombre legal o comercial del comercio.

alias

string

Alias para búsquedas rápidas.

organization_id

stringrequired

ID de la organización a la que pertenece el comercio.

supported_currencies

array[string]required

Lista de monedas soportadas por el comercio (código ISO 4217).

Each item: Moneda soportada (código ISO 4217).

default_currency

stringrequired

Moneda principal del comercio (código ISO 4217).

activity

string

Actividad principal del comercio.

phone

string

Teléfono de contacto del comercio.

string

Correo electrónico de contacto del comercio.

billing_address

objectrequired

Dirección de facturación del comercio.

location_address

objectrequired

Dirección física donde opera el comercio.

rails

object

Configuración de rieles de pago (VISA, MASTERCARD, etc).

custom_data

object

Datos personalizados del comercio.

website

string

Sitio web del comercio. Obligatorio para comercios de tipo ECOMMERCE.

tax_information

object

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).

payout_information

object

Información de pago del comercio.

contract_information

object

Información del contrato del comercio.

financial_fees

object

Configuración de fees.

notes

string

Notas adicionales sobre el comercio

Request Preview

{
  "supported_currencies": [],
  "billing_address": {},
  "location_address": {},
  "rails": {},
  "custom_data": {},
  "tax_information": {},
  "payout_information": {},
  "contract_information": {},
  "financial_fees": {}
}

Responses

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"
}

Language

REQUEST

1234567891011121314