Token

Se identifica como token, a la llave generada por un proceso de suscripción permitiendo generar cobros sin interacción del usuario.

POST/api/collect

Cobro usando token

Permite realizar cobros sin la intervención del usuario usando medios de pago previamente suscritos.

Solicitud

Permite realizar cobros sin la intervención del usuario usando medios de pago previamente suscritos.

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ón
Longitud 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 dolares
Ejemplo: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:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
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:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
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:digitalphysical
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ño
Valores permitidos:DMY
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 cobros
Ejemplo: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 dolares
Ejemplo: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:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
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:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
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:MERCHANTAIRLINE
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ólo FEDERAL_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 Inmobiliarias
Valores permitidos:1793418083192101891018999
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 es FEDERAL_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
instrument
Type
Instrument-collect
is Required
REQUIRED
Description
Estructura que contiene los detalles de un medio de pago suscrito.
Name
token
Type
SimpleToken
is Required
REQUIRED
Description
Información de un medio de pago "tokenizado". Se debe tokenizar con una sesión de suscripción.
Debe contener el token o el subtoken, ambas representaciones válidas de un medio de pago tokenizado.
Name
token
Type
number
is optional
Description
Representación del medio de pago.

EJ: a3bfc8e2afb9ac5583922eccd6d2061c1b0592b0...
Ejemplo:a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a
Name
subtoken
Type
string
is optional
Description
Representación numérica del medio de pago. Se usa en casos donde es requerido que el token sea numérico. Los últimos 4 dígitos son iguales a los últimos 4 dígitos de la tarjeta de crédito.

EJ: 8740257204881112
Ejemplo:8740257204881112
Name
installments
Type
integer
is optional
Description
Número de cuotas en las cuales se solicita el cobro. Aplica para Colombia.

EJ: 2 para 2 cuotas.
Name
cvv
Type
string
is optional
Description
Código de seguridad de la tarjeta. Si el usuario está presente en el proceso de cobro, es recomendado anexar este dato..

EJ: 123
Ejemplo:123
Name
pocket
Type
string
is optional
Description
Código de billetera. Aplica para Tarjetas en Uruguay

Valores posibles:
10 Cuenta de ahorros en UYU 20 Cuenta corriente en UYU 80 Cuenta de ahorros en USD 90 Cuenta corriente en USD
Valores permitidos:10208090
Ejemplo:10
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
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
payer
Type
Person
is Required
REQUIRED
Description
Datos del usuario pagador, hace referencia al dueño del medio de pago o usuario que pagó el monto solicitado.
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
buyer
Type
Person
is optional
Description
Datos del usuario comprador, hace referencia al usuario que está comprando un producto o un servicio.
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
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
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ón
Valores permitidos: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_DELIVERYCUSTOMER_PICKUPCOMMERCIAL_SHIPPINGOTHERNOT_AVAILABLE
Name
provider
Type
string
is optional
Description
Código del proveedor de la transacción

Solicitud

POST

/api/collect

curl -X "POST" https://checkout-test.placetopay.com/api/collect \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "es_CO",
    "auth": {
      "login": "c51ce410c124a10e0db5e4b97fc2af39",
      "tranKey": "VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
      "nonce": "NjE0OWVkODgwYjNhNw==",
      "seed": "2021-09-21T09:34:48-05:00"
    },
    "payment": {
      "reference": "1122334455",
      "description": "Prueba",
      "amount": {
        "currency": "USD",
        "total": 100
      }
    },
    "instrument": {
      "token": {
        "token": "e07ca9986cf0ecac8a557fa11c07bf37ea35e9e3e3a4180c49"
      }
    },
    "expiration": "2021-12-30T00:00:00-05:00",
    "returnUrl": "https://dnetix.co/p2p/client",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox"
  }'

Respuesta

Name
requestId
Type
integer
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:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
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
request
is optional
Description
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
payer
Type
Person
is optional
Description
Estructura que refleja la información de una persona involucrada en una transacción.
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
payment
Type
PaymentRequest
is optional
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 dolares
Ejemplo: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:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
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:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
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:digitalphysical
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ño
Valores permitidos:DMY
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 cobros
Ejemplo: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 dolares
Ejemplo: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:valueAddedTaxexciseDutyiceairportTaxstateTaxreducedStateTaxmunicipalTax
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:discountadditionalvatDevolutionBaseshippinghandlingFeeinsurancegiftWrapsubtotalfeetipairlineinterests
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:MERCHANTAIRLINE
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ólo FEDERAL_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 Inmobiliarias
Valores permitidos:1793418083192101891018999
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 es FEDERAL_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
returnUrl
Type
string
is optional
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
ipAddress
Type
string
is optional
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 optional
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
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
payment
Type
PaymentResponse
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:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
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
string
is optional
Description
Name
paymentMethod
Type
string
is optional
Description
Name
paymentMethodName
Type
string
is optional
Description
Name
issuerName
Type
string
is optional
Description
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
authorization
Type
string
is optional
Description
Name
reference
Type
string
is optional
Description
Name
franchise
Type
string
is optional
Description
Name
refunded
Type
boolean
is optional
Description
Name
processorFields
Type
PaymentResponse
is optional
Description
Campos adicionales que pueden 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
Name
value
Type
string|object|integer|array
is optional
Description
Name
displayOn
Type
string
is optional
Description
Name
receipt
Type
string
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:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
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:tokencuenta
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": "2021-11-30T15:49:47-05:00"
  },
  "request": {
    "locale": "es_CO",
    "payer": {
      "document": "1033332222",
      "documentType": "CC",
      "name": "Name",
      "surname": "LastName",
      "email": "[email protected]",
      "mobile": "3111111111",
      "address": {
        "postalCode": "12345"
      }
    },
    "payment": {
      "reference": "1122334455",
      "description": "Prueba",
      "amount": {
        "currency": "USD",
        "total": 100
      },
      "allowPartial": false,
      "subscribe": false
    },
    "returnUrl": "https://redirection.test/home",
    "ipAddress": "127.0.0.1",
    "userAgent": "PlacetoPay Sandbox",
    "expiration": "2021-12-30T00:00:00-05:00"
  },
  "payment": [
    {
      "status": {
        "status": "APPROVED",
        "reason": "00",
        "message": "Aprobada",
        "date": "2021-11-30T15:49:36-05:00"
      },
      "internalReference": 1,
      "paymentMethod": "visa",
      "paymentMethodName": "Visa",
      "issuerName": "JPMORGAN CHASE BANK, N.A.",
      "amount": {
        "from": {
          "currency": "USD",
          "total": 100
        },
        "to": {
          "currency": "USD",
          "total": 100
        },
        "factor": 1
      },
      "authorization": "000000",
      "reference": "1122334455",
      "receipt": "241516",
      "franchise": "DF_VS",
      "refunded": false,
      "processorFields": [
        {
          "keyword": "lastDigits",
          "value": "1111",
          "displayOn": "none"
        }
      ]
    }
  ],
  "subscription": null
}

POST/api/instrument/invalidate

Invalidar Token

Permite invalidar un token ya existente del sitio. Esto hará que el token o el subtoken ya no se pueda usar.

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ón
Longitud 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
instrument
Type
InstrumentInvalidate
is Required
REQUIRED
Description
Información del Token a invalidar.
Name
token
Type
object
is Required
REQUIRED
Description
Información de un medio de pago "tokenizado". Se debe tokenizar con una sesión de suscripción. Debe contener el token o el subtoken, ambas representaciones válidas de un medio de pago tokenizado.
Name
token
Type
number
is optional
Description
Representación del medio de pago.

EJ: a3bfc8e2afb9ac5583922eccd6d2061c1b0592b0...
Ejemplo:a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a
Name
subtoken
Type
string
is optional
Description
Representación numérica del medio de pago. Se usa en casos donde es requerido que el token sea numérico. Los últimos 4 dígitos son iguales a los últimos 4 dígitos de la tarjeta de crédito.

EJ: 8740257204881112
Ejemplo:8740257204881112
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}

Solicitud

POST

/api/instrument/invalidate

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

Respuesta

Example response

Name
status
Type
Status
is Required
REQUIRED
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:APPROVEDPENDINGREJECTEDAPPROVED_PARTIALPARTIAL_EXPIREDFAILED
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

Respuesta

{
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "La petición ha sido aprobada exitosamente",
    "date": "2022-07-27T14:51:27-05:00"
  }
}