Placetopay Docs

POST/gateway/information

Solicitud de Información

Este servicio proporciona información sobre la tarjeta del usuario que se va a procesar, tal como qué servicios son los que se usarán para ella y los tipos de crédito, si aplica, que hay para esta, si no hay tipos de crédito se retorna un arreglo vacío y si los hay, se debe iterar cada tipo de crédito con los installments que se encuentran en el arreglo.

Solicitud

Name
locale
Type
string
is optional
Description
Determina el idioma de la respuesta
Ejemplo:es-CO
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
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
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
metadata
Type
object
is optional
Description
Objeto dinámico que contiene información adicional de interés.

Solicitud

POST

/gateway/information

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/information \
-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"
    },
    "payment": {
        "reference": "1122334455",
        "description": "Prueba",
        "amount": {
            "currency": "USD",
            "total": 100
        }
    },
    "instrument": {
        "card": {
            "number": "4110760000000008",
        },
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Respuesta

Name
status
Type
Status
is Required
REQUIRED
Description
Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.
Name
provider
Type
string
is Required
REQUIRED
Description
Indica cual proveedor será utilizado en la transacción
Ejemplo:EBUS
Name
serviceCode
Type
string
is Required
REQUIRED
Description
Indica el código del servicio que procesará la transacción
Ejemplo:EB_VS
Name
cardTypes
Type
array[CardType]
is optional
Description
Indica los tipos de tarjeta soportados por el proveedor
Name
cardType
Type
CardType
is optional
Description
Indica el tipo de la tarjeta. C = credito, R = debito, A = ahorros
Valores permitidos:CRA
Name
requiereOtp
Type
boolean
is optional
Description
Indica si es necesario realizar el flujo de OTP
Name
requiereCvv2
Type
boolean
is optional
Description
Indica si es requerido enviar CVV para el procesamiento de la transacción
Name
threeDS
Type
string
is optional
Description
Indica si es necesario 3DS
Valores permitidos:optionalrequiredunsupported
Name
credits
Type
array[Credit]
is optional
Description
Indica los créditos disponibles por proveedor
Name
requirePockets
Type
boolean
is optional
Description
Indica si es requerido bolsillo para el procesamiento de la transacción
Name
pockets
Type
array[Pocket]
is optional
Description
Estructura que contiene los bolsillos de la tarjeta
Name
requireAvs
Type
boolean
is optional
Description
Indica si es requerida la información de código postal
Name
zipCodeFormat
Type
string
is optional
Description
Formato a ser utilizado para la validación del código postal
Nullable:Sí
Name
accountVerification
Type
boolean
is optional
Description
Indica si es necesario realizar el flujo de verificación de cuentas
Name
requirePin
Type
boolean
is optional
Description
Indica si es necesario pin para procesar la transacción
Name
requireRedirection
Type
boolean
is optional
Description
Indica si el medio de pago es del tipo redirección
Name
bankList
Type
array[BankItem]
is optional
Description
Lista de bancos disponibles para procesar un pago
Name
requireBalance
Type
boolean
is optional
Description
Indica si es requerido el consumo del servicio de balance
Name
hasForwarding
Type
boolean
is optional
Description
Indica si el medio de pago tiene configurado enrutamiento transaccional
Name
availablePaymentMethods
Type
integer
is optional
Description
Indica el total de medios de pago disponibles para procesar. Se indicará en la respuesta solo si se trata de selección de servicio por medio de índice.

Respuesta

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "La petición se ha procesado correctamente",
            "date": "2021-09-21T09:26:11-05:00"
        },
        "provider": "CREDIBANCO",
        "serviceCode": "CR_VS",
        "cardType": "C",
        "cardTypes": [
            "C",
            "R",
            "A"
        ],
        "displayInterest": false,
        "requireOtp": false,
        "requireCvv2": true,
        "threeDS": "optional",
        "credits": [
            {
                "status": {
                    "status": "OK",
                    "reason": "00",
                    "message": "La petición se ha procesado correctamente",
                    "date": "2021-09-21T09:26:11-05:00"
                },
                "provider": "CREDIBANCO",
                "serviceCode": "CR_VS",
                "cardType": "C",
                "cardTypes": [
                    "C",
                    "R",
                    "A"
                ],
                "displayInterest": false,
                "requireOtp": false,
                "requireCvv2": true,
                "threeDS": "optional",
                "credits": [
                    {
                    "description": "Cuotas",
                    "code": "0",
                    "groupCode": "C",
                    "type": "00",
                    "installments": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        8,
                        9,
                        10,
                        11,
                        12,
                        13,
                        14,
                        15,
                        16,
                        17,
                        18,
                        19,
                        20,
                        21,
                        22,
                        23,
                        24,
                        25,
                        26,
                        27,
                        28,
                        29,
                        30,
                        31,
                        32,
                        33,
                        34,
                        35,
                        36
                    ]
                    }
                ],
                "requireBalance": false,
            }
        ],
        "requireBalance": false,
    }

POST/gateway/interests

Cálculo de Intereses (solo Ecuador)

Este servicio se debe consumir si la tarjeta requiere que se muestren los intereses (displayInterest en true) y como ejemplo de esta manera se muestran los valores en el servicio de redirección.

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
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
payment
Type
Payment
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web

Solicitud

POST

/gateway/interests

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/interests \
-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",
        "email": "[email protected]"
    },
    "payment": {
        "reference": "1122334455",
        "amount": {
            "currency": "USD",
            "total": 100
        }
    },
    "instrument": {
        "card": {
            "number": "4110760000000008",
            "expiration": "12/20",
            "cvv": "123"
        },
        "credit": {
            "code": "1",
            "type": "02",
            "groupCode": "P",
            "installment": "24"
        }
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Respuesta

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
values
Type
InterestValues
is optional
Description
Estructura que contiene la información del cálculo de intereses para un tipo de crédito y monto
Name
conversion
Type
AmountConversion
is optional
Description
Estructura para definir el factor de conversión y los valores.

Respuesta

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "La petición se ha procesado correctamente",
            "date": "2021-09-22T16:08:19-05:00"
        },
        "provider": "INTERDIN",
        "values": {
            "original": 1,
            "installment": 0.04,
            "interest": 0.03,
            "total": 1.03
        },
        "conversion": {
            "from": {
            "currency": "COP",
            "total": 3000
            },
            "to": {
            "currency": "USD",
            "total": 1
            },
            "factor": 0.0003333333333333333
        }
    }

POST/gateway/balance

Solicitud de balance

Este servicio permite consultar la información de balance. Se debe consumir si el método de pago lo requiere (Cuando 'requireBalance' es 'true' en la respuesta obtenida del servicio de información).

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
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
payment
Type
Payment
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web

Solicitud

POST

/gateway/balance

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/balance \
-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"
    },
    "payment": {
        "reference": "1122334455",
        "description": "Prueba",
        "amount": {
            "currency": "CRC",
            "total": 1000
        }
    },
    "instrument": {
        "card": {
            "number": "4111111111111111",
            "expiration": "12/30"
        },
    },
    "ipAddress": "127.0.0.1",
    "userAgent": "Testing"
}'

Respuesta

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
total
Type
number
is optional
Description
Ejemplo:4973.19

Respuesta

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "La petición se ha procesado correctamente",
            "date": "2021-09-21T09:26:11-05:00"
        },
        "total": 42356.32
    }