Token

Se identifica como token, a la llave generada por un proceso de suscripción permitiendo generar cobros sin interacción del usuario.

POST/api/collect

Cobro usando token

Permite realizar cobros sin la intervención del usuario usando medios de pago previamente suscritos.

Solicitud

Permite realizar cobros sin la intervención del usuario usando medios de pago previamente suscritos.

Name
auth
Type
Authentication
is Required
REQUIRED
Description
La autenticación del sitio. Ver más en Autenticación
Name
payment
Type
PaymentRequest
is Required
REQUIRED
Description
Información del pago solicitado.
Name
instrument
Type
Instrument-collect
is Required
REQUIRED
Description
Estructura que contiene los detalles de un medio de pago suscrito.
Name
ipAddress
Type
string
is Required
REQUIRED
Description
Dirección IP del usuario que realizará el proceso.
Ej: 134.10.163.36
Ejemplo:134.10.163.36
Name
userAgent
Type
string
is Required
REQUIRED
Description
User Agent del navegador del usuario que realizará el proceso.
Ejemplo:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
Name
payer
Type
Person
is Required
REQUIRED
Description
Datos del usuario pagador, hace referencia al dueño del medio de pago o usuario que pagó el monto solicitado.
Name
buyer
Type
Person
is optional
Description
Datos del usuario comprador, hace referencia al usuario que está comprando un producto o un servicio.
Name
locale
Type
string
is optional
Description
Idioma en el que se tratará la petición y la sesión. Ver más en Localización
Ejemplo:en_US
Formato:regex
Patrón:^\w{2}\_[A-Z]{2}
Name
type
Type
string
is optional
Description
Parámetro usado para sesiones de tipo preauthorización

Sólo se soporta checkin para generar una sesión de preautorización
Valores permitidos:checkin
Name
metadata
Type
metadata
is optional
Description
Estructura de tipo clave-valor que se utiliza para enviar información adicional y determinar comportamientos específicos durante el procesamiento de una sesión.
Name
provider
Type
string
is optional
Description
Código del proveedor de la transacción

Solicitud

POST

/api/collect

curl -X "POST" https://checkout-test.placetopay.com/api/collect \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "es_CO",
    "auth": {
      "login": "aabbccdd1234567890aabbccdd123456",
      "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
      "nonce": "NjE0OWVkODgwYjNhNw==",
      "seed": "2021-09-21T09:34:48-05:00"
    },
    "payer": {
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "5551234567",
      "documentType": "CC",
      "document": "12345678"
    },
    "payment": {
      "reference": "1122334455",
      "description": "Prueba",
      "amount": {
        "currency": "USD",
        "total": 100
      }
    },
    "instrument": {
      "token": {
        "token": "e07ca9986cf0ecac8a557fa11c07bf37ea35e9e3e3a4180c49"
      }
    },
    "expiration": "2021-12-30T00:00:00-05:00",
    "returnUrl": "https://dnetix.co/p2p/client",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox"
  }'

Respuesta

Name
requestId
Type
integer
is optional
Description
Name
status
Type
Status
is optional
Description
Estructura que contiene el estado de una solicitud. Informa el estado actual de la sesión.
Name
request
Type
request
is optional
Description
Name
payment
Type
PaymentResponse
is optional
Description
Name
subscription
Type
SubscriptionResponse
is optional
Description
Estructura que contiene información para el método de pago suscripción.

Respuesta

{
  "requestId": 1,
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "La petición ha sido aprobada exitosamente",
    "date": "2021-11-30T15:49:47-05:00"
  },
  "request": {
    "locale": "es_CO",
    "payer": {
      "document": "1033332222",
      "documentType": "CC",
      "name": "Name",
      "surname": "LastName",
      "email": "[email protected]",
      "mobile": "3111111111",
      "address": {
        "postalCode": "12345"
      }
    },
    "payment": {
      "reference": "1122334455",
      "description": "Prueba",
      "amount": {
        "currency": "USD",
        "total": 100
      },
      "allowPartial": false,
      "subscribe": false
    },
    "returnUrl": "https://redirection.test/home",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox",
    "expiration": "2021-12-30T00:00:00-05:00"
  },
  "payment": [
    {
      "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2021-11-30T15:49:36-05:00"
      },
      "internalReference": 1,
      "paymentMethod": "visa",
      "paymentMethodName": "Visa",
      "issuerName": "JPMORGAN CHASE BANK, N.A.",
      "amount": {
        "from": {
          "currency": "USD",
          "total": 100
        },
        "to": {
          "currency": "USD",
          "total": 100
        },
        "factor": 1
      },
      "authorization": "000000",
      "reference": "1122334455",
      "receipt": "241516",
      "franchise": "DF_VS",
      "refunded": false,
      "processorFields": [
        {
          "keyword": "lastDigits",
          "value": "1111",
          "displayOn": "none"
        }
      ]
    }
  ],
  "subscription": null
}

POST/api/instrument/invalidate

Invalidar Token

Permite invalidar un token ya existente del sitio. Esto hará que el token o el subtoken ya no se pueda usar.

Solicitud

Name
auth
Type
Authentication
is Required
REQUIRED
Description
La autenticación del sitio. Ver más en Autenticación
Name
instrument
Type
InstrumentInvalidate
is Required
REQUIRED
Description
Información del Token a invalidar.
Name
locale
Type
string
is optional
Description
Idioma en el que se tratará la petición y la sesión. Ver más en Localización
Ejemplo:en_US
Formato:regex
Patrón:^\w{2}\_[A-Z]{2}

Solicitud

POST

/api/instrument/invalidate

curl -X "POST" https://checkout-test.placetopay.com/api/instrument/invalidate \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "en_US",
    "auth": {
        "login": "aabbccdd1234567890aabbccdd123456",
        "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
        "nonce": "NjE0OWVkODgwYjNhNw==",
        "seed": "2021-09-21T09:34:48-05:00"
    },
    "instrument": {
      "token": {
        "token": "a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a"
      }
    }
  }'

Respuesta

Example response

Name
status
Type
Status
is Required
REQUIRED
Description
Estructura que contiene el estado de una solicitud. Informa el estado actual de la sesión.

Respuesta

{
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "La petición ha sido aprobada exitosamente",
    "date": "2022-07-27T14:51:27-05:00"
  }
}