Versions Compared

Version Old Version 12 New Version 13
Changes made by

CBB Admin

CBB Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel1
stylenone

...

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticPaymentRequest

 

OBWriteDomesticPaymentRequest

 

OBWriteDomesticPaymentRequest

 

 

Data

1..1

OBWriteDomesticPaymentRequest/Data

 

OBWriteDomesticPaymentRequest/Data

 

 

ConsentId

1..1

OBWriteDomesticPaymentRequest/Data/ConsentId

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

String

 

 

Initiation

1..1

OBWriteDomesticPaymentRequest/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 domestic payment.

OBDomesticPaymentInitiation

 

 

Risk

1..1

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

 

 

PaymentContextCode

0..1

OBWriteDomesticPaymentRequest/Risk/PaymentContextCode

This field specifies the payment context

 

String

Enum:

  • BillPayment

  • EcommerceGoods

  • EcommerceServices

  • Other

  • PartyToParty

 

MerchantCategoryCode

0..1

OBWriteDomesticPaymentRequest/Risk/MerchantCategoryCode

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

 

String

 

 

MerchantCustomerIdentification

0..1

OBWriteDomesticPaymentRequest/Risk/MerchantCustomerIdentification

The unique customer identifier of the PSU with the merchant.

 

String

 

 

DeliveryAddress

0..1

OBWriteDomesticPaymentRequest/Risk/DeliveryAddress

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

It will contain AddressLine, StreetName, BuildingNumber, PostCode, TownName, CountrySubDivision, Country

OBWriteDomesticPaymentRequest/Risk/DeliveryAddress

 

 

3.

...

3  Domestic Payment - Response

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

...

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBWriteDomesticPaymentResponse

 

OBWriteDomesticPaymentResponse

 

OBWriteDomesticPaymentResponse

 

 

Data

1..1

OBWriteDomesticPaymentResponse/Data

 

OBWriteDomesticPaymentResponse/Data

 

 

DomesticPaymentId

1..1

OBWriteDomesticPaymentResponse/Data/DomesticPaymentId

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

String

 

 

ConsentId

1..1

OBWriteDomesticPaymentResponse/Data/ConsentId

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

String

 

 

CreationDateTime

1..1

OBWriteDomesticPaymentResponse/Data/CreationDateTime

Date and time at which the message was created.

DateTime

 

 

Status

1..1

OBWriteDomesticPaymentResponse/Data/Status

Specifies the status of the payment information group.

String

Enum:

  • AcceptedCreditSettlementCompleted

  • AcceptedWithoutPosting

  • AcceptedSettlementCompleted

  • AcceptedSettlementInProcess

  • Pending

  • Rejected

 

StatusUpdateDateTime

1..1

OBWriteDomesticPaymentResponse/Data/StatusUpdateDateTime

Date and time at which the resource status was updated.

DateTime

 

 

ExpectedExecutionDateTime

0..1

OBWriteDomesticPaymentResponse/Data/ExpectedExecutionDateTime

Expected execution date and time for the payment resource.

DateTime

 

 

ExpectedSettlementDateTime

0..1

OBWriteDomesticPaymentResponse/Data/ExpectedSettlementDateTime

Expected settlement date and time for the payment resource.

DateTime

 

 

Refund

0..1

OBWriteDomesticPaymentResponse/Data/Refund

Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.

OBWriteDomesticPaymentResponse/Data/Refund

 

 

Account

1..1

OBWriteDomesticPaymentResponse/Data/Refund/Account

Provides the details to identify an account. 

 

 

OBWriteDomesticPaymentResponse/Data/Refund/Account

 

 

SchemeName

1..1

OBWriteDomesticPaymentResponse/Data/Refund/Account/SchemeName

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

String

Enum:

  • BH.OBF.IBAN

 

Identification

1..1

OBWriteDomesticPaymentResponse/Data/Refund/Account//Identification

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

String

 

 

Name

0..1

OBWriteDomesticPaymentResponse/Data/Refund/Account/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.

 

ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

String

 

 

Charges

0..n

OBWriteDomesticPaymentResponse/Data/Charges

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

OBWriteDomesticPaymentResponse/Data/Charges

 

 

ChargeBearer

0..n

OBWriteDomesticPaymentResponse/Data/Charges/ChargeBearer

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

String

Enum:

  • BorneByCreditor

  • BorneByDebtor

  • FollowingServiceLevel

  • Shared

 

Type

0..n

OBWriteDomesticPaymentResponse/Data/Charges/Type

This denotes the charge type in a coded form.

String

Enum:

To be determined

 

Amount

1..1

OBWriteDomesticPaymentResponse/Data/Charges/Amount

Amount of money associated with the charge type.

 

OBActiveOrHistoricCurrencyAndAmount

 

 

 

Amount

1..1

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

OBWriteDomesticPaymentResponse/Data/Charges/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}$

Initiation

1..1

OBWriteDomesticPaymentResponse/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 domestic payment.

OBDomesticPaymentInitiation

 

 

Debtor

0..1

OBWriteDomesticPaymentResponse/Data/Debtor

Set of elements used to identify a person or an organisation.

OBWriteDomesticPaymentResponse/Data/Debtor

 

 

Name

1..1

OBWriteDomesticPaymentResponse/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.

Note: The account name is not the product name or the nickname of the account.

String

 

 

 

3.

...

4  Domestic Payment Order - Payment Details - Response

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

...

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

    "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

...