Airapi User Guide
  • 📙What is Airapi?
  • 📘Getting Started
    • Manage Environment
      • What is an Environment?
      • Add a New Environment
      • Update Environment
        • Reset Environment Cache
      • Delete Environment
      • Dashboard
      • Messages
      • Configurations
      • Endpoints
      • Applications
      • Documents
      • Agreements
      • Account Settings
    • Create Your Account
      • Verify Email
      • Forget Password
  • 📗Management Portal
    • API Definition
      • Consent Management
      • Scope Management
  • 📕Quota Management
    • Quota Management
    • API Base Quota
    • Application Base Quota
    • Domain Base Quota
  • 📔UK Open Banking
    • Account Details
    • Regular Payments
  • 📒TCMB Standard
    • Hata Kodları
  • 📓Advanced Features
    • App To App Authentication
    • mutual TLS
  • 📖How to
    • How To Get a Client Credential Token?
    • How To Get an AppToApp Token?
    • How To Add Multiple Function Policy?
    • How To Add Data Mask Policy?
    • How To Create a New Tenant User?
    • How To Configure Developer Portal?
    • How To Modify Global Rate Limit?
    • How To Retire an API?
    • How To Reject a Payment Initiation?
    • How To Add a Global Variable?
    • How To Restrict Working Hours?
    • How To Track Gateway Error?
    • How To Export/Import Endpoints?
    • How To Reject Account Consent?
    • How To Exclude an Endpoint?
    • How To Define an Endpoint?
    • How To Define a Mock Policy?
    • How To Define a Rate Limit Policy?
    • How To Define a Mail Policy?
    • How To Transform a Header?
    • How To XML to JSON?
    • How To JSON to XML?
  • 📙Release Notes
    • Versions
    • v2.1.80
    • v2.1.76
    • v2.1.72
    • v2.1.68
    • v2.1.64
    • v2.1.60
    • v2.1.56
    • v2.1.52
    • v2.1.44
    • v2.1.36
    • v2.1.20
    • v2.1.16
    • v2.0.96
    • v2.0.80
    • v2.0.72
    • v2.0.70
    • v2.0.66
    • v2.0.60
    • v2.0.55
    • v2.0.51
    • v2.0.50
    • v1.9.47
    • v1.9.46
    • v1.9.45
    • v1.9.44
    • v1.9.43
    • v1.9.42
    • v1.9.41
    • v1.9.40
    • v1.9.39
    • v1.9.38
    • v1.9.37
    • v1.9.3
    • v1.9.2
    • v1.9.1
    • v1.8.8
    • v1.8.7
    • v1.8.6
    • v1.8.5
    • v1.8.4
    • v1.8.3
    • v1.8.2
    • v1.8.1
    • v1.8.0
    • v1.7.9
    • v1.7.8
    • v1.7.7
    • v1.7.6
    • v1.7.5
    • v1.7.4
    • v1.7.3
    • v1.7.2
    • v1.7.1
    • v1.7.0
    • v1.6.9
    • v1.6.8
    • v1.6.7
    • v1.6.5
    • v1.6.2
    • v1.6.0
    • v1.5.8
    • v1.5.6
    • v1.5.4
    • v1.5
    • v1.4.6
    • v1.4.3
    • v1.4.0
    • v1.3.0
    • v1.2.1
    • v1.1.1
    • v0.8.6
  • ⚙️Planned Activities
Powered by GitBook
On this page
  1. UK Open Banking

Regular Payments

PreviousAccount DetailsNextTCMB Standard

Last updated 2 years ago

Regular Payments

ReadBeneficiariesDetail permission

An TPP may retrieve the account beneficiaries’ information resource for a specific AccountId (GET /accounts/{AccountId}/beneficiaries) or bulk (GET /beneficiaries). For bulk, an endpoint can retrieve the beneficiaries’ resources for all authorized accounts. ApiGo supports ReadBeneficiariesDetail permission, but do not overlook that ASPSP may not provide beneficiaries for an account (AccountId).

After the consent has been approved, TPP can call an account information service to reach beneficiaries’ details. As mentioned before, account information services need to be called with the token, taken with the authorization code. The TPP’s request will be responded with the body, which includes account basics and details.

ReadStandingOrdersDetail permission

With ApiGo, ASPSP can serve the standing-order resource for a specific AccountId (/accounts/{AccountId}/standing-orders) or as bulk (/standing-orders). An TPP may optionally retrieve the standing-order resources in bulk or an account.

Standing Order endpoint provides details of creditor account information (name, sort code, account, SO Info, frequency, creditor reference info, first/next/final payment info).

ReadDirectDebits permission

ApiGo users can provide an endpoint for TPPs to retrieve the direct-debits for a specific account identified by AccountId (/accounts/{AccountId}/direct-debits). With ApiGo, ApiGo may provide this endpoint for TPPs to retrieve direct debits for all accounts that the PSU has consented to. The TPP will be responded with the direct-debit resources for all authorized accounts.

There is a sample request and response body for a direct debit endpoint that provides details of PSU’s direct debits includes mandate info, status, name, previous payment information.

📔
apigo ReadDirectDebits permission
apigo ReadDirectDebits permission postman
apigo ReadBeneficiariesDetail permission postman
apigo ReadBeneficiariesDetail permission
apigo ReadStandingOrdersDetail permission
apigo ReadStandingOrdersDetail permission postman