Domestic Payments v3.1.2

Version Control

VersionDateAuthorComments
3.1 OB R/W API TeamThis is the baseline version.
4.0-draft1 OB R/W API TeamNo changes.
4.0-draft6 OB R/W API Team

v4.0-draft6 changes:

  • Added AcceptedCreditSettlementCompleted enumeration value  in OBTransactionIndividualStatus1Code
  • Added Payment Status details endpoint, Data Model, and underlying Status enumerations
  • Updated Account Name definition.
4.0-draft7 OB R/W API Team

v4.0-draft7 changes:

  • Payment Status details Data Model: changed the cardinality between Data and PaymentStatus from 1..unbounded to 0..Unbounded
  • Deleted the "AcceptedCreditSettlementCompleted to Rejected" flow from the Payment Order Status diagram
  • Added SCASupportData element to Domestic Payment Consent, to enable PISPs to provide Supporting Data, when requesting SCA Exemption
  • Changes for alignment with FAPI Implementer's Draft 2
    • Replace references of `x-fapi-customer-last-logged-time` to `x-fapi-auth-date`
    • Remove references of x-fapi-financial-id
3.1.2-RC1 OB R/W API Team

v3.1.2-RC1 changes:

  • Replaced reference to Mapping to Schemes and Standards section with Domestic Payment Message Formats page.
  • Release renamed to 3.1.2
  • Fixed a reference to old class name in the Endpoints table and once in description - OBWriteDomesticResponse2, should be OBWriteDomesticResponse3

Endpoints

ResourceHTTP OperationEndpointMandatory ?ScopeGrant TypeMessage SigningIdempotency KeyRequest ObjectResponse Object
domestic-payment-consentsPOSTPOST /domestic-payment-consentsMandatorypaymentsClient Credentials

Signed Request

Signed Response

YesOBWriteDomesticConsent3OBWriteDomesticConsentResponse3
domestic-payment-consentsGETGET /domestic-payment-consents/{ConsentId}Mandatorypayments

Client Credentials

Signed ResponseNoNAOBWriteDomesticConsentResponse3
domestic-payment-consentsGETGET /domestic-payment-consents/{ConsentId}/funds-confirmationMandatorypaymentsAuthorization CodeSigned ResponseNoNAOBWriteFundsConfirmationResponse1
domestic-paymentsPOSTPOST /domestic-paymentsMandatorypaymentsAuthorization Code

Signed Request

Signed Response

YesOBWriteDomestic2OBWriteDomesticResponse3
domestic-paymentsGETGET /domestic-payments/{DomesticPaymentId}Mandatorypayments

Client Credentials

Signed ResponseNoNAOBWriteDomesticResponse3
payment-detailsGETGET /domestic-payments/{DomesticPaymentId}/payment-detailsOptionalpaymentsClient CredentialsSigned ResponseNoNAOBWritePaymentDetailsResponse1

POST /domestic-payment-consents 

The API endpoint allows the PISP to ask an ASPSP to create a new domestic-payment-consent resource.

  • The POST action indicates to the ASPSP that a domestic payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP, 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 PSU and PISP) to the ASPSP for the PSU to authorise.
  • The ASPSP creates the domestic-payment-consent resource and responds with a unique ConsentId to refer to the resource.

Status

The default Status is "AwaitingAuthorisation" immediately after the domestic-payment-consent has been created.

Status
AwaitingAuthorisation

GET /domestic-payment-consents/{ConsentId}

A PISP can optionally retrieve a payment consent resource that they have created to check its status. 

Status

Once the PSU authorises the payment-consent resource - the Status of the payment-consent resource will be updated with "Authorised".

If the PSU rejects the consent or the domestic-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".

Once a domestic-payment has been successfully created using the domestic-payment-consent, the Status of the domestic-payment-consent will be set to "Consumed".

The available status codes for the domestic-payment-consent resource are:

Status
AwaitingAuthorisation
Rejected
Authorised
Consumed

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 UK.OBIE.Resource.InvalidConsentStatus error code.
  • Confirmation of funds requests do not affect the status of the domestic-payment-consent resource.

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.

Status

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

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

Status
Pending
Rejected
AcceptedSettlementInProcess 
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted

GET /domestic-payments/{DomesticPaymentId}

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

Status

The domestic-payment resource must have one of the following PaymentStatusCode code-set enumerations:

Status
Pending
Rejected
AcceptedSettlementInProcess 
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted

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.

Status

The domestic-payment - payment-details must have one of the following PaymentStatusCode code-set enumerations:

Status
Accepted
AcceptedCancellationRequest
AcceptedTechnicalValidation
AcceptedCustomerProfile
AcceptedFundsChecked
AcceptedWithChange
Pending
Rejected
AcceptedSettlementInProcess 
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted
Cancelled
NoCancellationProcess
PartiallyAcceptedCancellationRequest
PartiallyAcceptedTechnicalCorrect
PaymentCancelled
PendingCancellationRequest
Received
RejectedCancellationRequest

State Model

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.



The definitions for the Status:


StatusStatus Description
1AwaitingAuthorisationThe consent resource is awaiting PSU authorisation.
2RejectedThe consent resource has been rejected.
3Authorised The consent resource has been successfully authorised.
4ConsumedThe consented action has been successfully completed. This does not reflect the status of the consented action.

Payment Order

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


The definitions for the status:


StatusPayment Status Description
1PendingPayment initiation or individual transaction included in the payment initiation is pending.  Further checks and status update will be performed.
2RejectedPayment initiation or individual transaction included in the payment initiation has been rejected.
3AcceptedSettlementInProcess All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
4AcceptedSettlementCompletedSettlement on the debtor's account has been completed. 
5AcceptedWithoutPostingPayment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
6AcceptedCreditSettlementCompletedSettlement on the creditor's account has been completed.

Multiple Authorisation

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


The definitions for the status:


StatusStatus Description
1AwaitingFurtherAuthorisationThe payment-order resource is awaiting further authorisation.
2RejectedThe payment-order resource has been rejected by an authoriser.
3Authorised The payment-order resource has been successfully authorised by all required authorisers.

Data Model

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

Reused Classes

OBDomestic2

This section describes the OBDomestic2 class which is reused as the Initiation object in the domestic-payment-consent and domestic-payment resources.

UML Diagram

Notes

For the OBDomestic2 Initiation object:  

  • 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 PSU.
  • If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the domestic-payment-consent request immediately.

  • If the ASPSP establishes a problem with the domestic-payment-consent after the API call, the ASPSP must set the status of the domestic-payment-consent resource to Rejected.

  • DebtorAccount is optional as the PISP may not know the account identification details for the PSU.
  • If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the domestic-payment-consent will be set to Rejected after PSU authentication.
  • Account Identification field usage:
    • Where "UK.OBIE.SortCodeAccountNumber" is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field).
    • Where the "UK.OBIE.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.
  • The element Reference has been renamed from CreditorReferenceInformation as this is the unique ISO 20022 element used in pain.001, rather than an ISO 20022 message component.
  • 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-consent resource identifier (ConsentId) as the ConsentId must be uniquely generated by the ASPSP.
  • LocalInstrument is the requested payment scheme for execution. This is a free-text field.
  • Design decisions for the Initiation section of the payload and how this maps to the ISO 20022 messaging standard are articulated in the Domestic Payment Message Formats page.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern

OBDomestic2


OBDomestic2

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



InstructionIdentification

1..1

OBDomestic2/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.

Max35Text



EndToEndIdentification

1..1

OBDomestic2/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.

OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

Max35Text



LocalInstrument

0..1

OBDomestic2/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.

OBExternalLocalInstrument1Code



InstructedAmount

1..1

OBDomestic2/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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomestic2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBDomestic2/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".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

DebtorAccount

0..1

OBDomestic2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBDomestic2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBDomestic2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBDomestic2/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.

Max70Text



SecondaryIdentification

0..1

OBDomestic2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorAccount

1..1

OBDomestic2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBDomestic2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBDomestic2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBDomestic2/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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBDomestic2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorPostalAddress

0..1

OBDomestic2/CreditorPostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBDomestic2/CreditorPostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBDomestic2/CreditorPostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBDomestic2/CreditorPostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBDomestic2/CreditorPostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBDomestic2/CreditorPostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBDomestic2/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.

Max16Text



TownName

0..1

OBDomestic2/CreditorPostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBDomestic2/CreditorPostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBDomestic2/CreditorPostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBDomestic2/CreditorPostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



RemittanceInformation

0..1

OBDomestic2/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.

OBRemittanceInformation1



Unstructured

0..1

OBDomestic2/RemittanceInformation/Unstructured

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.

Max140Text



Reference

0..1

OBDomestic2/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.

OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

Max35Text



SupplementaryData

0..1

OBDomestic2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Domestic Payment Consent - Request

The OBWriteDomesticConsent3 object will be used for the call to:

  • POST /domestic-payment-consents

UML Diagram

Notes

The domestic-payment-consent request contains these objects:

  • Initiation
  • Authorisation
  • SCASupportData
  • Risk.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteDomesticConsent3OBWriteDomesticConsent3

OBWriteDomesticConsent3

Data1..1OBWriteDomesticConsent3/Data
OBWriteDataDomesticConsent3

Initiation1..1OBWriteDomesticConsent3/Data/InitiationThe 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

Authorisation0..1OBWriteDomesticConsent3/Data/AuthorisationThe authorisation type request from the TPP.OBAuthorisation1

SCASupportData0..1OBWriteDomesticConsent3/Data/SCASupportDataSupporting Data provided by TPP, when requesting SCA Exemption.OBSCASupportData1

Domestic Payment Consent - Response

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

  • POST /domestic-payment-consents
  • GET /domestic-payment-consents/{ConsentId}

UML Diagram

Notes

The domestic-payment-consent response contains the full original payload from the domestic-payment-consent request, with the additional elements below:

  • ConsentId.
  • CreationDateTime the domestic-payment-consent resource was created.
  • Status and StatusUpdateDateTime of the domestic-payment-consent resource.
  • CutOffDateTime Behaviour is explained in Payment Initiation API Specification, Section - Payment Restrictions -> CutOffDateTime API Behaviour.
  • ExpectedExecutionDateTime for the domestic-payment resource if created before CutOffDateTIme - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
  • ExpectedSettlementDateTime for the domestic-payment resource if created before CutOffDateTIme - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
  • Charges array for the breakdown of applicable ASPSP charges.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteDomesticConsentResponse3
OBWriteDomesticConsentResponse3
OBWriteDomesticConsentResponse3

Data1..1OBWriteDomesticConsentResponse3/Data
OBWriteDataDomesticConsentResponse3

ConsentId1..1OBWriteDomesticConsentResponse3/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

CreationDateTime1..1OBWriteDomesticConsentResponse3/Data/CreationDateTimeDate and time at which the resource was created.ISODateTime

Status1..1OBWriteDomesticConsentResponse3/Data/StatusSpecifies the status of consent resource in code form.OBExternalConsentStatus1CodeAuthorised
AwaitingAuthorisation
Consumed
Rejected

StatusUpdateDateTime1..1OBWriteDomesticConsentResponse3/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime

CutOffDateTime0..1OBWriteDomesticConsentResponse3/Data/CutOffDateTimeSpecified cut-off date and time for the payment consent.ISODateTime

ExpectedExecutionDateTime0..1OBWriteDomesticConsentResponse3/Data/ExpectedExecutionDateTimeExpected execution date and time for the payment resource.ISODateTime

ExpectedSettlementDateTime0..1OBWriteDomesticConsentResponse3/Data/ExpectedSettlementDateTimeExpected settlement date and time for the payment resource.ISODateTime

Charges0..nOBWriteDomesticConsentResponse3/Data/ChargesSet of elements used to provide details of a charge for the payment initiation.OBCharge2

Initiation1..1OBWriteDomesticConsentResponse3/Data/InitiationThe 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

Authorisation0..1OBWriteDomesticConsentResponse3/Data/AuthorisationThe authorisation type request from the TPP.OBAuthorisation1

SCASupportData0..1OBWriteDomesticConsentResponse3/Data/SCASupportDataSupporting Data provided by TPP, when requesting SCA Exemption.OBSCASupportData1

Risk1..1OBWriteDomesticConsentResponse3/RiskThe 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 Consent Confirmation of Funds - Response

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

  • GET /domestic-payment-consents/{ConsentId}/funds-confirmation

UML Diagram

Notes

The confirmation of funds response contains the result of a funds availability check, or SupplementaryData.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteFundsConfirmationResponse1
OBWriteFundsConfirmationResponse1
OBWriteFundsConfirmationResponse1

Data1..1OBWriteFundsConfirmationResponse1/Data
OBWriteDataFundsConfirmationResponse1

FundsAvailableResult0..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResultResult of a funds availability check.OBFundsAvailableResult1

FundsAvailableDateTime1..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailableDateTimeDate and time at which the funds availability check was generated.ISODateTime

FundsAvailable1..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailableFlag to indicate the availability of funds given the Amount in the consent request.xs:boolean

SupplementaryData0..1OBWriteFundsConfirmationResponse1/Data/SupplementaryDataAdditional information that can not be captured in the structured fields and/or any other specific block.OBSupplementaryData1

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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteDomestic2
OBWriteDomestic2
OBWriteDomestic2

Data1..1OBWriteDomestic2/Data
OBWriteDataDomestic2

ConsentId1..1OBWriteDomestic2/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

Initiation1..1OBWriteDomestic2/Data/InitiationThe 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

Risk1..1OBWriteDomestic2/RiskThe 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 OBWriteDomesticResponse3 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.
  • Status and StatusUpdateDateTime of the domestic-payment resource.
  • ExpectedExecutionDateTime for the domestic-payment resource.
  • ExpectedSettlementDateTime for the domestic-payment 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.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteDomesticResponse3
OBWriteDomesticResponse3
OBWriteDomesticResponse3

Data1..1OBWriteDomesticResponse3/Data
OBWriteDataDomesticResponse3

DomesticPaymentId1..1OBWriteDomesticResponse3/Data/DomesticPaymentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.Max40Text

ConsentId1..1OBWriteDomesticResponse3/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

CreationDateTime1..1OBWriteDomesticResponse3/Data/CreationDateTimeDate and time at which the message was created.ISODateTime

Status1..1OBWriteDomesticResponse3/Data/StatusSpecifies the status of the payment information group.OBTransactionIndividualStatus1Code

AcceptedCreditSettlementCompleted

AcceptedWithoutPosting

AcceptedSettlementCompleted
AcceptedSettlementInProcess
Pending
Rejected


StatusUpdateDateTime1..1OBWriteDomesticResponse3/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime

ExpectedExecutionDateTime0..1OBWriteDomesticResponse3/Data/ExpectedExecutionDateTimeExpected execution date and time for the payment resource.ISODateTime

ExpectedSettlementDateTime0..1OBWriteDomesticResponse3/Data/ExpectedSettlementDateTimeExpected settlement date and time for the payment resource.ISODateTime

Charges0..nOBWriteDomesticResponse3/Data/ChargesSet of elements used to provide details of a charge for the payment initiation.OBCharge2

Initiation1..1OBWriteDomesticResponse3/Data/InitiationThe 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

MultiAuthorisation0..1OBWriteDomesticResponse3/Data/MultiAuthorisationThe multiple authorisation flow response from the ASPSP.OBMultiAuthorisation1

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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWritePaymentDetailsResponse1
OBWritePaymentDetailsResponse1
OBWritePaymentDetailsResponse1

Data1..1OBWritePaymentDetailsResponse1/Data
OBWriteDataPaymentOrderStatusResponse1

PaymentStatus0..unboundedOBWritePaymentDetailsResponse1/Data/PaymentStatusPayment status details.OBWritePaymentDetails1

Usage Examples

Merchant Initiation via PISP

This example set of flows and payload examples are for a domestic payment initiated by a merchant via a PISP.

In this scenario:

  • The merchant has not specified the Debtor Account details for the PSU. The PSU will select their account during the authorisation of consent.
  • The merchant's account is a building society account with a roll number specified in the SecondaryIdentification field.

Sequence Diagram


Illustrative Interactions

Notes:

  • As per the Security & Access Control section, examples are given where the call to GET must use a client credentials grant to obtain a token to make GET requests.

Create Domestic Payment Order Consent

POST /domestic-payment-consents request

POST /domestic-payment-consents response

Confirm Funds on Domestic Payment Order Consent

GET /domestic-payment-consents/{ConsentId}/funds-confirmation Request

GET /domestic-payment-consents/{ConsentId}/funds-confirmation Response

Create Domestic Payment Order

POST /domestic-payments Request

POST /domestic-payments Response

Get Domestic Payment Order Consent

GET /domestic-payment-consents/{ConsentId} Request

GET /domestic-payment-consents/{ConsentId} Response

Get Domestic Payment Order

GET /domestic-payments/{DomesticPaymentId} Request

GET /domestic-payments/{DomesticPaymentId} Response

Person To Person Initiation via PISP

This example set of flows and payload examples are for a domestic payment initiated by a person to another person via a PISP.

In this scenario:

  • The PSU has pre-specified the account from which funds will be transferred (i.e., the Debtor Account details)
  • No building society accounts are involved in this interaction, and there only the sort code and account number are specified in the DebtorAccount and CreditorAccount sections.

Sequence Diagram

Illustrative Interactions

Create Domestic Payment Order Consent

POST /domestic-payment-consents request

POST /domestic-payment-consents response

Create Domestic Payment Order

POST /domestic-payments request

POST /domestic-payments response

Get Domestic Payment Order Consent

GET /domestic-payment-consents/{ConsentId} request

GET /domestic-payment-consents/{ConsentId} response

Get Domestic Payment Order

GET /domestic-payments/{DomesticPaymentId} request

GET /domestic-payments/{DomesticPaymentId} response

BACS Payment Order Consent

Use of LocalInstrument and CutOffDateTime.

POST /domestic-payment-consents request

POST /domestic-payment-consents response

CHAPS Payment Order Consent

Use of LocalInstrument, CreditorPostalAddress, CutOffDateTime and Charges.

POST /domestic-payment-consents request

POST /domestic-payment-consents response

Balance Transfer

Below in an example illustrating a balance transfer offer available on a Card A.

To facilitate a Balance Transfer, a PISP can initiate a Payment from Card B to Card A with LocalInstrument as UK.OBIE.BalanceTransfer, Account SchemeName as UK.OBIE.PAN and if there is an Offer Code/Id provided by Issuer of the Card A, then it can be supplied in the field: RemittanceInformation.Reference. Example below:

POST /domestic-payment-consents request

POST /domestic-payment-consents response

Money Transfer

Below in an example illustrating Money transfer from a card account to a bank account. 

POST /domestic-payment-consents request

POST /domestic-payment-consents response