...
The POST action indicates to the ASPSP (Bank) that a domestic payment consents has been staged. At this point, the Useruser/Customer customer may not have been identified by the ASPSP (Bank), and the request payload may not contain any information of the account that should be debited
The endpoint allows the PISP to send a copy of the consent (between Useruser/Customer customer and PISP) to the ASPSP (Bank) for the Useruser/Customer customer to authorise
The ASPSP (Bank) creates the domestic-payment-consents resource and responds with a unique ConsentId to refer to the resource.
...
S.No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting Useruser/Customer customer authorisation. |
2.2 GET /domestic-payment-consents/ {ConsentId}
A PISP can retrieve a payment consents resource that they have created to check its status.
Once the Useruser/Customer customer authorises the payment-consents resource - the status of the payment-consents resource will be updated with "Authorised"
If the Useruser/Customer customer rejects the consent or the domestic-payment-consents has failed some other ASPSP (Bank) validation, the Status will be set to "Rejected"
Once a domestic-payments has been successfully created using the domestic-payment-consents, the Status of the domestic-payment-consents will be set to "Consumed"
...
S.No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting Useruser/Customer customer authorisation. |
2 | Rejected | The consent resource has been rejected. |
3 | Authorised | The consent resource has been successfully authorised. |
4 | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action. |
...
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 Useruser/Customercustomer
If the ASPSP (Bank) is able to establish a problem with payload or any contextual error during the API call, the ASPSP (Bank) must reject the domestic-payment-consents request immediately
If the ASPSP (Bank) establishes a problem with the domestic-payment-consents after the API call, the ASPSP (Bank) must set the status of the domestic-payment-consents resource to Rejected
DebtorAccount is optional, as the PISP may not know the account identification details for the Useruser/Customercustomer
If the DebtorAccount is specified by the PISP and is invalid for the Useruser/Customercustomer, then the domestic-payment-consents will be set to Rejected after Useruser/Customer customer authentication
Account Identification field usage:
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
Where the “BH.OBF.PAN” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the identification field must be populated with the full Primary Account Number - identifier scheme used to identify a card account
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-consents 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 |
OBWriteDomesticPaymentConsentRequest |
| OBWriteDomesticPaymentConsentRequest |
| OBWriteDomesticPaymentConsentRequest |
|
|
Data | 1..1 | OBWriteDomesticPaymentConsentRequest/Data |
| OBWriteDomesticPaymentConsentRequest/Data |
|
|
ReadRefundAccount | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/ReadRefundAccount | Specifies to share the refund account details with PISP. | String | Enum:
|
|
Initiation | 1..1 | OBWriteDomesticPaymentConsentRequest/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 | OBWriteDomesticPaymentConsentRequest/Data/Authorisation | The authorisation request from the PISP. | OBWriteDomesticPaymentConsentRequest/Data/Authorisation |
|
|
AuthorisationType | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/Authorisation/AuthorisationType | The type of authorisation flow requested. | String | Enum:
|
|
CompletionDateTime | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/Authorisation/CompletionDateTime | The date and time at which the requested authorisation flow must be completed. | DateTime |
|
|
SCASupportData | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData |
|
|
RequestedSCAExemptionType | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData/RequestedSCAExemptionType | This field allows a PISP to request specific SCA Exemption for a Payment Initiation. | String |
| |
AppliedAuthenticationApproach | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData/AppliedAuthenticationApproach | This field indicates whether the Useruser/Customer customer was subject to SCA performed by the PISP. | String | Enum:
|
|
ReferencePaymentOrderId | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData/ReferencePaymentOrderId | If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP (Bank) can verify that the PISP, amount and the payee are the same as the previous occurrence. | String |
|
|
Risk | 1..1 | OBWriteDomesticPaymentConsentRequest/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 | OBWriteDomesticPaymentConsentRequest/Risk/PaymentContextCode | This field specifies the payment context.
| String | Enum:
|
|
MerchantCategoryCode | 0.1 | OBWriteDomesticPaymentConsentRequest/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 | OBWriteDomesticPaymentConsentRequest/Risk/MerchantCustomerIdentification | The unique customer identifier of the Useruser/Customer customer with the merchant.
| String |
|
|
DeliveryAddress | 1..1 | OBWriteDomesticPaymentConsentRequest/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. | OBWriteDomesticPaymentConsentRequest/Risk/DeliveryAddress |
|
|
...
ConsentId
CreationDateTime the domestic-payment-consents resource was created.
Status and StatusUpdateDateTime of the domestic-payment-consents resource.
CutOffDateTime Behaviour is explained in Payment Initiation API Profile, Section - Payment Restrictions -> CutOffDateTime Behaviour
ExpectedExecutionDateTime for the domestic-payments resource if created before CutOffDateTime - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP (Bank) must update the value with any changes (e.g., after Useruser/Customer customer authorisation)
ExpectedSettlementDateTime for the domestic-payments resource if created before CutOffDateTime - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP (Bank) must update the value with any changes (e.g., after Useruser/Customer customer authorisation)
Charges array for the breakdown of applicable ASPSP (Bank) charges
Post successful Useruser/Customer customer Authentication, an ASPSP (Bank) may provide Debtor/Name in the Payment Order Consent Response, even when the Payer didn't provide the Debtor Account via PISP
...
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 (Bank) 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 :
|
|
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,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 PISP. | 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 PISP, 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 |
|
|
AppliedAuthenticationApproach | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData/AppliedAuthenticationApproach | This field indicates whether the Useruser/Customer customer was subject to SCA performed by the PISP. | 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 (Bank) 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 Useruser/Customer customer with the merchant.
| String |
|
|
Debtor | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/Debtor | Set of elements used to identify a person or an organisation. | OBWriteDomesticPaymentConsentResponse/Data/Debtor |
| |
Name | 1..1 | OBWriteDomesticPaymentConsentResponse/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 (Bank’s) online channels. Note: The account name is not the product name or the nickname of the account. | 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 and Country. | OBWriteDomesticPaymentConsentResponse/Risk/DeliveryAddress |
|
|
...