bitpay-sdk
Version:
Complete version of the NodeJS library for the new cryptographically secure BitPay API
350 lines (349 loc) • 13.6 kB
TypeScript
import { z } from 'zod';
export declare const settlementInterfaceSchema: z.ZodObject<{
payoutInfo: z.ZodOptional<z.ZodObject<{
name: z.ZodOptional<z.ZodString>;
account: z.ZodOptional<z.ZodString>;
routing: z.ZodOptional<z.ZodString>;
merchantEin: z.ZodOptional<z.ZodString>;
label: z.ZodOptional<z.ZodString>;
bankCountry: z.ZodOptional<z.ZodString>;
bank: z.ZodOptional<z.ZodString>;
swift: z.ZodOptional<z.ZodString>;
address: z.ZodOptional<z.ZodString>;
city: z.ZodOptional<z.ZodString>;
postal: z.ZodOptional<z.ZodString>;
sort: z.ZodOptional<z.ZodString>;
wire: z.ZodOptional<z.ZodBoolean>;
bankName: z.ZodOptional<z.ZodString>;
bankAddress: z.ZodOptional<z.ZodString>;
bankAddress2: z.ZodOptional<z.ZodString>;
iban: z.ZodOptional<z.ZodString>;
additionalInformation: z.ZodOptional<z.ZodString>;
accountHolderName: z.ZodOptional<z.ZodString>;
accountHolderAddress: z.ZodOptional<z.ZodString>;
accountHolderAddress2: z.ZodOptional<z.ZodString>;
accountHolderPostalCode: z.ZodOptional<z.ZodString>;
accountHolderCity: z.ZodOptional<z.ZodString>;
accountHolderCountry: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
sort?: string | undefined;
name?: string | undefined;
address?: string | undefined;
label?: string | undefined;
city?: string | undefined;
account?: string | undefined;
routing?: string | undefined;
merchantEin?: string | undefined;
bankCountry?: string | undefined;
bank?: string | undefined;
swift?: string | undefined;
postal?: string | undefined;
wire?: boolean | undefined;
bankName?: string | undefined;
bankAddress?: string | undefined;
bankAddress2?: string | undefined;
iban?: string | undefined;
additionalInformation?: string | undefined;
accountHolderName?: string | undefined;
accountHolderAddress?: string | undefined;
accountHolderAddress2?: string | undefined;
accountHolderPostalCode?: string | undefined;
accountHolderCity?: string | undefined;
accountHolderCountry?: string | undefined;
}, {
sort?: string | undefined;
name?: string | undefined;
address?: string | undefined;
label?: string | undefined;
city?: string | undefined;
account?: string | undefined;
routing?: string | undefined;
merchantEin?: string | undefined;
bankCountry?: string | undefined;
bank?: string | undefined;
swift?: string | undefined;
postal?: string | undefined;
wire?: boolean | undefined;
bankName?: string | undefined;
bankAddress?: string | undefined;
bankAddress2?: string | undefined;
iban?: string | undefined;
additionalInformation?: string | undefined;
accountHolderName?: string | undefined;
accountHolderAddress?: string | undefined;
accountHolderAddress2?: string | undefined;
accountHolderPostalCode?: string | undefined;
accountHolderCity?: string | undefined;
accountHolderCountry?: string | undefined;
}>>;
withholdings: z.ZodOptional<z.ZodArray<z.ZodObject<{
amount: z.ZodNumber;
code: z.ZodString;
description: z.ZodOptional<z.ZodString>;
notes: z.ZodOptional<z.ZodString>;
label: z.ZodOptional<z.ZodString>;
bankCountry: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
code: string;
amount: number;
label?: string | undefined;
description?: string | undefined;
bankCountry?: string | undefined;
notes?: string | undefined;
}, {
code: string;
amount: number;
label?: string | undefined;
description?: string | undefined;
bankCountry?: string | undefined;
notes?: string | undefined;
}>, "many">>;
ledgerEntries: z.ZodOptional<z.ZodArray<z.ZodObject<{
invoiceData: z.ZodOptional<z.ZodObject<{
refundInfo: z.ZodOptional<z.ZodObject<{
supportRequest: z.ZodOptional<z.ZodString>;
currency: z.ZodString;
refundRequestEid: z.ZodOptional<z.ZodString>;
amounts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
}, {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
}>>;
price: z.ZodNumber;
orderId: z.ZodOptional<z.ZodString>;
date: z.ZodOptional<z.ZodString>;
currency: z.ZodOptional<z.ZodString>;
transactionCurrency: z.ZodOptional<z.ZodString>;
payoutPercentage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
}, {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
}>>;
amount: z.ZodNumber;
code: z.ZodOptional<z.ZodNumber>;
invoiceId: z.ZodOptional<z.ZodString>;
timestamp: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
amount: number;
code?: number | undefined;
description?: string | undefined;
timestamp?: string | undefined;
invoiceId?: string | undefined;
invoiceData?: {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
} | undefined;
}, {
amount: number;
code?: number | undefined;
description?: string | undefined;
timestamp?: string | undefined;
invoiceId?: string | undefined;
invoiceData?: {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
} | undefined;
}>, "many">>;
id: z.ZodNullable<z.ZodString>;
accountId: z.ZodNullable<z.ZodString>;
currency: z.ZodString;
status: z.ZodString;
dateCreated: z.ZodString;
dateExecuted: z.ZodString;
openingDate: z.ZodString;
closingDate: z.ZodString;
openingBalance: z.ZodNumber;
ledgerEntriesSum: z.ZodNumber;
withholdingsSum: z.ZodOptional<z.ZodNumber>;
totalAmount: z.ZodNumber;
token: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
currency: string;
id: string | null;
status: string;
dateExecuted: string;
accountId: string | null;
dateCreated: string;
openingDate: string;
closingDate: string;
openingBalance: number;
ledgerEntriesSum: number;
totalAmount: number;
token?: string | undefined;
payoutInfo?: {
sort?: string | undefined;
name?: string | undefined;
address?: string | undefined;
label?: string | undefined;
city?: string | undefined;
account?: string | undefined;
routing?: string | undefined;
merchantEin?: string | undefined;
bankCountry?: string | undefined;
bank?: string | undefined;
swift?: string | undefined;
postal?: string | undefined;
wire?: boolean | undefined;
bankName?: string | undefined;
bankAddress?: string | undefined;
bankAddress2?: string | undefined;
iban?: string | undefined;
additionalInformation?: string | undefined;
accountHolderName?: string | undefined;
accountHolderAddress?: string | undefined;
accountHolderAddress2?: string | undefined;
accountHolderPostalCode?: string | undefined;
accountHolderCity?: string | undefined;
accountHolderCountry?: string | undefined;
} | undefined;
withholdings?: {
code: string;
amount: number;
label?: string | undefined;
description?: string | undefined;
bankCountry?: string | undefined;
notes?: string | undefined;
}[] | undefined;
ledgerEntries?: {
amount: number;
code?: number | undefined;
description?: string | undefined;
timestamp?: string | undefined;
invoiceId?: string | undefined;
invoiceData?: {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
} | undefined;
}[] | undefined;
withholdingsSum?: number | undefined;
}, {
currency: string;
id: string | null;
status: string;
dateExecuted: string;
accountId: string | null;
dateCreated: string;
openingDate: string;
closingDate: string;
openingBalance: number;
ledgerEntriesSum: number;
totalAmount: number;
token?: string | undefined;
payoutInfo?: {
sort?: string | undefined;
name?: string | undefined;
address?: string | undefined;
label?: string | undefined;
city?: string | undefined;
account?: string | undefined;
routing?: string | undefined;
merchantEin?: string | undefined;
bankCountry?: string | undefined;
bank?: string | undefined;
swift?: string | undefined;
postal?: string | undefined;
wire?: boolean | undefined;
bankName?: string | undefined;
bankAddress?: string | undefined;
bankAddress2?: string | undefined;
iban?: string | undefined;
additionalInformation?: string | undefined;
accountHolderName?: string | undefined;
accountHolderAddress?: string | undefined;
accountHolderAddress2?: string | undefined;
accountHolderPostalCode?: string | undefined;
accountHolderCity?: string | undefined;
accountHolderCountry?: string | undefined;
} | undefined;
withholdings?: {
code: string;
amount: number;
label?: string | undefined;
description?: string | undefined;
bankCountry?: string | undefined;
notes?: string | undefined;
}[] | undefined;
ledgerEntries?: {
amount: number;
code?: number | undefined;
description?: string | undefined;
timestamp?: string | undefined;
invoiceId?: string | undefined;
invoiceData?: {
price: number;
currency?: string | undefined;
date?: string | undefined;
refundInfo?: {
currency: string;
supportRequest?: string | undefined;
amounts?: Record<string, number> | undefined;
refundRequestEid?: string | undefined;
} | undefined;
orderId?: string | undefined;
transactionCurrency?: string | undefined;
payoutPercentage?: Record<string, number> | undefined;
} | undefined;
}[] | undefined;
withholdingsSum?: number | undefined;
}>;