Country:
/v1/merchants
Obtener los Comercios de una Organización
El endpoint permite recuperar la lista de todos los comercios asociados a una organización específica, utilizando el ID único de la organización. Este endpoint es útil para obtener una visión general de todos los comercios que pertenecen a una organización y gestionar su información de manera centralizada.
page
example
page_size
example
sort
example
organization_id
Identificador único de la organización
example
Response Examples
200
Respuesta exitosa con la lista de comercios.
{
"data": [
{
"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
}
],
"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"
}
],
"pagination": {
"page": 123,
"page_size": 123,
"total": 123
}
}400
Error de validación
{
"message": "example_string",
"error_type": "example_string",
"details": [
{
"field": "example_string",
"description": "example_string"
}
]
}Language
Login required to test API
Code Examples
cURL
curl -X GET "https://api.akua.la/v1/merchants" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"