GET /accounts/{AccountId}/scheduled-payments

  • Live
  • 3.1.4

Usage

GET /accounts/{AccountId}/scheduled-payments

Description

By hitting this API, we will return the scheduled payments set up on a specific account. You will need to ensure you call the GET /accounts API prior to retrieve the account IDs for the authorised accounts.

Below, you can find our implementation and returned optional fields for version 3.1.1 of this API.

 

Request

Request
As per OBIE specification

Response

Response Data Block Optional Data Fields NBS Implementation
/Data/ScheduledPayment <Scheduled Payment> Block Returned
Reference Returned
ScheduledPaymentID Not Returned
/Data/ScheduledPayment/InstructedAmount <InstructedAmount> Block Returned
/Data/ScheduledPayment/CreditorAgent <CreditorAgent> Block Not Returned
SchemeName Not Returned
Identification Not Returned
/Data/ScheduledPayment/CreditorAccount <CreditorAccount> Block Returned
Name Returned
SecondaryIdentification Not Returned

API Reference

/accounts/{AccountId}/scheduled-payments
get /accounts/{AccountId}/scheduled-payments
Get Scheduled Payments

Resource URL

https://api-internal.obtpp.nationwideinterfaces.io/open-banking/v3.1/aisp /accounts/{AccountId}/scheduled-payments

Header Parameters

Content-Type

x-fapi-auth-date

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

Authorization
(required)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent

Indicates the user-agent that the PSU is using.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Category

Scheduled Payments

Response Error Details
  • 400 Bad request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 405 Method Not Allowed
  • 406 Not Acceptable
  • 429 Too Many Requests
  • 500 Internal Server Error

Working...

API Personas

Sam Jones
  • Retail
  • Lives alone
  • Is overdrawn
View Persona
Patrick Nadwarna
  • Retail
  • No regular payments
  • Large balance
View Persona
Cathy Powell
  • Retail
  • Fraud victim
  • Restricted account
View Persona
Josh Chambers
  • Retail
  • Economics student
  • Uses different payment channels
View Persona
Maz Patel
  • Retail
  • Full-time mum
  • Frequent spender
View Persona
Darren Nowak
  • Retail
  • Rarely at home
  • Financially savvy
View Persona
Janet Simpson
  • Retail
  • Closing current account
  • Insufficient funds
View Persona
Melanie Rossi
  • Retail
  • Travels a lot
  • Locked current account
View Persona
Hattie Walker
  • Retail
  • Credit card account
  • Frequent credit card use
View Persona
Victor Braganza
  • Retail
  • Credit card account
  • Inactive account
View Persona
Alex Baker
  • Retail
  • Credit card account
  • Restricted account
View Persona
Martin Hanger
  • Retail
  • Buying new house
  • Evaluating affordability
View Persona
Keesha Mclintock
  • Retail
  • Credit card account
  • Applying for a mortgage
View Persona
Jason Costello
  • Business
  • J C Plumbing
  • New business
View Persona
Jozef Ivan
  • Business
  • The Cake Cave
  • New business
View Persona
Brian McKay
  • Business
  • Johnson's Fish & Chip
  • Money Laundering- Fraud
View Persona
Lee Waterman
  • Business
  • L W Car Parts
  • Lots of payments
View Persona
Muhammed Patel
  • Business
  • Snips
  • Shrinking business
View Persona
Sharon Snow
  • Business
  • Endeavour Web Designs
  • Established, highly successful
View Persona
Lucy Baines
  • Business
  • The Royal Oak
  • Moving business account
View Persona
Roland Hanbury
  • Business
  • Grey Fox Marketing
  • Working abroad
View Persona