@mbanq/core-sdk-js / commands / CreateTransfer
Function: CreateTransfer()
CreateTransfer(
transfer):Command<{transfer: {amount:number;creditor: {accountType:"CHECKING"|"SAVINGS";agent: {identifier:string;name:string; };identifier:string;name:string; };currency:"USD";debtor: {accountType:"CHECKING"|"SAVINGS";identifier:string;name:string; };fileUrl:string;paymentType:"ACH"|"SAMEDAYACH";reference:string[];type:"CREDIT"|"DEBIT"; }; }, {clientId:number;data: {amount:number; };id:string;resourceId:number;resourceIdentifier?:string; }>
Defined in: src/commands/rest/transfer.ts:21
Parameters
transfer
amount
number = ...
creditor
{ accountType: "CHECKING" | "SAVINGS"; agent: { identifier: string; name: string; }; identifier: string; name: string; } = ...
creditor.accountType
"CHECKING" | "SAVINGS" = AccountTypeSchema
creditor.agent
{ identifier: string; name: string; } = AgentSchema
creditor.agent.identifier
string = ...
creditor.agent.name
string = ...
creditor.identifier
string = ...
creditor.name
string = ...
currency
"USD" = ...
debtor
{ accountType: "CHECKING" | "SAVINGS"; identifier: string; name: string; } = PartySchema
debtor.accountType
"CHECKING" | "SAVINGS" = AccountTypeSchema
debtor.identifier
string = ...
debtor.name
string = ...
fileUrl
string = ...
paymentType
"ACH" | "SAMEDAYACH" = PaymentRailSchema
reference
string[] = ...
type
"CREDIT" | "DEBIT" = PaymentTypeSchema
Returns
Command<{ transfer: { amount: number; creditor: { accountType: "CHECKING" | "SAVINGS"; agent: { identifier: string; name: string; }; identifier: string; name: string; }; currency: "USD"; debtor: { accountType: "CHECKING" | "SAVINGS"; identifier: string; name: string; }; fileUrl: string; paymentType: "ACH" | "SAMEDAYACH"; reference: string[]; type: "CREDIT" | "DEBIT"; }; }, { clientId: number; data: { amount: number; }; id: string; resourceId: number; resourceIdentifier?: string; }>