import {z} from 'zod' export type GetApiPaymentsBrChargesChargeIdArgs = {'X-Belvo-API-Resource-Version'?: 'Payments-BR.V2' | undefined, charge_id: string}; export type GetApiPaymentsBrChargesChargeIdOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const id = z.string(); export const createdAt = z.string(); export const createdBy = z.string(); export const enumPaymentLinkProvider = z.literal("belvo"); export const schedule = z.union([z.object({single: z.object({date: z.string().optional()}).nullable().optional()}).nullable(), z.object({daily: z.object({start_date: z.string().optional(), occurrences: z.number().int().gte(2).lte(60).optional()}).optional()}), z.object({weekly: z.object({start_date: z.string().optional(), day_of_week: z.enum(["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]).optional(), occurrences: z.number().int().gte(2).lte(60).optional()}).optional()}), z.object({monthly: z.object({start_date: z.string().optional(), day_of_month: z.number().int().gte(1).lte(31).optional(), occurrences: z.number().int().gte(2).lte(24).optional()}).optional()}), z.object({custom: z.object({dates: z.array(z.string()).optional(), description: z.string().max(256).optional()}).optional()})]).nullable(); export const chargePaymentMethodDetailsOfpiContent = z.object({schedule: schedule.optional(), payer_institution: z.string().optional(), beneficiary_bank_account: z.string().optional()}); export const chargePaymentMethodDetailsOfpi = z.object({open_finance: chargePaymentMethodDetailsOfpiContent.optional()}); export const paymentMethodInformationBodyOfpi = z.object({provider_request_id: z.string().nullable().optional(), redirect_url: z.string().nullable().optional(), end_to_end_id: z.string().nullable().optional(), settlement_date: z.string().optional()}); export const paymentMethodInformationOfpi = z.object({open_finance: paymentMethodInformationBodyOfpi.optional()}); export const chargePayerInformation = z.object({bank_account: z.object({type: z.string().optional(), agency: z.string().optional(), number: z.string().optional(), institution_id: z.string().optional()}).optional()}); export const enumPaymentsCurrency = z.literal("BRL"); export const enumPaymentTransactionType = z.enum(["INFLOW", "OUTFLOW"]); export const paymentTransaction = z.object({id: id, created_at: createdAt, created_by: createdBy, amount: z.string(), currency: enumPaymentsCurrency, description: z.string().max(128), transaction_type: enumPaymentTransactionType, beneficiary: z.string(), payer: z.unknown(), payment_intent: z.string().optional(), customer: z.string().optional()}); export const chargeBrazil = z.object({id: id, created_at: createdAt, updated_at: z.string().nullable(), created_by: createdBy.optional(), customer: z.string().optional(), payment_intent: z.string().optional(), status: z.enum(["CANCELED", "PENDING", "SCHEDULED", "SUCCEEDED", "FAILED", "PARTIAL"]), amount: z.string().nullable(), currency: z.literal("BRL").optional(), description: z.string().optional(), statement_description: z.string().max(50).optional(), beneficiary: z.string(), provider: enumPaymentLinkProvider, payment_method_type: z.literal("open_finance").optional(), payment_method_details: chargePaymentMethodDetailsOfpi, payment_method_information: paymentMethodInformationOfpi, payer_information: chargePayerInformation.optional(), transactions: z.array(paymentTransaction).optional(), failure_code: z.string().nullable(), failure_message: z.string().nullable(), metadata: z.object({})}); export const chargePaymentMethodDetailsPixContent = z.object({payer_institution: z.string().optional(), pix_key: z.string().optional(), schedule: schedule.optional()}); export const chargePaymentMethodDetailsPix = z.object({open_finance: chargePaymentMethodDetailsPixContent.optional()}); export const paymentMethodInformationPixKeysConfirmed = z.object({open_finance: z.object({provider_request_id: z.string().nullable().optional(), redirect_url: z.string().nullable().optional(), end_to_end_id: z.string().nullable().optional(), settlement_date: z.string().optional(), pix_key_details: z.object({identifier: z.string().optional(), name: z.string().optional()}).optional()}).optional()}); export const chargeBrazilPix = z.object({id: id, created_at: createdAt, updated_at: z.string().nullable(), created_by: createdBy.optional(), customer: z.string().optional(), payment_intent: z.string().optional(), status: z.enum(["CANCELED", "PENDING", "SCHEDULED", "SUCCEEDED", "FAILED", "PARTIAL"]), amount: z.string().nullable(), currency: z.literal("BRL").optional(), description: z.string().optional(), statement_description: z.string().max(50).optional(), beneficiary: z.string().nullable(), provider: enumPaymentLinkProvider, payment_method_type: z.literal("open_finance").optional(), payment_method_details: chargePaymentMethodDetailsPix, payment_method_information: paymentMethodInformationPixKeysConfirmed, payer_information: chargePayerInformation.optional(), transactions: z.unknown(), failure_code: z.string().nullable(), failure_message: z.string().nullable(), metadata: z.object({})}); export const externalIdPayments = z.string(); export const metadataPayments = z.record(z.string(), z.string().max(500)); export const chargeV2 = z.object({id: id.optional(), created_at: createdAt.optional(), status_updated_at: z.string().nullable().optional(), status: z.enum(["PENDING", "SCHEDULED", "SETTLED", "CANCELED", "FAILED"]).optional(), status_reason_code: z.string().nullable().optional(), status_reason_message: z.string().nullable().optional(), payment_authorization: z.string().optional(), payment_method: z.string().optional(), amount: z.string().nullable().optional(), date: z.string().nullable().optional(), end_to_end_id: z.string().nullable().optional(), statement_description: z.string().min(1).max(140).optional(), external_id: externalIdPayments.optional(), beneficiary: z.object({bank_account: z.object({id: z.string().optional(), holder: z.object({name: z.string().optional(), identifier: z.string().min(11).max(14).optional()}).optional(), details: z.object({institution: z.string().optional(), agency: z.string().optional(), number: z.string().optional(), account_type: z.string().optional(), code: z.string().optional()}).optional()}).optional()}).optional(), payer: z.object({bank_account: z.object({holder: z.object({identifier: z.string().min(11).max(14).optional()}).optional(), details: z.object({institution: z.string().optional(), code: z.string().optional(), account_type: z.string().optional(), agency: z.string().optional(), number: z.string().optional()}).optional()}).optional()}).optional(), metadata: metadataPayments.optional(), next: z.string().nullable().optional(), previous: z.string().nullable().optional()}); export const getApiPaymentsBrChargesChargeIdResponse = z.union([chargeBrazil, chargeBrazilPix, chargeV2]); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get details about a Charge * * GET /payments/br/charges/{charge_id}/ */ export const getApiPaymentsBrChargesChargeId = async (args: GetApiPaymentsBrChargesChargeIdArgs, options?: GetApiPaymentsBrChargesChargeIdOptions) => { const {baseUrl = "https://sandbox.belvo.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['X-Belvo-API-Resource-Version'] != null) headers.set("X-Belvo-API-Resource-Version", String(args['X-Belvo-API-Resource-Version'])) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/payments/br/charges/${encodeURIComponent(String(args.charge_id))}/${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiPaymentsBrChargesChargeIdResponse, await res.json()) };