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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
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
card
Type
Card
is optional
Description
Estructura que contiene la información de la tarjeta.
Name
number
Type
string
is Required
REQUIRED
Description
Longitud máxima:20
Name
expiration
Type
string
is optional
Description
Ejemplo:12/22
Patrón:^[01]\d\/\d{2}$
Name
cvv
Type
string
is optional
Description
Name
installments
Type
number
is optional
Description
Name
account
Type
Account
is optional
Description
Estructura que contiene la información de la cuenta bancaria.
Name
bankName
Type
string
is optional
Description
Nombre del banco de la cuenta a procesar
Longitud máxima:30
Name
bankCode
Type
string
is Required
REQUIRED
Description
Código que identifica al banco en la red
Longitud máxima:17
Name
accountType
Type
string
is Required
REQUIRED
Description
tipo de cuenta
Valores permitidos:SAVDDACCD
Name
accountNumber
Type
string
is Required
REQUIRED
Description
Número de cuenta
Longitud máxima:17
Name
franchise
Type
string
is optional
Description
Longitud máxima:20
Name
verificationCode
Type
string
is optional
Description
El verificationCode es un JSON Web Signature (JWS). Tiene el fin de ser el instrumento verificador del estado de la cuenta.
Ejemplo:eyJhbGciOiJSUzI1NiJ9.eyJhY2NvdW50SGFzaCI6ImM5YWM2ZjFhZDhjNDA3Y2ZjNzMyNDljNTE2MTJjNTdmMWQxZGNiNTA4YjE4ZGJlYWE1MWQ0NDI5NjBjMjUwNDUyMzY4ZTg2YmUzMWQ3MDMxMDY4ZDM2MjM2NzVjYzhkYTUzNzhhODNmMTUwZjg5OTczOTBiZTEyMGU1ZmExN2RhIiwib25UZXN0Ijp0cnVlLCJzZXJ2aWNlIjoibW9jayIsImlkIjo0MDB9.dFMY4EwCrWq9EBmERFkKCoLHExPH4vgaCgnZaqB_mf8n3Sv6Qnu6Pb79onluX1OZecmYmBuHqZ_ykKXWSD4RMZSpckYFCiO3mlcJKI4qb91COhl_c2qXxYJuLEdbLfGlzf0k8-oJgFcO9gAS1Xm0hpTP4iiXF6st1hFwlfR3fpX4rr-bTsKgMvRSReMuxa0Vs92DykfqUR_3udlc0DFCPB9ZTaSqeRNHFAPAWNniUPWURQlW5c9J9xcyKTgKGzfI1_7h2I4ALQeRifptE2nC-HZtEMwtcToNh7hn0oL9lNFXnXGK9sWKORcyWKVfpEChS8z30UfX6kOhU6fp_qUwmA
Name
token
Type
Token
is optional
Description
Estructura que contiene la información del token que asocia a la tarjeta Para la entrada solo es necesario el token o el subtoken y el cvv si se trata de una operación donde el usuario está presente Para la salida si se devuelven todos los datos al tokenizar
Name
token
Type
string
is optional
Description
Código generado para identificar la tarjeta en el sistema
Longitud máxima:64
Longitud mínima:64
Name
subtoken
Type
string
is optional
Description
Código alterno generado para identificar la tarjeta
Longitud máxima:16
Longitud mínima:16
Name
franchise
Type
string
is optional
Description
Codigo de la franquicia asociada al token (Solo como respuesta no es necesario enviarla)
Valores permitidos:visavisa_electronamexmastercodensadinersjbcdiscoverriscredencialcomfamacolsubsidiofalabellaelosomostuyaexitoalkostomaestromefiaath_card
Name
franchiseName
Type
string
is optional
Description
Name
issuerName
Type
string
is optional
Description
Name
lastDigits
Type
string
is optional
Description
Name
validUntil
Type
string
is optional
Description
Name
cvv
Type
string
is optional
Description
CVV solicitado al usuario en caso de que esté presente en la operación
Longitud máxima:4
Longitud mínima:3
Name
credit
Type
Credit
is optional
Description
Estructura que contiene la información del tipo de crédito
Name
code
Type
string
is optional
Description
Name
type
Type
string
is optional
Description
Name
groupCode
Type
string
is optional
Description
Name
installment
Type
integer
is optional
Description
Name
threeDS
Type
object
is optional
Description
Name
version
Type
string
is Required
REQUIRED
Description
Valores permitidos:v2v2x
Name
id
Type
number
is optional
Description
Este valor solo aplica si la validación se hizo con el servicio de 3DS de Placetopay
Name
enrolled
Type
string
is Required
REQUIRED
Description
Informa si la tarjeta se encuentra registrada en 3DS
Valores permitidos:YNU
Longitud mínima:1
Name
authenticated
Type
string
is Required
REQUIRED
Description
Valores permitidos:YNUAICDR
Longitud máxima:1
Longitud mínima:1
Name
eci
Type
string
is Required
REQUIRED
Description
Indicador del resultado de la autenticación generado por el comercio electrónico.
Valores permitidos:020100050607
Longitud mínima:1
Name
cavv
Type
string
is Required
REQUIRED
Description
Valor de autenticación para la franquicia generado por el ACS. (3DS campo authenticationValue).
Ejemplo:AJkBABIWcQAAAAM5FwIzdGiYeHM
Longitud máxima:28
Longitud mínima:28
Nullable:Sí
Name
xid
Type
string
is Required
REQUIRED
Description
ID de Transacción DS (3DS campo dsTransID).
Longitud mínima:1
Name
extra
Type
object
is optional
Description
Name
transStatusReason
Type
string
is optional
Description
Proporciona información sobre el estado de la transacción.
Nullable:Sí
Name
acsTransId
Type
string
is optional
Description
Identificador único de transacción generado por el ACS.
Ejemplo:37a7b6e0-fd58-4e38-98de-79c70c526a47
Name
threeDSServerTransID
Type
string
is optional
Description
Identificador único de transacción generado por el 3DS Server.
Ejemplo:eadd3a60-b870-41d0-977f-921b3dbe6323/MkGJDl2Y5E=
Name
validSignature
Type
boolean
is optional
Description
Name
otp
Type
string
is optional
Description
Name
pinPad
Type
PinPad
is optional
Description
Estructura que contiene la información del servicio pinPad
Name
transactionId
Type
string
is optional
Description
Name
positions
Type
string
is optional
Description
Name
pinBlock
Type
string
is optional
Description
Name
length
Type
integer
is optional
Description
Name
pin
Type
string
is optional
Description
Recibe el código PIN cuando es plano o cuando se trata de un PinBlock
Ejemplo:0B880E2326F6409E
Longitud máxima:20
Longitud mínima:2
Name
redirection
Type
Redirection
is optional
Description
Representa un medio de pago de redirección, es decir que requiere que se envíe el usuario a otra URL para completar el proceso
Name
paymentMethod
Type
string
is optional
Description
Valores permitidos:_PSE_BTNBCPGEFTBTNAV
Name
returnURL
Type
string
is optional
Description
URL para que una vez se termine el proceso de pago se retorne el control (cuando aplica)
Ejemplo:http://your-site.com/your-return-route
Formato:uri
Longitud máxima:250
Name
processURL
Type
string
is optional
Description
URL a la cual se debe enviar al cliente para continuar el proceso, está es proporcionada por el servicio
Formato:uri
Longitud máxima:250
Name
additional
Type
object
is optional
Description
Estructura para relacionar datos adicionales en el proceso.
Name
bankCode
Type
string
is optional
Description
Código que identifica al banco en la red.
Ejemplo:1007
Name
userType
Type
string
is optional
Description
Ejemplo:person
Name
kount
Type
Kount
is optional
Description
Maneja información especifica para usar con el filtro de riesgo Kount
Name
session
Type
string
is Required
REQUIRED
Description
Identificador de esta operación en Kount, debe ser único por transacción
Name
type
Type
string
is optional
Description
Describe el tipo de operación que se está manejando en la sesión para definir los campos adicionales a enviar
Valores permitidos:airlinesoat
Name
pocket
Type
string
is optional
Description
Bolsillo de la tarjeta utilizado para el pago
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
reference
Type
string
is optional
Description
Longitud máxima:32
Longitud mínima:1
Name
description
Type
string
is optional
Description
Longitud máxima:250
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
dispersion
Type
array[Dispersion]
is optional
Description
Name
agreement
Type
number
is optional
Description
Identificador de destinatario de la transacción. Para el sitio principal de la transacción, el valor debe ser null.
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
modifiers
Type
array[PaymentModifier]
is optional
Description
Estructura que contiene modificadores de pago
Name
type
Type
string
is optional
Description
Tipo de modificador
Valores permitidos:FEDERAL_GOVERNMENT
Name
code
Type
string
is optional
Description
Código del modificador. Cuando el tipo es FEDERAL_GOVERMENT, representa el número de ley para descuento.
Ejemplo:17934
Name
additional
Type
object
is optional
Description
Informaciones adicionales del modificador
Name
invoice
Type
string
is optional
Description
Número de factura. Requerido cuando tipo es FEDERAL_GOVERMENT.
Name
shipping
Type
Person
is optional
Description
Estructura para relacionar información de envío.
Name
documentType
Type
string
is optional
Description
Tipo de documento de identificación
Valores permitidos:CCNITRUTTIPNN
Ejemplo:CC
Longitud máxima:3
Name
Document
Type
string
is optional
Description
Número de documento de identificación.
Name
name
Type
string
is optional
Description
Nombre
Name
surname
Type
string
is optional
Description
Apellidos
Name
company
Type
string
is optional
Description
Compañia
Name
email
Type
string
is optional
Description
Correo electrónico.
Name
address
Type
Address
is optional
Description
Objeto que contiene información de la dirección de una persona.
Name
street
Type
string
is optional
Description
Calle
Longitud máxima:128
Name
city
Type
string
is optional
Description
Ciudad
Longitud máxima:30
Name
state
Type
string
is optional
Description
Estado /provincia /departamento. Código ISO 3166-2
Ejemplo:CUN
Name
postalCode
Type
string
is optional
Description
Código postal
Ejemplo:110111
Longitud máxima:10
Name
country
Type
string
is optional
Description
País. Código ISO 3166-1 alpha-2
Ejemplo:CO
Longitud máxima:2
Name
phone
Type
string
is optional
Description
Teléfono
Ejemplo:3003003000
Longitud máxima:20
Name
mobile
Type
string
is optional
Description
Teléfono movil
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
reference
Type
string
is optional
Description
Longitud máxima:32
Name
description
Type
string
is optional
Description
Longitud máxima:254
Longitud mínima:1

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":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
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
code
Type
string
is optional
Description
Name
type
Type
string
is optional
Description
Name
groupCode
Type
string
is optional
Description
Name
installment
Type
integer
is optional
Description
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
code
Type
string
is optional
Description
Valor del bolsillo
Name
description
Type
string
is optional
Description
Descripción del bolsillo
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
code
Type
string
is optional
Description
Código de la entidad bancaria
Name
description
Type
string
is optional
Description
Nombre de la entidad bancaria
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

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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
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
card
Type
Card
is optional
Description
Estructura que contiene la información de la tarjeta.
Name
number
Type
string
is Required
REQUIRED
Description
Longitud máxima:20
Name
expiration
Type
string
is optional
Description
Ejemplo:12/22
Patrón:^[01]\d\/\d{2}$
Name
cvv
Type
string
is optional
Description
Name
installments
Type
number
is optional
Description
Name
account
Type
Account
is optional
Description
Estructura que contiene la información de la cuenta bancaria.
Name
bankName
Type
string
is optional
Description
Nombre del banco de la cuenta a procesar
Longitud máxima:30
Name
bankCode
Type
string
is Required
REQUIRED
Description
Código que identifica al banco en la red
Longitud máxima:17
Name
accountType
Type
string
is Required
REQUIRED
Description
tipo de cuenta
Valores permitidos:SAVDDACCD
Name
accountNumber
Type
string
is Required
REQUIRED
Description
Número de cuenta
Longitud máxima:17
Name
franchise
Type
string
is optional
Description
Longitud máxima:20
Name
verificationCode
Type
string
is optional
Description
El verificationCode es un JSON Web Signature (JWS). Tiene el fin de ser el instrumento verificador del estado de la cuenta.
Ejemplo:eyJhbGciOiJSUzI1NiJ9.eyJhY2NvdW50SGFzaCI6ImM5YWM2ZjFhZDhjNDA3Y2ZjNzMyNDljNTE2MTJjNTdmMWQxZGNiNTA4YjE4ZGJlYWE1MWQ0NDI5NjBjMjUwNDUyMzY4ZTg2YmUzMWQ3MDMxMDY4ZDM2MjM2NzVjYzhkYTUzNzhhODNmMTUwZjg5OTczOTBiZTEyMGU1ZmExN2RhIiwib25UZXN0Ijp0cnVlLCJzZXJ2aWNlIjoibW9jayIsImlkIjo0MDB9.dFMY4EwCrWq9EBmERFkKCoLHExPH4vgaCgnZaqB_mf8n3Sv6Qnu6Pb79onluX1OZecmYmBuHqZ_ykKXWSD4RMZSpckYFCiO3mlcJKI4qb91COhl_c2qXxYJuLEdbLfGlzf0k8-oJgFcO9gAS1Xm0hpTP4iiXF6st1hFwlfR3fpX4rr-bTsKgMvRSReMuxa0Vs92DykfqUR_3udlc0DFCPB9ZTaSqeRNHFAPAWNniUPWURQlW5c9J9xcyKTgKGzfI1_7h2I4ALQeRifptE2nC-HZtEMwtcToNh7hn0oL9lNFXnXGK9sWKORcyWKVfpEChS8z30UfX6kOhU6fp_qUwmA
Name
token
Type
Token
is optional
Description
Estructura que contiene la información del token que asocia a la tarjeta Para la entrada solo es necesario el token o el subtoken y el cvv si se trata de una operación donde el usuario está presente Para la salida si se devuelven todos los datos al tokenizar
Name
token
Type
string
is optional
Description
Código generado para identificar la tarjeta en el sistema
Longitud máxima:64
Longitud mínima:64
Name
subtoken
Type
string
is optional
Description
Código alterno generado para identificar la tarjeta
Longitud máxima:16
Longitud mínima:16
Name
franchise
Type
string
is optional
Description
Codigo de la franquicia asociada al token (Solo como respuesta no es necesario enviarla)
Valores permitidos:visavisa_electronamexmastercodensadinersjbcdiscoverriscredencialcomfamacolsubsidiofalabellaelosomostuyaexitoalkostomaestromefiaath_card
Name
franchiseName
Type
string
is optional
Description
Name
issuerName
Type
string
is optional
Description
Name
lastDigits
Type
string
is optional
Description
Name
validUntil
Type
string
is optional
Description
Name
cvv
Type
string
is optional
Description
CVV solicitado al usuario en caso de que esté presente en la operación
Longitud máxima:4
Longitud mínima:3
Name
credit
Type
Credit
is optional
Description
Estructura que contiene la información del tipo de crédito
Name
code
Type
string
is optional
Description
Name
type
Type
string
is optional
Description
Name
groupCode
Type
string
is optional
Description
Name
installment
Type
integer
is optional
Description
Name
threeDS
Type
object
is optional
Description
Name
version
Type
string
is Required
REQUIRED
Description
Valores permitidos:v2v2x
Name
id
Type
number
is optional
Description
Este valor solo aplica si la validación se hizo con el servicio de 3DS de Placetopay
Name
enrolled
Type
string
is Required
REQUIRED
Description
Informa si la tarjeta se encuentra registrada en 3DS
Valores permitidos:YNU
Longitud mínima:1
Name
authenticated
Type
string
is Required
REQUIRED
Description
Valores permitidos:YNUAICDR
Longitud máxima:1
Longitud mínima:1
Name
eci
Type
string
is Required
REQUIRED
Description
Indicador del resultado de la autenticación generado por el comercio electrónico.
Valores permitidos:020100050607
Longitud mínima:1
Name
cavv
Type
string
is Required
REQUIRED
Description
Valor de autenticación para la franquicia generado por el ACS. (3DS campo authenticationValue).
Ejemplo:AJkBABIWcQAAAAM5FwIzdGiYeHM
Longitud máxima:28
Longitud mínima:28
Nullable:Sí
Name
xid
Type
string
is Required
REQUIRED
Description
ID de Transacción DS (3DS campo dsTransID).
Longitud mínima:1
Name
extra
Type
object
is optional
Description
Name
transStatusReason
Type
string
is optional
Description
Proporciona información sobre el estado de la transacción.
Nullable:Sí
Name
acsTransId
Type
string
is optional
Description
Identificador único de transacción generado por el ACS.
Ejemplo:37a7b6e0-fd58-4e38-98de-79c70c526a47
Name
threeDSServerTransID
Type
string
is optional
Description
Identificador único de transacción generado por el 3DS Server.
Ejemplo:eadd3a60-b870-41d0-977f-921b3dbe6323/MkGJDl2Y5E=
Name
validSignature
Type
boolean
is optional
Description
Name
otp
Type
string
is optional
Description
Name
pinPad
Type
PinPad
is optional
Description
Estructura que contiene la información del servicio pinPad
Name
transactionId
Type
string
is optional
Description
Name
positions
Type
string
is optional
Description
Name
pinBlock
Type
string
is optional
Description
Name
length
Type
integer
is optional
Description
Name
pin
Type
string
is optional
Description
Recibe el código PIN cuando es plano o cuando se trata de un PinBlock
Ejemplo:0B880E2326F6409E
Longitud máxima:20
Longitud mínima:2
Name
redirection
Type
Redirection
is optional
Description
Representa un medio de pago de redirección, es decir que requiere que se envíe el usuario a otra URL para completar el proceso
Name
paymentMethod
Type
string
is optional
Description
Valores permitidos:_PSE_BTNBCPGEFTBTNAV
Name
returnURL
Type
string
is optional
Description
URL para que una vez se termine el proceso de pago se retorne el control (cuando aplica)
Ejemplo:http://your-site.com/your-return-route
Formato:uri
Longitud máxima:250
Name
processURL
Type
string
is optional
Description
URL a la cual se debe enviar al cliente para continuar el proceso, está es proporcionada por el servicio
Formato:uri
Longitud máxima:250
Name
additional
Type
object
is optional
Description
Estructura para relacionar datos adicionales en el proceso.
Name
bankCode
Type
string
is optional
Description
Código que identifica al banco en la red.
Ejemplo:1007
Name
userType
Type
string
is optional
Description
Ejemplo:person
Name
kount
Type
Kount
is optional
Description
Maneja información especifica para usar con el filtro de riesgo Kount
Name
session
Type
string
is Required
REQUIRED
Description
Identificador de esta operación en Kount, debe ser único por transacción
Name
type
Type
string
is optional
Description
Describe el tipo de operación que se está manejando en la sesión para definir los campos adicionales a enviar
Valores permitidos:airlinesoat
Name
pocket
Type
string
is optional
Description
Bolsillo de la tarjeta utilizado para el pago
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
reference
Type
string
is optional
Description
Longitud máxima:32
Longitud mínima:1
Name
description
Type
string
is optional
Description
Longitud máxima:250
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
dispersion
Type
array[Dispersion]
is optional
Description
Name
agreement
Type
number
is optional
Description
Identificador de destinatario de la transacción. Para el sitio principal de la transacción, el valor debe ser null.
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
modifiers
Type
array[PaymentModifier]
is optional
Description
Estructura que contiene modificadores de pago
Name
type
Type
string
is optional
Description
Tipo de modificador
Valores permitidos:FEDERAL_GOVERNMENT
Name
code
Type
string
is optional
Description
Código del modificador. Cuando el tipo es FEDERAL_GOVERMENT, representa el número de ley para descuento.
Ejemplo:17934
Name
additional
Type
object
is optional
Description
Informaciones adicionales del modificador
Name
invoice
Type
string
is optional
Description
Número de factura. Requerido cuando tipo es FEDERAL_GOVERMENT.
Name
shipping
Type
Person
is optional
Description
Estructura para relacionar información de envío.
Name
documentType
Type
string
is optional
Description
Tipo de documento de identificación
Valores permitidos:CCNITRUTTIPNN
Ejemplo:CC
Longitud máxima:3
Name
Document
Type
string
is optional
Description
Número de documento de identificación.
Name
name
Type
string
is optional
Description
Nombre
Name
surname
Type
string
is optional
Description
Apellidos
Name
company
Type
string
is optional
Description
Compañia
Name
email
Type
string
is optional
Description
Correo electrónico.
Name
address
Type
Address
is optional
Description
Objeto que contiene información de la dirección de una persona.
Name
street
Type
string
is optional
Description
Calle
Longitud máxima:128
Name
city
Type
string
is optional
Description
Ciudad
Longitud máxima:30
Name
state
Type
string
is optional
Description
Estado /provincia /departamento. Código ISO 3166-2
Ejemplo:CUN
Name
postalCode
Type
string
is optional
Description
Código postal
Ejemplo:110111
Longitud máxima:10
Name
country
Type
string
is optional
Description
País. Código ISO 3166-1 alpha-2
Ejemplo:CO
Longitud máxima:2
Name
phone
Type
string
is optional
Description
Teléfono
Ejemplo:3003003000
Longitud máxima:20
Name
mobile
Type
string
is optional
Description
Teléfono movil

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":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
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
original
Type
number
is optional
Description
Name
installment
Type
number
is optional
Description
Name
interest
Type
number
is optional
Description
Name
total
Type
number
is optional
Description
Name
conversion
Type
AmountConversion
is optional
Description
Estructura para definir el factor de conversión y los valores.
Name
from
Type
AmountBase
is optional
Description
Estructura que representa una cantidad que define la moneda y el total.
Name
currency
Type
string
is optional
Description
Name
total
Type
number
is optional
Description
Name
to
Type
AmountBase
is optional
Description
Estructura que representa una cantidad que define la moneda y el total.
Name
currency
Type
string
is optional
Description
Name
total
Type
number
is optional
Description
Name
factor
Type
number
is optional
Description

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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
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
card
Type
Card
is optional
Description
Estructura que contiene la información de la tarjeta.
Name
number
Type
string
is Required
REQUIRED
Description
Longitud máxima:20
Name
expiration
Type
string
is Required
REQUIRED
Description
Ejemplo:12/22
Patrón:^[01]\d\/\d{2}$
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
reference
Type
string
is optional
Description
Longitud máxima:32
Longitud mínima:1
Name
description
Type
string
is optional
Description
Longitud máxima:250
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
dispersion
Type
array[Dispersion]
is optional
Description
Name
agreement
Type
number
is optional
Description
Identificador de destinatario de la transacción. Para el sitio principal de la transacción, el valor debe ser null.
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
amount
Type
Amount
is optional
Description
Estructura que contiene la información acerca del pago de la transacción requerida al servicio web
Name
currency
Type
string
is Required
REQUIRED
Description
Valores permitidos:USDCOPCRCEURCADAUDGBPMXNCLP
Ejemplo:COP
Longitud máxima:3
Longitud mínima:3
Name
total
Type
number
is Required
REQUIRED
Description
Name
taxes
Type
array[TaxDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Tipo de impuesto reportado
Valores permitidos:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
Ejemplo:valueAddedTax
Name
amount
Type
number
is optional
Description
Name
base
Type
number
is optional
Description
Name
details
Type
array[AmountDetail]
is optional
Description
Name
kind
Type
string
is optional
Description
Name
amount
Type
number
is optional
Description
Name
modifiers
Type
array[PaymentModifier]
is optional
Description
Estructura que contiene modificadores de pago
Name
type
Type
string
is optional
Description
Tipo de modificador
Valores permitidos:FEDERAL_GOVERNMENT
Name
code
Type
string
is optional
Description
Código del modificador. Cuando el tipo es FEDERAL_GOVERMENT, representa el número de ley para descuento.
Ejemplo:17934
Name
additional
Type
object
is optional
Description
Informaciones adicionales del modificador
Name
invoice
Type
string
is optional
Description
Número de factura. Requerido cuando tipo es FEDERAL_GOVERMENT.
Name
shipping
Type
Person
is optional
Description
Estructura para relacionar información de envío.
Name
documentType
Type
string
is optional
Description
Tipo de documento de identificación
Valores permitidos:CCNITRUTTIPNN
Ejemplo:CC
Longitud máxima:3
Name
Document
Type
string
is optional
Description
Número de documento de identificación.
Name
name
Type
string
is optional
Description
Nombre
Name
surname
Type
string
is optional
Description
Apellidos
Name
company
Type
string
is optional
Description
Compañia
Name
email
Type
string
is optional
Description
Correo electrónico.
Name
address
Type
Address
is optional
Description
Objeto que contiene información de la dirección de una persona.
Name
street
Type
string
is optional
Description
Calle
Longitud máxima:128
Name
city
Type
string
is optional
Description
Ciudad
Longitud máxima:30
Name
state
Type
string
is optional
Description
Estado /provincia /departamento. Código ISO 3166-2
Ejemplo:CUN
Name
postalCode
Type
string
is optional
Description
Código postal
Ejemplo:110111
Longitud máxima:10
Name
country
Type
string
is optional
Description
País. Código ISO 3166-1 alpha-2
Ejemplo:CO
Longitud máxima:2
Name
phone
Type
string
is optional
Description
Teléfono
Ejemplo:3003003000
Longitud máxima:20
Name
mobile
Type
string
is optional
Description
Teléfono movil

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":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
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
    }