Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Occurrence

Xpath

Enhanced Definition

Class

Codes

Pattern

OBRisk

 

OBRisk

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments

OBRisk

 

 

PaymentContextCode

0..1

OBRisk/PaymentContextCode

Specifies the payment context

String

Enum:·  

  • BillPayment

·  
  • EcommerceGoods

·  
  • EcommerceServices

·  
  • Other

·  
  • PartyToParty

 

MerchantCategoryCode

0..1

OBRisk/MerchantCategoryCode

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction

String

 

 

MerchantCustomerIdentification

0..1

OBRisk/MerchantCustomerIdentification

The unique customer identifier of the user/customer with the merchant

String

 

 

DeliveryAddress

0..1

OBRisk/DeliveryAddress

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

OBRisk/DeliveryAddress

 

 

AddressLine

0..7

OBRisk/DeliveryAddress/AddressLine

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

String

 

 

StreetName

0..1

OBRisk/DeliveryAddress/StreetName

Name of a street or thoroughfare

String

 

 

BuildingNumber

0..1

OBRisk/DeliveryAddress/BuildingNumber


Number that identifies the position of a building on a street

String

 

 

PostCode

0..1

OBRisk/DeliveryAddress/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

OBRisk/DeliveryAddress/TownName

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

String

 

 

CountrySubDivision

0..1

OBRisk/DeliveryAddress/CountrySubDivision


Identifies a subdivision of a country, for instance state, region

String

 

 

Country

0..1


OBRisk/DeliveryAddress/Country


Nation with its own government, occupying a particular territory

String

 


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

...

Name

Occurrence

Xpath

Enhanced Definition

Class

Codes

Pattern

OBCharge

 

OBCharge

Set of elements used to provide details of a charge for the payment initiation

OBCharge

 

 

ChargeBearer

1..1

OBCharge/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment transaction

String

Enum:·  

  • BorneByCreditor

·  
  • BorneByDebtor

·  
  • FollowingServiceLevel

·  
  • Shared

 

Type

1..1

OBCharge/Type

Charge type, in a coded form

String

Enum:·  

  • BH.OBF.DNS

·  
  • BH.OBF.NRT

·  
  • BH.OBF.BIL

 

Amount

1..1

OBCharge/Amount

Amount of money associated with the charge type

OBActiveOrHistoricCurrencyAndAmount

 

 

Amount

1..1

OBCharge/Amount/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

1..1

OBCharge/Amount/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}$

...

Name

Occurrence

Xpath

Enhanced Definition

Class

Codes

Pattern

OBDomesticRefundAccount

1..1

OBDomesticRefundAccount

Unambiguous identification of the refund account to which a refund will be made as a result of the transaction

OBDomesticRefundAccount

 

 

Account

1..1

OBDomesticRefundAccount/Account

Provides the details to identify an account

OBDomesticRefundAccount/Account

 

 

SchemeName

1..1

OBDomesticRefundAccount/Account/SchemeName

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

String

Enum:

 

·  
  • BH.OBF. IBAN

·  
  • BH.OBF.PAN

 

 

Identification

1..1

OBDomesticRefundAccount/Account/Identification

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

String

 

 

Name

0..1

OBDomesticRefundAccount/Account/Name

Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account

String

 

 

...

Name

Occurrence

Xpath

Enhanced Definition

Class

Codes

Pattern

OBWritePaymentDetails

1..1

OBWritePaymentDetails

Payment status details

OBWritePaymentDetails

 

 

PaymentTransactionId

1..1

OBWritePaymentDetails/PaymentTransactionId

Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable

String

 

 

Status

1..1

OBWritePaymentDetails/Status

Status of a transfer, as assigned by the transaction administrator

String

Enum:·  

  • Accepted

·  
  • AcceptedCancellationRequest

·  
  • AcceptedCreditSettlementCompleted

·  
  • AcceptedCustomerProfile

·  
  • AcceptedFundsChecked

·  
  • AcceptedSettlementCompleted

·  
  • AcceptedSettlementInProcess

·  
  • AcceptedTechnicalValidation

·  
  • AcceptedWithChange

·  
  • AcceptedWithoutPosting

·  
  • Cancelled

·  
  • NoCancellationProcess

·  
  • PartiallyAcceptedCancellationRequest

·  
  • PartiallyAcceptedTechnicalCorrect

·  
  • PaymentCancelled

·  
  • Pending

·  
  • PendingCancellationRequest

·  
  • Received

·  
  • Rejected

·  
  • RejectedCancellationRequest

 

StatusUpdateDateTime

1..1


OBWritePaymentDetails/StatusUpdateDateTime

Date and time at which the status was assigned to the transfer

DateTime

 

 

StatusDetail

0..1

OBWritePaymentDetails/StatusDetail

Payment status details as per underlying Payment Rail

OBWritePaymentDetails/StatusDetail

 

 

LocalInstrument

1..1


OBWritePaymentDetails/StatusDetail/LocalInstrument

User community specific instrument

Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level

String

Enum:·  

  • BH.OBF.DNS

·  
  • BH.OBF.NRT

·  
  • BH.OBF.BIL

 

Status

1..1

OBWritePaymentDetails/StatusDetail/Status

Status of a transfer, as assigned by the transaction administrator

String

 

 

StatusReason

0..1

OBWritePaymentDetails/StatusDetail/StatusReason


Reason Code provided for the status of a transfer

String

Enum:·  

  • Cancelled

·  
  • PendingFailingSettlement

·  
  • PendingSettlement

·  
  • Proprietary

·  
  • ProprietaryRejection

·  
  • Suspended

·  
  • Unmatched

 

StatusReasonDescription

0..1

OBWritePaymentDetails/StatusDetail/StatusReasonDescription

Reason provided for the status of a transfer

String

 

 

...

Name

Occurrence

Xpath

Enhanced Definition

Class

Codes

Pattern

OBSCASupportData

 

SCASupportData

Supporting Data provided by PISP, when requesting SCA Exemption

OBSCASupportData

 

 

RequestedSCAExemptionType

0..1

SCASupportData/RequestedSCAExemptionType

This field allows a PISP to request specific SCA Exemption for a Payment Initiation

String

 

Enum:

 

This field is under discussion with the CBB, will be finalised in the next version

 

AppliedAuthenticationApproach

0..1

SCASupportData/AppliedAuthenticationApproach

Specifies a character string with a maximum length of 40 characters

Usage: This field indicates whether the user/customer was subject to SCA performed by the PISP

String

Enum:·  

  • CA

·  
  • SCA

 

ReferencePaymentOrderId

0..1

SCASupportData/ReferencePaymentOrderId

Specifies a character string with a maximum length of 140 characters

Usage: If the payment is recurring, then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence

String

 

 

...

Generated

Identifier

Business Description

Merchant/PISP Sent in API Payload

EndToEndIdentification

The EndToEndIdentification reference is a reference that can be populated by the debtor (or merchant in the ecommerce space). This reference is important to the debtor (could be an internal reference Id against the transaction), it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary)

Merchant/PISP Sent in API Payload

InstructionIdentification

The PISP generates the InstructionIdentification which is a unique transaction Id and passes it to the ASPSP (this is mandatory), but this does not have to go any further in the payment flow. The flow of this identifier needs to align with payment scheme rules

The expectation is that this is unique indefinitely across all time periods. The PISP can ensure this is indefinitely unique by including a date or date time element to the field, or by inserting a unique Id

Merchant/PISP Sent in API Payload

RemittanceInformation

The RemittanceInformation is the reference information that the creditor (or beneficiary) will need to reconcile (e.g. Invoice 123)

ASPSP / API System

ConsentId

A unique identification as assigned by the ASPSP to uniquely identify the payment-order consent resource

ASPSP / API System

Payment Order Id

A unique identification as assigned by the ASPSP to uniquely identify the payment-order resource.·   

  • DomesticPaymentId

·   
  • DomesticFutureDatedPaymentId

·   
  • InternationalPaymentId

.
  • FilePaymentId

ASPSP / Payment Scheme

Scheme Payment ID

This is generated by the ASPSP to uniquely identify a payment through a processing scheme

...