@mbanq/core-sdk-js / commands / GetPayment
Function: GetPayment()
GetPayment(
id):Command<{id:number; },objectOutputType<{amount:ZodNumber;clientId:ZodNumber;correlationId:ZodString;createdAt:ZodString;currency:ZodString;currencyData:ZodObject<{code:ZodString;currencyCodeInDigit:ZodNumber;decimalPlaces:ZodNumber;displaySymbol:ZodString;isBaseCurrency:ZodBoolean;name:ZodString;nameCode:ZodString; },"strip",ZodTypeAny, {code:string;currencyCodeInDigit:number;decimalPlaces:number;displaySymbol:string;isBaseCurrency:boolean;name:string;nameCode:string; }, {code:string;currencyCodeInDigit:number;decimalPlaces:number;displaySymbol:string;isBaseCurrency:boolean;name:string;nameCode:string; }>;executedAt:ZodString;externalId:ZodString;id:ZodNumber;originator:ZodObject<{accountId:ZodOptional<ZodString>;address:ZodObject<{countryCode:ZodString;line1:ZodOptional<ZodString>;line2:ZodOptional<ZodString>;postalCode:ZodOptional<ZodString>;stateCode:ZodOptional<ZodString>; },"strip",ZodTypeAny, {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; }, {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; }>;name:ZodString;recipientType:ZodString; },"strip",ZodTypeAny, {accountId?:string;address: {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; };name:string;recipientType:string; }, {accountId?:string;address: {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; };name:string;recipientType:string; }>;paymentRail:ZodEnum<["ACH","SAMEDAYACH","WIRE","SWIFT","INTERNAL","FXPAY","CARD"]>;paymentRailMetaData:ZodOptional<ZodRecord<ZodString,ZodAny>>;paymentType:ZodEnum<["CREDIT","DEBIT"]>;recipient:ZodObject<{address:ZodObject<{countryCode:ZodString;line1:ZodOptional<ZodString>;line2:ZodOptional<ZodString>;postalCode:ZodOptional<ZodString>;stateCode:ZodOptional<ZodString>; },"strip",ZodTypeAny, {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; }, {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; }>;cardId:ZodOptional<ZodString>;name:ZodString;recipientType:ZodString; },"strip",ZodTypeAny, {address: {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; };cardId?:string;name:string;recipientType:string; }, {address: {countryCode:string;line1?:string;line2?:string;postalCode?:string;stateCode?:string; };cardId?:string;name:string;recipientType:string; }>;status:ZodEnum<["DRAFT","AML_SCREENING","AML_REJECTED","EXECUTION_SCHEDULED","EXECUTION_PROCESSING","EXECUTION_SUCCESS","EXECUTION_FAILURE","RETURNED","CANCELLED","COMPLIANCE_FAILURE","DELETED","UNKNOWN"]>; },ZodAny,"strip">>
Defined in: src/commands/rest/payment.ts:115
Parameters
id
number
Returns
Command<{ id: number; }, objectOutputType<{ amount: ZodNumber; clientId: ZodNumber; correlationId: ZodString; createdAt: ZodString; currency: ZodString; currencyData: ZodObject<{ code: ZodString; currencyCodeInDigit: ZodNumber; decimalPlaces: ZodNumber; displaySymbol: ZodString; isBaseCurrency: ZodBoolean; name: ZodString; nameCode: ZodString; }, "strip", ZodTypeAny, { code: string; currencyCodeInDigit: number; decimalPlaces: number; displaySymbol: string; isBaseCurrency: boolean; name: string; nameCode: string; }, { code: string; currencyCodeInDigit: number; decimalPlaces: number; displaySymbol: string; isBaseCurrency: boolean; name: string; nameCode: string; }>; executedAt: ZodString; externalId: ZodString; id: ZodNumber; originator: ZodObject<{ accountId: ZodOptional<ZodString>; address: ZodObject<{ countryCode: ZodString; line1: ZodOptional<ZodString>; line2: ZodOptional<ZodString>; postalCode: ZodOptional<ZodString>; stateCode: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }, { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }>; name: ZodString; recipientType: ZodString; }, "strip", ZodTypeAny, { accountId?: string; address: { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }; name: string; recipientType: string; }, { accountId?: string; address: { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }; name: string; recipientType: string; }>; paymentRail: ZodEnum<["ACH", "SAMEDAYACH", "WIRE", "SWIFT", "INTERNAL", "FXPAY", "CARD"]>; paymentRailMetaData: ZodOptional<ZodRecord<ZodString, ZodAny>>; paymentType: ZodEnum<["CREDIT", "DEBIT"]>; recipient: ZodObject<{ address: ZodObject<{ countryCode: ZodString; line1: ZodOptional<ZodString>; line2: ZodOptional<ZodString>; postalCode: ZodOptional<ZodString>; stateCode: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }, { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }>; cardId: ZodOptional<ZodString>; name: ZodString; recipientType: ZodString; }, "strip", ZodTypeAny, { address: { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }; cardId?: string; name: string; recipientType: string; }, { address: { countryCode: string; line1?: string; line2?: string; postalCode?: string; stateCode?: string; }; cardId?: string; name: string; recipientType: string; }>; status: ZodEnum<["DRAFT", "AML_SCREENING", "AML_REJECTED", "EXECUTION_SCHEDULED", "EXECUTION_PROCESSING", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "RETURNED", "CANCELLED", "COMPLIANCE_FAILURE", "DELETED", "UNKNOWN"]>; }, ZodAny, "strip">>