v1

latestOpenAPI 3.0.02026-08-069911.6 KB

Retrieve the current balance for a reference

Endpoint to retrieve the current balance for a companies refence – also knowns as account number, or service number – based on company ID and reference.

get/v2/utilities/{companyId}/{reference}

Path parameters

companyIdstring required

referencestring required

Response

Successfully returns private account information

idstring

companyNamestring

companyIdstring

referencestring

accountNumberstring

amountstring

currencystring

due_datestring date

metadataobject

consultedAtstring date-time

Example response

{
  "id": "1234567890123456789",
  "companyName": "CFE",
  "companyId": "123456789012",
  "reference": "019701209060882503020000042191",
  "accountNumber": "970120906088",
  "amount": "36.67",
  "currency": "MXN",
  "due_date": "2024-04-20",
  "metadata": {},
  "consultedAt": "2024-04-10T19:21:13.387Z"
}