Barclays Payments API is one of 30 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
11 operations
across 9 paths,
organized into 3 resource areas,
and defines 83 schemas.
It is described by OpenAPI 3.1.0, at version 2.0.
The identity and technical contract details declared by the specification.
BankName
string
Bank name of the bank account added as payment source
AmountOptions_minimumDue
object
Minimum due amount that customer needs to pay
2 properties
2 required
SchedulePaymentRequestData
object
Schedule Payment Request Data
1 property
1 required
ModifySubscriptionDetails
object
Object holding the subscription information after enrollment
8 properties
6 required
AmountOptions_statementBalance
object
Statement balance i.e. the amount owed by the customer till the last billing cycle
2 properties
2 required
AddSubscriptionResponse
object
Object holding the response for enrollment for an AutoPay subscription
3 properties
1 required
SubscriptionOptionsData
object
Subscription options data
1 property
1 required
ModifyAutoPaymentResponseData
object
Modify Current Cycle AutoPay Response Data
1 property
1 required
AddSubscriptionDetails
object
Object holding the subscription information after enrollment
6 properties
6 required
PaymentSummaryResponseData
object
Payment Summary Data
2 properties
2 required
ModifyAutoPaymentRequestData
object
Modify Current Cycle AutoPay Request Data
1 property
1 required
AmountOptions_remainingMinimumDue
object
Remaining minimum due amount if some part of it is already paid
2 properties
2 required
ModifyPaymentResponse
object
Modify Payment Response
3 properties
1 required
DaysBeforeDueDateToProcess
integer
Days from Due Date from which the subscription was set up
Subscription
object
Object holding the subscription information for an account
8 properties
8 required
DateType
string
Standard Date format
Status
string
Fraud verification status
ModifySubscriptionResponse
object
Object holding the response for updating an AutoPay subscription
3 properties
1 required
PaymentDate
string
Date on which processing of the payment started
ExternalBankAccountDetailsLast4
object
Bank account details
5 properties
ReferenceNumber
string
Payment reference number
DayOfMonth
integer
Day of the Month on which the subscription was set up
AuthorizationText
string
Authorization text displayed on the subscription confirmation screen
SubscriptionOptions_dateOptions
object
Options for the dates on which the subscription can be set up for
2 properties
2 required
ErrorResponseType
object
An API error response.
2 properties
ModifyAutoPaymentRequest
object
Modify AutoPay Request
2 properties
2 required
MinCustomRangeInterval
integer
Lower limit for Custom Amount payment option
RepeatPayOptionType
array
The amount options customer can choose to pay for the subscription
AmountOptions_remainingStatementBalance
object
Remaining statement balance if some part of it is already paid
2 properties
2 required
ProjectedCreditDate
string
Projected credit date of payment
ExternalBankDetails
object
4 properties
BankAccountId
string
ID of bank account added as payment source
BankAccountType
string
Account type of the bank account used as payment source
UpdatedPaymentDetails
object
Update Payment Response
3 properties
3 required
BankRoutingNumber
string
Bank routing number of the bank account added as payment source
GetAllExternalAccountsResponseDataLast4
object
All external bank accounts response data
1 property
1 required
SubscriptionOptions_dateOptions_daysBeforeDueDateRange
object
Interval from Due Date within the subscription can be set up
2 properties
2 required
sessionLoginTime
string
Timestamp when the customer login
BankAccountNickname
string
Nickname for bank account added as payment source
GetExternalAccountResponseDataLast4
object
external bank account response data
1 property
1 required
amt
number
Amount figure of payment amount
UpdatedAutoPaymentDetails
object
Update Auto Payment Response
4 properties
4 required
AmountOptionType
string
Payment amount option type
ExternalAccountListLast4
array
Get all external account list
AmountOptions_availableCredit
object
Credit available for the card account
2 properties
2 required
RiskAssessmentDetails
object
Risk summary
1 property
1 required
ExternalAccountLast4
object
Get all external account response
5 properties
DateOptions_customDateRange
object
Custom date range for future payments
2 properties
2 required
PaymentSummaryListResponse
array
List of payments
SubscriptionRequest
object
Object holding the subscription information for creating/patching an AutoPay subscription
7 properties
5 required
SubscriptionId
integer
Unique Identifier for the Subscription
PaymentSummary
object
Payment Summary fields
13 properties
13 required
BankAccountNumberLast4
string
Last 4 digits of Bank account number to be added as a payment source
ErrorType
object
Message details - additional operation execution information.
5 properties
3 required
PaymentOptionsResponse
object
payment options fields
2 properties
2 required
AmountOptions
object
amount options
7 properties
7 required
SchedulePaymentResponseData
object
Schedule Payment Response Data
1 property
1 required
ModifySubscriptionReqData
object
Update a subscription
1 property
1 required
SubscriptionOptions
object
Object holding options for date, payment option type & range for custom amount
3 properties
3 required
currency
string
Currency of payment amount
DateOptions
object
Date options available under payment options
6 properties
6 required
AmountOptions_currentBalance
object
Current balance i.e. total amount owed by the customer at the given moment
2 properties
2 required
AddSubscriptionReqData
object
Enroll to a subscription request data
1 property
1 required
ModifyPaymentRequest
object
Modify Payment Request
2 properties
2 required
ModifyPaymentResponseData
object
Modify Payment Response Data
1 property
1 required
ModifySubscriptionRequest
object
Object holding the subscription information for updating an AutoPay subscription
2 properties
2 required
Amount
object
Payment Amount Object
2 properties
2 required
PaymentSummaryMetaResponse
object
2 properties
AmountOptions_creditLimit
object
Credit limit for the card account
2 properties
2 required
CustomAmountRange
object
Range allowed for the custom amount payment option
2 properties
2 required
PaymentOptionsResponseData
object
Payment Options Response Data
1 property
1 required
ModifyPaymentRequestData
object
Modify Payment Request Data
1 property
1 required
actionSubmittedTime
string
Timestamp when the submit button was clicked
SchedulePaymentResponse
object
Schedule Payment Response
3 properties
1 required
RepeatPayOptions
string
The amount options customer can choose to pay for the subscription
ModifyAutoPaymentResponse
object
Modify AutoPay Response
3 properties
1 required
MinMaxDueDateInterval
integer
Lower or Upper limit from Due Date within the subscription can be set up
PaymentRequest
object
Payment Request
7 properties
7 required
ModifySubscriptionResData
object
Response for subscription update
1 property
1 required
MaxCustomRangeInterval
integer
Higher limit for Custom Amount payment option
SubscriptionData
object
Subscription data
1 property
1 required
AddSubscriptionResData
object
Response for subscription enrollment
1 property
1 required
ScheduledPaymentDetails
object
Schedule Payment Response
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Barclays publishes across the network.
