Domestic Future Dated Payment Consents

Owned by CBB Admin
Oct 27, 2020
14 min read

1. Version Control

Version

Date

Description of Changes

Bahrain OBF v1.0.0

28th Oct 2020

Initial Release

2.  Overview

The Domestic Future Dated Payment Consent resource is used by a PISP to register an intent to initiate a Domestic Future Dated Payment.

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

3.  Endpoints

Endpoints for the resources are defined below:

S. No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Message Signing

Idempotency Key

Request Object

Response Object

3.1

domestic-future-dated-payment-consents

POST

POST /domestic-future-dated-payment-consents

Conditional

payments

Client Credentials

Signed Request Signed Response

Yes

OBWriteDomesticFutureDatedConsent

OBWriteDomesticFutureDatedConsentResponse

3.2

domestic-future-dated-payment-consents

GET

GET /domestic-future-dated-payment-consents/{ConsentId}

Mandatory (if resource POST implemented)

payments

Client Credentials

Signed Response

No

NA

OBWriteDomesticFutureDatedConsentResponse

3.3

domestic-future-dated-payment-consents

POST

POST /domestic-future-dated-payment-cancellation-consents

Conditional

payments

Client Credentials

Signed Request

Signed Response

Yes

OBWriteDomesticFutureDatedCancellationConsent

 

OBWriteDomesticFutureDatedCancellationConsentResponse

 

3.4

domestic-future-dated-payment-consents

GET

GET /domestic-future-dated-payment-cancellation-consents/{ConsentId}

Mandatory (if resource POST implemented)

payments

Client Credentials

Signed Response

No

NA

OBWriteDomesticFutureDatedCancellationConsentResponse

 

 

3.1 POST/domestic-future-dated-payments-consents

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

  • The POST action indicates to the ASPSP that a Domestic Future Dated Payment consent has been staged. At this point, the user/customer 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 user/customer and PISP) to the ASPSP for the user/customer to authorise

  • The ASPSP creates the domestic-future-dated-payment-consents resource and responds with a unique ConsentId to refer to the resource

3.1.1 Status

  • The default Status is "AwaitingAuthorisation" immediately after the domestic-future-dated-payment-consents has been created

Status

AwaitingAuthorisation

 

3.2 GET /domestic-future-dated-payment-consents/{ConsentId}

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

3.2.1 Status

Once the user/customer authorises the payment-consents resource, the Status of the payment-consents resource will be updated with "Authorised".

If the user/customer rejects the consent or the domestic-future-dated-payment-consents has failed some other ASPSP validation, the Status will be set to "Rejected".

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

The available Status codes for the domestic-future-dated-payment-consents resource are:

Status

AwaitingAuthorisation

Rejected

Authorised

Consumed

3.3 POST/domestic-future-dated-payment-cancellation-consents

The API endpoint allows the PISP to ask an ASPSP to create a new domestic-future-dated-payment-cancellation-consents resource.

  • The POST action indicates to the ASPSP that a Domestic Future Dated Payment Cancellation consents that has been staged.

  • The endpoint allows the PISP to send a copy of the consent (between user/customer and PISP) to the ASPSP for the user/customer to authorise.

  • The ASPSP creates the domestic-future-dated-payment-cancellation-consents resource and responds with a unique ConsentId to refer to the resource

3.3.1 Status

  • The default Status is "AwaitingAuthorisation" immediately after the domestic-future-dated-payment-cancellation-consents has been created

Status

AwaitingAuthorisation

 

3.4  GET /domestic-future-dated-payment-cancellation-consents/{ConsentId}

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

3.4.1 Status

Once the user/customer authorises the payment-cancellation-consents resource, the Status of the payment-consents resource will be updated with "Authorised".

If the user/customer rejects the consent or the domestic-future-dated-payment-cancellation-consents has failed some other ASPSP validation, the Status will be set to "Rejected".

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

The available Status codes for the domestic-future-dated-payment-cancellation-consents resource are:

Status

AwaitingAuthorisation

Rejected

Authorised

Consumed

3.5  State Model

3.5.1 Payment Order Consent

The state model for the domestic-future-dated-payment-consents resource follows the generic consent state model.

The definitions for the Status:

 S.No.

Status

Status Description

1

AwaitingAuthorisation

The consent resource is awaiting user/customer 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

4.  Data Models

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

4.1  Reused Classes

4.1.1 OBDomesticFutureDatedInitiation

This section describes the OBDomesticFutureDatedInitiation class which is reused as the Initiation object in the domestic-future-dated-payment-consents resource.

4.1.1.1 UML Diagram

 

4.1.1.2 Notes

For the OBDomesticFutureDatedInitiation 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 user/customer

  • 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-future-dated-payment-consents request immediately

  • If the ASPSP establishes a problem with the domestic-future-dated-payment-consents after the API call, the ASPSP must set the Status of the domestic-future-dated-payment-consents resource to rejected

  • DebtorAccount is optional as the PISP may not know the account identification details for the user/customer

  • If the DebtorAccount is specified by the PISP and is invalid for the user/customer, then the domestic-future-dated-payment-consents will be set to Rejected after user/customer authentication. Account Identification field usage:

    • Where the "BH.OBF.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

    • Where the “BH.OBF.PAN” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the identification field must be populated with the full Primary Account Number - identifier scheme used to identify a card account

    • Neither the InstructionIdentification nor EndToEndIdentification will be used as the domestic-payment-consents resource identifier (ConsentId) as the ConsentId must be uniquely generated by the ASPSP

  • Permission field is restricted to "Create", however, may be extended to "Update" for cancellation of Single Future Dated Domestic Payment

  • LocalInstrument is the requested payment scheme for execution. This is a free-text field

  • RequestedExecutionDateTime allows a PISP to specify the date for an ASPSP to execute the Domestic Future Dated Payment

4.1.1.3 Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBDomesticFutureDatedInitiation

 

OBDomesticFutureDatedInitiation

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 Future Dated Domestic Payment

OBDomesticFutureDatedInitiation

OBDomesticFutureDatedInitiation

 

InstructionIdentification

1..1

OBDomesticFutureDatedInitiation/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

Enum:

  • Single

 

EndToEndIdentification

0..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/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:

  • BH.OBF.DNS

  • BH.OBF.BIL

 

RequestedExecutionDateTime

1..1

OBDomesticFutureDatedInitiation/RequestedExecutionDateTime

Date at which the initiating party requests the clearing agent to process the payment

Usage: This is the date on which the debtor's account is to be debited

DateTime

 

 

InstructedAmount

1..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/InstructedAmount

 

 

Amount

1..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/DebtorAccount

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

OBDomesticFutureDatedInitiation/DebtorAccount

 

 

SchemeName

1..1

OBDomesticFutureDatedInitiation/DebtorAccount/SchemeName

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

String

Enum:

  • BH.OBF. IBAN

  • BH.OBF.PAN

 

 

Identification

1..1

OBDomesticFutureDatedInitiation/DebtorAccount/Identification

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

String

 

 

Name

0..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/CreditorAccount

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

OBDomesticFutureDatedInitiation/CreditorAccount

 

 

SchemeName

1..1

OBDomesticFutureDatedInitiation/CreditorAccount/SchemeName

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

String

Enum:

  • BH.OBF. IBAN

  • BH.OBF.PAN

 

Identification

1..1

OBDomesticFutureDatedInitiation/CreditorAccount/Identification

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

String

 

 

Name

1..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/CreditorPostalAddress

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

OBPostalAddress

 

 

AddressType

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/AddressType

Identifies the nature of the postal address

String

Enum:

  • Business

  • Correspondence

  • DeliveryTo

  • MailTo

  • POBox

  • Postal

  • Residential

  • Statement

 

Department

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/Department

Identification of a division of a large organisation or building

String

 

 

SubDepartment

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/SubDepartment

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

String

 

 

AddressLine

0..7

OBDomesticFutureDatedInitiation/CreditorPostalAddress/AddressLine

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

String

 

 

StreetName

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/StreetName

Name of a street or thoroughfare

String

 

 

BuildingNumber

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/BuildingNumber

Number that identifies the position of a building on a street

String

 

 

PostCode

0..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/CreditorPostalAddress/TownName

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

String

 

 

CountrySubDivision

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region

String

 

 

Country

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/Country

Nation with its own government

String

 

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

RemittanceInformation

0..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/RemittanceInformation

 

 

RemittanceDescription

0..1

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/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

OBDomesticFutureDatedInitiation/SupplementaryData

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

OBSupplementaryData

 

 

 4.2  Domestic Future Dated Payment Consent – Request

The OBWriteDomesticFutureDatedConsent object will be used for the call to:

  • POST /domestic-future-dated-payment-consent

4.2.1 UML Diagram

 

4.2.2 Notes

The domestic-future-dated-payment-consents request contains these objects:

  • Initiation

  • Authorisation

  • SCASupportData

  • Risk

4.2.3 Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticFutureDatedConsent

 

OBWriteDomesticFutureDatedConsent

 

OBWriteDomesticFutureDatedConsent

 

 

Data

1..1

OBWriteDomesticFutureDatedConsent/Data

 

OBWriteDomesticFutureDatedConsent/Data

 

 

Permission

1..1

OBWriteDomesticFutureDatedConsent/Data/Permission

Specifies the Open Banking service request types

String

Enum:

  • Create

 

ReadRefundAccount

0..1

OBWriteDomesticFutureDatedConsent/Data/ReadRefundAccount

Specifies to share the refund account details with PISP

String

Enum:

  • Yes

  • No

 

Initiation

1..1

OBWriteDomesticFutureDatedConsent/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 Future Dated Domestic Payment

OBDomesticFutureDatedInitiation

 

 

Authorisation

0..1

OBWriteDomesticFutureDatedConsent/Data/Authorisation

Type of authorisation flow requested

OBAuthorisation

 

 

SCASupportData

0..1

OBWriteDomesticFutureDatedConsent/Data/SCASupportData

Supporting Data provided by PISP, when requesting SCA Exemption

OBSCASupportData

 

 

Risk

1..1

OBWriteDomesticFutureDatedConsent/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

 

 

4.3  Domestic Future Dated Payment Consent - Response

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

  • POST /domestic-future-dated-payment-consents

  • GET /domestic-future-dated-payment-consents/{ConsentId}

4.3.1 UML Diagram

 

4.3.2 Notes

The domestic-future-dated-payment-consents response contains the full original payload from the domestic-future-dated-payment-consents request with these additional elements:

  • ConsentId

  • CreationDateTime the domestic-future-dated-payment-consents resource was created

  • Status and StatusUpdateDateTime of the domestic-future-dated-payment-consents resource

  • Permission field in the original request

  • ReadRefundAccount field in the original request

  • CutOffDateTime Behaviour is explained in the Payment Initiation API Profile

  • ExpectedExecutionDateTime for the domestic-future-dated-payments 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 user/customer authorisation)

  • ExpectedSettlementDateTime for the domestic-future-dated-payments 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 user/customer authorisation)

  • Charges array - for the breakdown of applicable ASPSP charges

  • Post successful user/customer Authentication, an ASPSP may provide Debtor/Name in the payment-order-consent Response, even when the user/customer did not provide the Debtor Account via PISP

4.3.3 Data Dictionary 

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticFutureDatedConsentResponse

 

OBWriteDomesticFutureDatedConsentResponse

 

OBWriteDomesticFutureDatedConsentResponse

 

 

Data

1..1

OBWriteDomesticFutureDatedConsentResponse/Data

 

OBWriteDomesticFutureDatedConsentResponse/Data

Enum:

  • Single

 

ConsentId

1..1

OBWriteDomesticFutureDatedConsentResponse/Data/ConsentId

Unique identification as assigned by the ASPSP to uniquely identify the consent resource

String

 

 

CreationDateTime

1..1

OBWriteDomesticFutureDatedConsentResponse/Data/CreationDateTime

Date and time at which the resource was created

DateTime

 

 

Status

1..1

OBWriteDomesticFutureDatedConsentResponse/Data/Status

Specifies the status of consent resource in code form

String

Enum:

  • Authorised

  • AwaitingAuthorisation

  • Consumed

  • Rejected

 

StatusUpdateDateTime

1..1

OBWriteDomesticFutureDatedConsentResponse/Data/StatusUpdateDateTime

Date and time at which the consent resource status was updated

DateTime

 

 

Permission

1..1

OBWriteDomesticFutureDatedConsentResponse/Data/Permission

Specifies the Open Banking service request types

String

Enum:

  • Create

 

ReadRefundAccount

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/ReadRefundAccount

Specifies to share the refund account details with PISP

String

Enum:

  • Yes

  • No

 

CutOffDateTime

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/CutOffDateTime

Specified cut-off date and time for the payment consent

DateTime

 

 

ExpectedExecutionDateTime

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/ExpectedExecutionDateTime

Expected execution date and time for the payment resource

DateTime

 

 

ExpectedSettlementDateTime

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/ExpectedSettlementDateTime

Expected settlement date and time for the payment resource

DateTime

 

 

Charges

0..n

OBWriteDomesticFutureDatedConsentResponse/Data/Charges

Set of elements used to provide details of a charge for the payment initiation

OBCharge

 

 

Initiation

1..1

OBWriteDomesticFutureDatedConsentResponse/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 future dated domestic payment

OBDomesticFutureDatedInitiation

 

 

Authorisation

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/Authorisaion

Type of authorisation flow requested

OBAuthorisation

 

 

SCASupportData

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/SCASupportData

Supporting Data provided by PISP, when requesting SCA Exemption

OBSCASupportData

 

 

 

Debtor

0..1

OBWriteDomesticFutureDatedConsentResponse/Data/Debtor

Set of elements used to identify a person or an organisation

OBWriteDomesticFutureDatedConsentResponse/Data/Debtor

 

 

Name

1..1

OBWriteDomesticFutureDatedConsentResponse/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

 

 

Risk

1..1

OBWriteDomesticFutureDatedConsentResponse/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

 

 

4.4  Domestic Future Dated Payment Cancellation Consent – Request

The OBWriteDomesticFutureDatedCancellationConsent object will be used for the call to:

  • POST /domestic-future-dated-payment-cancellation-consents

4.4.1 UML Diagram

 

 

4.4.2 Data Dictionary

 

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticFutureDatedCancellationConsent

 

OBWriteDomesticFutureDatedCancellationConsent

 

OBWriteDomesticFutureDatedCancellationConsent

 

 

Data

1..1

OBWriteDomesticFutureDatedCancellationConsent/Data

 

OBWriteDomesticFutureDatedCancellationConsent/Data

 

 

Permission

1..1

OBWriteDomesticFutureDatedCancellationConsent/Data/Permission

Specifies the Open Banking service request types

String

Enum:

  • Update

 

DomesticFutureDatedPaymentId

 

1..1

OBWriteDomesticFutureDatedCancellationConsent/Data/DomesticFutureDatedPayment

Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource

 

String

 

 

ExpectedExecutionDateTime

0..1

OBWriteDomesticFutureDatedCancellationConsent/Data/ExpectedExecutionDateTime

Expected execution date and time for the payment resource

DateTime

 

 

ExpectedSettlementDateTime

0..1

OBWriteDomesticFutureDatedCancellationConsent/Data/ExpectedSettlementDateTime

Expected settlement date and time for the payment resource

DateTime

 

 

 

4.5  Domestic Future Dated Payment Cancellation Consent – Response

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

  • POST /domestic-future-dated-payment-cancellation -consents

  • GET /domestic-future-dated-payment-cancellation -consents/{ConsentId}

4.5.1 UML Diagram

 

 

4.5.2  Data Dictionary 

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticFutureDatedCancellationConsentResponse

 

OBWriteDomesticFutureDatedCancellationConsentResponse

 

OBWriteDomesticFutureDatedCancellationConsentResponse

 

 

Data

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data

 

OBWriteDomesticFutureDatedCancellationConsentResponse/Data

 

 

ConsentId

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ConsentId

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource

String

 

 

Permission

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Permission

Specifies the Open Banking service request types

String

Enum:

  • Update

 

DomesticFutureDatedPaymentId

 

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/DomesticFutureDatedPaymentId

Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource

 

String

 

 

ExpectedExecutionDateTime

0..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ExpectedExecutionDateTime

Expected execution date and time for the payment resource

DateTime

 

 

ExpectedSettlementDateTime

0..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ExpectedSettlementDateTime

Expected settlement date and time for the payment resource

DateTime

 

 

Charges

0..n

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges

Set of elements used to provide details of a charge for the payment cancellation

OBCharge

 

 

ChargeBearer

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment cancellation

String

Enum:

  • BorneByCreditor

  • BorneByDebtor

  • FollowingServiceLevel

  • Shared 

 

Type

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Type

Charge type, in a coded form

String

 

 

Amount

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount

Amount of money associated with the charge type

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount

 

 

Amount

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/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

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount/Amount/Currency

A code allocated to 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}$

5.  Usage Example

5.1  POST /domestic-future-dated-payment-consents

5.1.1 Request

POST /domestic-future-dated-payment-consents

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-idempotency-key: XYZ.51403.MLT.30

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==

x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

Accept: application/json

{

  "Data": {

    "Permission": "Create",

    "ReadRefundAccount": "No",

   "Initiation": {

      "InstructionIdentification": "0616I029",

      "EndToEndIdentification": "20190616B002",

      "LocalInstrument": "BH.OBF.DNS",

      "RequestedExecutionDateTime": "2020-03-18T04:57:51.126+03:00",

      "InstructedAmount": {

        "Amount": "2.13",

        "Currency": "BHD"

      },

      "DebtorAccount": {

        "SchemeName": "BH.OBF.IBAN",

        "Identification": "BH10BBKU00100000008876",

        "Name": "Mohammed Ahmed Abdulla",

              },

      "CreditorAccount": {

        "SchemeName": "BH.OBF.IBAN",

        "Identification": "BH89ABIC00000987654321",

        "Name": "Faisal Hassan Mohammed",

      },

        "CreditorPostalAddress": {

        "AddressType": "Business",

        "AddressLine": "XYZ Bank, Diplomatic Area”

        "StreetName": "Route 1888",

        "BuildingNumber": "27",

        "PostCode": "317",

        "TownName": "Manama",

        "CountySubDivision": "Manama”

        "Country": "BH",},   

      "RemittanceInformation": {

        "RemittanceDescription": "Internal ops code 5120101",

        "Reference": "STORE-101"

      },

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-12T09:10:17.594+03:00"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": " ",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "000025"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

        "AddressLine": "XYZ Bank, Diplomatic Area”

        "StreetName": "Route 1888",

        "BuildingNumber": "27",

        "PostCode": "317",

        "TownName": "Manama",

        "CountySubDivision": "Manama”

        "Country": "BH", }

}

5.1.2 Response

201 Created

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

{

  "Data": {

    "ConsentId": "56565656",

    "CreationDateTime": "2020-03-18T04:57:51.128+03:00",

    "Status": "Authorised",

    "StatusUpdateDateTime": "2020-03-18T04:57:51.128+03:00",

    "Permission": "Create",

    "ReadRefundAccount": "No",

    "CutOffDateTime": "2020-03-18T04:57:51.128+03:00",

    "ExpectedExecutionDateTime": "2020-03-18T04:57:51.128+03:00",

    "ExpectedSettlementDateTime": "2020-03-18T04:57:51.128+03:00",

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "BH.OBF.DNS",

        "Amount": {

          "Amount": "2.13",

          "Currency": "BHD"

        }

      }

    ],

   "Initiation": {
      "InstructionIdentification": "07171I030",
      "EndToEndIdentification": "20200716D004",
      "LocalInstrument": "BH.OBF.DNS",
      "InstructedAmount": {
        "Amount": "2.13",
        "Currency": "BHD"
      },

      "DebtorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH10BBKU001000000012345",
        "Name": "Mohammed Ahmed Abdulla",
      },
      "CreditorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH89ABIB00000123456789",
        "Name": "Faisal Hassan Mohammed",
      },

          "CreditorPostalAddress": {

        "AddressType": "Business",

        "AddressLine": "XYZ Bank, Diplomatic Area”

       “StreetName": "Route 1888",

        "BuildingNumber": "27",

        "PostCode": "317",

        "TownName": "Manama",

        "CountySubDivision": "Manama”

        "Country": "BH",},

      "RemittanceInformation": {

        "RemittanceDescription": "Internal ops code 5120101",

        "Reference": "STORE-101"

      },  

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-12T09:10:17.595+03:00"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": “ ",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "0000002345"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

        "AddressLine": "XYZ Bank, Diplomatic Area”

        "StreetName": "Route 1888",

        "BuildingNumber": "27",

        "PostCode": "317",

        "TownName": "Manama",

        "CountySubDivision": "Manama”

        "Country": "BH",}

  },

  "Links": {

    "Self": "www.TBC.com"

  },

  "Meta": {

    "TotalPages": 02,

    "FirstAvailableDateTime": "2020-03-12T09:10:17.596+03:00",

    "LastAvailableDateTime": "2020-03-12T09:10:17.596+03:00"

  }

} 

5.2  POST /domestic-future-dated-payment-cancellation-consents

5.2.1 Request

POST /domestic-future-dated-payment-cancellation-consents

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-idempotency-key: XYZ.51403.MLT.30

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==

x-fapi-auth-date: Tue, 17 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

Accept: application/json

{

  "Data": {

    "Permission": "Update",

    "DomesticFutureDatedPaymentId": "223567",

    "ExpectedExecutionDateTime": "2020-04-23T13:17:14.339+03:00",

    "ExpectedSettlementDateTime": "2020-04-23T13:17:14.339+03:00"

  }

}

5.2.2 Response

201 Created

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

{
  "Data": {
    "ConsentId": "12398",
    "Permission": "update",
    "DomesticFutureDatedPaymentId": "223567",
    "ExpectedExecutionDateTime": "2020-04-23T13:17:14.340+03:00",
    "ExpectedSettlementDateTime": "2020-04-23T13:17:14.340+03:00",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "BH.OBF.DNS",
        "Amount": {
          "Amount": "2.13",
          "Currency": "BHD"
        }
      }
    ]
  }

}

5.3  GET /domestic-future-dated-payment-cancellation-consents/{ConsentId}

5.3.1 Request

GET /domestic-future-dated-payment-cancellation-consents/12398

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 17 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Accept: application/json

5.3.2 Response

200 OK

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

{

  "Data": {

    "ConsentId": "12398",

    "Permission": "update",

    "DomesticFutureDatedPaymentId": "223567",

    "ExpectedExecutionDateTime": "2020-04-23T13:17:14.340+03:00",

    "ExpectedSettlementDateTime": "2020-04-23T13:17:14.340+03:00",

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "BH.OBF.DNS",

        "Amount": {

          "Amount": "2.13",

          "Currency": "BHD"

        }

      }

    ]

  }

}

 

 

CENTRAL BANK OF BAHRAIN © 2020