Skip to main content

Get client information

This operation allow you to query your registered client information.

HTTP Request

GET /clients

Header Parameters

HeaderDescription
Authorization 
required
The Bearer token created in
Get authorization Token
Content-Type
required
application/json

Example JSON Request:

GET /clients

Example JSON Response:

{
"success": true,
"code": 0,
"message": "OK",
"data": {
"client": {
"id": "65656565-ecb4-42d8-8555-858585858585",
"name": "Capsule Corp.",
"alias": "CAPCORP",
"code": "CAPSU",
"email": "[email protected]",
"available": 1000000.51,
"balance": 160.49,
"time_zone": "America/Mexico_City",
"status": "ACTIVE",
"create_subclients": true,
"minimum_amount_subclient_creation": 1000.0,
"create_spei_subclients": false,
"collection_spei": true,
"spei": {
"is_cost_center": false,
"in": {
"main_account": {
"enabled": true,
"clabe": null,
"commission": {
"type": "PERCENTAGE",
"value": 0.0
}
},
"spei_account": {
"enabled": false,
"clabe": null,
"commission": {
"type": "NONE",
"value": 0.0
},
"partner_fee": {
"type": "FLAT",
"value": 0.0
}
}
},
"out": {
"main_account": {
"enabled": false
},
"spei_account": {
"enabled": false,
"clabe": null,
"commission": {
"type": "FLAT",
"value": 8.0
},
"partner_fee": {
"type": "FLAT",
"value": 0.0
}
},
"card": {
"enabled": false
},
"client": {
"enabled": false
}
}
}
}
}
}