Esta API está destinada a ser utilizada por los TPPs.
Esta API permite que un proveedor externo (TPP) cree y recupere el consentimiento de pago de un usuario. Por lo general, se usa antes de iniciar un pago para garantizar que el usuario haya autorizado la transacción.
Grant Type : CLIENT_CREDENTIAL (nota: es el tipo concesión requerido para el uso del API)
Un PISP utiliza el recurso de Consentimiento de pago nacional para registrar una intención de iniciar un pago nacional antes de que se pueda ejecutar el pago real.
POST /{Bank}/domestic-payment-consents/v1
{Bank}/domestic-payment-consents/v1Esta es la primera API que un TPP invoca con el fin de crear el consentimiento de una orden de pago usando la solicitud POST /{BANK}/domestic-payment-consents/v1. Esta solicitud permite al TPP enviarle una copia del consentimiento (entre el cliente y el TPP) a la plataforma de Redeban para que el cliente lo autorice.
Una vez creado correctamente el consentimiento, el TPP puede usar el ID del consentimiento para obtener su estado usando la solicitud GET /{BANK}/domestic-payment-consents/v1/{CONSENTID}.
Estado
El estado por defecto que devuelve la solicitud POST para la creación de un consentimiento de pago una vez enviada es “AwaitingAuthorisation”, la cual indica que está en espera de la autorización.
| Estado |
|---|
| AwaitingAuthorisation |
GET /{Bank}/domestic-payment-consents/v1{consentID}
{Bank}/domestic-payment-consents/v1{consentID}Esta es la API que un TPP consume para obtener los detalles y el estado actual del consentimiento de una orden de pago.
El estado del consentimiento y su significado se mencionan en la siguiente tabla.
| Estado | Descripción del estado | |
|---|---|---|
| 1 | AwaitingAuthorisation | El consentimiento está a la espera de la autorización del usuario o cliente |
| 2 | Rejected | El consentimiento ha sido rechazado. |
| 3 | Authorized | El consentimiento ha sido autorizado correctamente. |
| 4 | Consumed | El uso del consentimiento se ha completado con éxito. Esto no refleja el estado de la acción a la cual se le aplicó el consentimiento, es decir algún pago. |
GET /{Bank}/domestic-payment-consents/v1/{ConsentId}/funds-confirmation
{Bank}/domestic-payment-consents/v1/{ConsentId}/funds-confirmationEsta API permite al TPP solicitar una confirmación de fondos basado en un consentimiento creado previamente. A continuación, algunos puntos a tener en cuenta:
- La plataforma de APIs solo puede responder una solicitud de confirmación de fondos sí el consentimiento tiene un estado de “Authorized”. Sí el consentimiento no tiene este estado, la plataforma de APIs devolverá un error con el código 400 (Bad Request).
- Las solicitudes de confirmación de fondos no afectan el estado del consentimiento.