Versions Compared

Key

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

1.  Overview

The International Payment Consent resource is used by a PISP to register an intent to initiate an International Payment.

This resource description should be read in conjunction with a compatible Payment Initiation API Profile.

2.  Endpoints

Endpoints for the resource - and available methods.

...

The definitions for the Status:

3.  Data Model

The Data Dictionary section gives the detail on the payload content for the International Payment API flows.

...

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

 

 

...