Métodos de Pago del Sitio - Placetopay Docs

POST/core/site/payment-methods/create

Agregar un medio de pago a un sitio

Este servicio permite agregar un medio de pago existente a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago asociado.

Solicitud

Name
auth
Type
Autentication
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
data
Type
object
is Required
REQUIRED
Description
Objeto que contiene los datos necesarios para agregar un medio de pago a un sitio.

Solicitud

POST

/core/site/payment-methods/create

curl -X "POST" https:\test.placetopay.com\rest\core\site\payment-methods\create \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "data": {
    "siteId": 1,
    "customerPaymentId": 1,
    "order": 1,
    "minAmount": 1,
    "maxAmount": 99999999.99,
    "accountType": 1,
    "accountNumber": "123456789900",
    "financialEntity": 1,
    "commissionModel": "P",
    "commissionValue": 1,
    "settings": {
      "merchantCode": "123456",
      "MID": "000468232",
      "RUC": "1234567890147",
      "terminalNumber": "01234567",
      "aggregatorModel": false
    },
    "creditRules": {
      "RM_MC": {
        "C": {
          "1": {
            "minimum": "1"
          },
          "2": {
            "remove": true
          },
          "3": {
            "maximum": "10"
          }
        }
      }
    }
  }
}'

Respuesta

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
id
Type
integer
is optional
Description
Identificador del medio de pago agregado
Ejemplo:2

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La petición se ha procesado correctamente.",
    "date": "2021-09-21T09:34:48-05:00"
  },
  "id": 2
}

POST/core/site/payment-methods/update

Actualizar un medio de pago asociado a un sitio

Este servicio permite actualizar un medio de pago asociado a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago actualizado.

Solicitud

Name
auth
Type
Autentication
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
id
Type
integer
is Required
REQUIRED
Description
Identificador del medio de pago.
Name
data
Type
object
is Required
REQUIRED
Description
Objeto que contiene la información del medio de pago a actualizar.

Solicitud

POST

/core/site/payment-methods/update

curl -X "POST" https:\test.placetopay.com\rest\core\site\payment-methods\update \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "id": 1,
  "data": {
    "order": 1,
    "minAmount": 1,
    "maxAmount": 99999999.99,
    "accountType": 1,
    "accountNumber": "123456789900",
    "financialEntity": 1,
    "commissionModel": "P",
    "commissionValue": 1,
    "settings": {
      "merchantCode": "123456",
      "MID": "000468232",
      "RUC": "1234567890147",
      "terminalNumber": "01234567",
      "aggregatorModel": false
    },
    "creditRules": null
  }
}'

Respuesta

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
id
Type
integer
is optional
Description
Identificador del medio de pago actualizado.
Ejemplo:2

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La petición se ha procesado correctamente.",
    "date": "2021-09-21T09:34:48-05:00"
  },
  "id": 2
}

POST/core/site/payment-methods/delete

Remover un medio de pago asociado a un sitio

Este servicio permite remover un medio de pago asociado a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago eliminado.

Solicitud

Name
auth
Type
Autentication
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
id
Type
integer
is Required
REQUIRED
Description
Identificador del medio de pago.

Solicitud

POST

/core/site/payment-methods/delete

curl -X "POST" https:\test.placetopay.com\rest\core\site\payment-methods\delete \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "id": 1
}'

Respuesta

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
id
Type
integer
is optional
Description
Identificador del medio de pago eliminado.
Ejemplo:2

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La petición se ha procesado correctamente.",
    "date": "2021-09-21T09:34:48-05:00"
  },
  "id": 1
}

POST/core/site/payment-methods/search

Consulta de medios de pago asociados a un sitio

Este servicio permite consultar los médios de págo asociados a un sitio. Es posible filtrar los resultados por medio de los parámetros: "id", "name", "code" y "franchise".

Nota

No es requerido ingresar todos los parámetros para el filtro.

Si requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.

Solicitud

Name
auth
Type
Autentication
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
siteId
Type
integer
is optional
Description
Identificador de sitio
Ejemplo:1
Name
id
Type
integer
is optional
Description
Identificador del medio de pago.
Name
name
Type
string
is optional
Description
Nombre del medio de pago
Ejemplo:payment method name
Longitud máxima:50
Longitud mínima:3
Name
code
Type
string
is optional
Description
Código identificador del medio de pago
Longitud máxima:5
Name
franchise
Type
string
is optional
Description
Franquicia del medio de pago
Ejemplo:VISA
Name
pagination
Type
object
is optional
Description
Objeto que contiene los parámetros de paginación

Solicitud

POST

/core/site/payment-methods/search

curl -X "POST" https:\test.placetopay.com\rest\core\site\payment-methods\search \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "siteId": 1,
  "id": 1,
  "name": "payment method name",
  "code": "ID_VS",
  "franchise": "VISA",
  "pagination": {
    "perPage": 15,
    "currentPage": 1
  }
}'

Respuesta

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
array[Payment Method]
is optional
Description
Arreglo que contiene los medios de pago consultados.
Name
pagination
Type
Pagination
is optional
Description
Estructura que contiene la información de la paginación.

Respuesta

{
  "status": {
    "status": "OK",
    "reason": "00",
    "message": "La petición se ha procesado correctamente.",
    "date": "2021-09-21T09:34:48-05:00"
  },
  "data": [
    {
      "id": 1,
      "customerPaymentId": 1,
      "siteId": 1,
      "code": "RM_MC",
      "name": "MasterCard",
      "minAmount": 100,
      "maxAmount": 999999.99,
      "commissionModel": "F",
      "commissionValue": 1,
      "accountNumber": "123456878890",
      "accountType": 1,
      "franchise": "MASTERCARD",
      "financialEntity": 1,
      "order": 1,
      "disabled": true,
      "settings": null,
      "creditRules": {
        "RM_MC": {
          "C": {
            "1": {
              "minimum": "1"
            },
            "2": {
              "remove": true
            },
            "3": {
              "maximum": "10"
            }
          }
        }
      }
    }
  ],
  "pagination": {
    "total": 30,
    "perPage": 10,
    "currentPage": 1,
    "lastPage": 1
  }
}