Recursos
Las API de Pagos abiertos son gestionadas por un servidor de recursos. Las operaciones en las API requieren que el cliente tenga un token de acceso válido emitido por un servidor de autorizaciones de confianza.
Tipos de Recursos
Sección titulada «Tipos de Recursos»La API del servidor de recursos de Pagos abiertos es una API REST simple con tres tipos de recursos: incoming-payment, quote y outgoing-payment.
Pago Entrante (incoming-payment)
Sección titulada «Pago Entrante (incoming-payment)»El recurso de pago entrante incoming-payment suele ser el primer recurso creado en el flujo de Pagos Abiertos en la cuenta del destinatario. Una vez creado, el ASE del destinatario devuelve al cliente datos de pago únicos que pueden utilizarse para realizar pagos a la cuenta. Cualquier pago recibido con estos datos se asocia entonces al recurso de pago entrante incoming-payment.
Un cliente puede solicitar los datos específicos de un pago entrante, así como listar todos los pagos entrantes para, por ejemplo, proporcionar al destinatario los detalles y el historial de las transacciones.
Cree un pago entrante sin especificar un monto entranteincomingAmount
Cuando una solicitud para crear un recurso de “pago entrante” incoming-payment incluye un monto entranteincomingAmount, y este es el importe máximo que se ingresará en la cuenta del destinatario. En otras palabras, es el importe que el destinatario debería recibir.
En lugar de especificar la cantidad a recibir, puedes especificar cuánto quieres enviar:
- Excluyendo el monto entrante
incomingAmounten la solicitud. - Incluir un
debitAmountdel monto que desea enviar dentro de una solicitud Crear cotización (conocida como cotización de envío fijo) - Creación de una solicitud de pago saliente que incluya el
quoteIdde la cotización anterior.
Se crea el pago saliente y los fondos se envían al recurso incoming-payment. Sin embargo, el incomingAmount nunca se configuró, por lo que el destinatario no tiene ningún indicador de cuánto esperar. El ASE del destinatario no sabrá cuándo se ha completado el pago.
En lugar de esperar a que expire la sesión de pago, el cliente puede emitir una solicitud explícita para completar manualmente el pago entrante para indicar que no se enviarán más pagos.
Cotización (Quote)
Sección titulada «Cotización (Quote)»Después de que se crea un recurso de pago entrante incoming-payment en la cuenta del receptor, normalmente se crea un recurso de cotización quote en la cuenta del remitente.
El propósito de una cotización es indicar cuánto costará realizar el pago, incluidas las tarifas aplicables. La cotización funciona como un compromiso por parte del ASE del remitente para entregar un monto específico al ASE del receptor. Una cotización solo es válida por un tiempo limitado.
Existen tres tipos de cotización:
- Cotización de envío fijo (Fixed-send quote) - Cotización de envío fijo (Fixed-send quote): Se pagará un monto fijo desde la cuenta del remitente sender’s account. Este tipo requiere un
debitAmount. Con esta cotización, el pago entrante no puede completarse automáticamente hasta que expire. En lugar de esperar a que expire, el cliente puede emitir una solicitud de “Completar Pago Entrante” (Complete Incoming Payment) Complete Incoming Payment request cuando el pago saliente se haya completado. - Cotización de recepción fija (Fixed-receive quote): - El pago entrante ya tiene un
incomingAmountdefinido. Para este tipo, el receptorreceiveres la URL del recurso de pago entranteincoming-paymental que se realizará el abono, indicada por la presencia de/incoming-paymentsen la URL.
Un recurso de cotización quote creado correctamente da como resultado la generación de un id de cotización en forma de URL.
Pago Saliente (outgoing-payment)
Sección titulada «Pago Saliente (outgoing-payment)»Tras crear un recurso de cotización, es casi el momento de crear el recurso outgoing-payment en la cuenta del remitente. El propósito de este recurso es servir como instrucción para realizar un pago outgoing-payment desde la cuenta del remitente.
Open Payments separa las instrucciones de pago de su ejecución, lo que permite a las aplicaciones emitir solicitudes de pago sin estar registradas como proveedores de servicios financieros. Esta estructura garantiza que las aplicaciones no tengan que gestionar directamente datos financieros confidenciales, lo que reduce el riesgo y la complejidad.
Open Payments requiere que el remitente dé su consentimiento explícito para la creación del recurso antes de que el cliente pueda emitir la solicitud de creación. El consentimiento se obtiene mediante una concesión interactiva interactive grant.
Dentro de la solicitud para crear el recurso outgoing-payment está la dirección de la billetera del destinatario, para que el ASE del remitente sepa dónde enviar el pago, y el ID del recurso de cotización, donde se definen los montos de pago.
Tras crear el recurso de pago saliente outgoing-payment, el pago entrante puede completarse, ya sea automática o manualmente, para finalizar el flujo de Pagos Abiertos. Ahora, el ASE del remitente debe liquidar con el ASE del destinatario mediante un canal de pago compartido.
Un recurso de pago outgoing-payment saliente puede representar un pago que se enviará, se está enviando o se ha enviado previamente desde la cuenta del remitente. Un cliente puede solicitar los detalles específicos de un pago saliente y listar todos los pagos salientes para, por ejemplo, proporcionar al remitente los detalles y el historial de las transacciones.
Subvenciones relacionadas
Sección titulada «Subvenciones relacionadas»Para obtener más información sobre el servidor de autorización y los tipos de subvención, consulte Tipos de subvención.