Versions Compared

Key

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

1.      Overview

...

Resource

HTTP Operation

Endpoint

Mandatory ?

Scope

Grant Type

Message Signing

Idempotency Key

Request Object

Response Object

international-payment-consents

POST

POST /international-payment-consents

Conditional

payments

Client Credentials

Signed Request Signed Response

Yes

OBWriteInternationalConsent

OBWriteInternationalConsentResponse

international-payment-consents

GET

GET /international-payment-consents/{ConsentId}

Mandatory (if resource POST implemented)

payments

Client Credentials

Signed Response

No

NA

OBWriteInternationalConsentResponse

international-payment-consents

GET

GET /international-payment-consents/{ConsentId}/funds-confirmation

Mandatory (if resource POST implemented)

payments

Authorization Authorisation Code

Signed Response

No

NA

OBWriteFundsConfirmationResponse

...

  • An ASPSP can only respond to a funds confirmation request if the international-payment-consent resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and a UKan BH.OBIEOBF.Resource.InvalidConsentStatus error code.

  • Confirmation of funds requests do not affect the status of the international-payment-consent resource

...

 S.No.

Status

Status Description

1

AwaitingAuthorisation

The consent resource is awaiting PSU authorisation.

2

Rejected

The consent resource has been rejected.

3

Authorised

The consent resource has been successfully authorised.

4

Consumed

The consented action has been successfully completed. This does not reflect the status of the consented action

3.1        Reused Classes

3.1.1        OBInternationalPaymentInitiation

This section describes the OBInternationalPaymentInitiation class which is reused as the Initiation object in the international-payment-consent resource.

3.1.1.1       UML Diagram

 

...

3.1.1.2       Notes

For the OBInternationalPaymentInitiation Initiation object:

  • All elements in the Initiation payload that are specified by the PISP, must not be changed via the ASPSP as this is part of formal consent from the PSU.

  • If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the international-payment-consent request immediately.

  • If the ASPSP establishes a problem with the international-payment-consent after the API call, the ASPSP must set the Status of the international-payment-consent resource to Rejected.

  • DebtorAccount is optional as the PISP may not know the account identification details for the PSU.

  • If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the international-payment-consent will be set to Rejected after PSU authentication.

  • CreditorAgent must at least have either of the pairs provided: Scheme Name and Identification or Name and Postal Address.

  • Account Identification field usage:

    Where "BH.OBF.SchemeName" is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount). Ex. the Identification populated with the combination of Code and Account Number.

    • Where the "BH.OBF.IBAN" is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN.

  • LocalInstrument is the requested payment scheme for execution. This is a free-text field.

  • InstructionPrioirty may be used by the ASPSP to determine the payment scheme for execution.

  • The InstructedAmount object must be populated with the desired Amount and Currency of transfer, regardless of the currency of the DebtorAccount or CreditorAccount. I.e., a PSU may wish to transfer 100EUR 100BHD from a GBP BH DebtorAccount (InstructedAmount will be 100EUR100BHD), or 100GBP 100BHD to an EUR BH CreditorAccount (the InstructedAmount will be 100GBP100BHD).

  • The CurrencyOfTransfer is used to specify the currency the funds will be transferred. I.e., a PSU may wish to transfer 100USD 100BHD from a GBP BH DebtorAccount to a Rupee INR CreditorAccount in India.

  • The ChargeBearer field is used by the PISP to indicate the bearer of charges. An ASPSP must reject the request if the requested charge allocation cannot be fulfilled.

The OBInternationalPaymentInitiation /ExchangeRateInformation object must conform to these behaviours:

  • A PISP must specify the DebtorAccount currency in the UnitCurrency field if the PISP is requesting a specific RateType so the ASPSP can respond with an exchange rate quote prior to PSU authorisation.

  • A PISP may indicate an exchange rate request using the RateType with these enumerations:

    • Actual.

    • Agreed.

    • Indicative.

  • A PISP must specify ExchangeRate and ContractIdentification when requesting an Agreed RateType. If an invalid ContractIdentification and ExchangeRate are requested together, an ASPSP must reject the request.

    • For an "Agreed" RateType a requested exchange rate is populated in the ExchangeRate field, against the UnitCurrency. I.e, if the UnitCurrency is GBP BHD and CurrencyOfTransfer is USD, then ExchangeRate will be 12.34 65 (USD to 1 GBPBHD).

    • For an "Agreed" RateType the exchange rate contract identifier is populated in the ContractIdentification field.

  • A PISP must not specify ExchangeRate and/or ContractIdentification when requesting an Actual RateType.

  • A PISP must not specify ExchangeRate and/or ContractIdentification when requesting an Indicative RateType.

...

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBInternationalPaymentInitiation

 

OBInternationalPaymentInitiation

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 international payment.

OBInternationalPaymentInitiation

 

 

InstructionIdentification

1..1

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

10..1

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

Enum:

  • Yes

  • No

 

LocalInstrument

0..1

 OBInternationalPaymentInitiation/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:To be determined

  • BH.OBF.DNS

  • BH.OBF.NRT

  • BH.OBF.BIL

 

 

InstructionPriority

0..1

 OBInternationalPaymentInitiation/InstructionPriority

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

String

Enum:

  • Normal

  • Urgent

 

Purpose

0..1

 OBInternationalPaymentInitiation/Purpose

Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

String

 

 

ExtendedPurpose

0..1

 OBInternationalPaymentInitiation/ExtendedPurpose

Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.

String

 

 

ChargeBearer

0..1

 OBInternationalPaymentInitiation/ChargeBearer

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

String

Enum:

  • BorneByCreditor

  • BorneByDebtor

  • FollowingServiceLevel

  • Shared

 

CurrencyOfTransfer

1..1

 OBInternationalPaymentInitiation/CurrencyOfTransfer

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

String

 

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

DestinationCountryCode

0..1

 OBInternationalPaymentInitiation/DestinationCountryCode

Country in which Credit Account is domiciled. Nation with its own government.

String

 

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

InstructedAmount

1..1

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

 OBInternationalPaymentInitiation/InstructedAmount

 

 

Amount

1..1

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

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

ExchangeRateInformation

0..1

 OBInternationalPaymentInitiation/ExchangeRateInformation

Provides details on the currency exchange rate and contract.

 OBInternationalPaymentInitiation/ExchangeRateInformation

 

 

UnitCurrency

1..1

 OBInternationalPaymentInitiation/ExchangeRateInformation/UnitCurrency

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

String

 

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

ExchangeRate

0..1

 OBInternationalPaymentInitiation/ExchangeRateInformation/ExchangeRate

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

Number

 

 

RateType

1..1

 OBInternationalPaymentInitiation/ExchangeRateInformation/RateType

Specifies the type used to complete the currency exchange.

String

Enum:

  • Actual

  • Agreed

  • Indicative

 

ContractIdentification

0..1

 OBInternationalPaymentInitiation/ExchangeRateInformation/ContractIdentification

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

String

 

 

DebtorAccount

0..1

 OBInternationalPaymentInitiation/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

 OBInternationalPaymentInitiation/DebtorAccount

 

 

SchemeName

1..1

 OBInternationalPaymentInitiation/DebtorAccount/SchemeName

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

String

Enum:

  • BH.OBF.

BBANBH.OBF.
  • IBAN

BH.OBF.PAN

 

Identification

1..1

 OBInternationalPaymentInitiation/DebtorAccount/Identification

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

String

 

 

Name

0..1

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

 

 

SecondaryIdentificationCreditor

0..1

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

 

 

Creditor

0..1

 OBInternationalPaymentInitiation/Creditor

Party to which an amount of money is due.

 OBInternationalPaymentInitiation/Creditor

 

 

Creditor

Party to which an amount of money is due.

 OBInternationalPaymentInitiation/Creditor

 

 

Name

0..1

 OBInternationalPaymentInitiation/Creditor/Name

Name by which a party is known and which is usually used to identify that party.

String

 

 

PostalAddress

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBInternationalPaymentInitiation/Creditor/PostalAddress

 

 

AddressType

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/AddressType

Identifies the nature of the postal address.

String

Enum:

  • Business

  • Correspondence

  • DeliveryTo

  • MailTo

  • POBox

  • Postal

  • Residential

  • Statement

 

Department

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/Department

Identification of a division of a large organisation or building.

String

 

 

SubDepartment

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

String

 

 

AddressLine

0..7

 OBInternationalPaymentInitiation/Creditor/PostalAddress/AddressLine

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

String

 

 

StreetName

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/StreetName

Name of a street or thoroughfare

String

 

 

BuildingNumber

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/BuildingNumber

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

String

 

 

RoadNumberPostCode

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/Creditor/PostalAddress/RoadNumberPostCode

Number of a road or thoroughfare.

String

BlockNumberIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

String

 

 

TownName

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/Creditor/PostalAddress/BlockNumber

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

String

CityTownName

Name of a built-up area, with defined boundaries, and a local government

String

 

 

CountrySubDivision

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/Creditor/PostalAddress/CityCountrySubDivision

Name of the city

StringIdentifies a subdivision of a country such as state, region, country

String

 

 

Country

0..1

 OBInternationalPaymentInitiation/Creditor/PostalAddress/Country

Nation with its own government.

String

 

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

CreditorAgent

0..1

 OBInternationalPaymentInitiation/CreditorAgent

Financial institution servicing an account for the creditor.

 OBInternationalPaymentInitiation/CreditorAgent

 

 

SchemeName

0..1

 OBInternationalPaymentInitiation/CreditorAgent/SchemeName

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

String

Enum:

  • BH.OBF.BICFI   IBAN

 

 

Identification

0..1

 OBInternationalPaymentInitiation/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

String

 

 

Name

0..1

 OBInternationalPaymentInitiation/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

String

 

 

PostalAddress

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress

 

 

AddressType

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

String

Enum:

  • Business

  • Correspondence

  • DeliveryTo

  • MailTo

  • POBox

  • Postal

  • Residential

  • Statement

 

Department

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

String

 

 

SubDepartment

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

String

 

 

AddressLine

0..7

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/AddressLine

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

String

 

 

BuildingNumberStreetName

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/BuildingNumberNumber that identifies the position of a building on a street.StreetName

Name of a street or thoroughfare

String

 

 

BuildingNumber

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street

String

 

 

RoadNumberPostCode

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/RoadNumberPostCode

Number Identifier consisting of a road or thoroughfare.

String

BlockNumbergroup of letters and/or numbers that is added to a postal address to assist the sorting of mail

String

 

 

TownName

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/BlockNumber

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

String

CityTownName

Name of a built-up area, with defined boundaries, and a local government

String

 

 

CountrySubDivision

0..1

OBInternationalPaymentInitiation OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/CityCountrySubDivision

Name of the cityIdentifies a subdivision of a country such as state, region, country

String

 

 

Country

0..1

 OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/Country

Nation with its own government.

String

 

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

CreditorAccount

1..1

 OBInternationalPaymentInitiation/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBInternationalPaymentInitiation/CreditorAccount

 

 

SchemeName

1..1

 OBInternationalPaymentInitiation/CreditorAccount/SchemeName

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

String

BH.OBF.IBAN

Enum:

  • BH.OBF.BBAN

  • :

    • BH.OBF.PANIBAN

     

     

    Identification

    1..1

     OBInternationalPaymentInitiation/CreditorAccount/Identification

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

    String

     

     

    Name

    1..1

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

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

     

     

    RemittanceInformation

    0..1

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

     OBInternationalPaymentInitiation/RemittanceInformation

     

     

    RemittanceDescription

    0..1

     OBInternationalPaymentInitiation/RemittanceInformation/Unstructured

    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

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

     OBInternationalPaymentInitiation/SupplementaryData

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

    OBSupplementaryData

     

     

     

    3.1.2        OBExchangeRateResponse

    This section describes the OBExchangeRateResponse class, which is used in the response payloads in the international-payment-consent resource.

    3.1.2.1       UML Diagram

    ...

    3.1.2.2       Data Dictionary

    Name

    Occurrence

    XPath

    EnhancedDefinition

    Class

    Codes

    Pattern

    OBExchangeRateResponse

     

    OBExchangeRateResponse

    Further detailed information on the exchange rate that has been used in the payment transaction.

    OBExchangeRateResponse

     

     

    UnitCurrency

    1..1

    OBExchangeRateResponse/UnitCurrency

    Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

    String

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

    ExchangeRate

    1..1

    OBExchangeRateResponse/ExchangeRate

    The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

    Number

     

     

    RateType

    1..1

    OBExchangeRateResponse/RateType

    Specifies the type used to complete the currency exchange.

    String

    Enum:

    • Actual

    • Agreed

    • Indicative

     

    ContractIdentification

    0..1

    OBExchangeRateResponse/ContractIdentification

    Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

    String

     

     

    ExpirationDateTime

    0..1

    OBExchangeRateResponse/ExpirationDateTime

    Specified date and time the exchange rate agreement will expire.

    DateTime

     

     

     

     

    3.

    ...

    2        International Payment Consent - Request

    The OBWriteInternationalConsent object will be used for the call to:

    • POST /international-payment-consents

    3.

    ...

    2.1        UML Diagram

     

    ...

    3.

    ...

    2.2        Notes

    The international-payment-consent request contains these objects:

    ...

    Name

    Occurrence

    XPath

    EnhancedDefinition

    Class

    Codes

    Pattern

    OBWriteInternationalConsent

     

    OBWriteInternationalConsent

     

    OBWriteInternationalConsent

     

     

    Data

    1..1

    OBWriteInternationalConsent/Data

     

    OBWriteInternationalConsent/Data

     

     

    ReadRefundAccount

    0..1

    OBWriteInternationalConsent/Data/ReadRefundAccount

    Specifies to share the refund account details with PISP

    String

    Enum:

    • Yes

    • No

     

    Initiation

    1..1

    OBWriteInternationalConsent/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 international payment.

    OBInternationalPaymentInitiation

     

     

    Authorisation

    0..1

    OBWriteInternationalConsent/Data/Authorisation

    The authorisation type request from the TPP.

    OBAuthorisation

     

     

    SCASupportData

    0..1

    OBWriteInternationalConsent/Data/SCASupportData

    Supporting Data provided by TPP, when requesting SCA Exemption.

    OBSCASupportData

     

     

    Risk

    1..1

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

     

     

     3.

    ...

    3        International Payment Consent - Response

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

    • POST /international-payment-consents

    • GET /international-payment-consents/{ConsentId}

    3.

    ...

    3.1        UML Diagram

     

    ...

    3.

    ...

    3.2        Notes

    The international-payment-consent response contains the full original payload from the international-payment-consent request with the additional elements below:

    ...

    • For an Agreed RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:

      • An ASPSP may respond with the same requested exchange rate in the Data/ExchangeRateInformation object.

      • An ASPSP must not populate Data/ExchangeRateInformation/ExpirationDateTime.

    • For an Actual RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:

      • An ASPSP must respond with an actual quote in the Data/ExchangeRateInformation object.

      • An ASPSP must respond with an actual ExchangeRate quote.

      • An ASPSP must respond with an ExpirationDateTime.

      • An ASPSP must reject the international-payment request if the PISP does not submit the international-payment within the ExchangeRateInformation/ExpirationDateTime.

    • For an Indicative RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:

      • An ASPSP must respond with an indicative quote in the Data/ExchangeRateInformation object.

      • An ASPSP must respond with an indicative ExchangeRate quote.

      • An ASPSP must not populate Data/ExchangeRateInformation/ExpirationDateTime for the exchange rate, as it is the market rate on the date of execution (date on which the DebtorAccount is debited)

    3.

    ...

    3.3        Data Dictionary

    Name

    Occurrence

    XPath

    EnhancedDefinition

    Class

    Codes

    Pattern

    OBWriteInternationalConsentResponse

     

    OBWriteInternationalConsentResponse

     

    OBWriteInternationalConsentResponse

     

     

    Data

    1..1

    OBWriteInternationalConsentResponse/Data

     

    OBWriteInternationalConsentResponse/Data

     

     

    ConsentId

    1..1

    OBWriteInternationalConsentResponse/Data/ConsentId

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

    String

     

     

    CreationDateTime

    1..1

    OBWriteInternationalConsentResponse/Data/CreationDateTime

    Date and time at which the resource was created.

    DateTime

     

     

    Status

    1..1

    OBWriteInternationalConsentResponse/Data/Status

    Specifies the status of consent resource in code form.

    String

    Enum:

    • Authorised

    • AwaitingAuthorisation

    • Consumed

    • Rejected

     

    StatusUpdateDateTime

    1..1

    OBWriteInternationalConsentResponse/Data/StatusUpdateDateTime

    Date and time at which the resource status was updated.

    DateTime

     

     

    ReadRefundAccount

    0..1

    OBWriteInternationalConsent/Data/ReadRefundAccount

    Specifies to share the refund account details with PISP

    String

    Enum:

    • Yes

    • No

     

    CutOffDateTime

    0..1

    OBWriteInternationalConsentResponse/Data/CutOffDateTime

    Specified cut-off date and time for the payment consent.

    DateTime

     

     

    ExpectedExecutionDateTime

    0..1

    OBWriteInternationalConsentResponse/Data/ExpectedExecutionDateTime

    Expected execution date and time for the payment resource.

    DateTime

     

     

    ExpectedSettlementDateTime

    0..1

    OBWriteInternationalConsentResponse/Data/ExpectedSettlementDateTime

    Expected settlement date and time for the payment resource.

    DateTime

     

     

    Charges

    0..n

    OBWriteInternationalConsentResponse/Data/Charges

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

    OBWriteInternationalConsentResponse/Data/Charges

     

     

    ChargeBearer

    0..n

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

    0..n

    OBWriteInternationalConsentResponse/Data/Charges/ Type

    Charge type, in a coded form.

    String

    Enum:
    TBD

     

    Amount

    0..n

    OBWriteInternationalConsentResponse/Data/Charges/Amount

    Amount of money associated with the charge type.

    OBWriteInternationalConsentResponse/Data/Charges/Amount

     

     

    Amount

    0..n

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

    0..n

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

    ExchangeRateInformation

    0..1

    OBWriteInternationalConsentResponse/Data/ExchangeRateInformation

    Further detailed information on the exchange rate that has been used in the payment transaction.

    OBExchangeRateResponse

     

     

    Initiation

    1..1

    OBWriteInternationalConsentResponse/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 international payment.

    OBInternationalPaymentInitiation

     

     

    Authorisation

    0..1

    OBWriteInternationalConsentResponse/Data/Authorisation

    The authorisation type request from the TPP.

    OBAuthorisation

     

     

    SCASupportData

    0..1

    OBWriteInternationalConsentResponse/Data/SCASupportData

    Supporting Data provided by TPP, when requesting SCA Exemption.

    OBSCASupportData

     

     

    Debtor

    0..1

    OBWriteInternationalConsentResponse/Data/Debtor

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

    OBWriteInternationalConsentResponse/Data/Debtor

     

     

    Name

    1..1

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

     

     

    Risk

    1..1

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

     

     

    3.

    ...

    4       International Payment Consent Confirmation of Funds - Response

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

    • GET /international-payment-consents/{ConsentId}/funds-confirmation

    3.

    ...

    4.1        UML Diagram

     

    ...

    3.5.2        Notes

    The confirmation of funds response contains the result of a funds availability check, or SupplementaryData

    ...

    POST /international-payment-consents

    AuthorizationAuthorisation: 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": {
        "ReadRefundAccount": "No",
        "Initiation": {
        "InstructionIdentification": "0616I029",
          "EndToEndIdentification": "20190616B002",
          "LocalInstrument": " TO_BE_DETERMINEDBH.OBF.DNS ",
          "InstructionPriority": "Normal",
          "Purpose": " ",
          "ExtendedPurpose": " ",
          "ChargeBearer": "BorneByCreditor",
          "CurrencyOfTransfer": "BHD",
          "DestinationCountryCode": "BH",
          "InstructedAmount": {
            "Amount": "5.60",
            "Currency": "BHD"
          },
          "ExchangeRateInformation": {
            "UnitCurrency": "USD",
            "ExchangeRate": 2.65,
            "RateType": "Actual",
            "ContractIdentification": "FEC"
          },
          "DebtorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "BH10CBBU00100000008876",
            "Name": "Albert JohnBH10CBBU00100000008876",
            "SecondaryIdentificationName": "00023Albert John",
          },
          "Creditor": {
            "Name": "Daniel d’souza",
            "PostalAddress": {
              "AddressType": "Business",
            "Department          "AddressLine": "TO_BE_CONFIRMED",
            "SubDepartment": "TO_BE_CONFIRMED",
            "AddressLine": "ABC Bank, Diplomatic Area”
            "BuildingNumber": "Building 152",
            “RoadNumber”: “Road 1703”,
            “BlockNumber”: “Block 317”,
            "City": "Manama",
            ABC Bank, Diplomatic Area”

              “StreetName”: “Al Barsha”

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

              "Country": "BahrainBH",     
            }
          },

          "CreditorAgent": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "USU00100000008984736",
            "Name": "Joseph Niel",
            "PostalAddress": {
              "AddressType": "Business",
            "Department": "TO_BE_CONFIRMED",
            "SubDepartment": "TO_BE_CONFIRMED",
            "  

              "AddressLine": "Batelco Headquarters”
           

              “StreetName”: “Acacia Avenue”

              "BuildingNumber": "Building 1095227",
            “RoadNumber”: “Road 1423”,
            “BlockNumber”: “Block 365”,
            "City": "Hamala",
                      "PostCode": "3122",
              "TownName": "Manama",
              "CountySubDivision": "Manama”             

              "Country": "BahrainBH",     
            }
          },
          "CreditorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": " USU0010000000667346“USU0010000000667346",
            "Name": "Daniel d’souza ",
          },
          "RemittanceInformation": {
            "RemittanceDescription": "External Ops Code 34251",
            "Reference": "XYZ-101"
          },
       

    "Authorisation": {
          "AuthorisationType": "Single",
          "CompletionDateTime": "2020-03-19T06:17:39.597Z597+03:00"
        },
        "SCASupportData": {
          "RequestedSCAExemptionType": "BillPayment“TO_BE_CONFIRMED ",

             "AppliedAuthenticationApproach": "CASCA",
          "ReferencePaymentOrderId": "936427-2"
        } 

      },

     "Risk": {
    },

        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
                      "AddressLine": "ABC Bank, Diplomatic Area”
           

              “StreetName”: “Al Barsha”

              "BuildingNumber": "Building 15227",
            “RoadNumber”: “Road 1703”,
            “BlockNumber”: “Block 317”,
            "City          "PostCode": "317",
              "TownName": "Manama",
           
              "CountySubDivision": "Manama”             

              "Country": "BahrainBH",  }     
                 },
        }

    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": "723852",
        "CreationDateTime": "2020-03-19T06:17:39.598Z598+03:00",
        "Status": "Authorised",
        "StatusUpdateDateTime": "2020-03-19T06:17:39.598Z598+03:00",
        "ReadRefundAccount": "No",
        "CutOffDateTime": "2020-03-19T06:17:39.598Z598+03:00",
        "ExpectedExecutionDateTime": "2020-03-19T06:17:39.598Z598+03:00",
        "ExpectedSettlementDateTime": "2020-03-19T06:17:39.598Z598+03:00",
        "Charges": [
          {
            "ChargeBearer": "BorneByCreditor",
            "Type": "TO_BE_CONFIRMED",
            "Amount": {
              "Amount": "string2.41",
              "Currency": "stringBHD"
            }
          }
        ],
        
        "ExchangeRateInformation": {
          "UnitCurrency": "USD",
          "ExchangeRate": 2.65,
          "RateType": "Actual",
          "ContractIdentification": "FEC",
          "ExpirationDateTime": "2020-03-19T06:17:39.598Z598+03:00"
        },    "Initiation": {
          "InstructionIdentification": "0616I029",

          "EndToEndIdentificationInitiation": "20190616B002",{
          "LocalInstrumentInstructionIdentification": "TO_BE_DETERMINED0616I029",
          "InstructionPriorityEndToEndIdentification": "Normal20190616B002",
          "PurposeLocalInstrument": “BH.OBF.DNS " ",
          "ExtendedPurposeInstructionPriority": "Normal",
          "ChargeBearer": "BorneByCreditor",
          "CurrencyOfTransfer": "BHD",
          "DestinationCountryCode": "BH",
          "InstructedAmount": {
            "Amount": "5.60",
            "Currency": "BHD"
          },

      "ExchangeRateInformation": {
            "UnitCurrency": "USD",
            "ExchangeRate": 2.65,
            "RateType": "Actual",
            "ContractIdentification": "FEC"
          },

    "DebtorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "BH10CBBU00100000008876",
            "Name": "Albert John",
            "SecondaryIdentification": "00023"
          },
          "Creditor": {
            "Name": "Daniel d’souza",
            "PostalAddress": {
              "AddressType": "Business",
            "Department": "TO_BE_CONFIRMED",
            "SubDepartment": "TO_BE_CONFIRMED",
                      "AddressLine": "ABC Bank, Diplomatic Area”
           

              “StreetName”: “Al Barsha”

              "BuildingNumber": "Building 15227",
            “RoadNumber”: “Road 1703”,
            “BlockNumber”: “Block 317”,
            "City": "Manama",
                      "PostCode": "317",
              "TownName": "Manama",
              "CountySubDivision": "Manama”             

              "Country": "BahrainBH",            },
            }
          },

      "CreditorAgent": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "USU00100000008984736",
            "Name": "Joseph Niel",
            "PostalAddress": {
              "AddressType": "Business",
            "Department": "TO_BE_CONFIRMED",
            "SubDepartment": "TO_BE_CONFIRMED",       

              "AddressLine": "Batelco Headquarters”       

              “StreetName”: “Acacia Avenue”

              "BuildingNumber": "Building 1095227",
            “RoadNumber”: “Road 1423”,
            “BlockNumber”: “Block 365”,
            "City": "Hamala",
                      "PostCode": "3122",
              "TownName": "Manama",
              "CountySubDivision": "Manama”             

              "Country": "BahrainBH",
            }     
          },

    "CreditorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": " USU0010000000667346",
            "Name": "Daniel d’souza ",
          },
          "RemittanceInformation": {
            "RemittanceDescription": "External Ops Code 34251",
            "Reference": "XYZ-101"
          },
        },
        "Authorisation": {
          "AuthorisationType": "Single",
          "CompletionDateTime": "2020-03-19T06:17:39.598Z598+03:00"
        },
        "SCASupportData": {
          "RequestedSCAExemptionType": " BillPaymentTO_BE_CONFIRMED ",
          "AppliedAuthenticationApproach": "CASCA",
          "ReferencePaymentOrderId": "936427-2"
        }

      },
      "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": "ABC Bank, Diplomatic Area”
            Area”

          “StreetName”: “Al Barsha”

          "BuildingNumber": "Building 15227",
            “RoadNumber”: “Road 1703”,
            “BlockNumber”: “Block 317”,
            "City": "Manama",
                  "PostCode": "317",
          "TownName": "Manama",
          "CountySubDivision": "Manama”             

          "Country": "BahrainBH",         }
           },
      "Links": {
        "Self": "www.TBC.com"
      },
      "Meta": {
        "TotalPages": 01,
        "FirstAvailableDateTime": "2020-03-19T09:10:17.596Z596+03:00",
        "LastAvailableDateTime": "2020-03-19T09:10:17.596Z596+03:00"
      }
    }

    4.2.  GET / international-payment-consents/{ConsentId}/funds-confirmation

    ...

    GET/ international-payment-consents/723852/funds-confirmation

    AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

    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

    ...

    200 OK

    x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

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

    Content-Type: application/json

    314Z true596Z596Z

    {
      "Data": {
        "FundsAvailableResult": {
          "FundsAvailableDateTime": "2020-03-19T12:25:29.

    314+03:00",
          "FundsAvailable":

    “true”
        },
      },
      "Links": {
        "Self": "www.TBC.com"
      },
      "Meta": {
        "TotalPages": 1,
        "FirstAvailableDateTime": "2020-03-19T09:10:17.

    596+03:00",
        "LastAvailableDateTime": "2020-03-19T09:10:17.

    596+03:00"
      }
    }