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

Barclays Payment Product External API One Time Payment API

OAS3 External Onetime Payment APIs

Barclays Payment Product External API One Time Payment API is one of 64 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against the base URL https://telesto.api.barclays/open-banking/v3.1.

5 operations 4 paths 45 schemas 2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://telesto.api.barclays/open-banking/v3.1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Barclays Payment Product External API One Time Payment API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ExternalTiaaUsCCAuth) using the clientCredentials flow, exposing 2 scopes.

  • ExternalTiaaUsCCAuth — OAuth2.0 Client Credentials Grant authentication using TIAA-US for external APIs

Paths & Operations 5

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

paymentProductExternalAPI-OneTimePayment 5

OAS3 External Onetime Payment APIs

PATCH
/cards/accounts/{extAccountId}/payments/{referenceNumber}
Modify One-time Payment for partner
updatePaymentV2 5 params body → 200400401500
GET
/cards/accounts/{extAccountId}/payments/payment-options
Payment options for the accountId from partner
getPaymentOptionsV2 3 params → 200400401500404
GET
/cards/accounts/{extAccountId}/payments
Payment activity for the accountId from partner
getPaymentSummaryV2 9 params → 200400401500404
POST
/cards/accounts/{extAccountId}/payments
Make a One-time Payment for account id from partner
schedulePaymentV2 4 params body → 200400401500
PATCH
/cards/accounts/{extAccountId}/auto-payments/{referenceNumber}
Modify Autopay Payment for current cycle
modifyAutoPayPayment 5 params body → 200400401500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are PaymentSummary (13 properties), PaymentRequest (7 properties), AmountOptions (7 properties), DateOptions (6 properties). Each schema is shown below with its type and property counts.

ModifyPaymentResponseData
object
Modify Payment Response Data
1 property 1 required
PaymentSummaryResponseData
object
Payment Summary Data
2 properties 2 required
SchedulePaymentResponseData
object
Schedule Payment Response Data
1 property 1 required
amt
number
Amount figure of payment amount
AmountOptions
object
amount options
7 properties 7 required
sessionLoginTime
string
Timestamp when the customer login
ErrorResponseType
object
An API error response.
2 properties
AuthorizationText
string
Authorization text displayed on the subscription confirmation screen
AmountOptions_creditLimit
object
Credit limit for the card account
2 properties 2 required
ErrorType
object
Message details - additional operation execution information.
5 properties 3 required
ReferenceNumber
string
Payment reference number
currency
string
Currency of payment amount
BankAccountNickname
string
Nickname for bank account added as payment source
PaymentSummaryMetaResponse
object
2 properties
ModifyAutoPaymentResponseData
object
Modify Current Cycle AutoPay Response Data
1 property 1 required
actionSubmittedTime
string
Timestamp when the submit button was clicked
Amount
object
Payment Amount Object
2 properties 2 required
BankAccountId
string
ID of bank account added as payment source
UpdatedPaymentDetails
object
Update Payment Response
3 properties 3 required
PaymentOptionsResponse
object
payment options fields
2 properties 2 required
PaymentSummary
object
Payment Summary fields
13 properties 13 required
PaymentSummaryListResponse
array
List of payments
ProjectedCreditDate
string
Projected credit date of payment
DateOptions
object
Date options available under payment options
6 properties 6 required
PaymentDate
string
Date on which processing of the payment started
AmountOptions_statementBalance
object
Statement balance i.e. the amount owed by the customer till the last billing cycle
2 properties 2 required
AmountOptions_minimumDue
object
Minimum due amount that customer needs to pay
2 properties 2 required
ModifyAutoPaymentResponse
object
Modify AutoPay Response
3 properties 1 required
BankAccountType
string
Account type of the bank account used as payment source
DateOptions_customDateRange
object
Custom date range for future payments
2 properties 2 required
AmountOptionType
string
Payment amount option type
AmountOptions_availableCredit
object
Credit available for the card account
2 properties 2 required
ModifyPaymentResponse
object
Modify Payment Response
3 properties 1 required
PaymentRequest
object
Payment Request
7 properties 7 required
PaymentOptionsResponseData
object
Payment Options Response Data
1 property 1 required
AmountOptions_currentBalance
object
Current balance i.e. total amount owed by the customer at the given moment
2 properties 2 required
AmountOptions_remainingStatementBalance
object
Remaining statement balance if some part of it is already paid
2 properties 2 required
RiskAssessmentDetails
object
Risk summary
1 property 1 required
ModifyPaymentRequest
object
Modify Payment Request
2 properties 2 required
SchedulePaymentResponse
object
Schedule Payment Response
3 properties 1 required
SchedulePaymentRequestData
object
Schedule Payment Request Data
1 property 1 required
ScheduledPaymentDetails
object
Schedule Payment Response
4 properties 4 required
UpdatedAutoPaymentDetails
object
Update Auto Payment Response
4 properties 4 required
AmountOptions_remainingMinimumDue
object
Remaining minimum due amount if some part of it is already paid
2 properties 2 required
ModifyPaymentRequestData
object
Modify Payment Request Data
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-paymentproductexternalapi-onetimepayment-api-openapi.yml Raw ↑

Other APIs Barclays publishes across the network.

Barclays Smartpay Web Payment API
Barclaycard Smartpay Connect API
Barclays Corporate Payment Initiation API
Barclays Balances and Transactions Reporting API
Barclays Account Access Consents API
Barclays Accounts API
Barclays Apply Product External API OAS API
Barclays Atms API
Barclays Balances API
Barclays Beneficiaries API
Barclays Branches API
Barclays Business Current Accounts API
Where this information came from

This is an independent, third-party profile of Barclays Payment Product External API One Time Payment 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.