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 Auto Pay API

OAS3 External AutoPay APIs

Barclays Payment Product External API Auto Pay 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-AutoPay. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 36 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.

4 operations 3 paths 36 schemas 2 GET1 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 Auto Pay 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 4

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

paymentProductExternalAPI-AutoPay 4

OAS3 External AutoPay APIs

PATCH
/cards/accounts/{extAccountId}/payments/subscriptions/{subscriptionId}
Update an AutoPay subscription - update attributes or cancel
updateSubscriptionV2 5 params body → 200401500404503
GET
/cards/accounts/{extAccountId}/payments/subscriptions
Retrieve the most recent and active AutoPay subscription
getSubscriptionV2 3 params → 200401500404503
POST
/cards/accounts/{extAccountId}/payments/subscriptions
Create an AutoPay subscription
addSubscriptionV2 4 params body → 200401500404503
GET
/cards/accounts/{extAccountId}/payments/subscriptions/options
Retrieve options for setting up an AutoPay subscription
getSubscriptionOptionsV2 3 params → 200401500404503

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Subscription (8 properties), ModifySubscriptionDetails (8 properties), SubscriptionRequest (7 properties), AddSubscriptionDetails (6 properties). Each schema is shown below with its type and property counts.

ModifySubscriptionResData
object
Response for subscription update
1 property 1 required
SubscriptionOptionsData
object
Subscription options data
1 property 1 required
Status
string
Fraud verification status
AddSubscriptionReqData
object
Enroll to a subscription request data
1 property 1 required
RepeatPayOptions
string
The amount options customer can choose to pay for the subscription
amt
number
Amount figure of payment amount
sessionLoginTime
string
Timestamp when the customer login
AddSubscriptionDetails
object
Object holding the subscription information after enrollment
6 properties 6 required
ErrorResponseType
object
An API error response.
2 properties
AuthorizationText
string
Authorization text displayed on the subscription confirmation screen
ErrorType
object
Message details - additional operation execution information.
5 properties 3 required
ReferenceNumber
string
Payment reference number
RepeatPayOptionType
array
The amount options customer can choose to pay for the subscription
MinMaxDueDateInterval
integer
Lower or Upper limit from Due Date within the subscription can be set up
MaxCustomRangeInterval
integer
Higher limit for Custom Amount payment option
actionSubmittedTime
string
Timestamp when the submit button was clicked
DayOfMonth
integer
Day of the Month on which the subscription was set up
AddSubscriptionResponse
object
Object holding the response for enrollment for an AutoPay subscription
3 properties 1 required
DaysBeforeDueDateToProcess
integer
Days from Due Date from which the subscription was set up
BankAccountId
string
ID of bank account added as payment source
SubscriptionOptions_dateOptions_daysBeforeDueDateRange
object
Interval from Due Date within the subscription can be set up
2 properties 2 required
SubscriptionData
object
Subscription data
1 property 1 required
SubscriptionRequest
object
Object holding the subscription information for creating/patching an AutoPay subscription
7 properties 5 required
ModifySubscriptionRequest
object
Object holding the subscription information for updating an AutoPay subscription
2 properties 2 required
ModifySubscriptionResponse
object
Object holding the response for updating an AutoPay subscription
3 properties 1 required
ModifySubscriptionReqData
object
Update a subscription
1 property 1 required
Subscription
object
Object holding the subscription information for an account
8 properties 8 required
SubscriptionOptions_dateOptions
object
Options for the dates on which the subscription can be set up for
2 properties 2 required
DateType
string
Standard Date format
RiskAssessmentDetails
object
Risk summary
1 property 1 required
ModifySubscriptionDetails
object
Object holding the subscription information after enrollment
8 properties 6 required
SubscriptionId
integer
Unique Identifier for the Subscription
AddSubscriptionResData
object
Response for subscription enrollment
1 property 1 required
SubscriptionOptions
object
Object holding options for date, payment option type & range for custom amount
3 properties 3 required
MinCustomRangeInterval
integer
Lower limit for Custom Amount payment option
CustomAmountRange
object
Range allowed for the custom amount payment option
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-paymentproductexternalapi-autopay-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 Auto Pay 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.