Versions Compared

Version Old Version 18 New Version 19
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

OBPatchDomesticFutureDatedPayment

 

OBPatchDomesticFutureDatedPayment

 

OBPatchDomesticFutureDatedPayment

 

 

Data

1..1

OBPatchDomesticFutureDatedPayment/Data

 

OBPatchDomesticFutureDatedPayment/Data

 

 

ConsentId

1..1

OBPatchDomesticFutureDatedPayment/Data/ConsentId

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

String

 

Status

1..1

OBPatchDomesticFutureDatedPayment/Data /Status

Specifies the status of the payment order resource

String

Enum:

  • RejectedCancellationRequest

  • AcceptedCancellationRequest

  • PendingCancellationRequest

 

4. 

...

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

...

Usage Example

...

4.1  POST /domestic-future-dated-payments

...

4.1.1 Request

POST /domestic-future-dated-payments

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": {

    "ConsentId": "123456",   

    "Initiation": {

      "InstructionIdentification": "07171I030",

      "EndToEndIdentification": "20200716D004",

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

      "RequestedExecutionDateTime": "2020-03-18T05:09:15.869+03:00"

      "InstructedAmount": {

        "Amount": "2.13",

        "Currency": "BHD"

      },   

      "DebtorAccount": {

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

        "Identification": "BH10BBKU00100000004444",

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

      },

      },

  "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=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==

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

Content-Type: application/json

{

  "Data": {

    "DomesticFutureDatedPaymentId": "565656",

    "ConsentId": "123456",

    "CreationDateTime": "2020-03-18T05:09:15.871+03:00",

    "Status": "Cancelled",

    "StatusUpdateDateTime": "2020-03-18T05:09:15.871+03:00",

    "ExpectedExecutionDateTime": "2020-03-18T05:09:15.871+03:00",

    "ExpectedSettlementDateTime": "2020-03-18T05:09:15.871+03:00",

    "Refund": {

      "Account": {

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

        "Identification": "08080021325677",

        "Name": "NTPC Inc ",       

      }

    },

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "TO_BE_CONFIRMED"",

        "Amount": {

          "Amount": "2.13",

          "Currency": "BHD"

        }

      }

    ],

      "Initiation": {

      "InstructionIdentification": "07171I030",

      "EndToEndIdentification": "20200716D004",

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

      "RequestedExecutionDateTime": "2020-03-18T05:09:15.869+03:00"

      "InstructedAmount": {

        "Amount": "2.13",

        "Currency": "BHD"

      },   

      "DebtorAccount": {

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

        "Identification": "BH10BBKU00100000004444",

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

      },

    },

  "Links": {

    "Self": "www.TBC.com",

  },

  "Meta": {

    "TotalPages": 02,

    "FirstAvailableDateTime": "2020-03-18T05:09:15.871+03:00",

    "LastAvailableDateTime": "2020-03-18T05:09:15.871+03:00"

  }

}

...

4.2  PATCH /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}

...

4.2.1 Request

PATCH /domestic-future-dated-payments/88379

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 16 Apr 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

{

  "Data": {

    "ConsentId": "122345",

    "Status": "PendingCancellationRequest"

  }

...

4.2.2 Response

200 Domestic Future Dated Payments Status Updated Successfully

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

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

Content-Type: application/json

...