...
POST /domestic-payments
GET /domestic-payments/{DomesticPaymentId}
3.3.1 UML Diagram
...
3.3.2 Notes
The domestic-payments response object contains the:
...
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:
|
|
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:
|
|
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:
|
|
Type | 0..n | OBWriteDomesticPaymentResponse/Data/Charges/Type | This denotes the charge type in a coded form. | String |
|
|
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 |
|
|
...
Name | Occurrence | XPath | Definition | Class | Codes | Pattern |
OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
|
|
Data | 1..1 | OBWritePaymentDetailsResponse/Data |
| OBWritePaymentDetailsResponse/Data |
|
|
PaymentStatus | 0..n | OBWritePaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetailsResponse/Data/PaymentStatus |
|
|
PaymentTransactionId | 1..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/PaymentTransactionId | Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
| String |
|
|
Status | 1..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/Status | Status of a transfer, as assigned by the transaction administrator.
| String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusUpdateDateTime | Date and time at which the status was assigned to the transfer. All dates in the JSON payloads are represented in ISO 8601 date-time format. | DateTime |
|
|
StatusDetail | 0..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail | Payment status details as per underlying Payment Rail.
| OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail |
|
|
LocalInstrument | 01..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/LocalInstrument | This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
| String | Enum:
|
|
Status | 1..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/Status | Status of a transfer, as assigned by the transaction administrator.
| String |
|
|
StatusReason
| 0..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/StatusReason
| Reason Code provided for the status of a transfer. | String | Enum:
|
|
StatusReasonDescription | 0..1 | OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/ StatusReasonDescription | Reason provided for the status of a transfer.
| String |
|
|
...