| Table of Contents | ||||
|---|---|---|---|---|
|
1. Overview
The Domestic Payments Consent resource is used by a PISP to register an intent to initiate a Domestic Payment.
This resource description should be read in conjunction with a Payment Initiation API Profile.
2. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | domestic-payment-consents | POST | POST /domestic-payment-consents | Mandatory | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteDomesticPaymentConsentRequest | OBWriteDomesticPaymentConsentResponse |
2.2 | domestic-payment-consents | GET | GET /domestic-payment-consents/{ConsentId} | Mandatory | payments | Client Credentials | Signed Response | No | NA | OBWriteDomesticPaymentConsentResponse |
2.3 | domestic-payment-consents | GET | GET /domestic-payment-consents/{ConsentId}/funds-confirmation | Mandatory | payments | Authorisation Code | Signed Response | No | NA | OBWriteFundsConfirmationResponse |
2.
...
1 POST /domestic-payment-consents
The API endpoint allows the PISP to ask an ASPSP to create a new domestic-payment-consent resource.
...
S.No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting PSU authorisation |
2.
...
2 GET /domestic-payment-consents/ {ConsentId}
A PISP can retrieve a payment consent resource that they have created to check its status.
...
S.No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting PSU 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 |
2.
...
3 GET / domestic-payment-consents/{ConsentId}/funds-confirmation
The API endpoint allows the PISP to ask an ASPSP to confirm funds on a domestic-payment-consent resource.
An ASPSP can only respond to a funds confirmation request if the domestic-payment-consent resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and a BH.OBF.Resource.InvalidConsentStatus error code.
Confirmation of funds requests do not affect the status of the domestic-payment-consent resource".
2.4
...
State Model
2.4.1 Payment Order Consent
The state model for the domestic-payment-consent resource follows the generic consent state model. However, does not use the Revoked status, as the consent for a domestic-payment is not a long-lived consent.
...
3. Data Models
The data dictionary section gives the detail on the payload content for the Domestic Payment API flows
Reused Classes
3.
...
1 OBDomesticPaymentInitiation
This section describes the OBDomesticPaymentInitiation class which is reused as the Initiation object in the domestic-payment-consent resource
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBDomesticPaymentInitiation |
| OBDomesticPaymentInitiation | 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 |
|
|
InstructionIdentification | 1..1 | OBDomesticPaymentInitiation/InstructionIdentification | Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. | String |
|
|
EndToEndIdentification | 1..1 | OBDomesticPaymentInitiation/EndToEndIdentification | Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. | String |
|
|
LocalInstrument | 0..1 | OBDomesticPaymentInitiation/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:
|
|
InstructedAmount | 1..1 | OBDomesticPaymentInitiation/InstructedAmount | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain. | OBDomesticPaymentInitiation/InstructedAmount |
|
|
Amount | 1..1 | OBDomesticPaymentInitiation/InstructedAmount/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 | OBDomesticPaymentInitiation/InstructedAmount/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}$ |
DebtorAccount | 0..1 | OBDomesticPaymentInitiation/DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. | OBDomesticPaymentInitiation/DebtorAccount |
|
|
SchemeName | 1..1 | OBDomesticPaymentInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBDomesticPaymentInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBDomesticPaymentInitiation/DebtorAccount/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. Note: the account name is not the product name or the nickname of the account. | String |
|
|
CreditorAccount | 1..1 | OBDomesticPaymentInitiation/CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction | OBDomesticPaymentInitiation/CreditorAccount |
|
|
SchemeName | 1..1 | OBDomesticPaymentInitiation/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBDomesticPaymentInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBDomesticPaymentInitiation/CreditorAccount/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 |
|
|
CreditorPostalAddress | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress |
|
|
AddressType | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum:
|
|
Department | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBDomesticPaymentInitiation/CreditorPostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String | ||
StreetName | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/StreetName | Name of a street or thoroughfare. | String |
|
|
BuildingNumber | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
|
PostCode | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/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 | OBDomesticPaymentInitiation/CreditorPostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, and country. | String |
|
|
Country | 0..1 | OBDomesticPaymentInitiation/CreditorPostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2} $ |
RemittanceInformation | 0..1 | OBDomesticPaymentInitiation/RemittanceInformation | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system | OBDomesticPaymentInitiation/RemittanceInformation |
|
|
RemittanceDescription | 0..1 | OBDomesticPaymentInitiation/RemittanceInformation/RemittanceDescription | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. | String |
|
|
Reference | 0..1 | OBDomesticPaymentInitiation/RemittanceInformation/Reference | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. | String |
|
|
SupplementaryData | 0..1 | OBDomesticPaymentInitiation/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
3.
...
2 Domestic Payment Consent - Request
The OBWriteDomesticPaymentConsentRequest object will be used for the call to:
...
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 TPP. | 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 is completed. | DateTime |
|
|
SCASupportData | 0..1 | OBWriteDomesticPaymentConsentRequest/Data/SCASupportData | Supporting Data provided by TPP, 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 PSU was subject to SCA performed by the TPP | 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 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 PSU 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, Country | OBWriteDomesticPaymentConsentRequest/Risk/DeliveryAddress |
|
|
3.
...
3 Domestic Payment Consent - Response
The OBWriteDomesticPaymentConsentResponse object will be used for a response to a call to:
...
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,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 |
|
|
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 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, Country | OBWriteDomesticPaymentConsentResponse/Risk/DeliveryAddress |
|
|
3.
...
4 Domestic Payment Consent Confirmation of Funds - Response
The OBWriteFundsConfirmationResponse object will be used for a response to a call to:
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteFundsConfirmationResponse |
| OBWriteFundsConfirmationResponse |
| OBWriteFundsConfirmationResponse |
|
|
Data | 1..1 | OBWriteFundsConfirmationResponse/Data |
| OBWriteFundsConfirmationResponse/Data |
|
|
FundsAvailableResult | 0..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult | Result of a funds availability check. | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult |
|
|
FundsAvailableDateTime | 1..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult/FundsAvailableDateTime | Date and time at which the funds availability check was generated. | DateTime |
|
|
FundsAvailable | 1..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult/FundsAvailable | Flag to indicate the availability of funds given the Amount in the consent request. | xs:boolean |
|
|
SupplementaryData | 0..1 | OBWriteFundsConfirmationResponse/Data/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
4. Usage Example
4.
...
1 POST /domestic-payment-consents
4.1.1 Request
|
...
|
4.
...
2 GET /domestic-payment-consents/{ConsentId}
4.2.1 Request
|
...