S. No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Idempotency Key

Parameter

Request Object

Response Object

2.1

beneficiaries

GET

GET /accounts/{AccountId}/beneficiaries

Conditional

accounts

Authorisation Code

No

OBReadBeneficiary

2.2

beneficiaries

GET

GET /beneficiaries

Conditional

accounts

Authorisation Code

No

Pagination

OBReadBeneficiary

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBReadBeneficiary

OBReadBeneficiary

OBReadBeneficiary

Data

1..1

OBReadBeneficiary/Data

OBReadBeneficiary/Data

Beneficiary

0..n

OBReadBeneficiary/Data/Beneficiary

OBReadBeneficiary/Data/Beneficiary

AccountId

0..1

OBReadBeneficiary/Data/Beneficiary/AccountId

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

String

BeneficiaryId

0..1

OBReadBeneficiary/Data/Beneficiary/BeneficiaryId

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

String

BeneficiaryType

1..1

OBReadBeneficiary/Data/Beneficiary/BeneficiaryType

Specifies the Beneficiary Type.

String

Enum:

• Trusted

• Ordinary

Reference

0..1

OBReadBeneficiary/Data/Beneficiary/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

String

SupplementaryData

0..1

OBReadBeneficiary/Data/Beneficiary/SupplementaryData

Additional information that cannot be captured in the structured fields and/or any other specific block.

OBSupplementaryData

CreditorAgent

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.

OBReadBeneficiary/Data/Beneficiary/CreditorAgent

SchemeName

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

String

Enum:

• BH.OBF.BICFI

Identification

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/Identification

Unique and unambiguous identification of the servicing institution.

String

Name

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

String

PostalAddress

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress

AddressType

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

String

Enum:

• Business

• Correspondence

• DeliveryTo

• MailTo

• POBox

• Postal

• Residential

• Statement

Department

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

String

SubDepartment

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

String

AddressLine

0..7

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

String

StreetName

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

String

BuildingNumber

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

String

PostCode

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

String

TownName

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

String

CountrySubDivision

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, country.

String

Country

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/Country

Nation with its own government.

String

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

CreditorAccount

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAccount

Provides the details to identify the beneficiary account.

OBReadBeneficiary/Data/Beneficiary/CreditorAccount

SchemeName

1..1

OBReadBeneficiary/Data/Beneficiary/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentificationCode

Enum:

• BH.OBF.IBAN

Identification

1..1

OBReadBeneficiary/Data/Beneficiary/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

String

Name

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAccount/Name

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

String