POST/autopay/session/:requestId

Consultar una sesión de Autopago

Este endpoint te permite obtener la información de la sesión, si en la sesión hay transacciones se muestra el detalle de las mismas.

Esta API funciona como un passthrough hacia la URL de Checkout, actuando únicamente como un puente entre el comercio y Checkout, sin modificar la información enviada.

Para mayor información sobre el comportamiento, validaciones y contratos aplicables, consulta la documentación oficial de Checkout en: Consultar sesión en Checkout.

Parámetros

  • Name
    requestId
    Type
    requestId
    is Required
    REQUIRED
    Description

    Id de la petición. Se debe enviar en el path de la consulta.


Solicitud

  • Name
    auth
    Type
    Autenticación
    is Required
    REQUIRED
    Description

    Estructura que contiene la información de autenticación del sitio generada de acuerdo al WSSE UsernameToken Profile 1.1. Ver más en Autenticación.

Solicitud

POST
/autopay/session/:requestId
curl -X "POST" {{baseURL}}/autopay/session/000000 \
  -H "Content-Type: application/json" \
  -d '{
      "auth": {
        "login": "aabbccdd1234567890aabbccdd123456",
        "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
        "nonce": "NjE0OWVkODgwYjNhNw==",
        "seed": "2021-09-21T09:34:48-05:00"
      }
    }'

Respuesta

Respuesta exitosa

  • Name
    status
    Type
    Status
    is Required
    REQUIRED
    Description

    Estructura para definir estados de respuestas

  • Name
    requestId
    Type
    string
    is optional
    Description

    Id de la petición

    Ejemplo:1
  • Name
    request
    Type
    object
    is optional
    Description

    Contiene la información con la cual se realizó la solicitud de creación/actualización de la sesión de autopagos.

  • Name
    autopay
    Type
    is optional
    Description

    Estructura con la información de los intentos de creación o actualización de un autopago dentro de la misma sesión.

  • Name
    payment
    Type
    array[Transaction]
    is optional
    Description

    Estructura con la información de la transacción registrada. Para autopagos este valor es null.

  • Name
    subscription
    Type
    SubscriptionResponse
    is optional
    Description

    Estructura que contiene información para el método de pago suscripción. Para autopagos este valor es null.


Respuesta

{
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "La petición ha sido aprobada exitosamente",
    "date": "2022-07-27T14:51:27-05:00"
  },
  "requestId": 100,
  "request": {
    "locale": "es_CO",
    "payer": {
      "document": "111111111",
      "documentType": "CC",
      "name": "Antonino",
      "surname": "Pan y queso",
      "email": "[email protected]",
      "mobile": "+573111111111"
    },
    "type": "autopay",
    "autopay": {
      "action": "CREATE",
      "reference": "12345",
      "description": "Inscripción autopago monto fijo",
      "recurring": {
        "type": "FIXED",
        "periodicity": "M",
        "interval": "1",
        "maxPeriods": 12,
        "startDate": "2026-11-26",
        "nextPayment": "2026-12-05",
        "dueDate": "2027-11-26",
        "notificationUrl": "https://merchant.test/notification",
      },
      "dueDay": 15,
      "amount": {
        "currency": "USD",
        "total": 100
      }
    },
    "fields": [
      {
        "keyword": "customerAccountNumber",
        "value": "112233",
        "displayOn": "none"
      }
    ],
    "returnUrl": "https://mysite.com/response/32120",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox",
    "expiration": "2023-03-09T23:28:43.775Z"
  },
  "autopay": [
    {
      "status": {
          "status": "APPROVED",
          "reason": "00",
          "date":"2023-06-21T09:56:06-05:00"
      },
      "siteId": "100200300",
      "id": "328eb09a-363f-48a6-a16e-51c5a58b89ec",
      "buyer": null,
      "payer": {
        "document": "111111111",
        "documentType": "CC",
        "name": "Antonino",
        "surname": "Pan y queso",
        "email": "[email protected]",
        "mobile": "+573111111111"
      },
      "subscription": {
        "reference": "12345",
        "description": "Inscripción autopago monto fijo",
        "amount": {
          "currency": "USD",
          "total": 100
        },
        "recurring": {
          "type": "FIXED",
          "periodicity": "M",
          "interval": "1",
          "maxPeriods": 12,
          "startDate": "2026-11-26",
          "nextPayment": "2026-12-05",
          "dueDate": "2027-11-26",
          "notificationUrl": "https://merchant.test/notification",
        },
      },
      "instrument": {
        "token": {
          "token": "faketoken12f233bd8f5d42138d681bf07ea8295429df07a4af287703e30c891",
          "subtoken": "fakesubtoken00000",
          "franchise": "master",
          "franchiseName": "Mastercard",
          "lastDigits": "0000",
          "validUntil": "2018-12-31"
        }
      },
      "additional": {
        "customerAccountNumber": "1232312323",
        "dueDay": "25",
      },
      "acceptedAt": "2021-09-24T10:02:17-05:00"
    },
  ],
  "payment": null,
  "subscription": null,
}