S. No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Idempotency Key

Parameter

Request Object

Response Object

2.1

direct-debits

GET

GET /accounts/{AccountId}/direct-debits

Conditional

accounts

Authorisation Code

No

OBReadDirectDebit

2.2

direct-debits

GET

GET /direct-debits

Conditional

accounts

Authorisation Code

No

Pagination

OBReadDirectDebit

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBReadDirectDebit

OBReadDirectDebit

OBReadDirectDebit

Data

1..1

OBReadDirectDebit/Data

OBReadDirectDebit/Data

DirectDebit

0..n

OBReadDirectDebit/Data/DirectDebit

Account to or from which a cash entry is made.

OBReadDirectDebit/Data/DirectDebit

AccountId

1..1

OBReadDirectDebit/Data/DirectDebit/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

String

DirectDebitId

0..1

OBReadDirectDebit/Data/DirectDebit/DirectDebitId

A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.

String

MandateIdentification

0..1

OBReadDirectDebit/Data/DirectDebit/MandateIdentification

Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.

String

DirectDebitStatusCode

0..1

OBReadDirectDebit/Data/DirectDebit/DirectDebitStatusCode

Specifies the status of the direct debit in code form.

String

Enum:

• Active

• Inactive

Name

0..1

OBReadDirectDebit/Data/DirectDebit/Name

Name of Service User.

String

PreviousPaymentDateTime

0..1

OBReadDirectDebit/Data/DirectDebit/PreviousPaymentDateTime

Date of most recent direct debit collection.

DateTime

Frequency

0..1

OBReadDirectDebit/Data/DirectDebit/Frequency

Regularity with which direct debit instructions are to be created and processed

String

Enum:

• BH.OBF.Annual

• BH.OBF.Daily

• BH.OBF.Fortnightly

• BH.OBF.HalfYearly

• BH.OBF.Monthly

• BH.OBF.NotKnown

• BH.OBF.Quarterly

• BH.OBF.Weekly

PreviousPaymentAmount

0..1

OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount

The amount of the most recent direct debit collection.

OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount

Amount

0..1

OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

String

^\d{1,13}$\|^\d{1,13}\.\d{1,5}$

Currency

0..1

OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

String

^[A-Z]{3,3}$