How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Paragon Bank

Paragon Bank File Payments API

The File Payments API from Paragon Bank — 4 operation(s) for file payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Paragon Bank File Payments API is one of 34 APIs that Paragon Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/pisp.

4 operations 4 paths 56 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.1
Server
/open-banking/v4.0/pisp
Authentication
OAuth 2.0, OAuth 2.0
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Paragon Bank File Payments API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

File Payments 4
POST
/file-payments
Submit a File Payment
CreateFilePayments 8 params body → 201400401403404405406409
GET
/file-payments/{FilePaymentId}
Get a File Payment by FilePaymentId
GetFilePaymentsFilePaymentId 7 params → 200400401403404405406429
GET
/file-payments/{FilePaymentId}/payment-details
Get payment details for a File Payment
GetFilePaymentsFilePaymentIdPaymentDetails 7 params → 200400401403404405406429
GET
/file-payments/{FilePaymentId}/report-file
Get a File Payment's Report File
GetFilePaymentsFilePaymentIdReportFile 7 params → 200400401403404405406429

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBRemittanceInformationStructured (7 properties), OBCashAccountDebtor4 (5 properties), OBUltimateDebtor1 (5 properties). Each schema is shown below with its type and property counts.

Floor
string
Number that identifies the level within a building
OBWritePaymentDetails1
object
4 properties 3 required
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalCha…
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
CountryCode
string
Nation with its own government.
UnitNumber
string
Number that identifies the unit of a specific address .
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
Name
string
Name by which an agent is known and which is usually used to identify that agent.
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBInternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
Identification_1
string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
OBWritePaymentDetailsResponse1
object
3 properties 1 required
Links
object
Links relevant to the payload
5 properties 1 required
File
object
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
ActiveOrHistoricCurrencyCode
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBRemittanceInformation2
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
2 properties
OBStatusReason
object
3 properties
BuildingNumber
string
Number that identifies the position of a building on a street.
ExternalPaymentTransactionStatus1Code
string
The current status of the payment resource. For a full list of values see ExternalPaymentTransactionStatus1Code in OBInternalCodeSet [here](https://github.com/…
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
OBCashAccountDebtor4
object
^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.
5 properties
StreetName
string
Name of a street or thoroughfare.
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in…
OBRemittanceInformationStructured
object
7 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBWriteFile2
object
1 property 1 required
Meta
object
Meta Data relevant to the payload
3 properties
Room
string
Information that locates and identifies a room to form part of an address
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values see ExternalProxyAccountTyp…
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
Department
string
Identification of a division of a large organisation or building.
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets).
OBReferredDocumentInformation
object
5 properties
ExternalPaymentTransactionStatus4Code
string
Specifies the status of the payment order resource. See ExternalPaymentTransactionStatus4Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Exte…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
BuildingName
string
Name of a referenced building.
Identification_4
string
Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties 2 required
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OBInternalPaymentChargeType1Code
string
Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
OBWriteFileResponse3
object
3 properties 1 required
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBError1
object
4 properties 1 required
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paragon-bank-file-payments-api-openapi.yml Raw ↑

Other APIs Paragon Bank publishes across the network.

Paragon Bank Account Access Consents API
AE Profile APIs.io
Paragon Bank Accounts API
AE Profile APIs.io
Paragon Bank ATM API
AE Profile APIs.io
Paragon Bank Balances API
AE Profile APIs.io
Paragon Bank BCA API
AE Profile APIs.io
Paragon Bank Beneficiaries API
AE Profile APIs.io
Paragon Bank Branch API
AE Profile APIs.io
Paragon Bank CCC API
AE Profile APIs.io
Paragon Bank Direct Debits API
AE Profile APIs.io
Paragon Bank Domestic Payment Consents API
AE Profile APIs.io
Paragon Bank Domestic Payments API
AE Profile APIs.io
Paragon Bank Domestic Scheduled Payment Consents API
AE Profile APIs.io
#File Payments
← Back to P APIs
API Details
ID
paragon-bank:paragon-bank-file-payments-api
Server
/open-banking/v4.0/pisp
Docs
https://openbankinguk.github.io/opendata-api-docs-pub/v2.4.0/
Provider
Paragon Bank
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paragon-bank-file-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paragon-bank-file-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Paragon Bank File Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.