Endpoints para Pago

La entidad Pago almacena información sobre los métodos de pago disponibles en la base de datos.

Características Comunes de los Pagos

Todas las entidades Pago tienen un identificador local id, un identificador remoto y una descripción. La descripción almacena el método de pago al que se refiere cada entidad.

Endpoints

GET/Payment/getPaymentMethod

Devuelve una lista paginada con todos los métodos de pago disponibles en la base de datos.

Descripción

Permite a los clientes obtener una lista con los métodos de pago basada en parámetros de paginación como el número de página (page) y el número de ítems por página (pageSize).

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
page	Número de página	Integer	1
pageSize	Elementos por página	Integer	10

Respuestas

JSON

{
  "data": [
      {
      "id": "string",
      "idRemote": "string",
      "description": "string"
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <description>string</description>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>  

👉Prueba este endopint🌱

POST/Payment/createPaymentMethod

Registro de Pagos en la API: Uso del Método POST

Este método está diseñado para manejar únicamente el formato JSON. Para registrar pagos de manera efectiva, es esencial seguir un proceso que garantice la integridad de los datos y la funcionalidad adecuada del sistema.

Detalles del Método POST:

Es importante proporcionar datos estructurados en formato JSON que incluyan información crucial como el id y la descripción. El proceso garantiza que cada pago tenga una identidad única y esté correctamente configurado para interactuar con la plataforma de manera segura y eficiente. El campo idRemote proporcionado en la creación de una nueva entidad se corresponde con el idRemote que quiera darle el usuario y el sistema creará automáticamente un id local.

El cuerpo de la solicitud debe seguir el siguiente esquema:

[
  {
    "idRemote": "string",
    "description": "string"
  }
]

Es posible añadir varios pagos a través de la misma solicitud separándolos con comas dentro del array en el cuerpo de la solicitud.

👉Prueba este endopint🌱

DELETE/Payment/delete

Eliminación de métodos de Pago

Descripción

Este endpoint permite la eliminación de métodos de pago utilizando su identificador único. Este campo id puede ser tanto el identificador generado por la base de datos del B2B como el idRemote que usted nos proporciona al registrar los métodos de pago.

Parámetros

Nombre	Descripción	Tipo
id	Identificador de Pago	String

👉Prueba este endpoint🌱

Posibles errores en la respuesta

Error	Código	Respuesta
Este error ocurre cuando no se puede establecer una conexión con la base de datos. Es un problema interno del servidor.	500	{"code": 500,"error": "Database connection failed."}
Este error ocurre cuando no puede insertar o actualizar y en la dbs de pruebas.	500	{"code": 500,"error": "Invalid connection name, you cannot insert in default"}
Este error indica que falta un parametro.	400	{"code": 400,"error": "Parameter $parameter is required"}
Este error indica que no está autorizado.	401	{"code": 401,"error": "Unauthorized."}
Este error indica que no ha sido posible encontrar el registro.	404	{"code": 404,"error": "No entity found for Payment with $id."}
Este error ocurre cuando intenta insertar un registro que ya existe	409	{"code": 409,"error": "Duplicate entry"}
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}