Payment Initiation APIs

Data
required

Payment Submission

Initiation
required

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.

Initiation

PaymentId
required

OB: Unique identification as assigned by the ASPSP to uniquely identify the payment setup resource.
Length : 1 - 40

string

CreditorAccount
required

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

Creditor Account

CreditorAgent
required

Financial institution servicing an account for the creditor.

Creditor Agent

DebtorAccount
optional

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

Debtor Account

DebtorAgent
optional

Financial institution servicing an account for the debtor.

DebtorAgent

EndToEndIdentification
required

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.
Length : 1 - 35

string

InstructedAmount
required

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.

InstructedAmount

InstructionIdentification
required

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.
Length : 1 - 35

string

RemittanceInformation
optional

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.

Remittance Information

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
required

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
optional

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Amount
required

Pattern : "^-?\\d{1,13}\\.\\d{1,5}$"

string

Currency
required

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.
Pattern : "[A-Z]{3}"

string

Reference
optional

Unique and unambiguous identification of a person.
Length : 1 - 35

string

Unstructured
optional

Name of the identification scheme, in a coded form as published in an external list.
Length : 1 - 140

string

201

Payment submit resource successfully created

Payment Submit POST 201 Response

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

CreationDateTime
required

Date and time at which the resource was created.

string (date-time)

Links
required

Link URIs relevant to the payload

Links

Meta
required

Meta Data Relevant to the payload

Meta

PaymentId
required

OB: Unique identification as assigned by the ASPSP to uniquely identify the payment setup resource.
Length : 1 - 40

string

PaymentSubmissionId
required

OB: Unique identification as assigned by the ASPSP to uniquely identify the payment submission resource.
Length : 1 - 40

string

Status
optional

Specifies the status of the payment submission resource.

enum (AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected)

first
optional

string (uri)

last
optional

string (uri)

next
optional

string (uri)

prev
optional

string (uri)

self
required

string (uri)

total-pages
optional

integer (int32)

oauth2

PSUOAuth2Security

payment

Header

x-idempotency-key
required

Every request will be processed only once per x-idempotency-key

string

Data
required

Payment Setup

Risk
required

Risk

Initiation
required

Initiation

CreditorAccount
required

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

Creditor Account

CreditorAgent
required

Financial institution servicing an account for the creditor.

Creditor Agent

DebtorAccount
optional

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

Debtor Account

DebtorAgent
optional

Financial institution servicing an account for the debtor.

DebtorAgent

EndToEndIdentification
required

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.
Length : 1 - 35

string

InstructedAmount
required

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.

InstructedAmount

InstructionIdentification
required

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.
Length : 1 - 35

string

RemittanceInformation
optional

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.

Remittance Information

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
required

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
optional

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Amount
required

Pattern : "^-?\\d{1,13}\\.\\d{1,5}$"

string

Currency
required

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.
Pattern : "[A-Z]{3}"

string

Reference
optional

Unique and unambiguous identification of a person.
Length : 1 - 35

string

Unstructured
optional

Name of the identification scheme, in a coded form as published in an external list.
Length : 1 - 140

string

DeliveryAddress
optional

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

DeliveryAddress

MerchantCategoryCode
optional

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction
Length : 3 - 4

string

MerchantCustomerIdentification
optional

The unique customer identifier of the PSU with the merchant.
Length : 1 - 70

string

PaymentContextCode
optional

Specifies the payment context

enum (BillPayment, EcommerceGoods, EcommerceServices, Other, PersonToPerson)

AddressLine
optional

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

< string > array

BuildingNumber
optional

Number that identifies the position of a building on a street.
Length : 1 - 16

string

Country
required

Nation with its own government, occupying a particular territory.
Pattern : "[A-Z]{2}"

string

CountrySubDivision
optional

Identifies a subdivision of a country, for instance state, region, county.

< string > array

PostCode
optional

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
Length : 1 - 16

string

StreetName
optional

Name of a street or thoroughfare
Length : 1 - 70

string

TownName
required

Name of a built-up area, with defined boundaries, and a local government.
Length : 1 - 35

string

201

Payment setup resource successfully created

Payment setup POST response

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Data
required

Reflection of The Main Data Payload, with Created Resource ID, Status and Timestamp

Payment Setup Response

Links
required

Link URIs relevant to the payload

Links

Meta
required

Meta Data Relevant to the payload

Meta

Risk
required

Reflection of POSTed Risk profile

Risk

CreationDateTime
required

Date and time at which the resource was created.

string (date-time)

Initiation
required

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.

Initiation

PaymentId
required

OB: Unique identification as assigned by the ASPSP to uniquely identify the payment setup resource.
Length : 1 - 40

string

Status
optional

Specifies the status of the payment resource.

enum (AcceptedCustomerProfile, AcceptedTechnicalValidation, Pending, Rejected)

CreditorAccount
required

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

Creditor Account

CreditorAgent
required

Financial institution servicing an account for the creditor.

Creditor Agent

DebtorAccount
optional

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

Debtor Account

DebtorAgent
optional

Financial institution servicing an account for the debtor.

DebtorAgent

EndToEndIdentification
required

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.
Length : 1 - 35

string

InstructedAmount
required

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.

InstructedAmount

InstructionIdentification
required

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.
Length : 1 - 35

string

RemittanceInformation
optional

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.

Remittance Information

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
required

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Identification
required

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Name
optional

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner’s identity and the account number.
Length : 1 - 70

string

SchemeName
required

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

enum (BBAN, IBAN)

SecondaryIdentification
optional

Identification assigned by an institution to identify an account. This identification is known by the account owner.
Length : 1 - 34

string

Identification
required

Unique and unambiguous identification of a person.
Length : 1 - 35

string

SchemeName
required

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

enum (BICFI, UKSortCode)

Amount
required

Pattern : "^-?\\d{1,13}\\.\\d{1,5}$"

string

Currency
required

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.
Pattern : "[A-Z]{3}"

string

Reference
optional

Unique and unambiguous identification of a person.
Length : 1 - 35

string

Unstructured
optional

Name of the identification scheme, in a coded form as published in an external list.
Length : 1 - 140

string

first
optional

string (uri)

last
optional

string (uri)

next
optional

string (uri)

prev
optional

string (uri)

self
required

string (uri)

total-pages
optional

integer (int32)

DeliveryAddress
optional

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

DeliveryAddress

MerchantCategoryCode
optional

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction
Length : 3 - 4

string

MerchantCustomerIdentification
optional

The unique customer identifier of the PSU with the merchant.
Length : 1 - 70

string

PaymentContextCode
optional

Specifies the payment context

enum (BillPayment, EcommerceGoods, EcommerceServices, Other, PersonToPerson)

AddressLine
optional

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

< string > array

BuildingNumber
optional

Number that identifies the position of a building on a street.
Length : 1 - 16

string

Country
required

Nation with its own government, occupying a particular territory.
Pattern : "[A-Z]{2}"

string

CountrySubDivision
optional

Identifies a subdivision of a country, for instance state, region, county.

< string > array

PostCode
optional

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
Length : 1 - 16

string

StreetName
optional

Name of a street or thoroughfare
Length : 1 - 70

string

TownName
required

Name of a built-up area, with defined boundaries, and a local government.
Length : 1 - 35

string

oauth2

TPPOAuth2Security

tpp_client_credential