Token
Se identifica como token, a la llave generada por un proceso de suscripción permitiendo generar cobros sin interacción del usuario.
Cobro usando token
Permite realizar cobros sin la intervención del usuario usando medios de pago previamente suscritos.
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.
- Name
tranKey
- Type
- string
- is optional
- Description
Credencial tranKey generado.
Ver más en Autenticación
- Name
nonce
- Type
- string
- is optional
- Description
Valor aleatorio para cada solicitud codificado en Base64.
- Name
seed
- Type
- string
- is optional
- Description
Fecha actual, la cual se genera en formato ISO 8601.
- 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. Máximo de 32 caracteres
Ej:PAYMENT_0001_ABC
- Name
description
- Type
- string
- is Required
- REQUIRED
- Description
Descripción del proceso a realizar
EJ:Consumo mes de Mayo
- 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
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolares
- 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
.
- 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
- 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.
- 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
Ej:
1017111222
- 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.
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
EJ:
Juan José
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
EJ:
Peréz Pinzon
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
EJ:
+573214445566
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
País del domicilio
EJ:
Colombia
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
EJ:
Antioquia
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
EJ:
Medellín
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
EJ:
050012
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
EJ:
Calle 12 #33a-12, Apto 101
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
EJ:
+573214445566
- 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
- Name
name
- Type
- string
- is optional
- Description
Nombre del artículo.
EJ:Manta de lana
- Name
category
- Type
- string
- is optional
- Description
Categoría del artículo. Uno de:
digital
physical
- Name
qty
- Type
- number
- is optional
- Description
Cantidad de artículos de este tipo.
EJ:23
- Name
price
- Type
- number
- is optional
- Description
Costo total del artículo.
EJ: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
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
- 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
.
- 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
- Name
interval
- Type
- number
- is optional
- Description
Intervalo asociado a la periodicidad
EJ:15
para días.
- Name
nextPayment
- Type
- string
- is optional
- Description
Fecha del próximo pago
EJ:2019-08-24
- 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
- Name
dueDate
- Type
- string
- is optional
- Description
Fecha de vencimiento de la recurrencia
EJ:2019-09-24
- 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
- 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.
- 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
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolares
- 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
.
- 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
- 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.
- 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.
- 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
- Name
additional
- Type
- object
- is optional
- Description
Estructura para anexar información al modificador
- Name
invoice
- Type
- string
- is optional
- Description
Requerido cuando
modifiers.[].type
esFEDERAL_GOVERMENT
. Indica el número de factura.EJ:
123456789
- Name
instrument
- Type
- Instrument
- 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 eltoken
o elsubtoken
, 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...
- 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
- 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
- Name
pocket
- Type
- string
- is optional
- Description
Código de billetera. Aplica para Tarjetas en Uruguay
Valores posibles:
10
Cuenta de ahorros en UYU20
Cuenta corriente en UYU80
Cuenta de ahorros en USD90
Cuenta corriente en USD
- Name
ipAddress
- Type
- string
- is Required
- REQUIRED
- Description
Dirección IP del usuario que realizará el proceso.
Ej:134.10.163.36
- Name
userAgent
- Type
- string
- is Required
- REQUIRED
- Description
User Agent del navegador del usuario que realizará el proceso.
EJ:
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
Ej:
1017111222
- 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.
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
EJ:
Juan José
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
EJ:
Peréz Pinzon
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
EJ:
+573214445566
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
País del domicilio
EJ:
Colombia
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
EJ:
Antioquia
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
EJ:
Medellín
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
EJ:
050012
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
EJ:
Calle 12 #33a-12, Apto 101
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
EJ:
+573214445566
- 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
Ej:
1017111222
- 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.
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
EJ:
Juan José
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
EJ:
Peréz Pinzon
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
EJ:
+573214445566
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
País del domicilio
EJ:
Colombia
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
EJ:
Antioquia
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
EJ:
Medellín
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
EJ:
050012
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
EJ:
Calle 12 #33a-12, Apto 101
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
EJ:
+573214445566
- 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
,es_CO
- 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
Solicitud
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
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
- 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
,es_CO
- 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
Ej:
1017111222
- 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.
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
EJ:
Juan José
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
EJ:
Peréz Pinzon
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
EJ:
+573214445566
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
País del domicilio
EJ:
Colombia
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
EJ:
Antioquia
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
EJ:
Medellín
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
EJ:
050012
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
EJ:
Calle 12 #33a-12, Apto 101
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
EJ:
+573214445566
- Name
payment
- Type
- PaymentRequest
- is optional
- Description
Información del pago solicitado.
- Name
reference
- Type
- string
- is Required
- REQUIRED
- Description
Referencia única del pago. Máximo de 32 caracteres
Ej:PAYMENT_0001_ABC
- Name
description
- Type
- string
- is Required
- REQUIRED
- Description
Descripción del proceso a realizar
EJ:Consumo mes de Mayo
- 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
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolares
- 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
.
- 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
- 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.
- 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
Ej:
1017111222
- 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.
- Name
name
- Type
- string
- is optional
- Description
Nombre de la persona o empresa
EJ:
Juan José
- Name
surname
- Type
- string
- is optional
- Description
Apellido de la persona. No aplica cuando el tipo de documento corresponde al de una empresa
EJ:
Peréz Pinzon
- Name
company
- Type
- string
- is optional
- Description
Nombre de la compañia a la que pertenece la persona
EJ:
Placetopay
- Name
email
- Type
- string
- is optional
- Description
Correo eléctronico del usuario o empresa
- Name
mobile
- Type
- string
- is optional
- Description
Número de teléfono del usuario o empresa
EJ:
+573214445566
- Name
address
- Type
- object
- is optional
- Description
Estructura para anexar información del domicilio o dirección
- Name
country
- Type
- string
- is optional
- Description
País del domicilio
EJ:
Colombia
- Name
state
- Type
- string
- is optional
- Description
Departamento del domicilio
EJ:
Antioquia
- Name
city
- Type
- string
- is optional
- Description
Ciudad del domicilio
EJ:
Medellín
- Name
postalCode
- Type
- string
- is optional
- Description
Código postal del domicilio
EJ:
050012
- Name
street
- Type
- string
- is optional
- Description
Dirección del domicilio
EJ:
Calle 12 #33a-12, Apto 101
- Name
phone
- Type
- string
- is optional
- Description
Número telefónico del domicilio
EJ:
+573214445566
- 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
- Name
name
- Type
- string
- is optional
- Description
Nombre del artículo.
EJ:Manta de lana
- Name
category
- Type
- string
- is optional
- Description
Categoría del artículo. Uno de:
digital
physical
- Name
qty
- Type
- number
- is optional
- Description
Cantidad de artículos de este tipo.
EJ:23
- Name
price
- Type
- number
- is optional
- Description
Costo total del artículo.
EJ: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
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
- 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
.
- 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
- Name
interval
- Type
- number
- is optional
- Description
Intervalo asociado a la periodicidad
EJ:15
para días.
- Name
nextPayment
- Type
- string
- is optional
- Description
Fecha del próximo pago
EJ:2019-08-24
- 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
- Name
dueDate
- Type
- string
- is optional
- Description
Fecha de vencimiento de la recurrencia
EJ:2019-09-24
- 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
- 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.
- 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
- Name
total
- Type
- number
- is optional
- Description
Valor total en la moneda base indicada
EJ:1000
equivalen a Mil dolares
- 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
.
- 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
- 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.
- 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.
- 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
- Name
additional
- Type
- object
- is optional
- Description
Estructura para anexar información al modificador
- Name
invoice
- Type
- string
- is optional
- Description
Requerido cuando
modifiers.[].type
esFEDERAL_GOVERMENT
. Indica el número de factura.EJ:
123456789
- 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.
EJ:
https://merchant.com/return
- Name
ipAddress
- Type
- string
- is optional
- Description
Dirección IP del usuario que realizará el proceso.
Ej:134.10.163.36
- Name
userAgent
- Type
- string
- is optional
- Description
User Agent del navegador del usuario que realizará el proceso.
EJ:
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.
EJ:2023-07-17T13:12:44-05:00
- 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
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
- 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).
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
- 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).
- Name
total
- Type
- number|string
- is optional
- Description
Valor total.
- Name
factor
- Type
- number|string
- is optional
- Description
Factor de conversión
- 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
- 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
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
- Name
type
- Type
- string
- is optional
- Description
Define tipo de suscripción que se devuelve
- Name
instrument
- Type
- array[NameValuePair]
- is optional
- Description
- Name
keyword
- Type
- string
- is optional
- Description
Identificador o índice del dato a anexar.
EJ:cmsInvoiceId
- Name
value
- Type
- string|object|array|number|boolean
- is optional
- Description
Valor del dato a anexar.
EJ:ID_2233
- 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
.
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
}
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.
- Name
tranKey
- Type
- string
- is optional
- Description
Credencial tranKey generado.
Ver más en Autenticación
- Name
nonce
- Type
- string
- is optional
- Description
Valor aleatorio para cada solicitud codificado en Base64.
- Name
seed
- Type
- string
- is optional
- Description
Fecha actual, la cual se genera en formato ISO 8601.
- 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 elsubtoken
, 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...
- 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
- 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
,es_CO
Solicitud
curl -X "POST" https://checkout-test.placetopay.com/api/instrument/invalidate \
-H 'Content-Type: application/json' \
-d '{
"auth": {
"auth": {
"login": "c51ce410c124a10e0db5e4b97fc2af39",
"tranKey": "VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
"nonce": "NjE0OWVkODgwYjNhNw==",
"seed": "2021-09-21T09:34:48-05:00"
}
},
"locale": "en_US",
"instrument": {
"token": {
"token": "a3bfc8e2afb9ac5583922eccd6d2061c1b0592b099f04e352a894f37ae51cf1a"
}
}
}'
Respuesta
- 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
- Name
reason
- Type
- string|number|null
- is optional
- Description
Código del motivo proporcionado.
- Name
message
- Type
- string|null
- is optional
- Description
Descripción del código de razón.
- Name
date
- Type
- string
- is optional
- Description
Fecha y hora en que se genera el estado de pago.
Respuesta
{
"status": {
"status": "APPROVED",
"reason": "00",
"message": "La petición ha sido aprobada exitosamente",
"date": "2022-07-27T14:51:27-05:00"
}
}