# # Domestic Payments - v4.0-draft1

- Overview
- Endpoints
  - POST /domestic-payments
  - GET /domestic-payments/{DomesticPaymentId}
    - StatusCode
  - GET /domestic-payments/{DomesticPaymentId}/payment-details
    - StatusCode
  - State Model
    - Payment Order
      - Multiple Authorisation
- Data Model
  - Reused Classes
    - OBDomestic2
    - OBRemittanceInformation1
    - OBRegulatoryReporting1
  - Domestic Payment - Request
    - UML Diagram
    - Notes
    - Data Dictionary
  - Domestic Payment - Response
    - UML Diagram
    - Notes
    - Data Dictionary
  - Domestic Payment Order - Payment Details - Response
    - UML Diagram
    - Data Dictionary
- Usage Examples
  - POST /domestic-payments
    - Request
    - Response
  - GET /domestic-payments/{DomesticPaymentId}
    - Request
    - Response

## # Overview

The Domestic Payments resource is used by a PISP to initiate a Domestic Payment.

This resource description should be read in conjunction with a compatible Payment Initiation API Profile.

## # Endpoints

Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
domestic-payments | POST | POST /domestic-payments | Mandatory | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteDomestic2 | OBWriteDomesticResponse5
domestic-payments | GET | GET /domestic-payments/{DomesticPaymentId} | Mandatory | payments | Client Credentials | Signed Response | No | NA | OBWriteDomesticResponse5
payment-details | GET | GET /domestic-payments/{DomesticPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | NA | OBWritePaymentDetailsResponse1

### # POST /domestic-payments

Once the domestic-payment-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-payment for processing:

- This is done by making a POST request to the domestic-payments endpoint.
- This request is an instruction to the ASPSP to begin the domestic single immediate payment journey. The domestic payment must be submitted immediately, however, there are some scenarios where the domestic payment may not be executed immediately (e.g., busy periods at the ASPSP).
- The PISP must ensure that the Initiation and Risk sections of the domestic-payment match the corresponding Initiation and Risk sections of the domestic-payment-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).
- Any operations on the domestic-payment resource will not result in a status change for the domestic-payment resource.

#### # StatusCode

A domestic-payment can only be created if its corresponding domestic-payment-consent resource has the StatusCode of "AUTH".

The domestic-payment resource that is created successfully must have one of the following initial PaymentStatusCode code-set enumerations:

StatusCode
RCVD
RJCT
RCVD

### # GET /domestic-payments/{DomesticPaymentId}

A PISP can retrieve the domestic-payment to check its status.

#### # StatusCode

The domestic-payment resource must have one of the following ExternalPaymentTransactionStatus1Code code-set enumerations (for more information see `ExternalPaymentTransactionStatus1Code` here
(opens new window)) :

StatusCode
RCVD
PDNG
ACTC
PATC
ACCP
ACFC
ACSP
ACWC
ACSC
ACWP
ACCC
BLCK
RJCT
RCVD

### # GET /domestic-payments/{DomesticPaymentId}/payment-details

A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.

#### # StatusCode

The domestic-payment - payment-details must have one of the following ExternalPaymentTransactionStatus1Code code-set enumerations (for more information see `ExternalPaymentTransactionStatus1Code` here
(opens new window)) :

StatusCode
RCVD
PDNG
ACTC
PATC
ACCP
ACFC
ACSP
ACWC
ACSC
ACWP
ACCC
BLCK
RJCT
RCVD

Refer to External_Internal_CodeSets
(opens new window) -> ISO_External_CodeSet -> `ExternalPaymentTransactionStatus1Code`.

### # State Model

#### # Payment Order

The state model for the domestic-payment resource follows the behaviour and definitions for the ISO 20022 PaymentStatusCode code-set.

Payment order state model key:

Colour (Style) | Description
--- | ---
Green (Bold) | Mandatory
Orange (Italic) | Optional, but recommended

##### # Multiple Authorisation

If the payment-order requires multiple authorisations the status of the multiple authorisations will be updated in the MultiAuthorisation object.

Once the payment is RCVD, the payment-order StatusCode must be set to PATC and the MultiAuthorisation object status updated with the AWAF status. Once all authorisations have been successfully completed the MultiAuthorisation status must be set to AUTH and payment-order StatusCode updated to ACSP if any intermediate status are not supported.

Any rejections in the multiple authorisation process should result in the MultiAuthorisation status and StatusCode being set to RJCT.

| Status | Status Description
--- | --- | ---
1 | AWAF | The consent resource is awaiting further authorisation.
2 | RJCT | The consent resource has been rejected.
3 | AUTH | The consent resource has been successfully authorised.

Refer to External_Internal_CodeSets
(opens new window) -> OB_Internal_CodeSet -> `OBInternalStatus2Code`.

## # Data Model

The data dictionary section gives the detail on the payload content for the Domestic Payment API flows.

### # Reused Classes

#### # OBDomestic2

The OBDomestic2 class is defined in the domestic-payment-consents page.

#### # OBRemittanceInformation1

The OBRemittanceInformation1 class is defined in the payment-initiation-api-profile page.

#### # OBRegulatoryReporting1

The OBRegulatoryReporting1 class is defined in the payment-initiation-api-profile page.

### # Domestic Payment - Request

The OBWriteDomestic2 object will be used for a call to:

- POST /domestic-payments

#### # UML Diagram

#### # Notes

The domestic-payment request object contains the:

- ConsentId.
- The full Initiation and Risk objects from the domestic-payment-consent request.

The Initiation and Risk sections of the domestic-payment request must match the Initiation and Risk sections of the corresponding domestic-payment-consent request.

#### # Data Dictionary

Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern
--- | --- | --- | --- | --- | --- | ---
OBWriteDomestic2 |  | OBWriteDomestic2 |  | OBWriteDomestic2 |  |
Data | 1..1 | OBWriteDomestic2/Data |  | OBWriteDataDomestic2 |  |
ConsentId | 1..1 | OBWriteDomestic2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text |  |
Initiation | 1..1 | OBWriteDomestic2/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. | OBDomestic2 |  |
Risk | 1..1 | OBWriteDomestic2/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. | OBRisk1 |  |

### # Domestic Payment - Response

The OBWriteDomesticResponse5 object will be used for a response to a call to:

- POST /domestic-payments
- GET /domestic-payments/{DomesticPaymentId}

#### # UML Diagram

#### # Notes

The domestic-payment response object contains the:

- DomesticPaymentId.
- ConsentId.
- CreationDateTime the domestic-payment resource was created.
- StatusCode and StatusUpdateDateTime of the domestic-payment resource.
- ExpectedExecutionDateTime for the domestic-payment resource.
- ExpectedSettlementDateTime for the domestic-payment resource.
- Refund account details, if requested by PISP as part of the domestic-payment-consents resource.
- Charges array for the breakdown of applicable ASPSP charges.
- The Initiation object from the domestic-payment-consent.
- The MultiAuthorisation object if the domestic-payment resource requires multiple authorisations.
- An ASPSP should conditionally provide `Debtor/Name` in the Payment Order Response, even when the Payer didn't provide the Debtor Account via PISP.

#### # Data Dictionary

Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern
--- | --- | --- | --- | --- | --- | ---
OBWriteDomesticResponse5 |  | OBWriteDomesticResponse5 |  | OBWriteDomesticResponse5 |  |
Data | 1..1 | OBWriteDomesticResponse5/Data |  | OBWriteDataDomesticResponse5 |  |
DomesticPaymentId | 1..1 | OBWriteDomesticResponse5/Data/DomesticPaymentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource. | Max40Text |  |
ConsentId | 1..1 | OBWriteDomesticResponse5/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text |  |
CreationDateTime | 1..1 | OBWriteDomesticResponse5/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime |  |
StatusCode | 1..1 | OBWriteDomesticResponse5/Data/StatusCode | Specifies the status of the payment information group. | OBTransactionIndividualStatus1Code | PDNG ACTC PATC ACCP ACFC ACSP ACWC ACSC ACWP ACCC BLCK RJCT |
StatusUpdateDateTime | 1..1 | OBWriteDomesticResponse5/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime |  |
StatusReason | 0..* | OBWriteDomesticResponse5/Data/StatusReason | An array of StatusReasonCode | OBStatusReason |  |
StatusReasonCode | 0..1 | OBWriteDomesticResponse5/Data/StatusReason/StatusReasonCode | Specifies the status reason in a code form. For a full description see `ExternalStatusReason1Code` here (opens new window). | ExternalStatusReason1Code |  |
StatusReasonDescription | 0..1 | OBWriteDomesticResponse5/Data/StatusReason/StatusReasonDescription | Description supporting the StatusReasonCode. | Max500Text |  |
Path | 0..1 | OBWriteDomesticResponse5/Data/StatusReason/Path | Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path. | Max500Text |  |
ExpectedExecutionDateTime | 0..1 | OBWriteDomesticResponse5/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | ISODateTime |  |
ExpectedSettlementDateTime | 0..1 | OBWriteDomesticResponse5/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | ISODateTime |  |
Refund | 0..1 | OBWriteDomesticResponse5/Data/Refund | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. | OBDomesticRefundAccount1 |  |
Charges | 0..n | OBWriteDomesticResponse5/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge2 |  |
Initiation | 1..1 | OBWriteDomesticResponse5/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. | OBDomestic2 |  |
MultiAuthorisation | 0..1 | OBWriteDomesticResponse5/Data/MultiAuthorisation | The multiple authorisation flow response from the ASPSP. | OBMultiAuthorisation1 |  |
Debtor | 0..1 | OBWriteDomesticResponse5/Data/Debtor | Set of elements used to identify a person or an organisation. | OBCashAccountDebtor4 |  |

### # Domestic Payment Order - Payment Details - Response

The OBWritePaymentDetailsResponse1 object will be used for a response to a call to:

- GET /domestic-payments/{DomesticPaymentId}/payment-details

#### # UML Diagram

#### # Data Dictionary

Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern
--- | --- | --- | --- | --- | --- | ---
OBWritePaymentDetailsResponse1 |  | OBWritePaymentDetailsResponse1 |  | OBWritePaymentDetailsResponse1 |  |
Data | 1..1 | OBWritePaymentDetailsResponse1/Data |  | OBWriteDataPaymentOrderStatusResponse1 |  |
StatusDetail | 0..* | OBWritePaymentDetailsResponse1/Data/StatusDetail | An array of Payment status details. | Array |  |

## # Usage Examples

Note, further usage examples are available here.

### # POST /domestic-payments

#### # Request

    POST /domestic-payments HTTP/1.1
    Authorization: Bearer Jhingapulaav
    x-idempotency-key: FRESNO.1317.GFX.22
    x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
    x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
    x-fapi-customer-ip-address: 104.25.212.99
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    Content-Type: application/json
    Accept: application/json

    {
      "Data": {
        "ConsentId": "58923",
        "Initiation": {
          "InstructionIdentification": "ACME412",
          "EndToEndIdentification": "FRESCO.21302.GFX.20",
          "InstructedAmount": {
            "Amount": "165.88",
            "Currency": "GBP"
          },
          "CreditorAccount": {
            "SchemeName": "UK.OB.SortCodeAccountNumber",
            "Identification": "08080021325698",
            "Name": "ACME Inc",
            "SecondaryIdentification": "0002",
            "Proxy": {
              "Identification": "+441632960540",
              "Code": "TELE"
            },
          },
        "UltimateDebtor": {
        "SchemeName": "UK.OB.BICFI",
        "Identification": "2360549017905161589",
        "Name": "Ultimate Debtor",
        "LEI": "8200007YHFDMEODY1965",
        "PostalAddress": {
            "AddressType": "BIZZ",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "6",
            "PostCode": "Z78 4TY",
            "TownName": "London",
            "Country": "UK"
        }
      },
      "UltimateCreditor": {
        "SchemeName": "UK.OB.BICFI",
        "Identification": "2360549017905161589",
        "Name": "Ultimate Creditor",
        "LEI": "60450004FECVJV7YN339",
        "PostalAddress": {
            "AddressType": "BIZZ",
            "StreetName": "Bank Street",
            "BuildingNumber": "11",
            "Floor": "6",
            "PostCode": "Z78 4TY",
            "TownName": "London",
            "Country": "UK"
            }
        },
        "RegulatoryReporting": [
            {
              "DebitCreditReportingIndicator": "CRED",
              "Authority": {
                "Name": "string",
                "CountryCode": "UG"
              },
              "Details": [
                {
                  "Date": "2024-04-25T13:26:41.911Z",
                  "Country": "QG",
                  "Amount": {
                    "Amount": "4.68702",
                    "Currency": "JGM"
                  }
                }
            ]
            }
        ],
        "RemittanceInformation": {
            "Structured": [
              {
                "ReferredDocumentInformation": [
                  {
                    "Code": "CINV",
                    "Issuer": "Issuer01",
                    "Number": "Number_01",
                    "RelatedDate": "2024-04-25T13:26:41.911Z",
                    "LineDetails": [
                      "string"
                    ]
                  }
                ],
                "ReferredDocumentAmount": 1,
                "CreditorReferenceInformation": {
                  "Code": "DISP",
                  "Issuer": "Issuer01",
                  "Reference": "REF_26518"
                },
                "Invoicer": "INVR51856",
                "Invoicee": "INVE5161856"
              }
            ]
        }
        }
      },
      "Risk": {
        "PaymentContextCode": "EcommerceMerchantInitiatedPayment",
        "ContractPresentIndicator": false,
        "PaymentPurposeCode": "EPAY",
        "BeneficiaryPaymentDetailsPrepopulatedIndicator": false,
        "BeneficiaryAccountType": "Business",
        "MerchantCustomerIdentification": "053598653254",
        "DeliveryAddress": {
          "AddressLine": [
            "Flat 7",
            "Acacia Lodge"
          ],
          "StreetName": "Acacia Avenue",
          "BuildingNumber": "27",
          "PostCode": "GU31 2ZZ",
          "TownName": "Sparsholt",
          "CountrySubDivision": "Wessex",
          "Country": "UK"
        }
      }
    }

#### # Response

    HTTP/1.1 201 Created
    x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    Content-Type: application/json

    {
      "Data": {
        "DomesticPaymentId": "58923-001",
        "ConsentId": "58923",
        "StatusCode": "ACSP",
        "CreationDateTime": "2017-06-05T15:15:22+00:00",
        "StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
        "Refund": {
          "Account": {
            "SchemeName": "UK.OB.SortCodeAccountNumber",
            "Identification": "08080021325677",
            "Name": "NTPC Inc"
          }
        },
        "Initiation": {
          "InstructionIdentification": "ACME412",
          "EndToEndIdentification": "FRESCO.21302.GFX.20",
          "InstructedAmount": {
            "Amount": "165.88",
            "Currency": "GBP"
          },
          "CreditorAccount": {
            "SchemeName": "UK.OB.SortCodeAccountNumber",
            "Identification": "08080021325698",
            "Name": "ACME Inc",
            "SecondaryIdentification": "0002"
          },
         "UltimateDebtor": {
            "SchemeName": "UK.OB.BICFI",
            "Identification": "2360549017905161589",
            "Name": "Ultimate Debtor",
            "LEI": "8200007YHFDMEODY1965",
            "PostalAddress": {
                "AddressType": "BIZZ",
                "StreetName": "Bank Street",
                "BuildingNumber": "11",
                "Floor": "6",
                "PostCode": "Z78 4TY",
                "TownName": "London",
                "Country": "UK"
            }
          },
        "UltimateCreditor": {
          "SchemeName": "UK.OB.BICFI",
          "Identification": "2360549017905161589",
          "Name": "Ultimate Creditor",
          "LEI": "60450004FECVJV7YN339",
          "PostalAddress": {
              "AddressType": "BIZZ",
              "StreetName": "Bank Street",
              "BuildingNumber": "11",
              "Floor": "6",
              "PostCode": "Z78 4TY",
              "TownName": "London",
              "Country": "UK"
              }
          },
        "RegulatoryReporting": [
            {
              "DebitCreditReportingIndicator": "CRED",
              "Authority": {
                "Name": "string",
                "CountryCode": "UG"
              },
              "Details": [
                {
                  "Date": "2024-04-25T13:26:41.911Z",
                  "Country": "QG",
                  "Amount": {
                    "Amount": "4.68702",
                    "Currency": "JGM"
                  }
                }
            ]
          }
        ],
        "RemittanceInformation": {
            "Structured": [
              {
                "ReferredDocumentInformation": [
                  {
                    "Code": "CINV",
                    "Issuer": "Issuer01",
                    "Number": "Number_01",
                    "RelatedDate": "2024-04-25T13:26:41.911Z",
                    "LineDetails": [
                      "string"
                    ]
                  }
                ],
                "ReferredDocumentAmount": 1,
                "CreditorReferenceInformation": {
                  "Code": "DISP",
                  "Issuer": "Issuer01",
                  "Reference": "REF_26518"
                },
                "Invoicer": "INVR51856",
                "Invoicee": "INVE5161856"
              }
            ]
          }
        }
      },
      "Links": {
        "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payments/58923-001"
      },
      "Meta": {}
    }

### # GET /domestic-payments/{DomesticPaymentId}

#### # Request

    GET /domestic-payments/58923-001 HTTP/1.1
    Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
    x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
    x-fapi-customer-ip-address: 104.25.212.99
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    Accept: application/json

#### # Response

    HTTP/1.1 200 OK
    x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    Content-Type: application/json

    {
      "Data": {
        "DomesticPaymentId": "58923-001",
        "ConsentId": "58923",
        "StatusCode": "ACSP",
        "CreationDateTime": "2017-06-05T15:15:22+00:00",
        "StatusUpdateDateTime": "2017-06-05T15:15:22+00:00",
        "Initiation": {
          "InstructionIdentification": "ACME412",
          "EndToEndIdentification": "FRESCO.21302.GFX.20",
          "InstructedAmount": {
            "Amount": "165.88",
            "Currency": "GBP"
          },
          "CreditorAccount": {
            "SchemeName": "UK.OB.SortCodeAccountNumber",
            "Identification": "08080021325698",
            "Name": "ACME Inc",
            "SecondaryIdentification": "0002",
          },
          "RemittanceInformation": {
            "Structured": [
              {
                "ReferredDocumentInformation": [
                  {
                    "Code": "CINV",
                    "Issuer": "Issuer01",
                    "Number": "Number_01",
                    "RelatedDate": "2024-04-25T13:26:41.911Z",
                    "LineDetails": [
                      "string"
                    ]
                  }
                ],
                "ReferredDocumentAmount": 1,
                "CreditorReferenceInformation": {
                  "Code": "DISP",
                  "Issuer": "Issuer01",
                  "Reference": "REF_26518"
                },
                "Invoicer": "INVR51856",
                "Invoicee": "INVE5161856"
              }
            ]
          }
        },
        "Debtor": {
          "Name": "D Jones"
        }
      },
      "Links": {
        "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payments/58923-001"
      },
      "Meta": {}
    }