Open Banking API
Retrieve all account's direct debits
api
get
/accounts/{AccountId}/direct-debits

Retrieve all account's direct debits

Get a list of all the direct debits for a specific user account.

See also Tutorials: Get account and transaction information.

Authorization​

Each Open Banking API must contain an authorization header in the following format to make a call: Bearer <yourAccessToken>.

Before you start, ensure that you've got an access token with the correct scope using the /token endpoint. You need to get the authorization code first and exchange it for an access token.

danger

Never share your access_token with anyone, as it can be used to access the banking data that you have access to and initiate transactions.

For more information, see Tutorial: Get account and transaction information and Tutorial: Initiate your first payment as examples.

x-jws-signature​

Open Banking API Payment requests additionally require a JSON Web Signature (JWS) which needs to be added to the header of the request. The JWS signature must be obtained using the full content of the payload.

Request​

Path Parameters
Path Parameters

The ID of the account.

Header Parameters
Header Parameters

The unique ID of the ASPSP that the request is issued to. The ID of Revolut is 001580000103UAvAAM.

Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

The date and time when the PSU last logged in with the TPP.

All dates in the HTTP headers are represented as RFC 7231 Full Dates. For example: Sun, 10 Sep 2017 19:43:31 UTC.

The IP address of the PSU if the PSU is logged in with the TPP.

An RFC4122 UUID used as a correlation ID.

The access token that you've generated. For more information, see Generate an access token.

The user agent that the PSU is using.

Response​

Direct Debits Read

HTTP Headers
HTTP Headers

An RFC4122 UUID used as a correlation ID.

Response body
Body object

A list of direct debits.

The account that a cash entry is made to or from.

Possible values: non-empty and <= 40 characters

The unique and immutable ID to identify the account resource. This ID has no meaning to the account owner.

Possible values: non-empty and <= 40 characters

The unique and immutable ID to identify the direct debit resource. This ID has no meaning to the account owner.

Possible values: non-empty and <= 35 characters

The direct debit reference.

  • For AUDDIS (Automated Direct Debit Instruction Service), users provide core reference.
  • For non AUDDIS, users provide core reference if possible, or last used reference.

Possible values: [Active, Inactive]

The status of the direct debit.

Possible values: non-empty and <= 70 characters

The name of service user.

The amount of the cash balance after a transaction entry is applied to the account.

Possible values: Value must match regular expression ^\d{1,13}\.\d{1,5}$

The amount of money.

Possible values: Value must match regular expression ^[A-Z]{3,3}$

ISO 4217 currency code in upper case.

Links relevant to the payload.

The absolute URI to the resource.

The absolute URI to the next pagination resource.

The absolute URI to the previous pagination resource.

Meta data relevant to the payload.

Used for pagination. Indicates how many pages of results are available.

Was this page helpful?
Loading...