Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Occurrence

XPath

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

 

 

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

 

 

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. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

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.INTERNAL

  • BH.OBF.EFTS-CSCT-NRT

  • BH.OBF. EFTS-CSCT-DNS

 

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.BBAN

  • 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

 

 

SecondaryIdentification

0..1

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

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.BBAN

  • 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. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

String

 

 

SecondaryIdentification

0..1

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

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

 

 

StreetNameAddressLine

0..17

OBDomesticFutureDatedInitiation/CreditorPostalAddress/StreetNameName of a street or thoroughfareAddressLine

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

String

 

 

BuildingNumber

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/BuildingNumber

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

String

 

 

PostCodeRoadNumber

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/PostCodeRoadNumber

Identifier consisting Number of a group of letters and/or numbers that is added to a postal address to assist the sorting of mailroad or thoroughfare.

String

 

 

TownNameBlockNumber

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/TownNameName of a built-up area, with defined boundaries, and a local governmentBlockNumber

Number that identifies the position of a block in a city.

String

 

 

CountrySubDivisionCity

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/CountrySubDivisionCity

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

String

 

 

Country

0..1

OBDomesticFutureDatedInitiation/CreditorPostalAddress/Country

Nation with its own government.

String

 

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

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

 

 

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. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

String

 

 

SupplementaryData

0..1

OBDomesticFutureDatedInitiation/SupplementaryData

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

OBSupplementaryData

 

 

...

{

  "Data": {

    "Permission": "Create",

    "ReadRefundAccount": "No",

   "Initiation": {

      "InstructionIdentification": "0616I029",

      "EndToEndIdentification": "20190616B002",

      "LocalInstrument": "EFT-CSCT-DNS",

      "RequestedExecutionDateTime": "2020-03-18T04:57:51.126Z",

      "InstructedAmount": {

        "Amount": "2.13",

        "Currency": "BHD"

      },

      "DebtorAccount": {

        "SchemeName": "IBAN",

        "Identification": "BH10BBKU00100000008876",

        "Name": "Aamir Khan",

        "SecondaryIdentification": "00023"

      },

      "CreditorAccount": {

        "SchemeName": "IBAN",

        "Identification": "BH89ABIC00000987654321",

        "Name": "Asif Khan",

        "SecondaryIdentification": "00025"

      },

        "CreditorPostalAddress": {

        " AddressType": "Business",

        "Department": " "TO_BE_CONFIRMED",

        "SubDepartment": "TO_BE_CONFIRMED",

                 "StreetNameAddressLine": "Route 1888",        ABC Bank, Diplomatic Area”

         "BuildingNumber": "27Building 152",

        "PostCode": "317",

        "TownName         “RoadNumber”: “Road 1703”,
         “BlockNumber”: “Block 317”,

         "City": "Manama",        "CountySubDivision": "Manama”
        "Country": "BHBahrain",

        "AddressLine": "Block 317, Road 1702, Building 96”

      },   

 

      "RemittanceInformation": {

        "RemittanceDescription": "Internal ops code 5120101",

        "Reference": "STORE-101"

      },

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-12T09:10:17.594Z"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": "BillPayment",

      "AppliedAuthenticationApproach": "CA",

      "ReferencePaymentOrderId": "000025"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

               "AddressLine": "Block 317, Road 1702, Building 96”,      "SubDepartmentABC Bank, Diplomatic Area”

         "BuildingNumber": "Building 152",

         "StreetName": "Route 1888",      "BuildingNumber": "27"“RoadNumber”: “Road 1703”,
         “BlockNumber”: “Block 317”,

         "PostCodeCity": "317",      "TownName": "Manama",

      "CountySubDivision": "Manama”      

              "Country": "BHBahrain",   

   }

  }

}

4.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.128Z",

    "Status": "Authorised",

    "StatusUpdateDateTime": "2020-03-18T04:57:51.128Z",

    "Permission": "Create",

    "ReadRefundAccount": "No",

    "CutOffDateTime": "2020-03-18T04:57:51.128Z",

    "ExpectedExecutionDateTime": "2020-03-18T04:57:51.128Z",

    "ExpectedSettlementDateTime": "2020-03-18T04:57:51.128Z",

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "TO_BE_CONFIRMED",

        "Amount": {

          "Amount": "2.13",

          "Currency": "BHD"

        }

      }

    ],

   "Initiation": {
      "InstructionIdentification": "07171I030",
      "EndToEndIdentification": "20200716D004",
      "LocalInstrument": "EFT-CSCT-DNS",
      "InstructedAmount": {
        "Amount": "2.13",
        "Currency": "BHD"
      },

      "DebtorAccount": {
        "SchemeName": "IBAN",
        "Identification": "BH10BBKU001000000012345",
        "Name": "Aamir Khan",
        "SecondaryIdentification": "00026"
      },
      "CreditorAccount": {
        "SchemeName": "IBAN",
        "Identification": "BH89ABIB00000123456789",
        "Name": "Asif Khan",
        "SecondaryIdentification": "00026"
      },

          "CreditorPostalAddress": {

        “AddressType"AddressType": "Business",

        "Department": "TO_BE_CONFIRMED",

        "SubDepartment": "TO_BE_CONFIRMED",

                 "StreetNameAddressLine": "Route 1888",
        ABC Bank, Diplomatic Area”

         "BuildingNumber": "27Building 152",        "PostCode": "317",
        "TownName": "Manama",
        "CountySubDivision": "Manama”       

        "Country": "BH         “RoadNumber”: “Road 1703”,
         “BlockNumber”: “Block 317”,

         "City": "Manama",
        "AddressLineCountry": "Block 317, Road 1702, Building 96”Bahrain",

      },

      "RemittanceInformation": {

        "RemittanceDescription": "Internal ops code 5120101",

        "Reference": "STORE-101"

      },  

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-12T09:10:17.595Z"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": "BillPayment",

      "AppliedAuthenticationApproach": "CA",

      "ReferencePaymentOrderId": "0000002345"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

         "AddressLine": "Block 317, Road 1702, Building 96”,    "SubDepartmentABC Bank, Diplomatic Area”

         "BuildingNumber": "Building 152",

    "StreetName": "Route 1888",

    "BuildingNumber": "27",

    "PostCode": "317",

    "TownName         “RoadNumber”: “Road 1703”,
         “BlockNumber”: “Block 317”,

         "City": "Manama",

    "CountySubDivision": "Manama”       

    "        "Country": "BHBahrain",   

    }

  },

  "Links": {

    "Self": "www.TBC.com"

  },

  "Meta": {

    "TotalPages": 02,

    "FirstAvailableDateTime": "2020-03-12T09:10:17.596Z",

    "LastAvailableDateTime": "2020-03-12T09:10:17.596Z"

  }

...