artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 17:37:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/develop' into develop

Browse Source
This commit is contained in:
Marko Milić 2024-12-10 10:48:05 +01:00
commit 98a576e3a7
2 changed files with 37 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
obp-api/src/main/scala/code/api/util/Glossary.scala
View File

@ -3427,6 +3427,33 @@ object Glossary extends MdcLoggable {
|
|""".stripMargin)
glossaryItems += GlossaryItem(
title = "Counterparty-Limits",
description =
s"""Counterparty Limits can be used to restrict payment (Transaction Request) amounts and frequencies (per month, year, total) that can be made to a Counterparty (Beneficiary).
|
|Counterparty Limits can be used to limit both single or repeated payments (VRPs) to a Counterparty Beneficiary.
|
|Counterparty Limits reference a counterparty_id (a UUID) rather an an IBAN or Account Number.
|This means it is possible to have multiple Counterparties that refer to the same external bank account.
|In other words, a Counterparty Limit restricts an OBP Counterparty rather than a certain IBAN or other Bank Account Number.
|
|Since Counterparties are bound to OBP Views it is possible to create similar Counterparties used by different Views. This is by design i.e. a Two Users called Accountant1 could Accountant2 could create their own Views and Counterparties referencing the same corporation but still have their own limits say for different cost centers.
|
|To manually create and use a Counterparty Limit via a Consent for Variable Recurring Payments (VRP) you would:
|1) Create a Custom View named e.g. VRP1.
|2) Place a Beneficiary Counterparty on that view.
|3) Add Counterparty Limits for that Counterparty.
|4) Generate a Consent containing the bank, account and view (e.g. VRP1)
|5) Let the App use the consent to trigger Transaction Requests.
|
|However, you can use the following ${Glossary.getApiExplorerLink("endpoint", "OBPv5.1.0-createVRPConsentRequest")} to automate the above steps.
|
|""".stripMargin)
glossaryItems += GlossaryItem(

12
obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala
View File

@ -2967,9 +2967,17 @@ trait APIMethods510 {
"POST",
"/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits",
"Create Counterparty Limit",
s"""Create Counterparty Limit.
s"""Create limits (for single or recurring payments) for a counterparty specified by the COUNTERPARTY_ID.
|
|Using this endpoint, we can attach a limit record to a Counterparty referenced by its counterparty_id (a UUID).
|
|For more information on Counterparty Limits, see ${Glossary.getGlossaryItemLink("Counterparty-Limits")}
|
|For an introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")}
|
|You can automate the process of creating counterparty limits and consents for VRP with this ${Glossary.getApiExplorerLink("endpoint", "OBPv5.1.0-createVRPConsentRequest")}.
|
|
|$counterPartyLimitIntro
|
|""".stripMargin,
postCounterpartyLimitV510,