ALalegra
Pagos recurrentes

Consultar un pago recurrente

Endpoint que permite consultar un pago registrado en la aplicación, mediante su identificador

get/recurring-payments/{id}

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/recurring-payments/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

Identificador de un pago

Response

Se obtiene un objeto que describe un pago

idstring

Identificador único que representa un pago. La aplicación lo asigna automáticamente.

numberstring

Número del recibo de caja o comprobante de egreso.

startDatestring yyyy-mm-dd

Fecha de pago. Formato yyyy-MM-dd.

endDatestring yyyy-mm-dd

Fecha de pago. Formato yyyy-MM-dd.

amountnumber

Valor total asociado en el pago

decimalPrecisioninteger

Número de decimales que se usan para representar el valor de la moneda.

repeatEveryinteger

Frecuencia del pago en meses

datesEditableboolean

Indica si el usuario puede modificar la fecha de inicio y fin del pago.

Example response

{
  "id": "12",
  "startDate": "2015-12-10",
  "amount": 7500.85,
  "currency": {
    "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/currency/example"
  },
  "decimalPrecision": 2,
  "account": {
    "id": "1",
    "name": "Cuenta de ahorros",
    "type": "bank"
  },
  "repeatEvery": 1,
  "datesEditable": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.