...
The maximum InstructedAmount allowable
The domestic-standing-order Frequency patterns supportedThe maximum future date on a future dated payment
...
This section describes the OBDomesticRefundAccount class which is used in the response payloads of Single Domestic Payment , Domestic and Single Future Dated Domestic Payment and Domestic Standing Order.
4.1.4.1 UML Diagram
...
4.1.4.2 Data Dictionary
...
Generated | Identifier | Business Description |
Merchant/PISP Sent in API Payload | EndToEndIdentification | The EndToEndIdentification reference is a reference that can be populated by the debtor (or merchant in the ecommerce space). This reference is important to the debtor (could be an internal reference Id against the transaction), it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary) |
Merchant/PISP Sent in API Payload | InstructionIdentification | The PISP generates the InstructionIdentification which is a unique transaction Id and passes it to the ASPSP (this is mandatory), but this does not have to go any further in the payment flow. The flow of this identifier needs to align with payment scheme rules The expectation is that this is unique indefinitely across all time periods. The PISP can ensure this is indefinitely unique by including a date or date time element to the field, or by inserting a unique Id |
Merchant/PISP Sent in API Payload | RemittanceInformation | The RemittanceInformation is the reference information that the creditor (or beneficiary) will need to reconcile (e.g. Invoice 123) |
ASPSP / API System | ConsentId | A unique identification as assigned by the ASPSP to uniquely identify the payment-order consent resource |
ASPSP / API System | Payment Order Id | A unique identification as assigned by the ASPSP to uniquely identify the payment-order resource. · DomesticPaymentId · DomesticFutureDatedPaymentId · DomesticStandingOrderIdInternationalPaymentId· InternationalPaymentId . FilePaymentId |
ASPSP / Payment Scheme | Scheme Payment ID | This is generated by the ASPSP to uniquely identify a payment through a processing scheme |
...
Code Class | Name | Definition |
OBExternalPaymentContextCode | BillPayment | The context of the payment initiation is a bill payment |
OBExternalPaymentContextCode | EcommerceGoods | The context of the payment initiation is for goods via an ecommerce channel |
OBExternalPaymentContextCode | EcommerceServices | The context of the payment initiation is for services via an ecommerce channel |
OBExternalPaymentContextCode | PartyToParty | The context of the payment initiation is a party to party payment |
OBExternalPaymentContextCode | Other | The context of the payment initiation is of another type |
OBTransactionIndividualStatusCode | AcceptedSettlementCompleted | Settlement on the debtor's account has been completed Usage: this can be used by the first agent to report to the debtor that the transaction has been completed
Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement PISPs must not use this status as confirmation that settlement is complete on the creditor's account |
OBTransactionIndividualStatusCode | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution |
OBTransactionIndividualStatusCode | Pending | Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed |
OBTransactionIndividualStatusCode | Rejected | Payment initiation or individual transaction included in the payment initiation has been rejected |
OBTransactionIndividualStatusCode | AcceptedWithoutPosting | Payment instruction included in the credit transfer is accepted without being posted to the creditor customer's account |
OBTransactionIndividualStatusCode | AcceptedCreditSettlementCompleted | Settlement on the creditor's account has been completed |
OBExternalConsentStatusCode | AwaitingAuthorisation | The consent resource is awaiting User/Customer authorisation |
OBExternalConsentStatusCode | Rejected | The consent resource has been rejected |
OBExternalConsentStatusCode | Authorised | The consent resource has been successfully authorised |
OBExternalConsentStatusCode | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action |
OBChargeBearerTypeCode | BorneByCreditor | All transaction charges are to be borne by the creditor |
OBChargeBearerTypeCode | BorneByDebtor | All transaction charges are to be borne by the debtor |
OBChargeBearerTypeCode | FollowingServiceLevel | Charges are to be applied following the rules agreed in the service level and/or scheme |
OBChargeBearerTypeCode | Shared | In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor |
OBExternalAuthorisationCode | Single | Single authorisation type is requested |
OBExternalStatusCode | InitiationCompleted | The payment-order initiation has been completed |
OBExternalStatusCode | InitiationFailed | The payment-order initiation has failed |
OBExternalStatusCode | InitiationPending | The payment-order initiation is pending |
OBExternalStatusCode | InitiationCompleted | The payment-order initiation has been completed |
OBExternalStatusCode | InitiationFailed | The payment-order initiation has failed |
OBExternalStatusCode | InitiationPending | The payment-order initiation is pending |
OBExternalStatusCode | Cancelled | Payment initiation has been successfully cancelled after having received a request for cancellation |
OBExchangeRateTypeCode | Actual | Exchange rate is the actual rate |
OBExchangeRateTypeCode | Agreed | Exchange rate is the agreed rate between the parties |
OBExchangeRateTypeCode | Indicative | Exchange rate is the indicative rate |
OBPriorityCode | Normal | Priority is normal |
OBPriorityCode | Urgent | Priority is urgent |
OBAddressTypeCode | Business | Address is the business address |
OBAddressTypeCode | Correspondence | Address is the address where correspondence is sent |
OBAddressTypeCode | Residential | Address is the home address |
OBTransactionIndividualExtendedISOStatusCode | Accepted | Request is accepted |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCancellationRequest | Cancellation is accepted |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCreditSettlementCompleted | Settlement on the creditor's account has been completed |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCustomerProfile | Preceding check of technical validation was successful. Customer profile check was also successful |
OBTransactionIndividualExtendedISOStatusCode | AcceptedFundsChecked | Preceding check of technical validation and customer profile was successful and an automatic funds check was positive |
OBTransactionIndividualExtendedISOStatusCode | AcceptedSettlementCompleted | Settlement on the debtor's account has been completed
Usage: this can be used by the first agent to report to the debtor that the transaction has been completed
Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement |
OBTransactionIndividualExtendedISOStatusCode | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution |
OBTransactionIndividualExtendedISOStatusCode | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful |
OBTransactionIndividualExtendedISOStatusCode | AcceptedWithChange | Instruction is accepted but a change will be made, such as date or remittance not sent |
OBTransactionIndividualExtendedISOStatusCode | AcceptedWithoutPosting | Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account |
OBTransactionIndividualExtendedISOStatusCode | Cancelled | Request is cancelled |
OBTransactionIndividualExtendedISOStatusCode | NoCancellationProcess | No cancellation process |
OBTransactionIndividualExtendedISOStatusCode | PartiallyAcceptedCancellationRequest | Cancellation is partially accepted |
OBTransactionIndividualExtendedISOStatusCode | PartiallyAcceptedTechnicalCorrect | Authentication and syntactical and semantical validation are successful |
OBTransactionIndividualExtendedISOStatusCode | PaymentCancelled | Transaction has been cancelled |
OBTransactionIndividualExtendedISOStatusCode | Pending | Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed |
OBTransactionIndividualExtendedISOStatusCode | PendingCancellationRequest | Cancellation request is pending |
OBTransactionIndividualExtendedISOStatusCode | Received | Payment initiation has been received by the receiving agent |
OBTransactionIndividualExtendedISOStatusCode | Rejected | Payment initiation or individual transaction included in the payment initiation has been rejected |
OBTransactionIndividualExtendedISOStatusCode | RejectedCancellationRequest | Cancellation request is rejected |
OBTransactionIndividualStatusReasonCode | Cancelled | Reason why the payment status is cancelled |
OBTransactionIndividualStatusReasonCode | PendingFailingSettlement | Reason why the payment status is pending (failing settlement) |
OBTransactionIndividualStatusReasonCode | PendingSettlement | Reason why the payment status is pending (settlement) |
OBTransactionIndividualStatusReasonCode | Proprietary | Defines a free text proprietary reason |
OBTransactionIndividualStatusReasonCode | ProprietaryRejection | Defines the reason that has been used by the Local Instrument system to reject the transaction |
OBTransactionIndividualStatusReasonCode | Suspended | Reason why the payment status is suspended |
OBTransactionIndividualStatusReasonCode | Unmatched | Reason why the payment status is unmatched |
OBExternalSCAExemptionTypeCode | BillPayment | Bill Payment |
OBExternalSCAExemptionTypeCode | ContactlessTravel | Contactless Travel |
OBExternalSCAExemptionTypeCode | EcommerceGoods | Ecommerce Goods |
OBExternalSCAExemptionTypeCode | EcommerceServices | Ecommerce Services |
OBExternalSCAExemptionTypeCode | Parking | Parking |
OBExternalSCAExemptionTypeCode | PartyToParty | Party To Party |
OBExternalAppliedAuthenticationApproachCode | CA | Single Factor Strong Customer Authentication |
OBExternalAppliedAuthenticationApproachCode | SCA | Multi Factor Strong Customer Authentication |
OBReadRefundAccountCode | Yes | Yes |
OBReadRefundAccountCode | No | No |
...