Placetopay Docs

POST/api/verification/session

Crear una Sesión

Este endpoint te permite crear una sesión de verificación de cuenta.

Solicitud

Name
auth
Type
Autenticación
is Required
REQUIRED
Description
Estructura que contiene la información de autenticación del sitio generada de acuerdo al WSSE UsernameToken Profile 1.1
Name
user
Type
object
is Required
REQUIRED
Description
Usuario dueño de la cuenta a validar
Name
returnUrl
Type
string
is Required
REQUIRED
Description
Url de retorno una vez culmine el proceso de validación de cuentas
Ejemplo:https://www.placetopay.com/return
Longitud máxima:255
Name
locale
Type
string
is Required
REQUIRED
Description
Determina el idioma de la respuesta
Ejemplo:es_CO
Name
isAuthenticated
Type
boolean
is optional
Description
Determina si ya se ha realizado un proceso de autenticación externa. La intención de no validar el correo electrónico del usuario dos veces. por defecto es false, quiere decir que se realizara envio de OTP para validar el usuario si este ya ha validado cuentas con microdepositos en el sistema
Ejemplo:true
Name
site
Type
string
is optional
Description
Si se usan credenciales API, se debe enviar el identificador del sitio
Ejemplo:aabbccdd1234567890aabbccdd123456

Solicitud

POST

/api/session

curl -X "POST" https://account-validator.placetopay.com/api/verification/session \
  -H "Content-Type: application/json" \
  -d '{
      "auth": {
        "login": "aabbccdd1234567890aabbccdd123456",
        "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
        "nonce": "NG5vejc2b41xdm8=",
        "seed": "2024-04-19T12:06:56-05:00"
      },
      "user": {
        "name": "John",
        "surname": "Doe",
        "email": "[email protected]"
      },
      "returnUrl": "https://www.placetopay.com",
      "locale": "es_PR"
  }'

Respuesta

Sesión creada exitosamente

Name
data
Type
object
is optional
Description
Estructura que contiene la respuesta a la solicitud en el caso de que el estado sea exitoso
Name
status
Type
Status
is Required
REQUIRED
Description
Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La solicitud ha sido aprobada exitosamente",
    "date": "2021-09-21T09:34:48-05:00"
  },
  "data": {
    "requestId": "9bd89c8d-6097-4d69-8ce9-d9b5ec35d8ea",
    "redirectUrl": "https://account-validator.placetopay.com/verification/redirect/9bd89c8d-6097-4d69-8ce9-d9b5ec35d8ea",
    "expiresAt": "2024-04-19 17:36:57"
  }
}

POST/api/verification/query

Consultar estado de sesión

Este endpoint te permitirá consultar el estado de la sesión creada.

La información de la cuenta solo se mostrará los primeros 10 minutos, sí solo si, la verificación de cuenta fue exitosa..

Posibles estados

Nombre	Descripción
APPROVED	La cuenta fue verificada exitosamente.
REJECTED	La verificación de cuenta fue rechazada.
FAILED	Ha ocurrido un error en el sistema.
PENDING	La verificación de cuenta está en proceso.

Razones de estado

Código	Descripción
?C	La verificación ha sido cancelada por el usuario.
05	La verificación ha sido rechazada por razones generales.
BR	Los datos de la solicitud han sido incorrectos.
00	La verificación ha sido realizada con éxito.
?-	La verificación está en proceso de validación.
38	Número de intentos agotado.
HX	Ha ocurrido un error en el servicio.
X3	La información suministrada es inválida.
X5	Número de seguridad social Inválido.
XN	Número de cuenta inválido.
?*	Pendiente de validación por microdepositos.

Solicitud

Name
auth
Type
Autenticación
is Required
REQUIRED
Description
Estructura que contiene la información de autenticación del sitio generada de acuerdo al WSSE UsernameToken Profile 1.1
Name
requestId
Type
string
is Required
REQUIRED
Description
Identificador unico de la sesión que desea consultar.
Ejemplo:1f630ff7-9c02-4da4-82d4-d676709acb21
Longitud máxima:36
Name
site
Type
string
is optional
Description
Si se usan credenciales API, se debe enviar el identificador del sitio
Ejemplo:aabbccdd1234567890aabbccdd123456

Solicitud

POST

api/verification/query

curl -X "POST" https://account-validator.placetopay.com/api/verification/query \
  -H "Content-Type: application/json" \
  -d '{
        "auth": {
          "login": "aabbccdd1234567890aabbccdd123456",
          "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
          "nonce": "NG5vejc2b41xdm8=",
          "seed": "2024-04-19T12:06:56-05:00"
        },
        "requestId": "1f630ff7-9c02-4da4-82d4-d676709acb21"
  }'

Respuesta

Consulta exitosa

Name
status
Type
Status
is optional
Description
Estructura que contiene la información sobre una solicitud o pago, informa al estado actual de la misma.
Name
data
Type
object
is optional
Description
Estructura que contiene la respuesta a la solicitud en el caso de que el estado sea exitoso

Respuesta

{
  "status": {
    "status": "APPROVED",
    "reason": "00",
    "message": "La verificación ha sido exitosa",
    "date": "2022-08-30T18:33:25+00:00"
  },
  "data": {
    "requestId": "1f630ff7-9c02-4da4-82d4-d676709acb21",
    "account": {
      "bankCode": "011401533",
      "bankName": "BANCO POPULAR DE PUERTO RICO (BPPR)",
      "accountType": "DDA",
      "accountNumber": "4111111111111111",
      "franchise": "_011401533_",
      "verificationCode": "eyJhbGciOiJSUzI1NiJ9.eyJhY2NvdW50SGFzaCI6ImZlMzRkNWFiODBkMjUyMzkwNzdhY2RmYTIwYWRjMjYyMWIzY2FlZjhhZGUzYzMyYzQ2NWQ5OGQ0NjdjOWViNjE3OWNmYTMwZWI1ZDdlY2E2MWVjZTY4NDIyNTY5MDUyYjJiMzdlYzMxY2Y3NjEyNzkxMWIxYzIwM2EyODRjMmFiIiwib25UZXN0IjpmYWxzZSwic2VydmljZSI6InBsYWlkIn0.UlZT9LawlL1epzYWv5V_WMMQ5NoYjORMzCND14h4z10pZtwjO80JEYccnTRViEKQXQDsCAXZyOCkCrGyCtliWaZOq8w-NVP37mu1dprAw_eRgClSD7MjOfBRl5LMYnSb3af3kHLd_3lDSMvi7AYY1JP9rGGnUTnXCd-tNdPNUYHUSJjQWQigUizOcrQKaYeKxgiEvIwuf-I4uG9WCPxN4bH-RNa2fggybiRXLJYGroRXCsURG_4EA3HqHszIUEKSj6BYnHOZX9J4KohAEwTQUy93COCXKimmQTlvBmEnQe2llYanpNvyDm35cmzzP3hr0J1IKx14N4DvagRfyCfjIQ"
    },
    "expiresAt": "2024-04-19 21:12:00"
  }
}