bfsi_payment_initiation_api.util
Modules
bfsi_payment_initiation_api.util
Module bfsi_payment_initiation_api.util
API
Declarations
Definitions
wso2bfsi/bfsi_payment_initiation_api.util
Functions
extractCreditorAccount
function extractCreditorAccount(json payload, string path) returns CreditorAccount|error
Exract creditor account from the payload.
Return Type
- CreditorAccount|error - the creditor account
extractDebtorAccount
function extractDebtorAccount(json payload, string path) returns DebtorAccount|error|()
Exract debtor account from the payload.
Return Type
- DebtorAccount|error|() - the creditor account
extractDomesticPaymentInitiation
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
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
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
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
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
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
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
function getDomesticPaymentInitiation() returns map<json>
Get Domestic Payment Initiation payload.
Return Type
- map<json> - a domestic payment initiation payload.
getDomesticScheduledPaymentInitiation
function getDomesticScheduledPaymentInitiation() returns map<json>
Get Domestic scheduled Payment Initiation payload.
Return Type
- map<json> - a domestic scheduled payment initiation payload.
getDomesticStandingOrderPaymentInitiation
function getDomesticStandingOrderPaymentInitiation() returns map<json>
Get Domestic standing order Payment Initiation payload.
Return Type
- map<json> - a domestic standing order payment initiation payload.
getFilePaymentInitiation
function getFilePaymentInitiation() returns map<json>
Get a file payment initiation payload.
Return Type
- map<json> - a file payment initiation payload.
getInternatioanlScheduledPaymentInitiation
function getInternatioanlScheduledPaymentInitiation() returns map<json>
Get the international scheduled payment initiation payload.
Return Type
- map<json> - an international scheduled payment initiation payload.
getInternatioanlStandingOrderPaymentInitiation
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
function getInternationalPaymentInitiation() returns map<json>
Get a International payment initiation payload.
Return Type
- map<json> - an international payment initiation payload.
validateAuthDateHeader
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
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
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
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
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
bfsi_payment_initiation_api.util: CODE_FIELD_INVALID
bfsi_payment_initiation_api.util: CODE_FIELD_MISSING
bfsi_payment_initiation_api.util: CODE_HEADER_INVALID
bfsi_payment_initiation_api.util: CODE_INTERNAL_SERVER_ERROR
bfsi_payment_initiation_api.util: CODE_RESOURCE_INVALID_FORMAT
bfsi_payment_initiation_api.util: DOMESTIC_PAYMENT
bfsi_payment_initiation_api.util: DOMESTIC_SCHEDULED_PAYMENT
bfsi_payment_initiation_api.util: DOMESTIC_STANDING_ORDER_PAYMENT
bfsi_payment_initiation_api.util: EMPTY_PAYMENT_ID
bfsi_payment_initiation_api.util: EMPTY_REQUEST_BODY
bfsi_payment_initiation_api.util: FILE_PAYMENT
bfsi_payment_initiation_api.util: INTERNATIONAL_PAYMENT
bfsi_payment_initiation_api.util: INTERNATIONAL_SCHEDULED_PAYMENT
bfsi_payment_initiation_api.util: INTERNATIONAL_STANDING_ORDER_PAYMENT
bfsi_payment_initiation_api.util: INVALID_PAYMENT_ID
bfsi_payment_initiation_api.util: STATUS_SETTLEMENT_IN_PROCESS
Records
bfsi_payment_initiation_api.util: BadRequest
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