Sesión
Se identifica como sesión, a la experiencia visual con el que interactuan los usuarios para completar un pago.
Crear una sesión
Este endpoint te permite crear una nueva sesión. En la sesión el usuario podrá completar un pago o suscripción.
Solicitud
Estructura que contiene toda la información acerca de la transacción para ser procesada.
- Name
auth
- Type
- Authentication
- is Required
- REQUIRED
- Description
La autenticación del sitio. Ver más en Autenticación
- Name
login
- Type
- string
- is optional
- Description
Identificador del sitio.
Longitud mínima:1
- Name
tranKey
- Type
- string
- is optional
- Description
Credencial tranKey generado.
Ver más en AutenticaciónLongitud mínima:1
- Name
nonce
- Type
- string
- is optional
- Description
Valor aleatorio para cada solicitud codificado en Base64.
Longitud mínima:1
- Name
seed
- Type
- string
- is optional
- Description
Fecha actual, la cual se genera en formato ISO 8601.
Longitud mínima:1
- Name
payment
- Type
- PaymentRequest
- is Required
- REQUIRED
- Description
Información del pago solicitado.
- Name
reference
- Type
- string
- is Required
- REQUIRED
- Description
Referencia única del pago. compuesta por hasta 32 caracteres alfanuméricos y símbolos permitidos EJ:
PAYMENT_0001_ABC
,Venta_1234-ABCD#2024/03/15$500
,Ord: 1001/2023
Ejemplo:PAYMENT_0001_ABC
- Name
description
- Type
- string
- is Required
- REQUIRED
- Description
Descripción del proceso a realizar, permitiendo hasta 250 caracteres alfanuméricos, acentuados y símbolos comunes.
Ejemplo:Cita con el Dr. Pérez a las 10:00 am. 5/12/2024, por $100.00
- Name
amount
- Type
- Amount
- is Required
- REQUIRED
- Description
Información del monto a cobrar
- Name
currency
- Type
- string
- is optional
- Description
Código alfabético de la moneda a usar (ISO 4217 alpha code)
EJ:USD
Ejemplo:COP
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolaresEjemplo:2000
- Name
taxes
- Type
- array[Taxes]
- is optional
- Description
Estructura para definir impuestos en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de impuesto
Uno de:
valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
.Valores permitidos:valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
Ejemplo:valueAddedTax
- Name
amount
- Type
- number
- is optional
- Description
Monto total del impuesto
EJ:200
- Name
base
- Type
- number
- is optional
- Description
Monto base sobre el cual se calcula el impuesto
EJ:1000
- Name
details
- Type
- array[Details]
- is optional
- Description
Estructura para definir detalles adicionales del monto en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de detalle. Uno de:
discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Valores permitidos:discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Ejemplo:discount
- Name
amount
- Type
- number
- is optional
- Description
Monto total del detalle
EJ:
200
- Name
allowPartial
- Type
- boolean
- is optional
- Description
Define si el monto a ser cobrado puede ser pagado en varias transacciones. Cuando es
true
el usuario podrá completar el pago en varias transacciones.Valor por defecto:false
- Name
shipping
- Type
- Person
- is optional
- Description
Estructura para relacionar información de envío.
- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
items
- Type
- array[Item]
- is optional
- Description
Estructura para relacionar productos o artículos en el proceso.
- Name
sku
- Type
- string
- is optional
- Description
Identificador SKU del artículo.
EJ:SKU-12345
Ejemplo:SKU-12345
- Name
name
- Type
- string
- is optional
- Description
Nombre del artículo.
EJ:Manta de lana
Ejemplo:product_1
Longitud mínima:1
- Name
category
- Type
- string
- is optional
- Description
Categoría del artículo. Uno de:
digital
physical
Valores permitidos:digital
physical
Ejemplo:physical
Longitud mínima:1
- Name
qty
- Type
- number
- is optional
- Description
Cantidad de artículos de este tipo.
EJ:23
Ejemplo:1
- Name
price
- Type
- number
- is optional
- Description
Costo total del artículo.
EJ:1400
Ejemplo:1400
- Name
tax
- Type
- number
- is optional
- Description
Monto en impuestos del artículo.
EJ:100
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
recurring
- Type
- object
- is optional
- Description
Estructura para indicar la frecuencia de un cobro recurrente.
- Name
periodicity
- Type
- string
- is optional
- Description
Periodicidad del cobro
D
Día,M
Mes,Y
AñoValores permitidos:D
M
Y
Ejemplo:D
- Name
interval
- Type
- number
- is optional
- Description
Intervalo asociado a la periodicidad
EJ:15
para días.Ejemplo:1
Longitud máxima:127
Longitud mínima:1
- Name
nextPayment
- Type
- string
- is optional
- Description
Fecha del próximo pago
EJ:2019-08-24
Ejemplo:2019-08-24
Formato:date
- Name
maxPeriods
- Type
- number
- is optional
- Description
Número máximo de periodos. Usar
-1
en caso de que no haya límite
EJ:12
para máximo 12 cobrosEjemplo:1
Longitud máxima:32767
Longitud mínima:-1
- Name
dueDate
- Type
- string
- is optional
- Description
Fecha de vencimiento de la recurrencia
EJ:2019-09-24
Ejemplo:2019-09-24
Formato:date
- Name
notificationUrl
- Type
- string
- is optional
- Description
URL en el que el servicio notificará cada vez que se haga un cobro
EJ:https://merchant.com/notification
Ejemplo:https://checkout.placetopay.com
- Name
subscribe
- Type
- boolean
- is optional
- Description
Cuando se envía
true
, se genera una sesión de pago con suscripción.En el proceso de pago, el usuario puede elegir si quiere o no guardar su medio de pago para que sea usado en futuros cobros.
Valor por defecto:false
- Name
dispersion
- Type
- array[DispersionDetail]
- is optional
- Description
Cuando se define, se genera una sesión de pago con dispersión. El pago generado puede ser dividido en diferentes destinos según las condiciones dadas.
- Name
amount
- Type
- Amount
- is optional
- Description
Monto a "dispersar" en este destino.
- Name
currency
- Type
- string
- is optional
- Description
Código alfabético de la moneda a usar (ISO 4217 alpha code)
EJ:USD
Ejemplo:COP
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolaresEjemplo:2000
- Name
taxes
- Type
- array[Taxes]
- is optional
- Description
Estructura para definir impuestos en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de impuesto
Uno de:
valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
.Valores permitidos:valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
Ejemplo:valueAddedTax
- Name
amount
- Type
- number
- is optional
- Description
Monto total del impuesto
EJ:200
- Name
base
- Type
- number
- is optional
- Description
Monto base sobre el cual se calcula el impuesto
EJ:1000
- Name
details
- Type
- array[Details]
- is optional
- Description
Estructura para definir detalles adicionales del monto en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de detalle. Uno de:
discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Valores permitidos:discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Ejemplo:discount
- Name
amount
- Type
- number
- is optional
- Description
Monto total del detalle
EJ:
200
- Name
agreement
- Type
- string|number
- is optional
- Description
Id del destino de este monto. Puede ser el id de un sitio.
EJ:
122
- Name
agreementType
- Type
- string
- is optional
- Description
Tipo de destino de este monto.
MERCHANT
para sitios,AIRLINE
para aerolineas.Valores permitidos:MERCHANT
AIRLINE
Ejemplo:MERCHANT
- Name
modifiers
- Type
- array[Modifiers]
- is optional
- Description
Estructura para definir modificadores en el cobro.
Aplica para leyes de impuestos en paises especificos.
- Name
type
- Type
- string
- is optional
- Description
Identificador del tipo de modificador.
SóloFEDERAL_GOVERMENT
es soportado actualmente.Valores permitidos:FEDERAL_GOVERNMENT
Ejemplo:FEDERAL_GOVERNMENT
- Name
code
- Type
- number
- is optional
- Description
Código del modificador.
Para
FEDERAL_GOVERMENT
representa el número de ley para descuento.
17934
Servicios Gastronómicos
18083
IMESI Brasil - Argentina
19210
Inclusión Financiera
18910
Asignaciones Familiares
18999
Reintegro InmobiliariasValores permitidos:17934
18083
19210
18910
18999
Ejemplo:17934
- Name
additional
- Type
- object
- is optional
- Description
Estructura para anexar información al modificador
- Name
invoice
- Type
- string
- is optional
- Description
Requerido cuando
modifiers.[n].type
esFEDERAL_GOVERMENT
. Indica el número de factura.Ejemplo:123456789
Longitud máxima:9
- Name
processorFields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura que puede variar en el tiempo según la información disponible para el medio de pago. Ver más en Datos de procesamiento
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
expiration
- Type
- string
- is optional
- Description
Fecha de expiración de una sesión. El usuario debe terminar el proceso antes de esta fecha. El tiempo de expiración debe ser de al menos 5 minutos desde el momento de la creación. Ver más en Fecha de expiración
Ejemplo:2024-09-03T12:23:39-05:00
Formato:date-time
- Name
ipAddress
- Type
- string
- is Required
- REQUIRED
- Description
Dirección IP del usuario que realizará el proceso.
Ej:134.10.163.36
Ejemplo:134.10.163.36
- Name
userAgent
- Type
- string
- is Required
- REQUIRED
- Description
User Agent del navegador del usuario que realizará el proceso.
Ejemplo:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
- Name
returnUrl
- Type
- string
- is Required
- REQUIRED
- Description
URL de retorno, a esta url se redirige al usuario una vez termina la sesión. Ocurre cuando el usuario da click en Volver al comercio.
Ejemplo:https://commerce.test/return
- Name
locale
- Type
- string
- is optional
- Description
Idioma en el que se tratará la petición y la sesión. Ver más en Localización
Ejemplo:en_US
Formato:regex
Patrón:^\w{2}\_[A-Z]{2}
- Name
buyer
- Type
- Person
- is optional
- Description
Datos del usuario comprador, hace referencia al usuario que está comprando un producto o un servicio.
Cuando se crea una sesión: Se puede enviar si conoces al usuario que está haciendo la compra, pues ayuda a completar la información de la sesión.
Si se envía este dato, el usuario tendrá sus datos personales pre-diligenciados y podrá cambiarlos en Checkout.- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
payer
- Type
- Person
- is optional
- Description
Datos del usuario pagador, hace referencia al dueño del medio de pago o usuario que pagó el monto solicitado.
Cuando se crea una sesión: Sólo se debe usar cuando quieres "forzar" los datos del usuario que completará el proceso.
Si se envía este dato, el usuario tendrá sus datos personales pre-diligenciados pero no podrá cambiarlos.- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
subscription
- Type
- SubscriptionRequest
- is optional
- Description
Cuando se envía, se genera una sesión de suscripción.
El usuario registra un medio de pago para que luego se realicen cobros sobre ese medio de pago.
- Name
reference
- Type
- Reference
- is optional
- Description
Referencia única del proceso. Máximo de 32 caracteres
Ejemplo:PAYMENT_0001_ABC
- Name
description
- Type
- Description
- is optional
- Description
Descripción del proceso a realizar
Ejemplo:Consumo mes de Mayo
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
paymentMethod
- Type
- string
- is optional
- Description
Se usa para restringir los métodos de pago disponibles en checkout. Se pueden enviar varios códigos separados por coma. Ver más en Métodos de pago
EJ:
visa,master,pse
Ejemplo:visa
- Name
cancelUrl
- Type
- string
- is optional
- Description
URL de cancelación, a esta url se redirige al usuario cuando decide no continuar con el proceso. Ocurre cuando el usario da click en No deseo continuar
Ejemplo:https://commerce.test/cancel
- Name
skipResult
- Type
- boolean
- is optional
- Description
Si se envía
true
, cuando el usuario finalice el proceso no se mostrará la página de resultado de sesión, en su lugar será redireccionado alreturnUrl
. Ver más en Omitir resultadoValor por defecto:false
- Name
noBuyerFill
- Type
- boolean
- is optional
- Description
Por defecto los datos enviados como
buyer
se pre-diligencian en la interfaz de Checkout para agilizar el proceso de pago, si se envía este parámetro comotrue
entonces no se hará este pre diligenciamiento.Valor por defecto:false
- Name
type
- Type
- string
- is optional
- Description
Parámetro usado para sesiones de tipo preauthorización
Sólo se soporta
checkin
para generar una sesión de preautorizaciónValores permitidos:checkin
Ejemplo:checkin
- Name
metadata
- Type
- metadata
- is optional
- Description
Estructura de tipo clave-valor que se utiliza para enviar información adicional y determinar comportamientos específicos durante el procesamiento de una sesión.
- Name
initiatorIndicator
- Type
- string
- is optional
- Description
Indica que la sesión sera procesada por un agente con los datos del tarjetahabiente
Valores permitidos:AGENT
- Name
EBTDeliveryIndicator
- Type
- string
- is optional
- Description
(Requerido para pagos con EBT): Define el tipo de entrega
Valores permitidos:DIRECT_DELIVERY
CUSTOMER_PICKUP
COMMERCIAL_SHIPPING
OTHER
NOT_AVAILABLE
Solicitud
curl -X "POST" https://checkout-test.placetopay.com/api/session \
-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
}
},
"expiration": "2021-12-30T00:00:00-05:00",
"returnUrl": "https://dnetix.co/p2p/client",
"ipAddress": "127.0.0.1",
"userAgent": "PlacetoPay Sandbox"
}'
Respuesta
OK
- Name
status
- Type
- Status
- is optional
- Description
Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.
- Name
status
- Type
- string
- is optional
- Description
Estado de una petición o pago
Valores permitidos:APPROVED
PENDING
REJECTED
APPROVED_PARTIAL
PARTIAL_EXPIRED
FAILED
Ejemplo:APPROVED
Longitud mínima:1
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
Ejemplo:00
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
Ejemplo:La petición ha sido aprobada exitosamente
Longitud mínima:1
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Ejemplo:2022-07-27T14:51:27-05:00
Formato:date-time
Longitud mínima:1
- Name
requestId
- Type
- integer
- is optional
- Description
- Name
processUrl
- Type
- string
- is optional
- Description
Respuesta
{
"status": {
"status": "OK",
"reason": "PC",
"message": "La petición se ha procesado correctamente",
"date": "2021-11-30T15:08:27-05:00"
},
"requestId": 1,
"processUrl": "https://checkout-co.placetopay.com/session/1/cc9b8690b1f7228c78b759ce27d7e80a",
}
Consultar una sesión
Este endpoint te permite obtener la información de la sesión, si en la sesión hay transacciones se muestra el detalle de las mismas.
Parámetros
- Name
requestId
- Type
- requestId
- is Required
- REQUIRED
- Description
Solicitud
- Name
auth
- Type
- Authentication
- is Required
- REQUIRED
- Description
La autenticación del sitio. Ver más en Autenticación
- Name
login
- Type
- string
- is optional
- Description
Identificador del sitio.
Longitud mínima:1
- Name
tranKey
- Type
- string
- is optional
- Description
Credencial tranKey generado.
Ver más en AutenticaciónLongitud mínima:1
- Name
nonce
- Type
- string
- is optional
- Description
Valor aleatorio para cada solicitud codificado en Base64.
Longitud mínima:1
- Name
seed
- Type
- string
- is optional
- Description
Fecha actual, la cual se genera en formato ISO 8601.
Longitud mínima:1
Solicitud
curl -X "POST" https://checkout-test.placetopay.com/api/session/000000 \
-H "Content-Type: application/json" \
-d '{
"auth": {
"login": "c51ce410c124a10e0db5e4b97fc2af39",
"tranKey": "VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
"nonce": "NjE0OWVkODgwYjNhNw==",
"seed": "2021-09-21T09:34:48-05:00"
}
}'
Respuesta
OK
- Name
requestId
- Type
- string|number|integer
- is optional
- Description
Id de la petición
Ejemplo:1
- Name
status
- Type
- Status
- is optional
- Description
Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.
- Name
status
- Type
- string
- is optional
- Description
Estado de una petición o pago
Valores permitidos:APPROVED
PENDING
REJECTED
APPROVED_PARTIAL
PARTIAL_EXPIRED
FAILED
Ejemplo:APPROVED
Longitud mínima:1
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
Ejemplo:00
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
Ejemplo:La petición ha sido aprobada exitosamente
Longitud mínima:1
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Ejemplo:2022-07-27T14:51:27-05:00
Formato:date-time
Longitud mínima:1
- Name
request
- Type
- RedirectRequest
- is optional
- Description
Estructura que contiene toda la información acerca de la transacción para ser procesada.
- Name
auth
- Type
- Authentication
- is Required
- REQUIRED
- Description
La autenticación del sitio. Ver más en Autenticación
- Name
login
- Type
- string
- is optional
- Description
Identificador del sitio.
Longitud mínima:1
- Name
tranKey
- Type
- string
- is optional
- Description
Credencial tranKey generado.
Ver más en AutenticaciónLongitud mínima:1
- Name
nonce
- Type
- string
- is optional
- Description
Valor aleatorio para cada solicitud codificado en Base64.
Longitud mínima:1
- Name
seed
- Type
- string
- is optional
- Description
Fecha actual, la cual se genera en formato ISO 8601.
Longitud mínima:1
- Name
payment
- Type
- PaymentRequest
- is Required
- REQUIRED
- Description
Información del pago solicitado.
- Name
reference
- Type
- string
- is Required
- REQUIRED
- Description
Referencia única del pago. compuesta por hasta 32 caracteres alfanuméricos y símbolos permitidos EJ:
PAYMENT_0001_ABC
,Venta_1234-ABCD#2024/03/15$500
,Ord: 1001/2023
Ejemplo:PAYMENT_0001_ABC
- Name
description
- Type
- string
- is Required
- REQUIRED
- Description
Descripción del proceso a realizar, permitiendo hasta 250 caracteres alfanuméricos, acentuados y símbolos comunes.
Ejemplo:Cita con el Dr. Pérez a las 10:00 am. 5/12/2024, por $100.00
- Name
amount
- Type
- Amount
- is Required
- REQUIRED
- Description
Información del monto a cobrar
- Name
currency
- Type
- string
- is optional
- Description
Código alfabético de la moneda a usar (ISO 4217 alpha code)
EJ:USD
Ejemplo:COP
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolaresEjemplo:2000
- Name
taxes
- Type
- array[Taxes]
- is optional
- Description
Estructura para definir impuestos en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de impuesto
Uno de:
valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
.Valores permitidos:valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
Ejemplo:valueAddedTax
- Name
amount
- Type
- number
- is optional
- Description
Monto total del impuesto
EJ:200
- Name
base
- Type
- number
- is optional
- Description
Monto base sobre el cual se calcula el impuesto
EJ:1000
- Name
details
- Type
- array[Details]
- is optional
- Description
Estructura para definir detalles adicionales del monto en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de detalle. Uno de:
discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Valores permitidos:discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Ejemplo:discount
- Name
amount
- Type
- number
- is optional
- Description
Monto total del detalle
EJ:
200
- Name
allowPartial
- Type
- boolean
- is optional
- Description
Define si el monto a ser cobrado puede ser pagado en varias transacciones. Cuando es
true
el usuario podrá completar el pago en varias transacciones.Valor por defecto:false
- Name
shipping
- Type
- Person
- is optional
- Description
Estructura para relacionar información de envío.
- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
items
- Type
- array[Item]
- is optional
- Description
Estructura para relacionar productos o artículos en el proceso.
- Name
sku
- Type
- string
- is optional
- Description
Identificador SKU del artículo.
EJ:SKU-12345
Ejemplo:SKU-12345
- Name
name
- Type
- string
- is optional
- Description
Nombre del artículo.
EJ:Manta de lana
Ejemplo:product_1
Longitud mínima:1
- Name
category
- Type
- string
- is optional
- Description
Categoría del artículo. Uno de:
digital
physical
Valores permitidos:digital
physical
Ejemplo:physical
Longitud mínima:1
- Name
qty
- Type
- number
- is optional
- Description
Cantidad de artículos de este tipo.
EJ:23
Ejemplo:1
- Name
price
- Type
- number
- is optional
- Description
Costo total del artículo.
EJ:1400
Ejemplo:1400
- Name
tax
- Type
- number
- is optional
- Description
Monto en impuestos del artículo.
EJ:100
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
recurring
- Type
- object
- is optional
- Description
Estructura para indicar la frecuencia de un cobro recurrente.
- Name
periodicity
- Type
- string
- is optional
- Description
Periodicidad del cobro
D
Día,M
Mes,Y
AñoValores permitidos:D
M
Y
Ejemplo:D
- Name
interval
- Type
- number
- is optional
- Description
Intervalo asociado a la periodicidad
EJ:15
para días.Ejemplo:1
Longitud máxima:127
Longitud mínima:1
- Name
nextPayment
- Type
- string
- is optional
- Description
Fecha del próximo pago
EJ:2019-08-24
Ejemplo:2019-08-24
Formato:date
- Name
maxPeriods
- Type
- number
- is optional
- Description
Número máximo de periodos. Usar
-1
en caso de que no haya límite
EJ:12
para máximo 12 cobrosEjemplo:1
Longitud máxima:32767
Longitud mínima:-1
- Name
dueDate
- Type
- string
- is optional
- Description
Fecha de vencimiento de la recurrencia
EJ:2019-09-24
Ejemplo:2019-09-24
Formato:date
- Name
notificationUrl
- Type
- string
- is optional
- Description
URL en el que el servicio notificará cada vez que se haga un cobro
EJ:https://merchant.com/notification
Ejemplo:https://checkout.placetopay.com
- Name
subscribe
- Type
- boolean
- is optional
- Description
Cuando se envía
true
, se genera una sesión de pago con suscripción.En el proceso de pago, el usuario puede elegir si quiere o no guardar su medio de pago para que sea usado en futuros cobros.
Valor por defecto:false
- Name
dispersion
- Type
- array[DispersionDetail]
- is optional
- Description
Cuando se define, se genera una sesión de pago con dispersión. El pago generado puede ser dividido en diferentes destinos según las condiciones dadas.
- Name
amount
- Type
- Amount
- is optional
- Description
Monto a "dispersar" en este destino.
- Name
currency
- Type
- string
- is optional
- Description
Código alfabético de la moneda a usar (ISO 4217 alpha code)
EJ:USD
Ejemplo:COP
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolaresEjemplo:2000
- Name
taxes
- Type
- array[Taxes]
- is optional
- Description
Estructura para definir impuestos en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de impuesto
Uno de:
valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
.Valores permitidos:valueAddedTax
exciseDuty
ice
airportTax
stateTax
reducedStateTax
municipalTax
Ejemplo:valueAddedTax
- Name
amount
- Type
- number
- is optional
- Description
Monto total del impuesto
EJ:200
- Name
base
- Type
- number
- is optional
- Description
Monto base sobre el cual se calcula el impuesto
EJ:1000
- Name
details
- Type
- array[Details]
- is optional
- Description
Estructura para definir detalles adicionales del monto en el proceso de pago.
- Name
kind
- Type
- string
- is optional
- Description
Identificador del tipo de detalle. Uno de:
discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Valores permitidos:discount
additional
vatDevolutionBase
shipping
handlingFee
insurance
giftWrap
subtotal
fee
tip
airline
interests
Ejemplo:discount
- Name
amount
- Type
- number
- is optional
- Description
Monto total del detalle
EJ:
200
- Name
agreement
- Type
- string|number
- is optional
- Description
Id del destino de este monto. Puede ser el id de un sitio.
EJ:
122
- Name
agreementType
- Type
- string
- is optional
- Description
Tipo de destino de este monto.
MERCHANT
para sitios,AIRLINE
para aerolineas.Valores permitidos:MERCHANT
AIRLINE
Ejemplo:MERCHANT
- Name
modifiers
- Type
- array[Modifiers]
- is optional
- Description
Estructura para definir modificadores en el cobro.
Aplica para leyes de impuestos en paises especificos.
- Name
type
- Type
- string
- is optional
- Description
Identificador del tipo de modificador.
SóloFEDERAL_GOVERMENT
es soportado actualmente.Valores permitidos:FEDERAL_GOVERNMENT
Ejemplo:FEDERAL_GOVERNMENT
- Name
code
- Type
- number
- is optional
- Description
Código del modificador.
Para
FEDERAL_GOVERMENT
representa el número de ley para descuento.
17934
Servicios Gastronómicos
18083
IMESI Brasil - Argentina
19210
Inclusión Financiera
18910
Asignaciones Familiares
18999
Reintegro InmobiliariasValores permitidos:17934
18083
19210
18910
18999
Ejemplo:17934
- Name
additional
- Type
- object
- is optional
- Description
Estructura para anexar información al modificador
- Name
invoice
- Type
- string
- is optional
- Description
Requerido cuando
modifiers.[n].type
esFEDERAL_GOVERMENT
. Indica el número de factura.Ejemplo:123456789
Longitud máxima:9
- Name
processorFields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura que puede variar en el tiempo según la información disponible para el medio de pago. Ver más en Datos de procesamiento
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
expiration
- Type
- string
- is optional
- Description
Fecha de expiración de una sesión. El usuario debe terminar el proceso antes de esta fecha. El tiempo de expiración debe ser de al menos 5 minutos desde el momento de la creación. Ver más en Fecha de expiración
Ejemplo:2024-09-03T12:23:39-05:00
Formato:date-time
- Name
ipAddress
- Type
- string
- is Required
- REQUIRED
- Description
Dirección IP del usuario que realizará el proceso.
Ej:134.10.163.36
Ejemplo:134.10.163.36
- Name
userAgent
- Type
- string
- is Required
- REQUIRED
- Description
User Agent del navegador del usuario que realizará el proceso.
Ejemplo:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
- Name
returnUrl
- Type
- string
- is Required
- REQUIRED
- Description
URL de retorno, a esta url se redirige al usuario una vez termina la sesión. Ocurre cuando el usuario da click en Volver al comercio.
Ejemplo:https://commerce.test/return
- Name
locale
- Type
- string
- is optional
- Description
Idioma en el que se tratará la petición y la sesión. Ver más en Localización
Ejemplo:en_US
Formato:regex
Patrón:^\w{2}\_[A-Z]{2}
- Name
buyer
- Type
- Person
- is optional
- Description
Datos del usuario comprador, hace referencia al usuario que está comprando un producto o un servicio.
Cuando se crea una sesión: Se puede enviar si conoces al usuario que está haciendo la compra, pues ayuda a completar la información de la sesión.
Si se envía este dato, el usuario tendrá sus datos personales pre-diligenciados y podrá cambiarlos en Checkout.- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
payer
- Type
- Person
- is optional
- Description
Datos del usuario pagador, hace referencia al dueño del medio de pago o usuario que pagó el monto solicitado.
Cuando se crea una sesión: Sólo se debe usar cuando quieres "forzar" los datos del usuario que completará el proceso.
Si se envía este dato, el usuario tendrá sus datos personales pre-diligenciados pero no podrá cambiarlos.- Name
document
- Type
- string
- is optional
- Description
Documento de identidad
Ejemplo:1122334455
Longitud mínima:1
- Name
documentType
- Type
- string
- is optional
- Description
Identificador del tipo de documento. Ver opciones en Tipos de documento
EJ:
CC
para "Cédula de Ciudadanía" en Colombia.Ejemplo:CC
Longitud mínima:1
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
Ejemplo:Juan José
Longitud mínima:1
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
Ejemplo:Peréz Pinzon
Longitud mínima:1
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
Ejemplo:Evertec
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
Ejemplo:[email protected]
Longitud mínima:1
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
Ejemplo:+573214445566
Longitud mínima:1
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
El país en el que se encuentra la dirección. Código ISO 3166-1 alpha-2.
Ejemplo:CO
Longitud máxima:2
Longitud mínima:2
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
Ejemplo:Antioquia
Longitud mínima:1
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
Ejemplo:Medellín
Longitud mínima:1
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
Ejemplo:050012
Longitud mínima:1
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
Ejemplo:Calle 12 #33a-12, Apto 101
Longitud mínima:1
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
Ejemplo:+573214445566
Longitud mínima:1
- Name
subscription
- Type
- SubscriptionRequest
- is optional
- Description
Cuando se envía, se genera una sesión de suscripción.
El usuario registra un medio de pago para que luego se realicen cobros sobre ese medio de pago.
- Name
reference
- Type
- Reference
- is optional
- Description
Referencia única del proceso. Máximo de 32 caracteres
Ejemplo:PAYMENT_0001_ABC
- Name
description
- Type
- Description
- is optional
- Description
Descripción del proceso a realizar
Ejemplo:Consumo mes de Mayo
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
fields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura para relacionar información adicional en el proceso. Ver más en Campos Adicionales
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
paymentMethod
- Type
- string
- is optional
- Description
Se usa para restringir los métodos de pago disponibles en checkout. Se pueden enviar varios códigos separados por coma. Ver más en Métodos de pago
EJ:
visa,master,pse
Ejemplo:visa
- Name
cancelUrl
- Type
- string
- is optional
- Description
URL de cancelación, a esta url se redirige al usuario cuando decide no continuar con el proceso. Ocurre cuando el usario da click en No deseo continuar
Ejemplo:https://commerce.test/cancel
- Name
skipResult
- Type
- boolean
- is optional
- Description
Si se envía
true
, cuando el usuario finalice el proceso no se mostrará la página de resultado de sesión, en su lugar será redireccionado alreturnUrl
. Ver más en Omitir resultadoValor por defecto:false
- Name
noBuyerFill
- Type
- boolean
- is optional
- Description
Por defecto los datos enviados como
buyer
se pre-diligencian en la interfaz de Checkout para agilizar el proceso de pago, si se envía este parámetro comotrue
entonces no se hará este pre diligenciamiento.Valor por defecto:false
- Name
type
- Type
- string
- is optional
- Description
Parámetro usado para sesiones de tipo preauthorización
Sólo se soporta
checkin
para generar una sesión de preautorizaciónValores permitidos:checkin
Ejemplo:checkin
- Name
metadata
- Type
- metadata
- is optional
- Description
Estructura de tipo clave-valor que se utiliza para enviar información adicional y determinar comportamientos específicos durante el procesamiento de una sesión.
- Name
initiatorIndicator
- Type
- string
- is optional
- Description
Indica que la sesión sera procesada por un agente con los datos del tarjetahabiente
Valores permitidos:AGENT
- Name
EBTDeliveryIndicator
- Type
- string
- is optional
- Description
(Requerido para pagos con EBT): Define el tipo de entrega
Valores permitidos:DIRECT_DELIVERY
CUSTOMER_PICKUP
COMMERCIAL_SHIPPING
OTHER
NOT_AVAILABLE
- Name
payment
- Type
- Transaction
- is optional
- Description
- Name
status
- Type
- Status
- is optional
- Description
Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.
- Name
status
- Type
- string
- is optional
- Description
Estado de una petición o pago
Valores permitidos:APPROVED
PENDING
REJECTED
APPROVED_PARTIAL
PARTIAL_EXPIRED
FAILED
Ejemplo:APPROVED
Longitud mínima:1
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
Ejemplo:00
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
Ejemplo:La petición ha sido aprobada exitosamente
Longitud mínima:1
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Ejemplo:2022-07-27T14:51:27-05:00
Formato:date-time
Longitud mínima:1
- Name
internalReference
- Type
- integer
- is optional
- Description
Referencia interna en PlacetoPay.
Ejemplo:12345
- Name
reference
- Type
- string
- is optional
- Description
Referencia enviada por el comercio para la transacción.
Ejemplo:12345
- Name
paymentMethod
- Type
- string
- is optional
- Description
Código del método de pago utilizado.
Ejemplo:visa
- Name
paymentMethodName
- Type
- string
- is optional
- Description
Nombre del método de pago utilizado.
Ejemplo:Visa
- Name
issuerName
- Type
- string
- is optional
- Description
Nombre del emisor o del procesador.
Ejemplo:JPMORGAN CHASE BANK, N.A.
- Name
amount
- 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
Moneda acorde al ISO 4217 (alphabetic code).
Ejemplo:COP
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
Ejemplo:10000
- 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
Moneda acorde al ISO 4217 (alphabetic code).
Ejemplo:COP
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
Ejemplo:10000
- Name
factor
- Type
- number|string
- is optional
- Description
Factor de conversión
Ejemplo:1
- Name
receipt
- Type
- string
- is optional
- Description
Numero de recibo de la transacción.
Ejemplo:052617800175
- Name
franchise
- Type
- string
- is optional
- Description
Franquicia de la tarjeta utilizada.
Ejemplo:PS_VS
- Name
refunded
- Type
- boolean
- is optional
- Description
Se utiliza para definir si la transacción ha sido reembolsada
Valor por defecto:false
- Name
authorization
- Type
- string
- is optional
- Description
Código de autorización.
Ejemplo:965960
- Name
processorFields
- Type
- array[NameValuePair]
- is optional
- Description
Estructura que puede variar en el tiempo según la información disponible para el medio de pago. Ver más en Datos de procesamiento
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
- Name
dispersion
- Type
- Transaction Dispersion
- is optional
- Description
Estructura que contiene información de dispersión
- Name
status
- Type
- Status
- is optional
- Description
Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.
- Name
status
- Type
- string
- is optional
- Description
Estado de una petición o pago
Valores permitidos:APPROVED
PENDING
REJECTED
APPROVED_PARTIAL
PARTIAL_EXPIRED
FAILED
Ejemplo:APPROVED
Longitud mínima:1
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
Ejemplo:00
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
Ejemplo:La petición ha sido aprobada exitosamente
Longitud mínima:1
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Ejemplo:2022-07-27T14:51:27-05:00
Formato:date-time
Longitud mínima:1
- Name
agreement
- Type
- integer|null|string|number
- is optional
- Description
Identificador de destinatario de la transacción. Para el sitio principal de la transacción.
Ejemplo:186
- Name
agreementType
- Type
- string|null
- is optional
- Description
Tipo de dispersión
Valores permitidos:MERCHANT
AIRLINE
Ejemplo:MERCHANT
- Name
authorization
- Type
- string|null
- is optional
- Description
Código de autorización.
Ejemplo:965960
- Name
receipt
- Type
- string|null
- is optional
- Description
Numero de recibo de la transacción.
Ejemplo:052617800175
- Name
amount
- 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
Moneda acorde al ISO 4217 (alphabetic code).
Ejemplo:COP
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
Ejemplo:10000
- 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
Moneda acorde al ISO 4217 (alphabetic code).
Ejemplo:COP
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
Ejemplo:10000
- Name
factor
- Type
- number|string
- is optional
- Description
Factor de conversión
Ejemplo:1
- Name
refunded
- Type
- boolean
- is optional
- Description
Se utiliza para definir si la transacción ha sido reembolsada
Valor por defecto:false
- Name
paymentMethod
- Type
- string
- is optional
- Description
Código del método de pago utilizado.
Ejemplo:visa
- Name
agreement
- Type
- integer|null|string|number
- is optional
- Description
Identificador de destinatario de la transacción. Para el sitio principal de la transacción.
Ejemplo:186
- Name
agreementType
- Type
- string|null
- is optional
- Description
Tipo de dispersión
Valores permitidos:MERCHANT
AIRLINE
Ejemplo:MERCHANT
- Name
discount
- Type
- object|null
- is optional
- Description
- Name
base
- Type
- string|number
- is optional
- Description
- Ejemplo:
3000
- Name
code
- Type
- string
- is optional
- Description
- Ejemplo:
17934
- Name
type
- Type
- string
- is optional
- Description
- Ejemplo:
FRANCHISE
- Name
amount
- Type
- number|string
- is optional
- Description
- Ejemplo:
1000
- Name
subscription
- Type
- string|null
- is optional
- Description
- Name
subscription
- Type
- SubscriptionResponse
- is optional
- Description
Estructura que contiene información para el método de pago suscripción.
- Name
status
- Type
- Status
- is optional
- Description
Estructura que contiene la información de la respuesta sobre una solicitud o pago, e informa el estado actual de la misma.
- Name
status
- Type
- string
- is optional
- Description
Estado de una petición o pago
Valores permitidos:APPROVED
PENDING
REJECTED
APPROVED_PARTIAL
PARTIAL_EXPIRED
FAILED
Ejemplo:APPROVED
Longitud mínima:1
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
Ejemplo:00
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
Ejemplo:La petición ha sido aprobada exitosamente
Longitud mínima:1
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Ejemplo:2022-07-27T14:51:27-05:00
Formato:date-time
Longitud mínima:1
- Name
type
- Type
- string
- is optional
- Description
Define tipo de suscripción que se devuelve
Valores permitidos:token
cuenta
Ejemplo:token
- Name
instrument
- Type
- array[NameValuePair]
- is optional
- Description
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
Ejemplo:1111
Longitud mínima:1
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
Ejemplo:lastDigits
Longitud mínima:1
- Name
displayOn
- Type
- string
- is optional
- Description
Indica en qué condiciones se muestra el dato anexo. Ver más en Campos Adicionales
Uno de:
none
,payment
,receipt
,both
,approved
.Ejemplo:none
Longitud mínima:1
Respuesta
{
"requestId": 1,
"status": {
"status": "APPROVED",
"reason": "00",
"message": "La petición ha sido aprobada exitosamente",
"date": "2022-07-27T14:51:27-05:00"
},
"request": {
"locale": "es_CO",
"payer": {
"document": "1122334455",
"documentType": "CC",
"name": "John",
"surname": "Doe",
"company": "Evertec",
"email": "[email protected]",
"mobile": "+5731111111111",
"address": {
"street": "Calle falsa 123",
"city": "Medellín",
"state": "Poblado",
"postalCode": "55555",
"country": "CO",
"phone": "+573111111111"
}
},
"buyer": {
"document": "1122334455",
"documentType": "CC",
"name": "John",
"surname": "Doe",
"company": "Evertec",
"email": "[email protected]",
"mobile": "+5731111111111",
"address": {
"street": "Calle falsa 123",
"city": "Medellín",
"state": "Poblado",
"postalCode": "55555",
"country": "CO",
"phone": "+573111111111"
}
},
"payment": {
"reference": "12345",
"description": "Prueba de pago",
"amount": {
"currency": "COP",
"total": 2000,
"taxes": [
{
"kind": "valueAddedTax",
"amount": 1000,
"base": 0
}
],
"details": [
{
"kind": "discount",
"amount": 1000
}
]
},
"allowPartial": false,
"shipping": {
"document": "1122334455",
"documentType": "CC",
"name": "John",
"surname": "Doe",
"company": "Evertec",
"email": "[email protected]",
"mobile": "+5731111111111",
"address": {
"street": "Calle falsa 123",
"city": "Medellín",
"state": "Poblado",
"postalCode": "55555",
"country": "CO",
"phone": "+573111111111"
}
},
"items": [
{
"sku": "12345",
"name": "product_1",
"category": "physical",
"qty": "1",
"price": 1000,
"tax": 0
}
],
"fields": [
{
"keyword": "_test_field_value_",
"value": "_test_field_",
"displayOn": "approved"
}
],
"recurring": {
"periodicity": "D",
"interval": "1",
"nextPayment": "2019-08-24",
"maxPeriods": 1,
"dueDate ": "2019-09-24",
"notificationUrl ": "https://checkout.placetopay.com"
},
"subscribe": false,
"dispersion": [
{
"agreement": "1299",
"agreementType": "MERCHANT",
"amount": {
"currency": "USD",
"total": 200
}
}
],
"modifiers": [
{
"type": "FEDERAL_GOVERNMENT",
"code": 17934,
"additional": {
"invoice": "123345"
}
}
]
},
"subscription": {
"reference": "12345",
"description": "Ejemplo de descripción",
"fields": {
"keyword": "1111",
"value": "lastDigits",
"displayOn": "none"
}
},
"fields": [
{
"keyword": "_processUrl_",
"value": "https://checkout.redirection.test/session/1/a592098e22acc709ec7eb30fc0973060",
"displayOn": "none"
}
],
"paymentMethod": "visa",
"expiration": "2019-08-24T14:15:22Z",
"returnUrl": "https://commerce.test/return",
"cancelUrl": "https://commerce.test/cancel",
"ipAddress": "127.0.0.1",
"userAgent": "PlacetoPay Sandbox",
"skipResult": false,
"noBuyerFill": false,
"type": "checkin"
},
"payment": [
{
"status": {
"status": "APPROVED",
"reason": "00",
"message": "La petición ha sido aprobada exitosamente",
"date": "2022-07-27T14:51:27-05:00"
},
"internalReference": 12345,
"reference": "12345",
"paymentMethod": "visa",
"paymentMethodName": "Visa",
"issuerName": "JPMORGAN CHASE BANK, N.A.",
"amount": {
"from": {
"currency ": "COP",
"total ": 10000
},
"to": {
"currency ": "COP",
"total ": 10000
},
"factor": 1
},
"receipt": "052617800175",
"franchise": "PS_VS",
"refunded": false,
"authorization": "965960",
"processorFields": [
{
"keyword": "1111",
"value": "lastDigits",
"displayOn": "none"
}
],
"dispersion": null,
"agreement": null,
"agreementType": null,
"discount": {
"base": 3000,
"code": "17934",
"type": "FRANCHISE",
"amount": 1000
},
"subscription": null
}
],
"subscription": {
"status": {
"status": "OK",
"reason": "00",
"message": "La petición ha sido aprobada exitosamente",
"date": "2022-07-27T14:51:27-05:00"
},
"type": "token",
"instrument": [
{
"keyword": "token",
"value": "a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a",
"displayOn": "none"
},
{
"keyword": "subtoken",
"value": "8740257204881111",
"displayOn": "none"
},
{
"keyword": "franchise",
"value": "visa",
"displayOn": "none"
},
{
"keyword": "franchiseName",
"value": "Visa",
"displayOn": "none"
},
{
"keyword": "issuerName",
"value": "JPMORGAN CHASE BANK, N.A.",
"displayOn": "none"
},
{
"keyword": "lastDigits",
"value": "1111",
"displayOn": "none"
},
{
"keyword": "validUntil",
"value": "2029-12-31",
"displayOn": "none"
},
{
"keyword": "installments",
"value": null,
"displayOn": "none"
}
]
}
}