@mbanq/core-sdk-js / commands / CreateAndSubmitTransfer
Function: CreateAndSubmitTransfer()
CreateAndSubmitTransfer(
params):Command<{params: {amount:number;bookingDate?:string|null;correlationId?:string|null;correspondent?: {address?:string[] |null;country?:string|null;identifier?:string|null;name:string; } |null;creditor: {accountEntity?:string|null;accountType?:string|null;address?:string[] |null;agent?: {address?:string[] |null;city?:string|null;country?:string|null;identifier?:string|null;name:string;postalCode?:string|null;stateOrProvince?:string|null; } |null;city?:string|null;country?:string|null;forFurtherCredit?:string|null;identifier?:string|null;name?:string|null;postalCode?:string|null;stateOrProvince?:string|null; };currency?:string|null;dateFormat?:string|null;debtor: {accountEntity?:string|null;accountType?:string|null;address?:string[] |null;agent?: {address?:string[] |null;city?:string|null;country?:string|null;identifier?:string|null;name:string;postalCode?:string|null;stateOrProvince?:string|null; } |null;city?:string|null;country?:string|null;forFurtherCredit?:string|null;identifier?:string|null;name?:string|null;postalCode?:string|null;stateOrProvince?:string|null; };externalId?:string|null;fileUrl?:string|null;instantFunds?:number|null;paymentRailMetaData?:any;paymentSubType?:string|null;paymentType?:string|null;reference?:string[] |null;transactionId?:string|null;transferDetails?:any;type:string;valueDate?:string|null; }; }, {commandId?:string|null;externalId?:string|null;id?:string|null; } |undefined>
Defined in: src/commands/rest/fxPay.ts:209
Create and Submit Transfer
Create and submit a transfer
Parameters
params
The parameters for creating a transfer
amount
number = ...
bookingDate?
string | null = ...
correlationId?
string | null = ...
correspondent?
{ address?: string[] | null; country?: string | null; identifier?: string | null; name: string; } | null = ...
creditor
{ accountEntity?: string | null; accountType?: string | null; address?: string[] | null; agent?: { address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null; city?: string | null; country?: string | null; forFurtherCredit?: string | null; identifier?: string | null; name?: string | null; postalCode?: string | null; stateOrProvince?: string | null; } = CounterpartyInputSchema
creditor.accountEntity?
string | null = ...
creditor.accountType?
string | null = ...
creditor.address?
string[] | null = ...
creditor.agent?
{ address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null = ...
creditor.city?
string | null = ...
creditor.country?
string | null = ...
creditor.forFurtherCredit?
string | null = ...
creditor.identifier?
string | null = ...
creditor.name?
string | null = ...
creditor.postalCode?
string | null = ...
creditor.stateOrProvince?
string | null = ...
currency?
string | null = ...
dateFormat?
string | null = ...
debtor
{ accountEntity?: string | null; accountType?: string | null; address?: string[] | null; agent?: { address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null; city?: string | null; country?: string | null; forFurtherCredit?: string | null; identifier?: string | null; name?: string | null; postalCode?: string | null; stateOrProvince?: string | null; } = CounterpartyInputSchema
debtor.accountEntity?
string | null = ...
debtor.accountType?
string | null = ...
debtor.address?
string[] | null = ...
debtor.agent?
{ address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null = ...
debtor.city?
string | null = ...
debtor.country?
string | null = ...
debtor.forFurtherCredit?
string | null = ...
debtor.identifier?
string | null = ...
debtor.name?
string | null = ...
debtor.postalCode?
string | null = ...
debtor.stateOrProvince?
string | null = ...
externalId?
string | null = ...
fileUrl?
string | null = ...
instantFunds?
number | null = ...
paymentRailMetaData?
any = ...
paymentSubType?
string | null = ...
paymentType?
string | null = ...
reference?
string[] | null = ...
transactionId?
string | null = ...
transferDetails?
any = ...
type
string = ...
valueDate?
string | null = ...
Returns
Command<{ params: { amount: number; bookingDate?: string | null; correlationId?: string | null; correspondent?: { address?: string[] | null; country?: string | null; identifier?: string | null; name: string; } | null; creditor: { accountEntity?: string | null; accountType?: string | null; address?: string[] | null; agent?: { address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null; city?: string | null; country?: string | null; forFurtherCredit?: string | null; identifier?: string | null; name?: string | null; postalCode?: string | null; stateOrProvince?: string | null; }; currency?: string | null; dateFormat?: string | null; debtor: { accountEntity?: string | null; accountType?: string | null; address?: string[] | null; agent?: { address?: string[] | null; city?: string | null; country?: string | null; identifier?: string | null; name: string; postalCode?: string | null; stateOrProvince?: string | null; } | null; city?: string | null; country?: string | null; forFurtherCredit?: string | null; identifier?: string | null; name?: string | null; postalCode?: string | null; stateOrProvince?: string | null; }; externalId?: string | null; fileUrl?: string | null; instantFunds?: number | null; paymentRailMetaData?: any; paymentSubType?: string | null; paymentType?: string | null; reference?: string[] | null; transactionId?: string | null; transferDetails?: any; type: string; valueDate?: string | null; }; }, { commandId?: string | null; externalId?: string | null; id?: string | null; } | undefined>
Command object for creating a transfer