Versions Compared

Key

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

...

  • This is done by making a POST request to the domestic-payments endpoint

  • This request is an instruction to the ASPSP (Bank) to begin the domestic single immediate payment journey. The domestic payment must be submitted immediately, however, there are some scenarios where the domestic payment may not be executed immediately (e.g., busy periods at the ASPSP)

  • The PISP must ensure that the Initiation and Risk sections of the domestic-payments match the corresponding Initiation and Risk sections of the domestic-payment-consents resource. If the two do not match, the ASPSP (Bank) must not process the request and must respond with a 400 (Bad Request)

...

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticPaymentRequest

 

OBWriteDomesticPaymentRequest

 

OBWriteDomesticPaymentRequest

 

 

Data

1..1

OBWriteDomesticPaymentRequest/Data

 

OBWriteDomesticPaymentRequest/Data

 

 

ConsentId

1..1

OBWriteDomesticPaymentRequest/Data/ConsentId

Unique identification as assigned by the ASPSP (Bank) to uniquely identify the consent resource.

String

 

 

Initiation

1..1

OBWriteDomesticPaymentRequest/Data/Initiation

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a Single Domestic Payment.

OBDomesticPaymentInitiation

 

 

Risk

1..1

OBWriteDomesticPaymentRequest/Risk

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

OBWriteDomesticPaymentRequest/Risk/PaymentContextCode

This field specifies the payment context.

String

Enum:

  • BillPayment

  • EcommerceGoods

  • EcommerceServices

  • Other

  • PartyToParty

 

MerchantCategoryCode

0..1

OBWriteDomesticPaymentRequest/Risk/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

OBWriteDomesticPaymentRequest/Risk/MerchantCustomerIdentification

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

 

String

 

 

DeliveryAddress

0..1

OBWriteDomesticPaymentRequest/Risk/DeliveryAddress

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

It will contain AddressLine, StreetName, BuildingNumber, PostCode, TownName, CountrySubDivision and Country.

OBWriteDomesticPaymentRequest/Risk/DeliveryAddress

 

 

...

  • DomesticPaymentId

  • ConsentId

  • CreationDateTime the domestic-payments resource was created

  • Status and StatusUpdateDateTime of the domestic-payments resource

  • ExpectedExecutionDateTime for the domestic-payments resource

  • ExpectedSettlementDateTime for the domestic-payments resource

  • Refund account details, if requested by PISP as part of the domestic-payment-consents resource

  • Charges array for the breakdown of applicable ASPSP (Bank) charges

  • The Initiation object from the domestic-payment-consents

  • An ASPSP (Bank) should conditionally provide Debtor/Name in the Payment Order Response, even when the Payer did not provide the Debtor Account via PISP

...

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticPaymentResponse

 

OBWriteDomesticPaymentResponse

 

OBWriteDomesticPaymentResponse

 

 

Data

1..1

OBWriteDomesticPaymentResponse/Data

 

OBWriteDomesticPaymentResponse/Data

 

 

DomesticPaymentId

1..1

OBWriteDomesticPaymentResponse/Data/DomesticPaymentId

Unique identification as assigned by the ASPSP (Bank) to uniquely identify the domestic payment resource.

String

 

 

ConsentId

1..1

OBWriteDomesticPaymentResponse/Data/ConsentId

Unique identification as assigned by the ASPSP (Bank) to uniquely identify the consent resource.

String

 

 

CreationDateTime

1..1

OBWriteDomesticPaymentResponse/Data/CreationDateTime

Date and time at which the message was created.

DateTime

 

 

Status

1..1

OBWriteDomesticPaymentResponse/Data/Status

Specifies the status of the payment information group.

String

Enum:

  • AcceptedCreditSettlementCompleted

  • AcceptedWithoutPosting

  • AcceptedSettlementCompleted

  • AcceptedSettlementInProcess

  • Pending

  • Rejected

 

StatusUpdateDateTime

1..1

OBWriteDomesticPaymentResponse/Data/StatusUpdateDateTime

Date and time at which the resource status was updated.

DateTime

 

 

ExpectedExecutionDateTime

0..1

OBWriteDomesticPaymentResponse/Data/ExpectedExecutionDateTime

Expected execution date and time for the payment resource.

DateTime

 

 

ExpectedSettlementDateTime

0..1

OBWriteDomesticPaymentResponse/Data/ExpectedSettlementDateTime

Expected settlement date and time for the payment resource.

DateTime

 

 

Refund

0..1

OBWriteDomesticPaymentResponse/Data/Refund

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

OBWriteDomesticPaymentResponse/Data/Refund

 

 

Account

1..1

OBWriteDomesticPaymentResponse/Data/Refund/Account

Provides the details to identify an account.

 

 

OBWriteDomesticPaymentResponse/Data/Refund/Account

 

 

SchemeName

1..1

OBWriteDomesticPaymentResponse/Data/Refund/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

OBWriteDomesticPaymentResponse/Data/Refund/Account//Identification

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

String

 

 

Name

0..1

OBWriteDomesticPaymentResponse/Data/Refund/Account/Name

The account name is the name or names of the account owner(s) represented at an account level.

 

Note: The account name is not the product name or the nickname of the account.

 

String

 

 

Charges

0..n

OBWriteDomesticPaymentResponse/Data/Charges

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

OBWriteDomesticPaymentResponse/Data/Charges

 

 

ChargeBearer

0..n

OBWriteDomesticPaymentResponse/Data/Charges/ChargeBearer

It specifies which party/parties will bear the charges associated with the processing of the payment transaction.

String

Enum:

  • BorneByCreditor

  • BorneByDebtor

  • FollowingServiceLevel

  • Shared

 

Type

0..n

OBWriteDomesticPaymentResponse/Data/Charges/Type

This denotes the charge type in a coded form.

String

  • BH.OBF.DNS

  • BH.OBF.NRT

  • BH.OBF.BIL

 

Amount

1..1

OBWriteDomesticPaymentResponse/Data/Charges/Amount

Amount of money associated with the charge type.

 

OBActiveOrHistoricCurrencyAndAmount

 

 

 

Amount

1..1

OBWriteDomesticPaymentResponse/Data/Charges/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

OBWriteDomesticPaymentResponse/Data/Charges/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}$

Initiation

1..1

OBWriteDomesticPaymentResponse/Data/Initiation

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a Single Domestic Payment.

OBDomesticPaymentInitiation

 

 

Debtor

0..1

OBWriteDomesticPaymentResponse/Data/Debtor

Set of elements used to identify a person or an organization.

OBWriteDomesticPaymentResponse/Data/Debtor

 

 

Name

1..1

OBWriteDomesticPaymentResponse/Data/Debtor/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.

String

 

 

...