Regionalized Solutions
Updated On 02 September 2024 |
Min(s) read
APIs
Please find below the API details for the OBIE Payment Initiation Service (PIS) and Confirmation of Funds (CoF) APIs module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| initiatePaymentConsent | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consentInitiation/payments | Inititate the new payment access consent with details such as customer. |
| updatePaymentConsent | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consentInitiation/{consentId}/payments | Update the new payment access consent with details such as customer. |
| approvePaymentConsent | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consentApprovals/{consentId}/payments | Approve the new payment access consent with details such as customer. |
| withdrawPaymentConsent | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/payments/revocations | Revoke the payment access consent with details such as customer. |
| getConsentPaymentReference | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/paymentReferences | Retrieve the references for the payment in the consent to capture the additional payment details such as scheme name. |
| createConsentPaymentReference | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/paymentReferences | Create the references for the payment in the consent to capture the additional payment details such as scheme name. |
| getAvailableFunds | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/confirmationOfFunds | Retrieve the fund confirmation request details initiated by the customer/tpp such as accountId of debtor. |
| createFundsConfirmationRequest | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/confirmationOfFunds | Create the funds confirmation requested by Third Party Provider(TPP) with details such as Id of the consent. |
| updateFundsConfirmationRequest | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/confirmationOfFunds | Update the funds confirmation requested by Third Party Provider(TPP) with details such as Id of the consent. |
| getFundsConfirmationHistory | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/confirmationOfFunds/transactions | Retrieve the fund confirmation history details initiated by the tpp such as accountId of debtor. |
| getFundsAvailability | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/confirmationOfFunds/status | Retrieve the status of availability of funds based on the customer consent which includes date&time and availability of funds. |
| getUnauthAvailableFunds | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consentsInitiation/{consentId}/confirmationOfFunds | Retrieve the details of the unapproved available funds. |
| getCustomerAccountDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/consents/{consentId}/customerAccounts | Retrieve the arrangement reference and customer reference of the consent such as arrangementId. |
| createDomesticPayment | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderInitiation/domesticOrders | Create the new domestic payment order with details such as payment amount. |
| updateDomesticPayment | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderInitiation/domesticOrders/{paymentId} | Update the new domestic payment order with details such as payment amount. |
| approveDomesticPayment | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderApprovals/domesticOrders/{paymentId} | Approve the new domestic payment order with details such as payment amount. |
| getUnapprovedDomesticPaymentDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrdersInitiation/{paymentOrderId}/domesticOrders | Retrieve the details of the unapproved domestic payments such as payment reference. |
| createInternationalPayment | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderInitiation/internationalOrders | Create the new international payment order with details such as payment amount. |
| updateInternationalPayment | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderInitiation/internationalOrders/{paymentId} | Update the new international payment order with details such as payment amount. |
| approveInternationalPayment | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrderApprovals/internationalOrders/{paymentId} | Approve the new international payment order with details such as payment amount. |
| getInternationalPaymentOrder | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrders/{paymentOrderId}/internationalOrders | Retrieve the details of the international payments such as payment reference. |
| getUnapprovedInternationalPaymentOrder | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrdersInitiation/{paymentOrderId}/internationalOrders | Retrieve the details of the unapproved international payments such as payment reference. |
| getPaymentOrderDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrders/{paymentOrderId}/domesticOrders | Retrieve the details of the domestic payment order such as payment reference. |
| createInternationalStandingOrder | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrdersInitiation/{standingOrderId}/internationalOrders | Create the international standing orders with fields such as method of payment. |
| updateInternationalStandingOrder | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrdersInitiation/{standingOrderId}/internationalOrders | Update the international standing orders with fields such as method of payment. |
| approveInternationalStandingOrder | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrderApprovals/{standingOrderId}/internationalOrders | Approve the international standing orders with fields such as method of payment. |
| getInternationalStandingOrder | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrders/{StandingOrderId}/internationalOrders | Retrieve the details of the international standing orders such as standing order reference. |
| getInternationalStandingOrderUnauth | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrdersInitiation/{StandingOrderId}/internationalOrders | Retrieve the details of the unapproved international standing orders such as standing order reference. |
| deleteInternationalStandingOrder | DELETE | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x//order/uk/standingOrderDelete/{standingOrderId}/internationalOrders | Delete the international standing orders with fields such as method of payment. |
| createDomesticStandingOrder | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrdersInitiation/{standingOrderId}/domesticOrders | Create the domestic standing orders with fields such as method of payment. |
| updateDomesticStandingOrder | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrdersInitiation/{standingOrderId}/domesticOrders | Update the domestic standing orders with fields such as method of payment. |
| approveDomesticStandingOrder | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrderApprovals/{standingOrderId}/domesticOrders | Approve the domestic standing orders with fields such as method of payment. |
| deleteDomesticStandingOrder | DELETE | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrderDelete/{standingOrderId}/domesticOrders | Delete the domestic standing orders with fields such as method of payment. |
| getDomesticStandingOrder | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrders/{standingOrderId}/domesticOrders | Retrieve the details of the domestic standingOrders such as standing order reference. |
The list of Publisher APIs offered as part of this module is provided below.
| UK Open Banking PIS Endpoint *) | Method | URL (UKOBPX_Publisher_Container) | Description |
|---|---|---|---|
| DomesticPayments | |||
| domestic-payment-consents | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-payment-consents | Create consent on the basis of an initial request. |
| domestic-payments | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-payments | To authorise the unauthorised Domestic Payment order created while the consent creation is initiated. |
| domestic-payment-consents/{ConsentId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-payment-consents/{ConsentId} | Return details of the payment consent being created with the permission DOMESTIC.PAYMENTS for the consentId provided. |
| domestic-payment-consents/{ConsentId}/funds-confirmation | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-payment-consents/{ConsentId}/funds-confirmation | Return details of the funds confirmation for the PISP consent with the permission DOMESTIC.PAYMENTS for the consentId provided. |
| domestic-payments/{DomesticPaymentId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-payments/{DomesticPaymentId} | Return payment order details for the Domestic Payment Id provided. |
| DomesticScheduledPayments | |||
| domestic-scheduled-payment-consents | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-scheduled-payment-consents | Create consent on the basis of an initial request. |
| domestic-scheduled-payments | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-scheduled-payments | To authorise the unauthorised Domestic Scheduled Payment created while the consent creation is initiated. |
| domestic-scheduled-payment-consents/{ConsentId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-scheduled-payment-consents/{ConsentId} | Return details of the payment consent being created with the permission DOMESTIC.SCHEDULED.PAYMENTS for the consentId provided. |
| domestic-scheduled-payments/{DomesticScheduledPaymentId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-scheduled-payments/{DomesticScheduledPaymentId} | Return payment order details for the Domestic Scheduled Payment Id provided. |
| DomesticStandingOrders | |||
| domestic-standing-order-consents | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-standing-order-consents | Create consent on the basis of an initial request. |
| domestic-standing-orders | POST | /api/open-banking/v3.1/pisp/v3.1.0/domestic-standing-orders | To authorise the unauthorised Domestic StandingOrder created while the consent creation is initiated. |
| domestic-standing-order-consents/{ConsentId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-standing-order-consents/{ConsentId} | Return details of the payment consent being created with the permission DOMESTIC.STANDING.ORDER for the consentId provided. |
| domestic-standing-orders/{DomesticStandingOrderId} | GET | /api/open-banking/v3.1/pisp/v3.1.0/domestic-standing-orders/{DomesticStandingOrderId} | Return standing order details for the Domestic Standing Order Id provided. |
| UK Open Banking CoF Endpoint *) | Method | URL (UKOBPX_Publisher_Container) | Description |
|---|---|---|---|
| funds-confirmation-consents | POST | /api/open-banking/v3.0/cbpii/v3.0-RC3/funds-confirmation-consents | Create consent on the basis of an initial request. |
| funds-confirmations | POST | /api/open-banking/v3.0/cbpii/v3.0-RC3/funds-confirmations | To authorise the unauthorised funds confirmation record created while the consent creation is initiated. |
| funds-confirmation-consents/{ConsentId} | DELETE | /api/open-banking/v3.0/cbpii/v3.0-RC3/funds-confirmation-consents/{ConsentId} | To revoke the payment consent being created. (i.e) Status will be updated from Valid to revokedByPSU. |
| funds-confirmation-consents/{ConsentId} | GET | /api/open-banking/v3.0/cbpii/v3.0-RC3/funds-confirmation-consents/{ConsentId} | Return details of the funds confirmation record for the provided consentId. |
*) PIS and CoF Endpoints are documented in the pisp-v3.3.1.0-swagger.json swagger file.
In this topic