Placetopay Docs

POST/gateway/process

Procesamiento de transacción

Este servicio permite que se realice el cobro a la tarjeta del usuario, los parámetros del instrument son variables, si no se pide tipo de crédito ni otp no es necesario enviar esas variables, payer es siempre requerido, buyer es opcional pero recomendado.

Solicitud

Name
action
Type
string
is optional
Description
Este campo debe ser enviado únicamente cuando se realice un proceso de checkin, de lo contrario, no debe ser enviado en la solicitud
Valores permitidos:checkin
Name
locale
Type
string
is optional
Description
Ejemplo:es_CO
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
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
payer
Type
Person
is Required
REQUIRED
Description
Estructura que refleja la información de una persona involucrada en una transacción.
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
buyer
Type
Person
is optional
Description
Estructura que refleja la información de una persona involucrada en una transacción.
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
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
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 Required
REQUIRED
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
additional
Type
object
is optional
Description
Objeto dinámico clave valor de información que se desee guardar con la transacción. Las siguientes claves NO son permitidas: _accountNumber, userAgent, fingerprint, sourcePlatform, tokenizationID, trazabilyCode, transactionCycle, RequestId, PartnerAuthCode, onTest, threeDSEnrolled, threeDSAuthenticated. Ver más en Datos adicionales
Name
metadata
Type
object
is optional
Description
Objeto dinámico clave valor de información adicional que solicitan los servicios externos para ser ejecutados.
Name
EBTDeliveryIndicator
Type
string
is optional
Description
Valores permitidos:DIRECT_DELIVERYCUSTOMER_PICKUPCOMMERCIAL_SHIPPINGOTHERNOT_AVAILABLE
Name
notificationURL
Type
string
is optional
Description
URL a la que se enviará una notificación HTTP con la información de la transacción una vez que esta haya sido procesada. Ver más en Notificación
Ejemplo:https://your-site.com/your-notification-path
Name
ipAddress
Type
string
is optional
Description
Name
userAgent
Type
string
is optional
Description
Ejemplo:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36
Name
sourcePlatform
Type
string
is optional
Description

Solicitud

POST

/gateway/process

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/process \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login": "c4ca4238a0b923820dcc509a6f75849b",
        "tranKey": "cgqVhiaKSUSJmYQsXMsBqpfjz155nyKk54I66xyfuDI=",
        "nonce": "NjBhZTllMjZjYmQxYg==",
        "seed": "2021-05-26T14:14:46-05:00"
    },
    "payer": {
        "name": "Ms. Nelle Beahan DVM",
        "surname": "Spencer",
        "email": "[email protected]",
        "documentType": "CC",
        "document": "3154383838",
        "mobile": "3006108300"
    },
    "payment": {
        "reference": "TEST_20210526_141005",
        "description": "Cum vitae et consequatur quas adipisci ut rem.",
        "amount": {
            "currency": "COP",
            "total": 32030
        }
    },
    "instrument": {
        "card": {
            "number": "36545400000008",
            "expiration": "12/20",
            "cvv": "123",
            "installments": 2
        }
    },
    "ipAddress": "190.85.90.130",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
}'

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
date
Type
string
is optional
Description
Ejemplo:2021-09-20T21:51:59-05:00
Name
transactionDate
Type
string
is optional
Description
Ejemplo:2021-09-20T21:51:59-05:00
Name
internalReference
Type
number
is optional
Description
Name
reference
Type
string
is optional
Description
Longitud mínima:1
Name
paymentMethod
Type
string
is optional
Description
Longitud mínima:1
Name
franchise
Type
string
is optional
Description
Longitud mínima:1
Name
franchiseName
Type
string
is optional
Description
Ejemplo:Botón Aval
Longitud mínima:1
Name
issuerName
Type
string
is optional
Description
Nombre del banco procesador
Ejemplo:Banco Bogotá
Longitud mínima:1
Nullable:Sí
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
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
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud máxima:16
Nullable:Sí
Name
type
Type
string
is optional
Description
Valores permitidos:AUTH_ONLY
Longitud mínima:1
Name
refunded
Type
boolean
is optional
Description
Name
lastDigits
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
provider
Type
string
is optional
Description
Valores permitidos:ACHATH-AVALNETATH-MOVILAUSTROAVALBANCOLOMBIABRASPAGCOMFANDICREDIBANCODATAFASTEBUSEVERTECFLAMINGOINTERDINMEDIANETPAYSTUDIOREDEBANSABRESUPERGIROSTECNICARDTRANSERVERTUYA-DIRECT
Name
discount
Type
string
is optional
Description
Nullable:Sí
Name
processorFields
Type
object
is optional
Description
Name
id
Type
string
is optional
Description
Ejemplo:e67122e3b9af1f7f72eacd430996d94b
Name
b24
Type
string
is optional
Description
Ejemplo:?-
Name
paymentURL
Type
string
is optional
Description
Ejemplo:https://avalpaycenter.labdigbdbstgpb.com/?trazabilityCode=000000437981
Name
additional
Type
object
is optional
Description
Ver más en Datos adicionales
Name
merchantCode
Type
string
is optional
Description
Código de entidad
Name
terminalNumber
Type
string
is optional
Description
Número de terminal del medio de pago
Name
trazabilyCode
Type
string
is optional
Description
Name
_wcTransactionId_
Type
string
is optional
Description
Identificador de transacción en comercio
Name
preAuthorization
Type
object
is optional
Description
Name
condition
Type
string
is optional
Description
Name
internalReference
Type
number
is optional
Description
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
salt
Type
string
is optional
Description
Name
dispersion
Type
array
is optional
Description
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
agreement
Type
integer
is optional
Description
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
refunded
Type
boolean
is optional
Description
Name
paymentMethod
Type
string
is optional
Description
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
notificationURL
Type
string
is optional
Description
URL a la que se enviará una notificación HTTP con la información de la transacción una vez que esta haya sido procesada. Ver más en Notificación
Ejemplo:https://your-site.com/your-notification-path

Respuesta

    {
        "status": {
            "status": "APPROVED",
            "reason": "00",
            "message": "Aprobada",
            "date": "2021-09-24T11:51:31-05:00"
        },
        "date": "2021-09-24T11:51:31-05:00",
        "transactionDate": "2021-09-24T11:51:31-05:00",
        "internalReference": 41,
        "reference": "ON1434012-PN1433129",
        "paymentMethod": "CR_VS",
        "franchise": "visa",
        "franchiseName": "Visa",
        "issuerName": "BANCO DE GUAYAQUIL, S.A.",
        "amount": {
            "taxes": [
            {
                "kind": "airportTax",
                "amount": 63,
                "base": 0
            },
            {
                "kind": "valueAddedTax",
                "amount": 158.47,
                "base": 0
            }
            ],
            "currency": "USD",
            "total": 1161.12
        },
        "conversion": {
            "from": {
            "currency": "USD",
            "total": 1161.12
            },
            "to": {
            "currency": "USD",
            "total": 1161
            },
            "factor": 1
        },
        "authorization": "739877",
        "receipt": "713329175945",
        "type": "DISPERSION",
        "refunded": false,
        "lastDigits": "0032",
        "provider": "CREDIBANCO",
        "discount": null,
        "processorFields": {
            "id": "08c0284b20510c8db8dcb29137374718",
            "b24": "XX"
        },
        "additional": {
            "merchantCode": "123456",
            "terminalNumber": "12345678",
            "bin": "411076",
            "expiration": "1220"
        },
        "dispersion": [
            {
            "status": {
                "status": "APPROVED",
                "reason": "00",
                "message": "Transacción aprobada",
                "date": "2021-09-24T11:51:31-05:00"
            },
            "agreement": 1,
            "type": "AIRLINE",
            "authorization": "739877",
            "receipt": "713329175945",
            "amount": {
                "currency": "CLP",
                "total": 638155.3
            },
            "refunded": false,
            "paymentMethod": "PS_VS"
            },
            {
            "status": {
                "status": "APPROVED",
                "reason": "00",
                "message": "Transacción aprobada",
                "date": "2021-09-24T11:51:31-05:00"
            },
            "agreement": null,
            "type": "MERCHANT",
            "authorization": "000000",
            "receipt": null,
            "amount": {
                "currency": "COP",
                "total": 297580
            },
            "refunded": false,
            "paymentMethod": "CR_VS"
            }
        ]
    }

POST/gateway/query

Consulta de transacción por referencia interna

Permite consultar una transacción en particular usando su referencia interna.

Solicitud

Name
locale
Type
string
is optional
Description
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
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
internalReference
Type
number
is Required
REQUIRED
Description

Solicitud

POST

/gateway/query

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/query \
-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"
    },
    "internalReference": "230364"
}'

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
date
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
transactionDate
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
internalReference
Type
number
is Required
REQUIRED
Description
Name
reference
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
paymentMethod
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchise
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchiseName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
issuerName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
amount
Type
Amount
is Required
REQUIRED
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
conversion
Type
AmountConversion
is Required
REQUIRED
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
Name
authorization
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is Required
REQUIRED
Description
Longitud máxima:16
Nullable:Sí
Name
type
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
refunded
Type
boolean
is Required
REQUIRED
Description
Name
lastDigits
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
provider
Type
string
is Required
REQUIRED
Description
Valores permitidos:CREDIBANCOREDEBANINTERDINDATAFASTTUYA-DIRECTBRASPAGTRANSERVERSABREEVERTECACHATH-AVALNETSUPERGIROSTECNICARDMEDIANETAUSTROCOMFANDIPAYSTUDIOFLAMINGOATH-MOVILEBUSBANCOLOMBIA
Name
discount
Type
string
is Required
REQUIRED
Description
Name
processorFields
Type
object
is Required
REQUIRED
Description
Name
id
Type
string
is optional
Description
Name
b24
Type
string
is optional
Description
Name
additional
Type
object
is Required
REQUIRED
Description
Ver más en Datos adicionales
Name
preAuthorization
Type
object
is optional
Description
Name
condition
Type
string
is optional
Description
Name
internalReference
Type
number
is optional
Description
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
salt
Type
string
is optional
Description
Name
dispersion
Type
array
is optional
Description
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
agreement
Type
integer
is optional
Description
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
refunded
Type
boolean
is optional
Description
Name
paymentMethod
Type
string
is optional
Description

Respuesta

{
    "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2024-12-04T00:09:40-05:00"
    },
    "date": "2021-09-24T10:02:17-05:00",
    "transactionDate": "2021-09-24T10:02:18-05:00",
    "internalReference": 230364,
    "reference": "800166551",
    "paymentMethod": "ID_DN",
    "franchise": "diners",
    "franchiseName": "Diners",
    "issuerName": "Diners",
    "amount": {
        "taxes": [
        {
            "kind": "valueAddedTax",
            "amount": 0,
            "base": 0
        }
        ],
        "currency": "USD",
        "total": 120
    },
    "conversion": {
        "from": {
        "currency": "USD",
        "total": 120
        },
        "to": {
        "currency": "USD",
        "total": 120
        },
        "factor": 1
    },
    "authorization": "999999",
    "receipt": "230364",
    "type": "AUTH_ONLY",
    "refunded": false,
    "lastDigits": "0008",
    "provider": "INTERDIN",
    "discount": null,
    "processorFields": {
        "id": "cf3e77878a07d6e3ee667c60081dc39d",
        "b24": "00"
    },
    "additional": {
        "merchantCode": "1065152",
        "terminalNumber": "00990099",
        "credit": {
        "code": 1,
        "type": "03",
        "groupCode": "X",
        "installments": 3
        },
        "totalAmount": 120,
        "interestAmount": 0,
        "installmentAmount": 40,
        "iceAmount": 0,
        "batch": null,
        "line": null,
        "bin": "365454",
        "expiration": "1122"
    },
    "notificationURL": "https://test.placetopay.ec/redirection/api/notify"
}

POST/gateway/search

Búsqueda de transacciones

Este servicio permite la búsqueda de transacciones por referencia y monto, suele utilizarse en caso de pérdida de comunicación al crear una transacción para obtener la referencia interna nuevamente.

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
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
reference
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
amount
Type
Amount
is Required
REQUIRED
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

Solicitud

POST

/gateway/search

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/search \
-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"
    },
    "reference": "TEST_20171108_144400"
    "amount": {
        "currency": "COP",
        "total": 1000
    }
}'

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
transactions
Type
array
is Required
REQUIRED
Description
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
date
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
transactionDate
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
internalReference
Type
number
is Required
REQUIRED
Description
Name
reference
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
paymentMethod
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchise
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchiseName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
issuerName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
amount
Type
Amount
is Required
REQUIRED
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
conversion
Type
AmountConversion
is Required
REQUIRED
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
Name
authorization
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is Required
REQUIRED
Description
Longitud máxima:16
Nullable:Sí
Name
type
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
refunded
Type
boolean
is Required
REQUIRED
Description
Name
lastDigits
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
provider
Type
string
is Required
REQUIRED
Description
Valores permitidos:CREDIBANCOREDEBANINTERDINDATAFASTTUYA-DIRECTBRASPAGTRANSERVERSABREEVERTECACHATH-AVALNETSUPERGIROSTECNICARDMEDIANETAUSTROCOMFANDIPAYSTUDIOFLAMINGOATH-MOVILEBUSBANCOLOMBIA
Name
discount
Type
string
is Required
REQUIRED
Description
Name
processorFields
Type
object
is Required
REQUIRED
Description
Name
id
Type
string
is optional
Description
Name
b24
Type
string
is optional
Description
Name
additional
Type
object
is Required
REQUIRED
Description
Ver más en Datos adicionales
Name
preAuthorization
Type
object
is optional
Description
Name
condition
Type
string
is optional
Description
Name
internalReference
Type
number
is optional
Description
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
salt
Type
string
is optional
Description
Name
dispersion
Type
array
is optional
Description
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
agreement
Type
integer
is optional
Description
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
refunded
Type
boolean
is optional
Description
Name
paymentMethod
Type
string
is optional
Description

Respuesta

{
    "status": {
        "status": "OK",
        "reason": "00",
        "message": "La petición se ha procesado correctamente",
        "date": "2021-09-20T21:51:59-05:00"
    },
    "transactions": [
        {
        "status": {
            "status": "PENDING",
            "reason": "?-",
            "message": "Transacción pendiente",
            "date": "2021-09-20T21:51:59-05:00"
        },
        "date": "2021-09-20T21:51:59-05:00",
        "transactionDate": "2021-09-20T21:51:59-05:00",
        "internalReference": 453,
        "reference": "TEST_3",
        "paymentMethod": "ID_VS",
        "franchise": "visa",
        "franchiseName": "Visa",
        "issuerName": "Testing Bank",
        "amount": {
            "taxes": [
            {
                "kind": "valueAddedTax",
                "amount": 3.27,
                "base": 0
            }
            ],
            "currency": "USD",
            "total": 17.2
        },
        "conversion": {
            "from": {
            "currency": "USD",
            "total": 17.2
            },
            "to": {
            "currency": "USD",
            "total": 17.2
            },
            "factor": 1
        },
        "authorization": null,
        "receipt": null,
        "type": "AUTH_ONLY",
        "refunded": false,
        "lastDigits": "0008",
        "provider": "INTERDIN",
        "discount": null,
        "processorFields": {
            "id": "a9cb4b7a7aa03f681a0545ba6807e1fc",
            "b24": "?-"
        },
        "additional": {
            "merchantCode": "000468232",
            "terminalNumber": "00990101",
            "credit": null,
            "totalAmount": 17.2,
            "interestAmount": 0,
            "installmentAmount": 0,
            "iceAmount": 0,
            "batch": null,
            "line": null,
            "bin": "411076",
            "expiration": "1228"
        }
        },
        {
        "status": {
            "status": "PENDING",
            "reason": "?-",
            "message": "Transacción pendiente",
            "date": "2021-09-20T21:51:59-05:00"
        },
        "date": "2021-09-20T21:51:59-05:00",
        "transactionDate": "2021-09-20T21:51:59-05:00",
        "internalReference": 452,
        "reference": "TEST_3",
        "paymentMethod": "ID_VS",
        "franchise": "visa",
        "franchiseName": "Visa",
        "issuerName": "Testing Bank",
        "amount": {
            "taxes": [
            {
                "kind": "valueAddedTax",
                "amount": 3.27,
                "base": 0
            }
            ],
            "details": [
            {
                "kind": "shipping",
                "amount": 100
            }
            ],
            "currency": "USD",
            "total": 17.2
        },
        "conversion": {
            "from": {
            "currency": "USD",
            "total": 17.2
            },
            "to": {
            "currency": "USD",
            "total": 17.2
            },
            "factor": 1
        },
        "authorization": null,
        "receipt": null,
        "type": "AUTH_ONLY",
        "refunded": false,
        "lastDigits": "0008",
        "provider": "INTERDIN",
        "discount": null,
        "processorFields": {
            "id": "cbc65da9667ca078dc774cad2fd510e4",
            "b24": "?-"
        },
        "additional": {
            "merchantCode": "000468232",
            "terminalNumber": "00990101",
            "credit": null,
            "totalAmount": 17.2,
            "interestAmount": 0,
            "installmentAmount": 0,
            "iceAmount": 0,
            "batch": null,
            "line": null,
            "bin": "411076",
            "expiration": "1228"
        }
        }
    ]
}

POST/gateway/transaction

Operaciones sobre una transacción

Permite realizar un reembolso, re-autorización o checkout sobre una transacción existente

Solicitud

Name
locale
Type
string
is optional
Description
Ejemplo:es-CO
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
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
action
Type
string
is Required
REQUIRED
Description
Tipo de operación a realizar sobre la transacción

reverse para revesar una transacción. reauthorization para modificar una transacción de checkin. checkout para cerrar y cobrar una transacción de checkin. refund para rembolsar una transacción. process, para aprobar de manera manual una transacción. void para cancelar el procesamiento de una transacción pendiente de aprobación manual.
Valores permitidos:reverserefundprocessvoiddispersioncheckoutreauthorization
Ejemplo:reverse
Name
internalReference
Type
number
is Required
REQUIRED
Description
Referencia interna única de la transacción

EJ: 543423
Name
authorization
Type
string
is optional
Description
Autorización de la transacción

EJ: 9999999
Name
payment
Type
object
is optional
Description
Estructura que contiene la información acerca del pago de la transacción
Name
amount
Type
object
is optional
Description
Name
currency
Type
number
is optional
Description
Código alfabético de la moneda a usar (ISO 4217 alpha code)

EJ: USD
Name
total
Type
number
is optional
Description
Valor total en la moneda base indicada

EJ: 1000 Valor total en la moneda base indicada

Solicitud

POST

/gateway/transaction

curl -X "POST" https://api-co-dev.placetopay.ws/gateway/transaction \
    -H "Content-Type: application/json" \
    -d "{
        "auth": {
            "login": "c51ce410c124a10e0db5e4b97fc2af39",
            "tranKey": "VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
            "nonce": "NjE0OWVkODgwYjNhNw==",
            "seed": "2021-09-21T09:34:48-05:00"
        },
        "internalReference": "1505723583",
        "authorization": "999999"
        "action": "reverse",
    }"

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
date
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
transactionDate
Type
string
is optional
Description
EJ: 2021-09-20T21:51:59-05:00
Name
internalReference
Type
number
is Required
REQUIRED
Description
Name
reference
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
paymentMethod
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchise
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
franchiseName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
issuerName
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
amount
Type
Amount
is Required
REQUIRED
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
conversion
Type
AmountConversion
is Required
REQUIRED
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
Name
authorization
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is Required
REQUIRED
Description
Longitud máxima:16
Nullable:Sí
Name
type
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Name
refunded
Type
boolean
is Required
REQUIRED
Description
Name
lastDigits
Type
string
is Required
REQUIRED
Description
Longitud mínima:1
Nullable:Sí
Name
provider
Type
string
is Required
REQUIRED
Description
Valores permitidos:CREDIBANCOREDEBANINTERDINDATAFASTTUYA-DIRECTBRASPAGTRANSERVERSABREEVERTECACHATH-AVALNETSUPERGIROSTECNICARDMEDIANETAUSTROCOMFANDIPAYSTUDIOFLAMINGOATH-MOVILEBUSBANCOLOMBIA
Name
discount
Type
string
is Required
REQUIRED
Description
Name
processorFields
Type
object
is Required
REQUIRED
Description
Name
id
Type
string
is optional
Description
Name
b24
Type
string
is optional
Description
Name
additional
Type
object
is Required
REQUIRED
Description
Ver más en Datos adicionales
Name
preAuthorization
Type
object
is optional
Description
Name
condition
Type
string
is optional
Description
Name
internalReference
Type
number
is optional
Description
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
salt
Type
string
is optional
Description
Name
dispersion
Type
array
is optional
Description
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
agreement
Type
integer
is optional
Description
Nullable:Sí
Name
agreementType
Type
string
is optional
Description
Valores permitidos:AIRLINEMERCHANT
Name
authorization
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
Name
receipt
Type
string
is optional
Description
Longitud mínima:1
Nullable:Sí
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
refunded
Type
boolean
is optional
Description
Name
paymentMethod
Type
string
is optional
Description

Respuesta

    {
        "status": {
            "status": "APPROVED",
            "reason": "00",
            "message": "Aprobada",
            "date": "2024-09-25T14:17:56-05:00"
        },
        "date": "2024-09-25T14:17:53-05:00",
        "transactionDate": "2024-09-25T14:17:56-05:00",
        "internalReference": 9,
        "reference": "331122",
        "paymentMethod": "CR_VS",
        "franchise": "visa",
        "franchiseName": "Visa",
        "issuerName": "JPMORGAN CHASE BANK, N.A.",
        "amount": {
            "taxes": [
                {
                    "kind": "valueAddedTax",
                    "amount": 0,
                    "base": 0
                }
            ],
            "currency": "COP",
            "total": 20000
        },
        "conversion": {
            "from": {
                "currency": "COP",
                "total": 20000
            },
            "to": {
                "currency": "COP",
                "total": 20000
            },
            "factor": 1
        },
        "authorization": "000000",
        "receipt": null,
        "type": "CREDIT",
        "refunded": false,
        "lastDigits": "1111",
        "provider": "CREDIBANCO",
        "discount": null,
        "processorFields": {
            "id": "0aba335e6b5a67822150e27f98949b3a",
            "b24": "000"
        },
        "additional": {
            "merchantCode": "012988341",
            "terminalNumber": "00022645",
            "bin": "411111",
            "expiration": "0525",
            "installments": 1
        }
    }