Métodos de Pago del Comerciante

POST/core/merchant/payment-methods/create

Agregar un método de pago a un comercio

Este servicio permite agregar un método de pago existente al comercio. Si la respuesta es exitosa, retorna el identificador del método de pago agregado.

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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
Type
string
is optional
Description
Name
data
Type
object
is Required
REQUIRED
Description
Objeto con la información necesaria para agregar un método de pago a un comercio.
Name
customerId
Type
integer
is Required
REQUIRED
Description
Identificador del comercio.
Ejemplo:1
Name
code
Type
string
is Required
REQUIRED
Description
Código identificador del método de pago.
Ejemplo:RM_MC
Longitud máxima:5
Name
commissionModel
Type
string
is Required
REQUIRED
Description
Modelo de comisión.
Valores permitidos:PF
Ejemplo:P
Longitud máxima:1
Name
commissionValue
Type
number
is Required
REQUIRED
Description
Valor de comisión.
Ejemplo:1000.5
Formato:float
Name
accountType
Type
integer
is Required
REQUIRED
Description
Identificador del tipo de cuenta de recaudo.
Ejemplo:1
Name
accountNumber
Type
string
is Required
REQUIRED
Description
Número de cuenta de recaudo.
Ejemplo:1234567890
Longitud máxima:20
Name
financialEntity
Type
integer
is optional
Description
Identificador de la entidad financiera o Banco recaudador del medio de pago. La entidad financiera debe ser del país del comercio a asociar.
Ejemplo:2
Name
order
Type
integer
is optional
Description
Nivel de prioridad.
Ejemplo:1
Name
settings
Type
Settings-Payment-Method
is optional
Description
Estructura que contiene la información de las configuraciones de un sitio/comercio asociadas a un medio de pago
Name
merchantCode
Type
string
is optional
Description
Código de entidad
Name
terminalNumber
Type
string
is optional
Description
Número de terminal del medio de pago
Name
MID
Type
string
is optional
Description
ID de comerciante
Name
RUC
Type
string
is optional
Description
Registro único de contribuyente
Name
username
Type
string
is optional
Description
Usuario de la terminal
Longitud máxima:30
Name
password
Type
string
is optional
Description
Contraseña de la terminal
Longitud máxima:30
Name
retailCode
Type
string
is optional
Description
Código único de venta
Longitud máxima:10
Name
terminalLocation
Type
string
is optional
Description
Determina la ubicación de la terminal
Name
serviceCode
Type
string
is optional
Description
Código que representa el servicio del comercio
Name
isEcommerce
Type
boolean
is optional
Description
Determina si es un comercio electrónico
Name
3DSVersion
Type
is optional
Description
Determina la versión de 3DS
Valores permitidos:v1v2
Name
3DSApiKey
Type
string
is optional
Description
3DS API key
Longitud máxima:380
Name
aggregatorModel
Type
boolean
is optional
Description
Determina si es modelo agregador (PSE)
Valor por defecto:false
Name
creditRules
Type
object
is optional
Description
Objeto que contiene las reglas de crédito del meio de pago

Solicitud

POST

/core/merchant/payment-methods/create

curl -X "POST" https:\test.placetopay.com\rest\core\merchant\payment-methods\create \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "data": {
    "customerId": 1,
    "code": "RM_MC",
    "commissionModel": "P",
    "commissionValue": 1,
    "accountType": 1,
    "accountNumber": "1234567890",
    "financialEntity": 2,
    "order": 1,
    "settings": {
      "username": "username",
      "terminalLocation": "Medellin",
      "serviceCode": "123456",
      "isEcommerce": true,
      "3DSVersion": "v2",
      "3DSApiKey": "468232"
    },
    "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
Name
id
Type
integer
is optional
Description
Identificador del método de pago agregado al comercio.
Ejemplo:1

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/merchant/payment-methods/update

Actualizar un método de pago asociado a un comercio

Este servicio permite actualizar un médio de pago asociado a un comercio. Si la respuesta es exitosa, retorna el identificador del medio de pago.

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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
Type
string
is optional
Description
Name
id
Type
integer
is Required
REQUIRED
Description
Identificador del medio de pago.
Ejemplo:1
Name
data
Type
object
is Required
REQUIRED
Description
Objeto con la información necesaria para agregar un método de pago a un comercio.
Name
commissionModel
Type
string
is optional
Description
Modelo de comisión. Este campo es requerido si commissionValue está presente.
Valores permitidos:PF
Ejemplo:F
Longitud máxima:1
Name
commissionValue
Type
number
is optional
Description
Valor de comisión. Este campo es requerido si el campo commissionModel está presente.
Formato:float
Name
accountType
Type
integer
is optional
Description
Identificador de tipo de cuenta de recaudo. Este campo es requerido si accountNumber está presente.
Ejemplo:1
Name
accountNumber
Type
string
is optional
Description
Número de cuenta de recaudo. Este campo es requerido si el campo accountType está presente.
Ejemplo:1234567890
Longitud máxima:20
Name
financialEntity
Type
integer
is optional
Description
Identificador de la entidad financiera o banco recaudador del medio de pago. La entidad financiera debe ser del mismo país del comercio asociado.
Ejemplo:2
Name
order
Type
integer
is optional
Description
Nivel de prioridad.
Ejemplo:1
Name
settings
Type
Settings-Payment-Method
is optional
Description
Estructura que contiene la información de las configuraciones de un sitio/comercio asociadas a un medio de pago
Name
merchantCode
Type
string
is optional
Description
Código de entidad
Name
terminalNumber
Type
string
is optional
Description
Número de terminal del medio de pago
Name
MID
Type
string
is optional
Description
ID de comerciante
Name
RUC
Type
string
is optional
Description
Registro único de contribuyente
Name
username
Type
string
is optional
Description
Usuario de la terminal
Longitud máxima:30
Name
password
Type
string
is optional
Description
Contraseña de la terminal
Longitud máxima:30
Name
retailCode
Type
string
is optional
Description
Código único de venta
Longitud máxima:10
Name
terminalLocation
Type
string
is optional
Description
Determina la ubicación de la terminal
Name
serviceCode
Type
string
is optional
Description
Código que representa el servicio del comercio
Name
isEcommerce
Type
boolean
is optional
Description
Determina si es un comercio electrónico
Name
3DSVersion
Type
is optional
Description
Determina la versión de 3DS
Valores permitidos:v1v2
Name
3DSApiKey
Type
string
is optional
Description
3DS API key
Longitud máxima:380
Name
aggregatorModel
Type
boolean
is optional
Description
Determina si es modelo agregador (PSE)
Valor por defecto:false
Name
creditRules
Type
object
is optional
Description
Objeto que contiene las reglas de crédito del medio de pago

Solicitud

POST

/core/merchant/payment-methods/update

curl -X "POST" https:\test.placetopay.com\rest\core\merchant\payment-methods\update \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "id": 1,
  "data": {
    "commissionModel": "P",
    "commissionValue": 0,
    "accountType": 1,
    "accountNumber": "1234567890",
    "financialEntity": 2,
    "order": 1,
    "settings": {
      "username": "username",
      "terminalLocation": "Medellin",
      "serviceCode": "123456",
      "isEcommerce": true,
      "3DSVersion": "v2",
      "3DSApiKey": "468232"
    },
    "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
Name
id
Type
integer
is optional
Description
Identificador del método de pago actualizado.
Ejemplo:1

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/merchant/payment-methods/delete

Remover un método de pago asociado a un comercio

Este servicio permite remover un método de pago de un comercio. Si el proceso es exitoso, se retorna el identificador del medio de pago.

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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
Type
string
is optional
Description
Name
id
Type
integer
is Required
REQUIRED
Description
Identificador del método de pago.

Solicitud

POST

/core/merchant/payment-methods/delete

curl -X "POST" https:\test.placetopay.com\rest\core\merchant\payment-methods\delete \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
Name
id
Type
integer
is optional
Description
Identificador del método de pago eliminado.

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/merchant/payment-methods/search

Consulta de métodos de pago de un comercio

Este servicio permite consultar los médios de págo asociados a un comercio. Es posible emplear filtrado 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
login
Type
string
is optional
Description
Name
tranKey
Type
string
is optional
Description
Name
nonce
Type
string
is optional
Description
Name
seed
Type
string
is optional
Description
Name
customerId
Type
integer
is Required
REQUIRED
Description
Identificador del comercio.
Ejemplo:1
Name
id
Type
integer
is optional
Description
Identificador del método de pago a consultar.
Ejemplo:100
Name
name
Type
string
is optional
Description
Nombre del método de pago a consultar.
Ejemplo:masterCard
Longitud máxima:50
Longitud mínima:3
Name
code
Type
string
is optional
Description
Código identificador del método de pago a consultar.
Ejemplo:RM_MC
Longitud máxima:5
Name
franchise
Type
string
is optional
Description
Franquicia del método de pago a consultar.
Valores permitidos:AMEXDINERSDISCOVERJBCUNIONPAYMASTERCARDVISAEXITOALKOSTOMAESTROVISAELECTRONATH
Ejemplo:MASTERCARD
Name
pagination
Type
object
is optional
Description
Objeto que contiene los parámetros de paginación.
Name
perPage
Type
integer
is optional
Description
Número de registros por página
Ejemplo:10
Name
currentPage
Type
integer
is optional
Description
Página actual
Ejemplo:1

Solicitud

POST

/core/merchant/payment-methods/search

curl -X "POST" https:\test.placetopay.com\rest\core\merchant\payment-methods\search \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "customerId": 1,
  "id": 100,
  "name": "masterCard",
  "code": "RM_MC",
  "franchise": "MASTERCARD",
  "pagination": {
    "perPage": 10,
    "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
status
Type
string
is optional
Description
Valores permitidos:OKFAILEDAPPROVEDAPPROVED_PARTIALPARTIAL_EXPIREDREJECTEDPENDINGPENDING_VALIDATIONPENDING_PROCESSREFUNDEDREVERSEDERRORUNKNOWNMANUALDISPUTE
Name
reason
Type
string
is optional
Description
Longitud máxima:4
Longitud mínima:1
Name
message
Type
string
is optional
Description
Name
date
Type
string
is optional
Description
Ejemplo:2021-09-21T09:34:48-05:00
Name
data
Type
array[Payment Method]
is optional
Description
Name
id
Type
integer
is optional
Description
Identificador del método de pago.
Ejemplo:1
Name
customerId
Type
integer
is optional
Description
Identificador del comercio al que pertence el método de pago.
Ejemplo:1
Name
code
Type
string
is optional
Description
Código identificador del método de pago.
Ejemplo:RM_MC
Longitud máxima:5
Name
name
Type
string
is optional
Description
Nombre del método de pago.
Ejemplo:MasterCard
Longitud máxima:50
Name
commissionModel
Type
string
is optional
Description
Modelo de comisión.
Valores permitidos:PF
Ejemplo:P
Longitud máxima:1
Name
commissionValue
Type
number
is optional
Description
Valor de comisión.
Ejemplo:1
Formato:float
Name
accountNumber
Type
string
is optional
Description
Número de cuenta de recuado.
Ejemplo:123456878890
Longitud máxima:20
Name
accountType
Type
integer
is optional
Description
Identificador de tipo de cuenta de recaudo.
Ejemplo:1
Name
franchise
Type
string
is optional
Description
Franquicia del medio de pago.
Valores permitidos:AMEXVISADINERSDISCOVERJBCMASTERCARDEXITOALKOSTOMAESTROVISAELECTRONATH
Ejemplo:MASTERCARD
Name
financialEntity
Type
integer
is optional
Description
Identificador de la entidad financiera o banco recaudador del medio de pago. La entidad financiera debe ser del mismo país del comercio asociado.
Ejemplo:1
Name
order
Type
integer
is optional
Description
Nivel de prioridad.
Ejemplo:1
Name
disabled
Type
boolean
is optional
Description
Indicador de estado inactivo del medio de pago.
Name
settings
Type
object
is optional
Description
Objeto que contiene las configuraciones del medio de pago.
Name
creditRules
Type
object
is optional
Description
Objeto que contiene las reglas de crédito del medio de pago
Name
pagination
Type
Pagination
is optional
Description
Estructura que contiene la información de la paginación.
Name
total
Type
integer
is optional
Description
Número total de registros encontrados en la consulta.
Ejemplo:30
Name
perPage
Type
integer
is optional
Description
Número de registros por página
Valor por defecto:15
Ejemplo:10
Name
currentPage
Type
integer
is optional
Description
Página actual
Valor por defecto:1
Ejemplo:1
Name
lastPage
Type
integer
is optional
Description
Ultima página disponible
Ejemplo:1

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,
      "customerId": 1,
      "code": "RM_MC",
      "name": "MasterCard",
      "commissionModel": "P",
      "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
  }
}