Skip to content

Commit

Permalink
Async CTs, Collections, OB TOC adjustment, misc edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Tommy Curnyn authored and Tommy Curnyn committed Oct 29, 2024
1 parent e9e60bf commit b6377bb
Show file tree
Hide file tree
Showing 107 changed files with 4,642 additions and 711 deletions.
8 changes: 8 additions & 0 deletions _data/glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@ addacs: "The Automated Direct Debit Amendment and Cancellation Service. An elect

ack_nack: "Ack/Nack (Acknowledgement/Negative Acknowledgement), is used in file processing. An Acknowledgement (Ack) confirms successful receipt and processing of the transmitted file data, while a Negative Acknowledgement (Nack) indicates failure or error in the submission."

ais: "Account Information Service: AIS allows third-party providers (Like Nuapay) to access users’ bank account information with their consent."

allowed-ips: "These are the IPs from which your API requests may originate. Any request not passed from one of your defined allowed-IP addresses will fail with a HTTP status code response of 403 - Forbidden"

auddis: "The Automated Direct Debit Instruction Service. A Bacs service allowing merchants to set up new Direct Debit Instructions (DDIs) and also to notify the scheme of any DDI cancellations."

awacs: "Advice of Wrong Account for Automated Credits Service. A Bacs service that notifies the paying party of a change to beneficiary details. This may be triggered where incorrect beneficiary account details were supplied and the receiving bank has adjusted the details or where a beneficiary has switched accounts."

bacs-clearing: "Bacs Payment Schemes Limited, previously known as Bankers' Automated Clearing Services, is the organisation with responsibility for the scheme behind the clearing and settlement of Direct Debits in the UK."
clearing: "The Clearing and Settlement Mechanism (CSM) that processes SEPA payments. (The EBA's STEP-2 system allows banks across Europe to use one channel to send and receive their SEPA Credit Transfer and SEPA Direct Debit transactions)"

Expand All @@ -17,10 +21,14 @@ aspsp: "The Account Servicing Payment Service Provider: this is the Bank or Paym

collection_date: "The date on which funds are debited from payers' accounts and credited to the merchant account. Can also be referred to as the value date or the settlement date."

cop: "A UK-specific account checking service: when an account name, sort code, and account number of a payee is provided, the CoP service checks if the details match the account holder’s information. A confirmation response, such as match, no match, or close match, is returned helping users ensure they’re paying the correct recipient."

csm: "The Clearing and Settlement Mechanisms are the processes underlying all payment transactions exchanged between two payment service providers (PSPs)."

credit_transfer: "A Credit Transfer or CT is a payment instruction from one account to another. Unlike a Direct Debit payment where funds are pulled from an account, a CT payment is a push payment."

bacs_ct_cycle: "Day 1 (Input Day): You submit the credit transfer payment instruction; Day 2: the payment is processed by Bacs; Day 3; The credit is applied to the destination PSP (beneficiary's bank) account."

direct_debit: "A Direct Debit or DD is a payment initiated by an originator that pulls the requested amount from the payer's bank account. Payers must have agreed to the payment being pulled from their account in advance by signing a mandate or Direct Debit Instruction. "

ddi: "A Direct Debit Instruction - used in the Bacs Direct Debit scheme to gain a payer's authority to debit his/her account; a DDI is the SEPA equivalent of a Direct Debit Mandate."
Expand Down
73 changes: 59 additions & 14 deletions _data/sidebars/ct_sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.

entries:
- title: Credit Transfers
product: Credit Transfers
Expand All @@ -22,45 +20,64 @@ entries:
- title: Introduction
output: web, pdf
folderitems:

- title: Overview
url: /np_ctoverview.html
output: web

- title: Versioning
url: /np_ctversioning.html
output: web
- title: CT Collections
url: /np_ctcollectionoverview.html
output: web
- title: Credit Transfer Statuses
url: /np_ctstatuses.html
output: web, pdf
- title: Credit Transfer Cut Off Timing
url: /np_ctcutoffs.html
output: web, pdf

- title: Credit Transfer APIs
output: web, pdf
folderitems:

- title: Create Beneficiary
url: /np_createbeneficiary.html
output: web

- title: Retrieve Beneficiary
url: /np_retrievebene.html
output: web

- title: List Beneficiaries
url: /np_listbeneficiaries.html
output: web

- title: Create Credit Transfer
url: /np_createct.html
output: web

- title: Create Credit Transfer & Beneficiary
url: /np_createctandbene.html
output: web

- title: Retrieve Credit Transfer
url: /np_retrievect.html
output: web
- title: List Credit Transfers (Originator)
url: /np_listctsorig.html
output: web
- title: List Credit Transfers (Beneficiary)
url: /np_listctbene.html
output: web

- title: List Credit Transfers
url: /np_listcts.html
- title: CT Collection APIs
output: web, pdf
folderitems:
- title: Create Collection
url: /np_ctcreatecoll.html
output: web
- title: List Collections
url: /np_ctlistcoll.html
output: web
- title: View Collection
url: /np_ctviewcoll.html
output: web
- title: List CTs in a Collection
url: /np_ctlistctcoll.html
output: web

- title: Webhooks
Expand All @@ -72,7 +89,7 @@ entries:
output: web, pdf

subfolders:
- title: Webhook Events
- title: Credit Transfer Notifications
output: web
subfolderitems:

Expand All @@ -94,4 +111,32 @@ entries:

- title: Express Credit Transfer Accept
url: /np_whctexpaccept.html
output: web
output: web

- title: Beneficiary Update
url: /np_whctbenefupdate.html
output: web

- title: CT Collections Notifications
output: web
subfolderitems:

- title: Collection Initiated
url: /np_whctcollinit.html
output: web

- title: Collection Rejected
url: /np_whctcollreject.html
output: web

- title: Collection Failed
url: /np_whctcollfailed.html
output: web

- title: Collection Complete
url: /np_whctcollcomplete.html
output: web

- title: Collection Complete With Errors
url: /np_whctcollcompleteerror.html
output: web
4 changes: 4 additions & 0 deletions _data/sidebars/fm_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ entries:
url: /fm_retrieve_single_batch.html
output: web, pdf

- title: Recall a Batch
url: /fm_recall_batch.html
output: web, pdf

- title: Transaction Services
output: web, pdf
folderitems:
Expand Down
97 changes: 8 additions & 89 deletions _data/sidebars/ob_sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.

entries:
- title: Open Banking
product: Open Banking
Expand All @@ -18,17 +16,13 @@ entries:
url: /ob_servicesoverview.html
output: web

# - title: General API Rules
# url: /ob_generalrules.html
# output: web, pdf

- title: Bank Service
output: web, pdf
folderitems:

- title: Overview
url: /ob_bankoverview.html
output: web, pdf
output: web

subfolders:
- title: Bank APIs
Expand All @@ -47,10 +41,6 @@ entries:
url: /ob_getbankfamily.html
output: web

## - title: View Bank
## url: /ob_viewbank.html --> NOT IMPLEMENTS - REMOVED
## output: web

- title: Payment Initiation Service
output: web, pdf
folderitems:
Expand All @@ -59,64 +49,35 @@ entries:
url: /ob_pispoverview.html
output: web, pdf

- title: Implementation Options
url: /ob_pispimplementations.html
output: web, pdf

subfolders:
- title: Partner Integration
- title: Implementation Options
output: web
subfolderitems:

- title: Quick Start
url: /ob_quickstartpart.html
output: web, pdf

- title: Checkout Setup
url: /ob_checkoutoverview.html
output: web, pdf

- title: Self-Hosted Setup
url: /ob_selfsetupoverview.html
url: /ob_quickstart.html
output: web, pdf

# - title: Self-Hosted-Callback Setup
# url: /ob_selfcallbacksetupoverview.html
# output: web, pdf --> Not usable for Partners

- title: Redirect Setup
url: /ob_redirectoverview.html
output: web, pdf

- title: Merchant Integration
output: web
subfolderitems:

- title: Quick Start
url: /ob_quickstart.html
output: web, pdf

- title: Checkout Setup
url: /ob_checkoutoverviewmerch.html
output: web, pdf

- title: Self-Hosted Setup
url: /ob_selfsetupoverviewmerch.html
url: /ob_selfsetupoverview.html
output: web, pdf

- title: Self-Hosted-Callback Setup
url: /ob_selfcallbackmerch.html
- title: Self-Hosted Callback Setup
url: /ob_selfcallback.html
output: web, pdf

- title: Redirect Setup
url: /ob_redirectoverviewmerch.html
- title: Checkout Setup
url: /ob_checkoutoverview.html
output: web, pdf

- title: Payment & Refund Statuses
url: /ob_paymentstatuses.html
output: web, pdf


- title: Payment Retries
url: /ob_paymentretries.html
output: web, pdf
Expand Down Expand Up @@ -215,48 +176,6 @@ entries:
url: /ob_listaccount.html
output: web


#- title: Subscription Payments ---> Moved to the E-Mandate section. Delete this later once it's confirmed it's okay under the E-Mandates section
# output: web, pdf
# folderitems:

# - title: Overview
# url: /ob_emoverview.html
# output: web, pdf

# subfolders:
# - title: Payment-Initiated E-Mandates
# output: web
# subfolderitems:

# - title: Launching the Flow
# url: /ob_emlaunching.html
# output: web, pdf

# - title: The User Journey
# url: /ob_emoverallflow.html
# output: web, pdf

# - title: Self-Hosted Mode
# url: /ob_emselfhosted.html
# output: web, pdf

# - title: Account-Access E-Mandates
# output: web
# subfolderitems:

# - title: Launching the Flow
# url: /ob_acc_emlaunching.html
# output: web, pdf

# - title: The User Journey
# url: /ob_acc_emoverallflow.html
# output: web, pdf

# - title: Self-Hosted Mode
# url: /ob_acc_emselfhosted.html
# output: web, pdf

- title: Bank Status Service
output: web, pdf
folderitems:
Expand Down
44 changes: 36 additions & 8 deletions _data/sidebars/sec_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,59 @@ entries:
url: /np_secoverview.html
output: web, pdf

- title: Authentication Options
- title: API Key Authentication
url: /np_secapikeyauth.html
output: web, pdf

- title: MTLS Configuration
url: /np_secmtls.html
output: web, pdf

subfolders:
- title: JSON Web Signature
- title: MTLS Configuration
output: web
subfolderitems:

- title: Overview
url: /np_secmtls.html
output: web, pdf

- title: MTLS via UI
url: /np_secmtlsui.html
output: web, pdf

- title: MTLS via REST
url: /np_secmtlsrest.html
output: web, pdf

- title: JWS Configuration
output: web
subfolderitems:

- title: Overview
url: /np_secjws.html
output: web, pdf

- title: JWS Configuration via UI
- title: JWS via UI
url: /np_secjwsui.html
output: web, pdf

- title: JWS Configuration via REST
- title: JWS via REST
url: /np_secjwsrest.html
output: web, pdf

- title: JWS Signature Samples
url: /np_secjwssample.html
output: web, pdf

- title: Certificate APIs
output: web
subfolderitems:

- title: Create Certificates
url: /np_seccreatecert.html
output: web, pdf

- title: List Certificates
url: /np_seclistcert.html
output: web, pdf

- title: Delete Certificate
url: /np_secdeletecert.html
output: web, pdf
Loading

0 comments on commit b6377bb

Please sign in to comment.