Microsites API

Los micrositios son una excelente opción para vender y recaudar en línea sin tener un sitio web. Podrás personalizarlo con tu marca y compartirlo con tus clientes.

POST/api/microsites

Crear un micrositio

Permite crear micrositios (Abiertos/Cerrados), el micrositio creado es habilitado por defecto (de no indicarse lo contrario)

Hay varios campos que son opcionales y dependeran de tus necesidades, puedes ver mas información en Campos opcionales

Solicitud

Creación de micrositios

Name
auth
Type
object
is Required
REQUIRED
Description
La autenticación del sitio. Ver más en Autenticación
Name
login
Type
string
is Required
REQUIRED
Description
Identificador del sitio
Name
tranKey
Type
string
is Required
REQUIRED
Description
Credencial tranKey generado
Name
nonce
Type
string
is Required
REQUIRED
Description
Valor aleatorio para cada solicitud codificado en Base64.
Name
seed
Type
string
is Required
REQUIRED
Description
Fecha actual, la cual se genera en formato ISO 8601.
Name
name
Type
string
is Required
REQUIRED
Description
Nombre usado en el panel, vistas y formularios de pago y otros reportes.
Longitud máxima:64
Longitud mínima:3
Name
alias
Type
string
is Required
REQUIRED
Description
Complemento de la url con el que se podrá acceder al micrositio desde internet, por ejemplo https://dev.placetopay.com/mi-alias.
Longitud máxima:32
Longitud mínima:3
Name
type
Type
string
is Required
REQUIRED
Description
Define del tipo de micrositio a crear. Valores permitidos "OPEN" or "CLOSED".
Name
categories
Type
array
is Required
REQUIRED
Description
Alias de las categorias asociadas, están deben ser creadas o consultadas previamente por el administrador del sistema.
Name
sites
Type
array
is Required
REQUIRED
Description
Identificadores de los sitios a los que puede pertenecer el micrositio, puede ser uno o muchos. Mínimo uno debe ser definido.
Name
loginFields
Type
array
is Required
REQUIRED
Description
Define los campos de acceso para iniciar la sesión de pago. Valores permitidos document|reference|alt_reference, requerido cuando el type es CLOSED.
Name
header
Type
string
is optional
Description
Imágen de encabezado mostrado durante el proceso de pago. Formatos de archivos permitidos jpg|jpeg|png|svg.
Formato:binary
Name
logo
Type
string
is optional
Description
Imágen mostrada en la búsqueda de micrositios (si aplica, ver hide). Formatos de archivos permitidos jpg|jpeg|png|svg.
Formato:binary
Name
footer
Type
string
is optional
Description
Imágen de pie de página mostrado durante el proceso de pago. Formatos de archivos permitidos jpg|jpeg|png|svg.
Formato:binary
Name
paymentExpiration
Type
integer
is optional
Description
Expiración (en minutos) de la sesión de pago una vez se realiza la redirección, por defecto son 10 minutos.
Name
disabled
Type
boolean
is optional
Description
Determina si el micrositio está activo (true) o inactivo (false).
Valor por defecto:false
Name
useWcLightbox
Type
boolean
is optional
Description
Determina si se debe hacer redirección o levantar un lightbox durante el proceso de pago.
Valor por defecto:false
Name
hide
Type
boolean
is optional
Description
Permite configurar si el micrositio está disponible (true) o no (false) en el listado de búsqueda presentado al público en general.
Valor por defecto:false
Name
allowPartial
Type
boolean
is optional
Description
Permite configurar si se aceptan pagos parciales de los montos para completar el monto total usando varios métodos y formas de pago.
Valor por defecto:false
Name
isNoBuyerFill
Type
boolean
is optional
Description
Permite prediligenciar los datos del pagador en la sesión de pago o no. Solo aplica para CLOSED.
Valor por defecto:true
Name
allowDispersion
Type
boolean
is optional
Description
Habilitar pagos con dispersión de fondos. Solo aplica para CLOSED.
Valor por defecto:false
Name
allowPayWithDuplicateReference
Type
boolean
is optional
Description
Permitir pagos con referencias duplicadas.
Valor por defecto:false
Name
allowUnlimitedInstallments
Type
boolean
is optional
Description
Permitir depósitios ilimitados. Solo aplica para CLOSED.
Valor por defecto:false
Name
autoReferenced
Type
boolean
is optional
Description
Generar referencias aleatorias en el proceso de pago. Solo aplica para OPEN.
Valor por defecto:false
Name
allowRecurrence
Type
boolean
is optional
Description
Permitir la configuración de recurrencias. Solo aplica para OPEN.
Valor por defecto:false
Name
notSendBuyerAsPayer
Type
boolean
is optional
Description
Normalmente en el micrositio se captura los datos del comprador (buyer) y los datos del pagador (payer) se capturan en el proceso de pago. Esta configuración permite definir al comprador como el pagador usando los mismos datos. Solo aplica para OPEN.
Valor por defecto:false
Name
onlyPaymentLink
Type
boolean
is optional
Description
Determina si el micrositio solo se puede consumir usando Links de Pago. Solo aplica para OPEN.
Valor por defecto:false
Name
exactSearchByReference
Type
boolean
is optional
Description
Determina si en el listado de ordenes de pago se debe mostrar únicamente la orden de pago asociada a los datos de inición de sesión suministrados. Solo aplica para CLOSED.
Valor por defecto:false
Name
allowPayMultipleInvoicesAtOnce
Type
boolean
is optional
Description
Permite definir si se permiten pagar múltiples ordenes de pago en una sola transacción agrupandolas en un solo monto de pago. Solo aplica para CLOSED.
Valor por defecto:false
Name
showDescription
Type
boolean
is optional
Description
Permite configurar si la información de descripción de la orden de pago se muestra en el listado de ordenes de pago luego de iniciar una sesión de pago. Solo aplica para CLOSED.
Valor por defecto:true
Name
allowShowDebtorName
Type
boolean
is optional
Description
Permite configurar si la información de persona responsable de la orden de pago se muestra en el listado de ordenes de pago luego de iniciar una sesión de pago. Solo aplica para CLOSED.
Valor por defecto:false
Name
allowSendDebtorCode
Type
boolean
is optional
Description
Permite configurar la referencia alterna como descripción del pago. Solo aplica para CLOSED.
Valor por defecto:false
Name
allowChangeTotal
Type
boolean
is optional
Description
Permite cambiar el monto total al pagar de la orden de pago. Solo aplica para CLOSED.
Valor por defecto:false
Name
olderFirst
Type
boolean
is optional
Description
Define si se deben pagar las ordenes antiguas primero (basado en la fecha creación/generación de la orden). Solo aplica para CLOSED.
Valor por defecto:false
Name
allowSeeHistoryPayments
Type
boolean
is optional
Description
Determina si se puede ver el histórico de pagos asociados en el listado de ordenes de pago. Solo aplica para CLOSED.
Valor por defecto:true
Name
loginFromUrl
Type
boolean
is optional
Description
Determina si se puede iniciar sesión de pago usando los datos de autenticación entregados por URL (GET). Solo aplica para CLOSED.
Valor por defecto:true
Name
flushInvoices
Type
boolean
is optional
Description
Habilita la eliminación de ordenes de pago expiradas y no pagadas de forma automática. Solo aplica para CLOSED.
Valor por defecto:true
Name
returnUrl
Type
string
is optional
Description
URL opcional que se utiliza para redirigir al usuario una vez que cierran sesión en el micrositio. Este campo debe contener una URL válida a la que el usuario será dirigido después de cerrar sesión. Solo aplica para CLOSED
Name
fee
Type
integer
is optional
Description
Valor adicional que se cobrará por cada pago realizado a través del micrositio. Este campo es opcional, de tipo entero, y debe ser mayor a 0 si se utiliza. solo aplica para CLOSED

Solicitud

POST

/api/microsites

curl -X "POST"	https://sites.placetopay.com/api/microsites \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login":"c51ce410c124a10e0db5e4b97fc2af39",
        "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    },
    "name": "Test microsite 1",
    "alias": "microsite-test-1",
    "type": "OPEN",
    "sites": [5300],
    "categories" : ["test_tecnologia"]
}'

Respuesta

Correcta

Name
status
Type
object
is Required
REQUIRED
Description
Name
status
Type
string
is Required
REQUIRED
Description
Estado de error retornado en la solicitud. Valores permitidos "OK", "FAILED"
Longitud mínima:1
Name
reason
Type
string
is Required
REQUIRED
Description
Código de error retornado en la solicitud.
Longitud mínima:1
Name
message
Type
string
is Required
REQUIRED
Description
Descripción o detalle de error retornado en la solicitud.
Longitud mínima:1
Name
date
Type
string
is Required
REQUIRED
Description
Fecha en formato ISO 8601.
Longitud mínima:25

Respuesta

{
    "status": {
        "date": "2021-03-26T16:19:31-05:00",
        "reason": "201",
        "status": "OK",
        "message": "Micrositio creado correctamente"
    }
}

Campos opcionales

Opciones de configuración de pagos: Los siguientes campos son opcionales y se pueden utilizar según se necesite, siempre y cuando el tipo de micrositio a crear corresponda.

Campo	Tipo	Micrositio Compatible
allowPartial	boolean	OPEN/CLOSED
allowPayWithDuplicateReference	boolean	OPEN/CLOSED
isNoBuyerFill	boolean	CLOSED
allowDispersion	boolean	CLOSED
allowUnlimitedInstallments	boolean	CLOSED
autoReferenced	boolean	OPEN
allowRecurrence	boolean	OPEN
notSendBuyerAsPayer	boolean	OPEN
onlyPaymentLink	boolean	OPEN
exactSearchByReference	boolean	CLOSED
showDescription	boolean	CLOSED
allowPayMultipleInvoicesAtOnce	boolean	CLOSED
allowSendDebtorCode	boolean	CLOSED
allowChangeTotal	boolean	CLOSED
olderFirst	boolean	CLOSED
allowSeeHistoryPayments	boolean	CLOSED
loginFromUrl	boolean	CLOSED
flushInvoices	boolean	CLOSED
returnUrl	string	CLOSED
fee	integer	CLOSED