POST/core/tools/payment-facilitator/search

Consulta de facilitadores de pago

Este servicio permite buscar los facilitadores de pago registrados en el sistema.

Si la respuesta es exitosa, se retorna un arreglo con la información de cada facilitador de pago.

Puede filtrar los resultados de la consulta empleando el parámetro 'id', 'name' y 'active' como filtro, segun lo requiera.

Si requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.

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
    string
    is optional
    Description

    id primario del facilitador de pago

  • Name
    name
    Type
    string
    is optional
    Description

    nombre del facilitador de pago

  • Name
    active
    Type
    boolean
    is optional
    Description
  • Name
    pagination
    Type
    object
    is optional
    Description

    Objeto que contiene los parámetros de paginación

    • Name
      perPage
      Type
      integer
      is optional
      Description

      Cantidad 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

Solicitud

POST
/core/tools/payment-facilitator/search
curl -X "POST" https:/test.placetopay.com/rest/core/tools/payment-facilitator/search \
-H "Content-Type: application/json" \
-d '{
  "auth": {
    "login": "613822f45568191a8cdf4ad2299f6d23",
    "tranKey": "bHehjzNcMQVQ1zto0GhmZxjeMhwA+3OlFPbOup16HGc=",
    "nonce": "NjE1MWQ4MDE5YWViMw==",
    "seed": "2021-09-27T09:41:05-05:00"
  },
  "id": 1,
  "name": "Kyle Walker",
  "pagination": {
    "perPage": 15,
    "currentPage": 1
  }
}'

Respuesta

OK

  • Name
    status
    Type
    object
    is optional
    Description
    • Name
      status
      Type
      string
      is optional
      Description
    • Name
      reason
      Type
      string
      is optional
      Description
    • Name
      message
      Type
      string
      is optional
      Description
    • Name
      date
      Type
      string
      is optional
      Description
  • Name
    data
    Type
    array
    is optional
    Description
    • Name
      id
      Type
      integer
      is optional
      Description

      Id del facilitador de pago

      Ejemplo:1
    • Name
      name
      Type
      string
      is optional
      Description

      Nombre del facilitador de pago

      Ejemplo:Payment Facilitator
    • Name
      active
      Type
      boolean
      is optional
      Description

      Indicador de estado activo.

    • Name
      country
      Type
      string
      is optional
      Description

      Código ISO del país

      Ejemplo:CO
    • Name
      visa
      Type
      integer
      is optional
      Description

      Identificador de franquicia Visa

      Ejemplo:123456
    • Name
      mastercard
      Type
      integer
      is optional
      Description

      Identificador franquicia MasterCard

      Ejemplo:123456
  • Name
    pagination
    Type
    object
    is optional
    Description
    • Name
      total
      Type
      integer
      is optional
      Description
    • Name
      perPage
      Type
      integer
      is optional
      Description
    • Name
      currentPage
      Type
      integer
      is optional
      Description
    • Name
      lastPage
      Type
      integer
      is optional
      Description

Respuesta

{
  "value": {
    "status": {
      "status": "OK",
      "reason": "00",
      "message": "La petición se ha procesado correctamente",
      "date": "2021-09-21T09:34:48-05:00"
    },
    "data": [
      {
        "id": 1,
        "name": "Keeling-Bernier",
        "active": true,
        "country": "CL",
        "visa": 1973076210,
        "mastercard": 963389732
      }
    ],
    "pagination": {
      "total": 30,
      "perPage": 10,
      "currentPage": 1,
      "lastPage": 1
    }
  }
}