Versions Compared

Key

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

...

  • The POST action indicates to the ASPSP that a payment consent has been staged. At this point, the PSU user/customer may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.

  • The endpoint allows the PISP to send a copy of the consent (between PSU user/customer and PISP) to the ASPSP for the PSU user/customer to authorise.

  • The ASPSP creates the international-payment-consent resource and responds with a unique ConsentId to refer to the resource.

...

A PISP can optionally retrieve a payment consent resource that they have created to check its status.

2.2.1 Status

Once the PSU user/customer authorises the payment-consent resource, the Status of the payment-consent resource will be updated with "Authorised".

If the PSU user/customer rejects the consent or the international-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".

...

 S.No.

Status

Status Description

1

AwaitingAuthorisation

The consent resource is awaiting PSU user/customer 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

...

  • 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 PSUuser/customer.

  • 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 PSUuser/customer.

  • If the DebtorAccount is specified by the PISP and is invalid for the PSUuserr/customer, then the international-payment-consent will be set to Rejected after PSU user/customer 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 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 user/customer may wish to transfer 100BHD from a BH DebtorAccount (InstructedAmount will be 100BHD), or 100BHD to an BH CreditorAccount (the InstructedAmount will be 100BHD)

  • The CurrencyOfTransfer is used to specify the currency the funds will be transferred. I.e., a PSU user/customer may wish to transfer 100BHD from a 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

...

  • 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 user/customer 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 BHD and CurrencyOfTransfer is USD, then ExchangeRate will be 2.65 (USD to 1 BHD)

    • 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

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

...

  • ConsentId.

  • CreationDateTime the international-payment-consent resource was created.

  • Status and StatusUpdateDateTime of the international-payment-consent resource.

  • CutOffDateTime Behaviour is explained in Payment Initiation API Profile, Section -Payment Restrictions -> CutOffDateTime Behaviour. 

  • ExpectedExecutionDateTime for the international-payment resource if created before CutOffDateTIme - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU user/customer authorisation).

  • ExpectedSettlementDateTime for the international-payment resource if created before CutOffDateTIme - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU user/customer authorisation).

  • Charges array which will be used by the ASPSP to indicate charges, and the ChargeBearer as relevant.

  • Post successful PSU user/customer Authentication, an ASPSP may provide Debtor/Name in the Payment Order Consent Response, even when the Payer did not provide the Debtor Account via PISP

  • ExchangeRateInformation (the ASPSP response) - this object will be used to communicate exchange rate information back to the PISP. It must be consistent with what is requested in the Initiation object from the PISP.

...

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.

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

 

 

...