POST/gateway/tokenize

Tokenización (tokenize)

Este servicio permite almacenar un instrumento de pago como: tarjetas de crédito o cuenta bancaria de manera segura, a través de una petición que contenga la información de la misma, se generará un token que puede ser usado en el servicio de procesamiento y para todos los efectos, en PlacetoPay equivale a una tarjeta de crédito o cuenta bancaria, la diferencia es que se envía la estructura token en vez de card o account.

Previamente al consumo de este servicio se debe consultar el de información para saber si es necesario o no generar un OTP al cliente y en caso de ser necesario, solicitar el token a la persona y enviarlo en el consumo.

Solicitud

  • Name
    locale
    Type
    string
    is optional
    Description
  • Name
    auth
    Type
    Autenticación
    is optional
    Description

    Estructura que contiene la información de autenticación del sitio generada de acuerdo al WSSE UsernameToken Profile 1.1

  • Name
    payer
    Type
    Person
    is optional
    Description

    Estructura que refleja la información de una persona involucrada en una transacción.

  • Name
    instrument
    Type
    Instrument
    is Required
    REQUIRED
    Description

    Estructura que contiene la información acerca del medio de pago a usar en una transacción, esta estructura es variable de acuerdo a la solicitud que se genere, cada servicio requiere que se usen unos u otros datos.

  • Name
    payment
    Type
    Payment
    is optional
    Description

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

  • Name
    subscription
    Type
    Subscription
    is optional
    Description

    Estructura que contiene la información sobre una suscripción o transacción que no requiera un monto en específico

  • Name
    ipAddress
    Type
    string
    is optional
    Description
  • Name
    userAgent
    Type
    string
    is optional
    Description

Solicitud

POST
/gateway/tokenize
curl -X "POST" https://api-co-dev.placetopay.ws/gateway/tokenize \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login": "c4ca4238a0b923820dcc509a6f75849b",
        "tranKey": "ytIEiMHa8W4V09lBjztshdczGcv4SvJh6VclvVa1/hI=",
        "nonce": "NjBjYjc3YTYwZGZhYw==",
        "seed": "2021-06-17T11:26:14-05:00"
    },
    "payer": {
        "name": "Diego",
        "surname": "Calle",
        "email": "[email protected]"
    },
    "instrument": {
        "card": {
            "number": "5180300000000005",
            "expiration": "12/18",
            "cvv": "123",
            "installments": "3"
        }
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Respuesta

OK

  • Name
    status
    Type
    Status
    is optional
    Description

    Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.

  • Name
    provider
    Type
    string
    is optional
    Description
  • Name
    instrument
    Type
    Instrument
    is optional
    Description

    Estructura que contiene la información acerca del medio de pago a usar en una transacción, esta estructura es variable de acuerdo a la solicitud que se genere, cada servicio requiere que se usen unos u otros datos.

  • Name
    additional
    Type
    object
    is optional
    Description

    Objeto que almacena información adicional de la respuesta de tokenización.


Respuesta

{
    "status": {
        "status": "OK",
        "reason": "00",
        "message": "La petición se ha procesado correctamente",
        "date": "2021-06-17T11:29:37-05:00"
    },
    "provider": "CREDIBANCO",
    "instrument": {
        "token": {
            "token": "faketoken12f233bd8f5d42138d681bf07ea8295429df07a4af287703e30c891",
            "subtoken": "fakesubtoken00005",
            "franchise": "master",
            "franchiseName": "Mastercard",
            "lastDigits": "0005",
            "validUntil": "2018-12-31"
        }
    }
}

POST/invalidate

Tokenización (invalidate)

Este servicio permite invalidar y eliminar un token asociado a una tarjeta de crédito.

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

  • Name
    instrument
    Type
    object
    is Required
    REQUIRED
    Description

Solicitud

POST
/invalidate
curl -X "POST" https://api-co-dev.placetopay.ws/invalidate \
-H "Content-Type: application/json" \
-d '{
    "locale": "es_CO",
    "auth": {
        "login":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    },
    "instrument": {
        "token": {
            "token": "faketoken12f233bd8f5d42138d681bf07ea8295429df07a4af287703e30c891"
        }
    }
}'

Respuesta

OK

  • Name
    status
    Type
    Status
    is optional
    Description

    Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.


Respuesta

{
    "status": {
        "status": "OK",
        "reason": "00",
        "message": "La petición se ha procesado correctamente",
        "date": "2021-06-17T11:29:37-05:00"
    }
}

POST/gateway/token

Consultar Tokenización

Este servicio permite buscar una tokenización mediante el valor del token o subtoken.

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

  • Name
    instrument
    Type
    Instrument
    is Required
    REQUIRED
    Description

Solicitud

POST
/gateway/token
curl -X "POST" https://api-co-dev.placetopay.ws/gateway/token \
-H "Content-Type: application/json" \
-d '{
    "locale": "es_CO",
    "auth": {
        "login":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    },
    "instrument": {
        "token": {
            "token": "faketoken12f233bd8f5d42138d681bf07ea8295429df07a4af287703e30c891",
            "subtoken": "fakesubtoken00005"
        }
    }
}'

Respuesta

OK

  • Name
    status
    Type
    Status
    is optional
    Description

    Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.

  • Name
    data
    Type
    object
    is optional
    Description

    Objeto con la información de la tokenización encontrada.


Respuesta

{
    "status": {
        "status": "OK",
        "reason": "00",
        "message": "La petición se ha procesado correctamente",
        "date": "2021-06-17T11:29:37-05:00"
    },
    "data": {
        "id": 1,
        "type": "card",
        "token": "faketoken12f233bd8f5d42138d681bf07ea8295429df07a4af287703e30c891",
        "subtoken": "fakesubtoken00005",
        "franchise": "visa",
        "franchiseName": "Visa",
        "issuerName": "TESTING",
        "lastDigits": "1111",
        "validUntil": "12/29",
        "owner": "John Doe",
    }
}