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
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 que contiene los datos necesarios para agregar un medio de pago a un sitio.
Name
siteId
Type
integer
is Required
REQUIRED
Description
Identificador del sitio.
Ejemplo:1
Name
customerPaymentId
Type
integer
is Required
REQUIRED
Description
Identificador del medio de pago asociado al comercio (comercio al cual pertenece el sitio).
Ejemplo:1
Name
order
Type
integer
is optional
Description
Nivel de prioridad
Ejemplo:1
Name
minAmount
Type
number
is optional
Description
Mínimo valor permitido por transacción. Este campo es requerido cuando el campo maxAmount está presente.
Ejemplo:1
Formato:float
Name
maxAmount
Type
number
is optional
Description
Máximo valor permitido por transacción. Este campo es requerido cuando el campo minAmount está presente.
Ejemplo:99999999.99
Formato:float
Name
accountType
Type
integer
is optional
Description
Identificador del tipo de cuenta de recaudo. Este campo es requerido cuando el campo accountNumber está presente.
Ejemplo:1
Name
accountNumber
Type
string
is optional
Description
Número de cuenta de recaudo. Este campo es requerido cuando el campo accountType está presente.
Ejemplo:123456789900
Longitud máxima:20
Name
financialEntity
Type
integer
is optional
Description
Identificador de la entidad financiera o banco de recaudo del medio de pago. La entidad financiera debe ser del país del comercio asociado al sitio.
Ejemplo:1
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
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/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": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "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
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 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
}