POST{{baseURL}}/autopay/balance

Consultar monto a cobrar

baseURL: Es la URL base del aplicativo del cliente/comercio la cual debe ser entregada por el mismo y configurada en el momento del onboarding del comercio con AutoPay.

Autenticación (Basic Authentication): Este endpoint requiere autenticación vía header Authorization. El comercio debe validar las credenciales configuradas para AutoPay en cada solicitud entrante. Ver más en Autenticación de contratos.

Este endpoint permite conocer el monto que debe cobrarse asociado a un AutoPay. Devuelve dos valores:

  • amount: monto total a cobrar en el ciclo actual.
  • min_amount: monto mínimo requerido para ejecutar el cobro.

Puede usarse para validar si existen valores pendientes antes de iniciar un proceso de pago o conciliación automática.

Solicitud

  • Name
    reference
    Type
    string
    is Required
    REQUIRED
    Description

    Referencia del AutoPago proporcionada por el cliente/comercio, esta referencia debe ser unica activa por comercio.

    Ejemplo:ACC00012345
    Longitud máxima:32
  • Name
    id
    Type
    string
    is Required
    REQUIRED
    Description

    Identificador único del autopago confirmado en el registro de la notificación.

    Ejemplo:2972c13d-6315-4da3-80d7-64c24eb232ad
    Formato:uuid
    Longitud máxima:36
    Longitud mínima:36

Solicitud

POST
{{baseURl}}/autopay/balance
curl -X "POST" {{baseURl}}/autopay/balance \
-H "Content-Type: application/json" \
-H "Authorization: Basic <base64(username:password)>" \
-d '{
"reference": "ACC00012345",
"id": "2972c13d-6315-4da3-80d7-64c24eb232ad"
}
'

Respuesta

Respuesta satisfactoria con el monto a cobrar al usuario

  • Name
    status
    Type
    Status
    is Required
    REQUIRED
    Description

    Estructura para definir estados de respuestas

  • Name
    id
    Type
    string
    is Required
    REQUIRED
    Description

    Identificador único del autopago confirmado en el registro de la notificación.

    Ejemplo:2972c13d-6315-4da3-80d7-64c24eb232ad
    Formato:uuid
    Longitud máxima:36
    Longitud mínima:36
  • Name
    amount
    Type
    Amount
    is Required
    REQUIRED
    Description

    Estructura que contiene la información acerca del pago de la transacción requerida al servicio web

  • Name
    min_amount
    Type
    Amount
    is optional
    Description

    Estructura que contiene la información acerca del pago de la transacción requerida al servicio web


Respuesta

{
  "status": {
     "status": "OK",
     "reason": "00",
     "message": "Respuesta exitosa",
     "date": "2025-09-29T17:09:29-05:00"
  },
  "id": "2972c13d-6315-4da3-80d7-64c24eb232ad",
  "amount": {
     "currency": "USD",
     "total": 10
  },
  "min_amount": {
     "currency": "USD",
     "total": 5
  }
}