Table of Contents |
---|
...
All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP, as this is part of formal consent from the PSU.
If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the domestic-payment-consent request immediately.
If the ASPSP establishes a problem with the domestic-payment-consent after the API call, the ASPSP must set the status of the domestic-payment-consent resource to Rejected.
DebtorAccount is optional, as the PISP may not know the account identification details for the PSU.
If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the domestic-payment-consent will be set to Rejected after PSU authentication.
Account Identification field usage:
Where "BH.OBF.SchemeNumSchemeName" is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount). Ex. the Identification populated with the combination of Code and Account Number.
Where the "BH.OBF.IBAN" is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN.
As a merchant may be initiating a payment via a PISP two identifiers are included in the payload:
InstructionIdentification is uniquely generated by the PISP. The expectation is that this is unique indefinitely across all time periods. The PISP can ensure that this is indefinitely unique by including a date or date-time element to the field, or by inserting a unique Id.
EndToEndIdentification is uniquely generated by the merchant.
Neither the InstructionIdentification nor EndToEndIdentification will be used as the domestic-payment-consent resource identifier (ConsentId) as the ConsentId must be uniquely generated by the ASPSP.
LocalInstrument is the requested payment scheme for execution.
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticPaymentConsentResponse |
| OBWriteDomesticPaymentConsentResponse |
| OBWriteDomesticPaymentConsentResponse |
|
|
Data | 1..1 | OBWriteDomesticPaymentConsentResponse/Data |
| OBWriteDomesticPaymentConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteDomesticPaymentConsentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteDomesticPaymentConsentResponse/Data/CreationDateTime | Date and time at which the resource was created | DateTime |
|
|
Status | 1..1 | OBWriteDomesticPaymentConsentResponse/Data/Status | Specifies the status of consent resource in code form | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteDomesticPaymentConsentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated | DateTime |
|
|
ReadRefundAccount | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/ReadRefundAccount | Specifies to share the refund account details with PISP | String | Enum:
|
|
CutOffDateTime | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/CutOffDateTime | Specified cut-off date and time for the payment consent | DateTime |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | DateTime |
|
|
Charges | 0..n | OBWriteDomesticPaymentConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBWriteDomesticPaymentConsentResponse/Data/Charges |
|
|
ChargeBearer | 0..n | OBWriteDomesticPaymentConsentResponse/Data/Charges/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | String | Enum:
|
|
Type | 0..n | OBWriteDomesticPaymentConsentResponse/Data/Charges/Type | This denotes the charge type in a coded form. | String | Enum : To be determined |
|
Amount | 1..1 | OBWriteDomesticPaymentConsentResponse/Data/Charges/Amount | Amount of money associated with the charge type.
| OBActiveOrHistoricCurrencyAndAmount |
|
|
Amount | 1..1 | OBWriteDomesticPaymentConsentResponse/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,5}$ |
Currency | 1..1 | OBWriteDomesticPaymentConsentResponse/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 | OBWriteDomesticPaymentConsentResponse/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 |
|
|
Authorisation | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/Authorisation | The authorisation request from the TPP. | OBWriteDomesticPaymentConsentResponse/Data/Authorisation |
|
|
AuthorisationType | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/Authorisation/AuthorisationType | The type of authorisation flow requested. | String | Enum:
|
|
CompletionDateTime | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/Authorisation/CompletionDateTime | The date and time at which the requested authorisation flow is completed. | DateTime |
|
|
SCASupportData | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData | Supporting Data provided by TPP, when requesting SCA Exemption. | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData |
|
|
RequestedSCAExemptionType | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData/RequestedSCAExemptionType | This field allows a PISP to request specific SCA Exemption for a Payment Initiation | String | Enum:
|
|
AppliedAuthenticationApproach | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData/AppliedAuthenticationApproach | This field indicates whether the PSU was subject to SCA performed by the TPP | String | Enum:
|
|
ReferencePaymentOrderId | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData/ReferencePaymentOrderId | 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 |
|
|
Risk | 1..1 | OBWriteDomesticPaymentConsentResponse/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 | OBWriteDomesticPaymentConsentResponse/Risk/PaymentContextCode | This field specifies the payment context
| String | Enum:
|
|
MerchantCategoryCode | 0..1 | OBWriteDomesticPaymentConsentResponse/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 | OBWriteDomesticPaymentConsentResponse/Risk/MerchantCustomerIdentification | The unique customer identifier of the PSU with the merchant.
| String |
|
|
DeliveryAddress | 1..1 | OBWriteDomesticPaymentConsentResponse/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, Country | OBWriteDomesticPaymentConsentResponse/Risk/DeliveryAddress |
|
|
...