POST{{baseURl}}/autopay/settlement

Asentar/Confirmar un pago

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.

El asentamiento se realiza solo para las transacciones que han sido procesadas exitosamente y están en estado APPROVED.

Este endpoint se utiliza para confirmar un pago previamente procesado, enviando los detalles de la transacción.

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
    Longitud mínima: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
  • Name
    transaction
    Type
    object
    is Required
    REQUIRED
    Description

    Datos de la transacción

Solicitud

POST
{{baseURl}}/autopay/settlement
curl -X POST {{baseURl}}/autopay/settlement \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64(username:password)>" \
  -d '{
    "reference": "ACC00012345",
    "id": "2972c13d-6315-4da3-80d7-64c24eb232ad",
    "transaction": {
      "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2021-09-24T11:51:31-05:00"
      },
      "date": "2021-09-24T11:51:31-05:00",
      "transactionDate": "2021-09-24T11:51:31-05:00",
      "internalReference": 41,
      "reference": "ON1434012-PN1433129",
      "paymentMethod": "CR_VS",
      "franchise": "visa",
      "franchiseName": "Visa",
      "issuerName": "BANCO DE GUAYAQUIL, S.A.",
      "amount": {
        "taxes": [
          { "kind": "airportTax", "amount": 63, "base": 0 },
          { "kind": "valueAddedTax", "amount": 158.47, "base": 0 }
        ],
        "currency": "USD",
        "total": 1161.12
      },
      "conversion": {
        "from": { "currency": "USD", "total": 1161.12 },
        "to": { "currency": "USD", "total": 1161 },
        "factor": 1
      },
      "authorization": "739877",
      "receipt": "713329175945",
      "type": "AUTH_ONLY",
      "refunded": false,
      "lastDigits": "0032",
      "provider": "CREDIBANCO",
      "discount": null,
      "processorFields": {
        "id": "08c0284b20510c8db8dcb29137374718",
        "b24": "XX"
      },
      "additional": {
        "merchantCode": "123456",
        "terminalNumber": "12345678",
        "bin": "411076",
        "expiration": "1220"
      }
    }
  }'

Respuesta

Autopago registrado correctamente.

  • 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

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "Respuesta sactisfactoria",
    "date": "2025-09-29T17:09:29-05:00"
  },
  "id": "2972c13d-6315-4da3-80d7-64c24eb232ad"
}