Esta API está destinada a ser utilizada por los TPPs.
La API de pagos nacionales (domestic payment) está diseñada para iniciar y gestionar pagos nacionales (domestic payment). Esta API maneja instrucciones de pago reales y sus actualizaciones de estado.
Grant Type : AUTHORIZATION_CODE (nota: es el tipo concesión requerido para el uso del API)
El recurso de Pagos nacionales se utiliza para iniciar el pago real después de que se haya autorizado el consentimiento.
POST /{Bank}/domestic-payments/v1
{Bank}/domestic-payments/v1Una vez que el consentimiento de pago ha sido autorizado por el cliente, el TPP puede proceder a enviar la orden de pago para su respectivo procesamiento.
Estado
Un pago puede ser creado solo si su recurso de consentimiento de pago tiene el estado de Autorizado (Authorized).
Los estados que se utilizan dependen de los estándares de procesamiento de pagos del banco registrado. Las definiciones de todos los estados posibles se encuentran a continuación:
| Estado | Descripción del estado de pago | |
|---|---|---|
| 1 | Pending | La iniciación de pago, o la transacción individual incluida en esta iniciación, está pendiente. Se llevarán a cabo verificaciones y actualizaciones de estado. |
| 2 | Rejected | La iniciación de pago, o la transacción individual incluida en esta iniciación, ha sido rechazada. |
| 3 | AcceptedSettlementInProcess | Todas las verificaciones previas, como la validación técnica y el perfil del cliente, fueron exitosas, por lo que la iniciación de pago ha sido aprobada para su ejecución. |
| 4 | AcceptedSettlementCompleted | La liquidación en la cuenta del ordenante ha sido completada. |
| 5 | AcceptedWithoutPosting | La instrucción de pago incluida en la transferencia de crédito es aceptada, sin ser registrada en la cuenta del cliente receptor. |
| 6 | AcceptedCreditSettlementCompleted | La liquidación en la cuenta del receptor ha sido completada. |
GET /{Bank}/domestic-payments/v1/{DomesticPaymentId}
{Bank}/domestic-payments/v1/{DomesticPaymentId}Un TPP puede recuperar el recurso de pago para verificar su estado.
El recurso de pago puede tener uno de los estados mencionados en la tabla a continuación:
| Estado | Descripción del estado de pago | |
|---|---|---|
| 1 | Pending | La iniciación de pago, o la transacción individual incluida en esta iniciación, está pendiente. Se llevarán a cabo verificaciones y actualizaciones de estado. |
| 2 | Rejected | La iniciación de pago, o la transacción individual incluida en esta iniciación, ha sido rechazada |
| 3 | AcceptedSettlementInProcess | Todas las verificaciones previas, como la validación técnica y el perfil del cliente, fueron exitosas, por lo que la iniciación de pago ha sido aprobada para su ejecución. |
| 4 | AcceptedSettlementCompleted | La liquidación en la cuenta del ordenante ha sido completada. |
| 5 | AcceptedWithoutPosting | La instrucción de pago incluida en la transferencia de crédito es aceptada, sin ser registrada en la cuenta del cliente receptor. |
| 6 | AcceptedCreditSettlementCompleted | La liquidación en la cuenta del receptor ha sido completada. |