bfsi_payment_initiation_api.util
Modules
bfsi_payment_initiation_api.util
Module bfsi_payment_initiation_api.util
API
Declarations
Definitions
![](https://bcentral-packageicons.azureedge.net/images/wso2bfsi_bfsi_payment_initiation_api_1.0.0.png)
wso2bfsi/bfsi_payment_initiation_api.util
Functions![](/images/permalink.svg)
extractCreditorAccount![](/images/permalink.svg)
function extractCreditorAccount(json payload, string path) returns CreditorAccount|error
Exract creditor account from the payload.
Return Type
- CreditorAccount|error - the creditor account
extractDebtorAccount![](/images/permalink.svg)
function extractDebtorAccount(json payload, string path) returns DebtorAccount|error|()
Exract debtor account from the payload.
Return Type
- DebtorAccount|error|() - the creditor account
extractDomesticPaymentInitiation![](/images/permalink.svg)
function extractDomesticPaymentInitiation(json payload) returns DomesticPaymentInitiation|error
Exract Domestic Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- DomesticPaymentInitiation|error - the Domestic Payment Initiation
extractDomesticScheduledPaymentInitiation![](/images/permalink.svg)
function extractDomesticScheduledPaymentInitiation(json payload) returns DomesticScheduledPaymentInitiation|error
Exract Domestic Scheduled Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- DomesticScheduledPaymentInitiation|error - the Domestic Scheduled Payment Initiation
extractDomesticStandingOrderInitiation![](/images/permalink.svg)
function extractDomesticStandingOrderInitiation(json payload) returns DomesticStandingOrderInitiation|error
Exract Domestic Standing Order Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- DomesticStandingOrderInitiation|error - the Domestic Standing Order Payment Initiation
extractFilePaymentInitiation![](/images/permalink.svg)
function extractFilePaymentInitiation(anydata payload) returns FilePaymentInitiation|error
Exract File Payment Initiation from the payload.
Parameters
- payload anydata - the payload
Return Type
- FilePaymentInitiation|error - the File Payment Initiation
extractInternationalPaymentInitiation![](/images/permalink.svg)
function extractInternationalPaymentInitiation(json payload) returns InternationalPaymentInitiation|error
Exract International Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- InternationalPaymentInitiation|error - the International Payment Initiation
extractInternationalScheduledPaymentInitiation![](/images/permalink.svg)
function extractInternationalScheduledPaymentInitiation(json payload) returns InternationalScheduledPaymentInitiation|error
Exract International Scheduled Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- InternationalScheduledPaymentInitiation|error - the International Scheduled Payment Initiation
extractInternationalStandingOrderInitiation![](/images/permalink.svg)
function extractInternationalStandingOrderInitiation(json payload) returns InternationalStandingOrderInitiation|error
Exract International Standing Order Payment Initiation from the payload.
Parameters
- payload json - the payload
Return Type
- InternationalStandingOrderInitiation|error - the International Standing Order Payment Initiation
getDomesticPaymentInitiation![](/images/permalink.svg)
function getDomesticPaymentInitiation() returns map<json>
Get Domestic Payment Initiation payload.
Return Type
- map<json> - a domestic payment initiation payload.
getDomesticScheduledPaymentInitiation![](/images/permalink.svg)
function getDomesticScheduledPaymentInitiation() returns map<json>
Get Domestic scheduled Payment Initiation payload.
Return Type
- map<json> - a domestic scheduled payment initiation payload.
getDomesticStandingOrderPaymentInitiation![](/images/permalink.svg)
function getDomesticStandingOrderPaymentInitiation() returns map<json>
Get Domestic standing order Payment Initiation payload.
Return Type
- map<json> - a domestic standing order payment initiation payload.
getFilePaymentInitiation![](/images/permalink.svg)
function getFilePaymentInitiation() returns map<json>
Get a file payment initiation payload.
Return Type
- map<json> - a file payment initiation payload.
getInternatioanlScheduledPaymentInitiation![](/images/permalink.svg)
function getInternatioanlScheduledPaymentInitiation() returns map<json>
Get the international scheduled payment initiation payload.
Return Type
- map<json> - an international scheduled payment initiation payload.
getInternatioanlStandingOrderPaymentInitiation![](/images/permalink.svg)
function getInternatioanlStandingOrderPaymentInitiation() returns map<json>
Get the international standing order payment initiation payload.
Return Type
- map<json> - an international standing order payment initiation payload.
getInternationalPaymentInitiation![](/images/permalink.svg)
function getInternationalPaymentInitiation() returns map<json>
Get a International payment initiation payload.
Return Type
- map<json> - an international payment initiation payload.
validateAuthDateHeader![](/images/permalink.svg)
Validate x-fapi-auth-date header
Parameters
- authDateHeader string? - x-fapi-auth-date Hedaer
Return Type
- error? - Returns an error if the auth date header is future date
validateCreditorAccount![](/images/permalink.svg)
function validateCreditorAccount(CreditorAccount creditorAccount) returns InvalidPayloadError?
Validates the Creditor Account
Parameters
- creditorAccount CreditorAccount - Creditor Account to be validated
Return Type
- InvalidPayloadError? - Returns an error if validation fails
validateDebtorAccount![](/images/permalink.svg)
function validateDebtorAccount(DebtorAccount debtorAccount) returns InvalidPayloadError?
Validates the Debtor Account
Parameters
- debtorAccount DebtorAccount - Debtor Account to be validated
Return Type
- InvalidPayloadError? - Returns error if validation fails
validateIpAddress![](/images/permalink.svg)
Validate x-fapi-customer-ip-address header
Parameters
- ipAddress string? - x-fapi-customer-ip-address Hedaer
Return Type
- error? - Return an error if the ip address is invalid
validateUUID![](/images/permalink.svg)
Validate x-fapi-interaction-id header
Parameters
- uuidHeader string? - x-fapi-interaction-id Hedaer
Return Type
- error? - Return an error if the uuid is invalid
Constants![](/images/permalink.svg)
bfsi_payment_initiation_api.util: CODE_FIELD_INVALID![](/images/permalink.svg)
bfsi_payment_initiation_api.util: CODE_FIELD_MISSING![](/images/permalink.svg)
bfsi_payment_initiation_api.util: CODE_HEADER_INVALID![](/images/permalink.svg)
bfsi_payment_initiation_api.util: CODE_INTERNAL_SERVER_ERROR![](/images/permalink.svg)
bfsi_payment_initiation_api.util: CODE_RESOURCE_INVALID_FORMAT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: DOMESTIC_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: DOMESTIC_SCHEDULED_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: DOMESTIC_STANDING_ORDER_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: EMPTY_PAYMENT_ID![](/images/permalink.svg)
bfsi_payment_initiation_api.util: EMPTY_REQUEST_BODY![](/images/permalink.svg)
bfsi_payment_initiation_api.util: FILE_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: INTERNATIONAL_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: INTERNATIONAL_SCHEDULED_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: INTERNATIONAL_STANDING_ORDER_PAYMENT![](/images/permalink.svg)
bfsi_payment_initiation_api.util: INVALID_PAYMENT_ID![](/images/permalink.svg)
bfsi_payment_initiation_api.util: STATUS_SETTLEMENT_IN_PROCESS![](/images/permalink.svg)
Records![](/images/permalink.svg)
bfsi_payment_initiation_api.util: BadRequest![](/images/permalink.svg)
Represents a subtype of BAD_REQUEST error
Fields
- Fields Included from *BadRequest
Import
import wso2bfsi/bfsi_payment_initiation_api.util;
Metadata
Released date: over 1 year ago
Version: 1.0.0
Compatibility
Platform: any
Ballerina version: 2201.3.1
GraalVM compatible: Yes
Pull count
Total: 2
Current verison: 2
Weekly downloads
Keywords
Type/RestApi
Category/Service
Internal/http
Cost/Free
Vertical/bfsi
Contributors
Other versions
1.0.0