Merchant Payment Methods - Placetopay Docs

A NOTICE

Since this page is not yet available in English, you will see it in Spanish.

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.

Request

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Authentication object. See more in Authentication. Structure containing the site’s authentication information generated according to the WSSE UsernameToken Profile 1.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.

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": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "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"
          }
        }
      }
    }
  }
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request, indicating its current state.
Name
id
Type
integer
is optional
Description
Identificador del método de pago agregado al comercio.
Example: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.

Request

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Authentication object. See more in Authentication. Structure containing the site’s authentication information generated according to the WSSE UsernameToken Profile 1.1.
Name
id
Type
integer
is Required
REQUIRED
Description
Identificador del medio de pago.
Example: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.

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": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "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
  }
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request, indicating its current state.
Name
id
Type
integer
is optional
Description
Identificador del método de pago actualizado.
Example: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.

Request

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Authentication object. See more in Authentication. Structure containing the site’s authentication information generated according to the WSSE UsernameToken Profile 1.1.
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": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "id": 1
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request, indicating its current state.
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.

Request

Name
auth
Type
Authentication
is Required
REQUIRED
Description
Authentication object. See more in Authentication. Structure containing the site’s authentication information generated according to the WSSE UsernameToken Profile 1.1.
Name
customerId
Type
integer
is Required
REQUIRED
Description
Identificador del comercio.
Example:1
Name
id
Type
integer
is optional
Description
Identificador del método de pago a consultar.
Example:100
Name
name
Type
string
is optional
Description
Nombre del método de pago a consultar.
Example:masterCard
Max length:50
Min length:3
Name
code
Type
string
is optional
Description
Código identificador del método de pago a consultar.
Example:RM_MC
Max length:5
Name
franchise
Type
string
is optional
Description
Franquicia del método de pago a consultar.
Allowed values:AMEXDINERSDISCOVERJBCUNIONPAYMASTERCARDVISAEXITOALKOSTOMAESTROVISAELECTRONATH
Example:MASTERCARD
Name
pagination
Type
object
is optional
Description
Objeto que contiene los parámetros de paginación.

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": "aabbccdd1234567890aabbccdd123456",
    "tranKey": "ABC123example456trankey+789abc012def3456ABC=",
    "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
  }
}'

Response

Name
status
Type
Status
is optional
Description
Structure that contains information about a request, indicating its current state.
Name
data
Type
array[Payment Method]
is optional
Description
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,
      "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
  }
}