Module bfsi_payment_initiation_api.model
wso2bfsi/bfsi_payment_initiation_api.model
1.0.0
Functions
getDateTime
Isolated Function
function getDateTime() returns stringGet current Date and Time.
Return Type
- string - current date and time.
getFutureDateTime
Isolated Function
function getFutureDateTime() returns stringGet future Date and Time.
Return Type
- string - future date and time.
getPastDateTime
Isolated Function
function getPastDateTime() returns stringGet past Date and Time.
Return Type
- string - past date and time.
getRandomAmount
Isolated Function
function getRandomAmount() returns stringGenerate a random amount.
Return Type
- string - a random amount.
getRandomId
Isolated Function
function getRandomId() returns stringGenerate a random UUID.
Return Type
- string - a random UUID.
Records
bfsi_payment_initiation_api.model: Amount
Closed record
Amount of money of the cash balance.
Fields
- Amount string(default getRandomAmount()) - A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
- Currency string(default "USD") - 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).
bfsi_payment_initiation_api.model: Creditor
Closed record
Party to which an amount of money is due.
Fields
- Name string? - Name by which a party is known and which is usually used to identify that party.
- PostalAddress PostalAddress? - Information that locates and identifies a specific address, as defined by postal services.
bfsi_payment_initiation_api.model: CreditorAccount
Closed record
Provides the details to identify the beneficiary account.
Fields
- SchemeName string - Name of the identification scheme, in a coded form as published in an external list.
- Identification string - Beneficiary account identification.
- Name string? - The account name is the name or names of the account owner(s) represented at an account level, as displayed by the bank's online channels. Note, the account name is not the product name or the nickname of the account.
- SecondaryIdentification string? - 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).
bfsi_payment_initiation_api.model: CreditorAgent
Closed record
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Fields
- SchemeName string - Name of the identification scheme, in a coded form as published in an external list.
- Identification string - Unique and unambiguous identification of the servicing institution.
bfsi_payment_initiation_api.model: DataCharges
Closed record
Set of elements used to provide details of a charge for the payment initiation.
Fields
- ChargeBearer string - Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- Type string - Charge type, in a coded form.
- Amount Amount - Amount of money associated with the charge type.
bfsi_payment_initiation_api.model: DataRefund
Closed record
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
Fields
- Account CreditorAccount - Provides the details to identify an account.
bfsi_payment_initiation_api.model: DebtorAccount
Closed record
Provides the details to identify the beneficiary account.
Fields
- SchemeName string - Name of the identification scheme, in a coded form as published in an external list.
- Identification string - Beneficiary account identification.
- Name string? - The account name is the name or names of the account owner(s) represented at an account level, as displayed by the bank's online channels. Note, the account name is not the product name or the nickname of the account.
- SecondaryIdentification string? - 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).
bfsi_payment_initiation_api.model: DomesticPaymentInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
Fields
- InstructionIdentification string - 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.
- EndToEndIdentification string - 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.
- LocalInstrument string? - 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.
- InstructedAmount Amount - 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.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- CreditorAccount CreditorAccount - Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
- CreditorPostalAddress PostalAddress? - Information that locates and identifies a specific address, as defined by postal services.
- RemittanceInformation 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.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: DomesticPaymentRequest
Closed record
Represents a domestic pament intitiation request payload.
Fields
- Data DomesticPaymentRequestData - Represents data of the domestic pament intitiation request
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: DomesticPaymentRequestData
Closed record
Represents data of the domestic pament intitiation request.
Fields
- ConsentIdreadonly string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation DomesticPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
bfsi_payment_initiation_api.model: DomesticPaymentResponse
Closed record
Represents the payload of the domestic payment response.
Fields
- Data DomesticPaymentResponseData - Data object Domestic Payment Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: DomesticPaymentResponseData
Closed record
Represents the data inside the payload of the domestic payment response.
Fields
- DomesticPaymentId string - OB: Unique identification as assigned by the bank to uniquely identify the domestic payment resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment information group.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedExecutionDateTime string? - Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedSettlementDateTime string? - Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? - Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- Initiation DomesticPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: DomesticScheduledPaymentData
Closed record
Represents data of the domestic scheduled payment intitiation request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation DomesticScheduledPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
bfsi_payment_initiation_api.model: DomesticScheduledPaymentInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
Fields
- InstructionIdentification string - 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.
- EndToEndIdentification string? - 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.
- LocalInstrument string? - 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.
- RequestedExecutionDateTime string(default getFutureDateTime()) - Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- InstructedAmount Amount - 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.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- CreditorAccount CreditorAccount - Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
- CreditorPostalAddress PostalAddress? - Information that locates and identifies a specific address, as defined by postal services.
- RemittanceInformation 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.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: DomesticScheduledPaymentRequest
Closed record
Represents a domestic scheduled payment request payload.
Fields
- Data DomesticScheduledPaymentData - Represents data of the domestic scheduled payment intitiation request.
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: DomesticScheduledPaymentResponse
Closed record
Represents the payload of the domestic scheduled payment response.
Fields
- Data DomesticScheduledPaymentsResponseData - Data object Domestic Scheduled Payment Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: DomesticScheduledPaymentsResponseData
Closed record
Represents the data inside the payload of the domestic scheduled payment response.
Fields
- DomesticScheduledPaymentId string - OB: Unique identification as assigned by the bank to uniquely identify the domestic schedule payment resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment order resource.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedExecutionDateTime string? - Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedSettlementDateTime string? - Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? - Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- Initiation DomesticScheduledPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: DomesticStandingOrderData
Closed record
Represents data of the domestic standing order intitiation request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation DomesticStandingOrderInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
bfsi_payment_initiation_api.model: DomesticStandingOrderInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
Fields
- Frequency string - Frequency of the standing order payment. Allowed values are EvryDay, EvryWorkgDay, IntrvlWkDay, WkInMnthDay, IntrvlMnthDay and QtrDay.
- Reference string? - 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.
- NumberOfPayments string? - Number of the payments that will be made in completing this frequency sequence including any execute d since the sequence start date.
- FirstPaymentDateTime string(default getFutureDateTime()) - The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- RecurringPaymentDateTime string? - The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- FinalPaymentDateTime string? - The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- FirstPaymentAmount Amount - The amount of the first Standing Order
- RecurringPaymentAmount Amount? - The amount of the recurring Standing Order
- FinalPaymentAmount Amount? - The amount of the final Standing Order
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- CreditorAccount CreditorAccount - Identification assigned by an institution to identify an account. This identification is known by the account owner.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: DomesticStandingOrderRequest
Closed record
Represents a domestic standing order intitiation request payload.
Fields
- Data DomesticStandingOrderData - Represents data of the domestic standing order intitiation request
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: DomesticStandingOrderResponse
Closed record
Set of elements used to define the domestic standing order response.
Fields
- Data DomesticStandingOrderResponseData - Data object Domestic Standing Order Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: DomesticStandingOrderResponseData
Closed record
Represents the data inside the payload of the domestic standing order response.
Fields
- DomesticStandingOrderId string - OB: Unique identification as assigned by the bank to uniquely identify the domestic standing order resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment order resource.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? - Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- Initiation DomesticStandingOrderInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: ErrorDetail
Closed record
An object of detail error codes, and messages, and URLs to documentation to help remediation.
Fields
- ErrorCode string - Low level textual error code, e.g., OB.Field.Missing
- Path string? - Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
- Url string? - URL to help remediate the problem, or provide more information, or to API Reference, or help etc
bfsi_payment_initiation_api.model: ExchangeRateInformation
Closed record
Further detailed information on the exchange rate that has been used in the payment transaction.
Fields
- UnitCurrency string - Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- ExchangeRate decimal? - 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.
- RateType string - Specifies the type used to complete the currency exchange.
- ContractIdentification string? - Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
- ExpirationDateTime string? - Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
bfsi_payment_initiation_api.model: FilePaymentDaoModel
Closed record
This model is used to store file payment data.
Fields
- PaymentIdreadonly string - OB: Unique identification as assigned by the bank to uniquely identify the domestic payment resource.
- ConsentIdreadonly string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation json - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
bfsi_payment_initiation_api.model: FilePaymentData
Closed record
Represents data of the file payment request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation FilePaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds using a payment file.
bfsi_payment_initiation_api.model: FilePaymentInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds using a payment file.
Fields
- FileType string - Specifies the payment file type.
- FileHash string - A base64 encoding of a SHA256 hash of the file to be uploaded.
- FileReference string? - Reference for the file.
- NumberOfTransactions string? - Number of individual transactions contained in the payment information group.
- ControlSum decimal? - Total of all individual amounts included in the group, irrespective of currencies.
- RequestedExecutionDateTime string? - Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- LocalInstrument string? - 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.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- RemittanceInformation 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.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: FilePaymentRequest
Closed record
Represents a file payment request payload.
Fields
- Data FilePaymentData - Represents data of the file payment request.
bfsi_payment_initiation_api.model: FilePaymentResponse
Closed record
Set of elements used to define the file payment response.
Fields
- Data FilePaymentsResponseData - Data object File Payment Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: FilePaymentsResponseData
Closed record
Represents data of the file payment response.
Fields
- FilePaymentId string - OB: Unique identification as assigned by the bank to uniquely identify the file payment resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment order resource.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- Initiation FilePaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds using a payment file.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: InternationalPaymentData
Closed record
Represents the data of an international payment request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation InternationalPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
bfsi_payment_initiation_api.model: InternationalPaymentInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
Fields
- InstructionIdentification string - 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.
- EndToEndIdentification string - 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.
- LocalInstrument string? - 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.
- InstructionPriority string? - 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.
- Purpose string? - 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.
- ExtendedPurpose string? - Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
- ChargeBearer string? - Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- CurrencyOfTransfer string - Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
- DestinationCountryCode string? - Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
- InstructedAmount Amount - 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.
- ExchangeRateInformation ExchangeRateInformation? - Provides details on the currency exchange rate and contract.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- Creditor Creditor? - Party to which an amount of money is due.
- CreditorAgent CreditorAgent? - Financial institution servicing an account for the creditor.
- CreditorAccount CreditorAccount - Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
- RemittanceInformation 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.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: InternationalPaymentRequest
Closed record
Represents an international payment request payload.
Fields
- Data InternationalPaymentData - Represents the data of an international payment request.
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: InternationalPaymentResponse
Closed record
Represents an international payment response payload.
Fields
- Data InternationalPaymentResponseData - Data object International Payment Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: InternationalPaymentResponseData
Closed record
Represents the data of an international payment response.
Fields
- InternationalPaymentId string - OB: Unique identification as assigned by the bank to uniquely identify the international payment resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment information group.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedExecutionDateTime string? - Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedSettlementDateTime string? - Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? - Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- ExchangeRateInformation ExchangeRateInformation? - Further detailed information on the exchange rate that has been used in the payment transaction.
- Initiation InternationalPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: InternationalScheduledPaymentData
Closed record
Represents the data of an international scheduled payment request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation InternationalScheduledPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
bfsi_payment_initiation_api.model: InternationalScheduledPaymentInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
Fields
- InstructionIdentification string - 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.
- EndToEndIdentification string? - 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.
- LocalInstrument string? - 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.
- InstructionPriority string? - 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.
- Purpose string? - 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.
- ExtendedPurpose string? - Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
- ChargeBearer string? - Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- RequestedExecutionDateTime string - Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- CurrencyOfTransfer string - Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
- DestinationCountryCode string? - Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
- InstructedAmount Amount - 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.
- ExchangeRateInformation ExchangeRateInformation? - Provides details on the currency exchange rate and contract.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- Creditor Creditor? - Party to which an amount of money is due.
- CreditorAgent CreditorAgent? - Financial institution servicing an account for the creditor.
- CreditorAccount CreditorAccount - Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
- RemittanceInformation 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.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: InternationalScheduledPaymentRequest
Closed record
Represents an international scheduled payment request payload.
Fields
- Data InternationalScheduledPaymentData - Represents the data of an international scheduled payment request.
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: InternationalScheduledPaymentResponse
Closed record
Represents an international scheduled payment response payload.
Fields
- Data InternationalScheduledResponseData - Data object International Scheduled Payment Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: InternationalScheduledResponseData
Closed record
Represents the data of an international scheduled payment response.
Fields
- InternationalScheduledPaymentId string - OB: Unique identification as assigned by the bank to uniquely identify the international scheduled payment resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of the payment order resource.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedExecutionDateTime string? - Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpectedSettlementDateTime string? - Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? -
- Charges DataCharges[]? -
- ExchangeRateInformation ExchangeRateInformation? - Further detailed information on the exchange rate that has been used in the payment transaction.
- Initiation InternationalScheduledPaymentInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: InternationalStandingOrderData
Closed record
Represents the data of an international standing order request.
Fields
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation InternationalStandingOrderInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
bfsi_payment_initiation_api.model: InternationalStandingOrderInitiation
Closed record
The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
Fields
- Frequency string - Frequency of the standing order payment. Allowed values are EvryDay, EvryWorkgDay, IntrvlWkDay, WkInMnthDay, IntrvlMnthDay and QtrDay.
- Reference string? - 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.
- NumberOfPayments string? - Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
- FirstPaymentDateTime string - The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- FinalPaymentDateTime string? - The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Purpose string? - 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.
- ExtendedPurpose string? - Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.
- ChargeBearer string? - Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- CurrencyOfTransfer string - Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
- DestinationCountryCode string? - Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
- InstructedAmount Amount - 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.
- DebtorAccount DebtorAccount? - Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
- Creditor Creditor? - Party to which an amount of money is due.
- CreditorAgent CreditorAgent? - Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
- CreditorAccount CreditorAccount - Provides the details to identify the beneficiary account.
- SupplementaryData anydata? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_payment_initiation_api.model: InternationalStandingOrderRequest
Closed record
Represents an international standing order request payload.
Fields
- Data InternationalStandingOrderData - Represents the data of an international standing order request.
- Risk Risk - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: InternationalStandingOrderResponse
Closed record
Represents an international standing order response payload.
Fields
- Data InternationalStandingOrderResponseData - Data object International Standing Order Response
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: InternationalStandingOrderResponseData
Closed record
Represents the data of an international standing order response.
Fields
- InternationalStandingOrderId string - OB: Unique identification as assigned by the bank to uniquely identify the international standing order resource.
- ConsentId string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- CreationDateTime string(default getPastDateTime()) - Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Status string - Specifies the status of resource in code form.
- StatusUpdateDateTime string(default getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Refund DataRefund? - Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
- Charges DataCharges[]? - Set of elements used to provide details of a charge for the payment initiation.
- Initiation InternationalStandingOrderInitiation - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
- MultiAuthorisation MultiAuthorisation? - The multiple authorisation flow response from the bank.
- Debtor CreditorAccount? - ^ Only incuded in the response if
Data. ReadRefundAccountis set toYesin the consent.
bfsi_payment_initiation_api.model: Links
Closed record
Links relevant to the payload.
Fields
- Self string - Self Link relevant to the payload
- First string? - First Link relevant to the payload
- Prev string? - Prev Link relevant to the payload
- Next string? - Next Link relevant to the payload
- Last string? - Last Link relevant to the payload
bfsi_payment_initiation_api.model: Meta
Closed record
Meta Data relevant to the payload.
Fields
- TotalPages int? - Count of Metadata
- FirstAvailableDateTime string? - All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- LastAvailableDateTime string? - All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
bfsi_payment_initiation_api.model: MultiAuthorisation
Closed record
The multiple authorisation flow response from the bank.
Fields
- Status string - Specifies the status of the authorisation flow in code form.
- NumberRequired int? - Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
- NumberReceived int? - Number of authorisations received.
- LastUpdateDateTime string? - Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ExpirationDateTime string? - Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
bfsi_payment_initiation_api.model: PaymentDaoModel
Closed record
This model is used to store payment data.
Fields
- PaymentIdreadonly string - OB: Unique identification as assigned by the bank to uniquely identify the domestic payment resource.
- ConsentIdreadonly string - OB: Unique identification as assigned by the bank to uniquely identify the consent resource.
- Initiation json - The Initiation payload is sent by the initiating party to the bank. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
- Risk json - The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
bfsi_payment_initiation_api.model: PaymentDetailsResponse
Closed record
Response model for Payment Details retrieval endpoint
Fields
- Data PaymentDetailsResponseData - Payment details response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_payment_initiation_api.model: PaymentDetailsResponseData
Closed record
Data model for the payment details response.
Fields
- PaymentStatus PaymentDetailsResponseDataPaymentStatus[]? - Payment status details
bfsi_payment_initiation_api.model: PaymentDetailsResponseDataPaymentStatus
Closed record
Payment status details.
Fields
- PaymentTransactionId string - Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- Status string - Status of a transfe, as assigned by the transaction administrator.
- StatusUpdateDateTime string - 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- StatusDetail PaymentDetailsResponseDataStatusDetail? - Payment status details as per underlying Payment Rail.
bfsi_payment_initiation_api.model: PaymentDetailsResponseDataStatusDetail
Closed record
Payment status details as per underlying Payment Rail.
Fields
- LocalInstrument string? - 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.
- Status string - Status of a transfer, as assigned by the transaction administrator.
- StatusReason string? - Reason Code provided for the status of a transfer.
- StatusReasonDescription string? - Reason provided for the status of a transfer.
bfsi_payment_initiation_api.model: PostalAddress
Closed record
Information that locates and identifies a specific address, as defined by postal services.
Fields
- AddressType string? - Identifies the nature of the postal address.
- Department string? - Identification of a division of a large organisation or building.
- SubDepartment string? - Identification of a sub-division of a large organisation or building.
- StreetName string? - Name of a street or thoroughfare.
- BuildingNumber string? - Number that identifies the position of a building on a street.
- PostCode string? - Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
- TownName string? - Name of a built-up area, with defined boundaries, and a local government.
- CountrySubDivision string? - Identifies a subdivision of a country such as state, region, county.
- Country string? - Nation with its own government.
- AddressLine string[]? - Describes address line list
bfsi_payment_initiation_api.model: RemittanceInformation
Closed record
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.
Fields
- Unstructured string? - 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.
- Reference string? - 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.
bfsi_payment_initiation_api.model: Risk
Closed record
The Risk section is sent by the initiating party to the bank. It is used to specify additional details for risk scoring for Payments.
Fields
- PaymentContextCode string? - Specifies the payment context
- BillPayment - @deprecated
- EcommerceGoods - @deprecated
- EcommerceServices - @deprecated
- Other - @deprecated
- PartyToParty - @deprecated
- MerchantCategoryCode string? - Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- MerchantCustomerIdentification string? - The unique customer identifier of the user with the merchant.
- ContractPresentInidicator boolean? - Indicates if Payee has a contractual relationship with the TPP.
- BeneficiaryPrepopulatedIndicator boolean? - Indicates if TPP has immutably prepopulated payment details in for the user.
- PaymentPurposeCode string? - Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended Purpose Code in ISO 20022 Payment Messaging List
- BeneficiaryAccountType string? - Specifies the extended type of account.
- DeliveryAddress PostalAddress? - Information that locates and identifies a specific address, as defined by postal services or in free format text.
Import
import wso2bfsi/bfsi_payment_initiation_api.model;Other versions
1.0.0