| Table of Contents | ||||
|---|---|---|---|---|
|
...
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 | Enum:
|
|
AppliedAuthenticationApproach | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData/AppliedAuthenticationApproach | This field indicates whether the User/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 User/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 |
|
|
...
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 : 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,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 | Enum:
|
|
AppliedAuthenticationApproach | 0..1 | OBWriteDomesticPaymentConsentResponse/Data/SCASupportData/AppliedAuthenticationApproach | This field indicates whether the User/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 User/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 |
|
|
...
The swagger code for the Domestic Payment Consents API can be found on this link.
5. Usage Example
5.1 POST /domestic-payment-consents
...