Versions Compared

Version Old Version 20 New Version 21
Changes made by

CBB Admin

CBB Admin

Saved on

Key

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

...

Name

Occurrence

XPath

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 (Bank) 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 (Bank) 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 initiation

OBCharge

 

 

ChargeBearer

1..1

OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/ChargeBearer

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

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 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}$

The swagger code for the Domestic Future Dated Payment Consents API can be found on this link

...

4. 

...

 Usage Example

...

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

...

4.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": "Aamir Khan",

              },

      "CreditorAccount": {

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

        "Identification": "BH89ABIC00000987654321",

        "Name": "Asif Khan",

      },

        "CreditorPostalAddress": {

        "AddressType": "Business",

        "AddressLine": "ABC 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": "TO_BE_CONFIRMED",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "000025"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

        "AddressLine": "ABC Bank, Diplomatic Area”

        "StreetName": "Route 1888",

        "BuildingNumber": "27",

        "PostCode": "317",

        "TownName": "Manama",

        "CountySubDivision": "Manama”

        "Country": "BH", }

}

...

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.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": "TO_BE_CONFIRMED",

        "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": "Aamir Khan",
      },
      "CreditorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH89ABIB00000123456789",
        "Name": "Asif Khan",
      },

          "CreditorPostalAddress": {

        "AddressType": "Business",

        "AddressLine": "ABC 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": “TO_BE_CONFIRMED",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "0000002345"

    }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "002345",

    "MerchantCustomerIdentification": "0023456789",

    "DeliveryAddress": {

        "AddressLine": "ABC 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"

  }

} 

...

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

...

4.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"

  }

}

...

4.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": "TO_BE_CONFIRMED",
        "Amount": {
          "Amount": "2.13",
          "Currency": "BHD"
        }
      }
    ]
  }

}

...

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

...

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

...

4.3.2 Response

200 OK

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

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

Content-Type: application/json

...