@mbanq/core-sdk-js / commands / CreateRecipient
Function: CreateRecipient()
CreateRecipient(
clientId,data):Command<{clientId:number;data: {accountDetails?: {accountId?:string;accountNumber?:string;accountType?:"CHECKING"|"SAVINGS";bankInformation?: {routingNumber?:string;swiftCode?:string; };paymentRailMetaData?: {bankIdentifier?:number;branchIdentifier?:string;destinationCurrency?:string; }; };address?: {city:string;countryCode:string;line1:string;line2:string;postalCode:string;stateCode:string; };businessName?:string;emailAddress?:string;firstName?:string;isOwnAccount:boolean;lastName?:string;nickName:string;paymentRail:"ACH"|"SAMEDAYACH"|"WIRE"|"SWIFT"|"INTERNAL"|"FXPAY"|"CARD";phoneNumber?:string;recipientType:"INDIVIDUAL"|"BUSINESS"; }; }, {clientId:number;officeId?:number;resourceId:number; }>
Defined in: src/commands/rest/recipient.ts:68
Parameters
clientId
number
data
accountDetails?
{ accountId?: string; accountNumber?: string; accountType?: "CHECKING" | "SAVINGS"; bankInformation?: { routingNumber?: string; swiftCode?: string; }; paymentRailMetaData?: { bankIdentifier?: number; branchIdentifier?: string; destinationCurrency?: string; }; } = ...
accountDetails.accountId?
string = ...
accountDetails.accountNumber?
string = ...
accountDetails.accountType?
"CHECKING" | "SAVINGS" = ...
accountDetails.bankInformation?
{ routingNumber?: string; swiftCode?: string; } = ...
accountDetails.bankInformation.routingNumber?
string = ...
accountDetails.bankInformation.swiftCode?
string = ...
accountDetails.paymentRailMetaData?
{ bankIdentifier?: number; branchIdentifier?: string; destinationCurrency?: string; } = ...
accountDetails.paymentRailMetaData.bankIdentifier?
number = ...
accountDetails.paymentRailMetaData.branchIdentifier?
string = ...
accountDetails.paymentRailMetaData.destinationCurrency?
string = ...
address?
{ city: string; countryCode: string; line1: string; line2: string; postalCode: string; stateCode: string; } = ...
address.city
string = ...
address.countryCode
string = ...
address.line1
string = ...
address.line2
string = ...
address.postalCode
string = ...
address.stateCode
string = ...
businessName?
string = ...
emailAddress?
string = ...
firstName?
string = ...
isOwnAccount
boolean = ...
lastName?
string = ...
nickName
string = ...
paymentRail
"ACH" | "SAMEDAYACH" | "WIRE" | "SWIFT" | "INTERNAL" | "FXPAY" | "CARD" = PaymentRailSchema
phoneNumber?
string = ...
recipientType
"INDIVIDUAL" | "BUSINESS" = RecipientTypeSchema
Returns
Command<{ clientId: number; data: { accountDetails?: { accountId?: string; accountNumber?: string; accountType?: "CHECKING" | "SAVINGS"; bankInformation?: { routingNumber?: string; swiftCode?: string; }; paymentRailMetaData?: { bankIdentifier?: number; branchIdentifier?: string; destinationCurrency?: string; }; }; address?: { city: string; countryCode: string; line1: string; line2: string; postalCode: string; stateCode: string; }; businessName?: string; emailAddress?: string; firstName?: string; isOwnAccount: boolean; lastName?: string; nickName: string; paymentRail: "ACH" | "SAMEDAYACH" | "WIRE" | "SWIFT" | "INTERNAL" | "FXPAY" | "CARD"; phoneNumber?: string; recipientType: "INDIVIDUAL" | "BUSINESS"; }; }, { clientId: number; officeId?: number; resourceId: number; }>