Versions Compared

Version Old Version 16 New Version 17
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

Codes

Pattern

OBWritePaymentDetailsResponse

 

OBWritePaymentDetailsResponse

 

OBWritePaymentDetailsResponse

 

 

Data

1..1

OBWritePaymentDetailsResponse/Data

 

OBWritePaymentDetailsResponse/Data

 

 

PaymentStatus

0..n

OBWritePaymentDetailsResponse/Data/PaymentStatus

Payment status details.

OBWritePaymentDetailsResponse/Data/PaymentStatus

 

 

PaymentTransactionId

1..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/PaymentTransactionId

Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.

 

String

 

 

Status

1..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/Status

Status of a transfer, as assigned by the transaction administrator.

 

String

Enum:

  • Accepted

  • AcceptedCancellationRequest

  • AcceptedCreditSettlementCompleted

  • AcceptedCustomerProfile

  • AcceptedFundsChecked

  • AcceptedSettlementCompleted

  • AcceptedSettlementInProcess

  • AcceptedTechnicalValidation

  • AcceptedWithChange

  • AcceptedWithoutPosting

  • Cancelled

  • NoCancellationProcess

  • PartiallyAcceptedCancellationRequest

  • PartiallyAcceptedTechnicalCorrect

  • PaymentCancelled

  • Pending

  • PendingCancellationRequest

  • Received

  • Rejected

  • RejectedCancellationRequest

 

StatusUpdateDateTime

1..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusUpdateDateTime

Date and time at which the status was assigned to the transfer. All dates in the JSON payloads are represented in ISO 8601 date-time format.

DateTime

 

 

StatusDetail

0..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail

Payment status details as per underlying Payment Rail.

 

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail

 

 

LocalInstrument

0..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/LocalInstrument

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

  • BH.OBF.BIL

 

Status

1..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/Status

Status of a transfer, as assigned by the transaction administrator.

 

String

 

 

StatusReason

 

0..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/StatusReason

 

Reason Code provided for the status of a transfer.

String

Enum:

  • Cancelled

  • PendingFailingSettlement

  • PendingSettlement

  • Proprietary

  • ProprietaryRejection

  • Suspended

  • Unmatched

 

 

StatusReasonDescription

0..1

OBWritePaymentDetailsResponse/Data/PaymentStatus/StatusDetail/ StatusReasonDescription

Reason provided for the status of a transfer.

 

String

 

 

4

...

.

...

  Usage Example

...

4.1  POST /domestic-payments

...

4.1.1   Request

POST /domestic-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": "72544",

      "Initiation": {

      "InstructionIdentification": "0616I029",

      "EndToEndIdentification": "20190616B002",

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

      "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": "STORES-101" },

     "Authorisation": {

      "AuthorisationType": "Single",

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

    "SCASupportData": {

      "RequestedSCAExemptionType": "TO_BE_CONFIRMED",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "85674"  }

  },

  "Risk": {

    "PaymentContextCode": "BillPayment",

    "MerchantCategoryCode": "000123",

    "MerchantCustomerIdentification": "0001234567",

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

    "DomesticPaymentId": "561278129",

    "ConsentId": "72544",

    "CreationDateTime": "2020-03-12T09:42:25.959+03:00",

    "Status": "AcceptedCreditSettlementCompleted",

    "StatusUpdateDateTime": "2020-03-12T09:42:25.959+03:00",

    "ExpectedExecutionDateTime": "2020-03-12T09:42:25.959+03:00",

    "ExpectedSettlementDateTime": "2020-03-12T09:42:25.959+03:00",

    "Refund": {

      "Account": {

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

        "Identification": "08080021325677",

        "Name": "NTPC Inc",

      }

    },

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "TO_BE_CONFIRMED",

        "Amount": {

          "Amount": "20.91",

          "Currency": "BHD"

        }

      }

    ],

    "Initiation": {
      "InstructionIdentification": "0616I029",
      "EndToEndIdentification": "20190616B002",
      "LocalInstrument": "BH.OBF.DNS",
      "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": "STORES-101"

      },

   },

  "Links": {

    "Self": "www.TBC.com"

  },

  "Meta": {

    "TotalPages": 02,

    "FirstAvailableDateTime": "2020-03-12T09:42:25.959+03:00",

    "LastAvailableDateTime": "2020-03-12T09:42:25.959+03:00"

  }

}

...

4.2  GET /domestic-payments/{DomesticPaymentId}

...

4.2.1   Request

GET /domestic-payments/561278129

Authorisation: Bearer 2YotnFZFEjr1zCsicMWpAA

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

x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
Accept: application/json

...

4.2.2  Response

200 OK

x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Content-Type: application/json

...