import {z} from 'zod' export type GetApiPaymentsBrPaymentIntentsArgs = {page?: number | undefined, page_size?: number | undefined, id__in?: Array | undefined, amount?: number | undefined, amount__gt?: number | undefined, amount__gte?: number | undefined, amount__lt?: number | undefined, amount__lte?: number | undefined, amount__range?: Array | undefined, created_at?: string | undefined, created_at__gt?: string | undefined, created_at__gte?: string | undefined, created_at__lt?: string | undefined, created_at__lte?: string | undefined, created_at__range?: Array | undefined, customer?: string | undefined, customer__in?: Array | undefined, external_id?: string | undefined, external_id__in?: Array | undefined, ordering?: ('updated_at' | '-updated_at') | undefined, provider?: 'belvo' | undefined, payment_method_type?: ('open_finance' | 'open_finance_biometric_pix') | undefined, search?: string | undefined, status?: string | undefined, status__in?: Array | undefined, updated_at?: string | undefined, updated_at__gt?: string | undefined, updated_at__gte?: string | undefined, updated_at__lt?: string | undefined, updated_at__lte?: string | undefined, updated_at__range?: Array | undefined}; export type GetApiPaymentsBrPaymentIntentsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const id = z.string(); export const externalIdPayments = z.string(); export const createdAt = z.string(); export const createdBy = z.string(); export const enumPaymentIntentStatus = z.enum(["REQUIRES_PAYMENT_METHOD", "REQUIRES_ACTION", "SUCCEEDED", "PROCESSING", "FAILED"]); export const enumPaymentsCurrency = z.literal("BRL"); export const enumPaymentLinkAllowedPaymentMethod = z.enum(["open_finance", "open_finance_biometric_pix"]); 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 paymentIntentPaymentMethodDetailsBodyIndividualOfpi = z.object({beneficiary_bank_account: z.string(), payer_institution: z.string(), schedule: schedule.optional(), callback_url: z.string(), cpf: z.string().nullable().optional()}); export const paymentIntentPaymentMethodDetailsIndividualOfpi = z.object({open_finance: paymentIntentPaymentMethodDetailsBodyIndividualOfpi}); export const paymentIntentPaymentMethodDetailsBodyBusinessOfpi = z.object({beneficiary_bank_account: z.string(), payer_institution: z.string(), schedule: schedule.optional(), callback_url: z.string(), cpf: z.string().nullable()}); export const paymentIntentPaymentMethodDetailsBusinessOfpi = z.object({open_finance: paymentIntentPaymentMethodDetailsBodyBusinessOfpi}); 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 enumPaymentLinkProvider = z.literal("belvo"); 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 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 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 lastErrorPaymentError = z.object({error_code: z.string(), error_message: z.string()}); export const enumPaymentsCountry = z.enum(["BRA", "null"]).max(3).nullable(); export const institutionsFormFieldValues = z.object({code: z.string().optional(), label: z.string().optional(), validation: z.string().optional(), validation_message: z.string().optional(), placeholder: z.string().optional()}); export const institutionFormField = z.object({name: z.string().optional(), type: z.string().optional(), label: z.string().optional(), dependency: z.string().nullable().optional(), validation: z.string().optional(), placeholder: z.string().optional(), validation_message: z.string().optional(), values: z.array(institutionsFormFieldValues).optional(), length: z.number().int().optional(), optional: z.boolean().optional()}); export const institutionFormFieldUsernameType = z.object({name: z.string().optional(), type: z.string().optional(), placeholder: z.string().optional(), values: z.array(institutionsFormFieldValues).optional(), preselected: z.number().int().optional()}); export const institutionFormFieldSaveCredentials = z.object({name: z.string().optional(), type: z.string().optional(), label: z.string().optional(), validation: z.string().nullable().optional()}); export const paymentInstitution = z.object({id: id, active: z.boolean(), name: z.string(), display_name: z.string(), legal_entity_name: z.string().nullable(), website: z.string(), logo: z.string(), icon_logo: z.string(), text_logo: z.string(), primary_color: z.string(), country: enumPaymentsCountry, form_fields: z.array(z.union([institutionFormField, institutionFormFieldUsernameType, institutionFormFieldSaveCredentials])), sort_priority: z.number().int(), description: z.string().nullable()}); export const displayPaymentMethodInformationContentOfpi = z.object({institutions: z.array(paymentInstitution).optional()}); export const nextStepDisplayPaymentMethodInformation = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_payment_method_information: displayPaymentMethodInformationContentOfpi.optional(), ready_to_confirm: z.boolean().optional()}); export const needsRedirectContent = z.object({payer_institution: paymentInstitution.optional()}); export const nextStepNeedsRedirect = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_needs_redirect: needsRedirectContent.optional(), ready_to_confirm: z.boolean().optional()}); export const enumBankAccountPixAccountTypeOfpi = z.enum(["CHECKINGS", "SAVINGS", "SALARY", "PAYMENTS"]); export const bankAccountDetailsOpenFinance = z.object({country: enumPaymentsCountry, account_type: enumBankAccountPixAccountTypeOfpi, agency: z.string(), number: z.string()}); export const bankAccountDetailsOpenFinancePix = z.object({country: enumPaymentsCountry, pix_key: z.string()}); export const enumBankAccountHolderTypeOfpi = z.enum(["INDIVIDUAL", "BUSINESS"]); export const holderInformationBusinessOfpiResponse = z.object({name: z.string().min(1).max(256), identifier_type: z.literal("CNPJ"), identifier: z.string().min(14).max(14)}); export const holderInformationIndividualOfpiResponse = z.object({first_name: z.string().min(1).max(256), last_name: z.string().min(1).max(256), identifier_type: z.literal("CPF"), identifier: z.string().min(11).max(11)}); export const holderResponseOfpi = z.object({type: enumBankAccountHolderTypeOfpi, information: z.union([holderInformationBusinessOfpiResponse, holderInformationIndividualOfpiResponse])}); export const beneficiaryBankAccountOfpi = z.object({id: id, created_at: createdAt, created_by: createdBy, institution: paymentInstitution, details: z.union([bankAccountDetailsOpenFinance, bankAccountDetailsOpenFinancePix]).optional(), holder: holderResponseOfpi}); export const displayConfirmationRequiredOfpi = z.object({beneficiary_bank_account: beneficiaryBankAccountOfpi.optional(), payer_name: z.string().optional(), payer_identifier: z.string().optional(), payer_institution: paymentInstitution.optional()}); export const nextStepDisplayConfirmationRequiredOfpi = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_confirmation_required: displayConfirmationRequiredOfpi.optional(), ready_to_confirm: z.boolean().optional()}); export const displayPaymentProcessing = z.object({payer_institution: paymentInstitution.optional()}); export const nextStepDisplayPaymentProcessing = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_payment_processing: displayPaymentProcessing.optional(), ready_to_confirm: z.boolean().optional()}); export const displayPaymentSucceeded = z.object({payer_institution: paymentInstitution.optional()}); export const nextStepDisplayPaymentSucceeded = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_payment_succeeded: displayPaymentSucceeded.optional(), ready_to_confirm: z.boolean().optional()}); export const displayPaymentFailed = z.object({payer_institution: paymentInstitution.optional()}); export const nextStepDisplayPaymentFailed = z.object({type: z.enum(["open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed"]).optional(), open_finance_display_payment_failed: displayPaymentFailed.optional(), ready_to_confirm: z.boolean().optional()}); export const paymentIntentOfpi = z.object({id: id, customer: z.string(), external_id: externalIdPayments.optional(), created_at: createdAt, created_by: createdBy, updated_at: z.string().nullable(), status: enumPaymentIntentStatus, amount: z.string(), currency: enumPaymentsCurrency, description: z.string(), statement_description: z.string().max(50).optional(), selected_payment_method_type: enumPaymentLinkAllowedPaymentMethod, allowed_payment_method_types: z.array(z.string()), payment_method_details: z.union([paymentIntentPaymentMethodDetailsIndividualOfpi, paymentIntentPaymentMethodDetailsBusinessOfpi]), payment_method_information: paymentMethodInformationOfpi, failure_code: z.string().nullable(), failure_message: z.string().nullable(), metadata: z.object({}).optional(), charges: z.array(chargeBrazil).optional(), provider: enumPaymentLinkProvider, last_error: lastErrorPaymentError, next_step: z.union([nextStepDisplayPaymentMethodInformation, nextStepNeedsRedirect, nextStepDisplayConfirmationRequiredOfpi, nextStepDisplayPaymentProcessing, nextStepDisplayPaymentSucceeded, nextStepDisplayPaymentFailed])}); export const getApiPaymentsBrPaymentIntentsResponse = z.object({count: z.number().int().optional(), next: z.string().nullable().optional(), previous: z.string().nullable().optional(), results: z.array(paymentIntentOfpi).optional()}); 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 }; /** * List all payment intents * * GET /payments/br/payment-intents/ */ export const getApiPaymentsBrPaymentIntents = async (args: GetApiPaymentsBrPaymentIntentsArgs, options?: GetApiPaymentsBrPaymentIntentsOptions) => { 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.page != null) query.append("page", String(args.page)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.id__in != null) query.append("id__in", args.id__in.join(',')) if (args.amount != null) query.append("amount", String(args.amount)) if (args.amount__gt != null) query.append("amount__gt", String(args.amount__gt)) if (args.amount__gte != null) query.append("amount__gte", String(args.amount__gte)) if (args.amount__lt != null) query.append("amount__lt", String(args.amount__lt)) if (args.amount__lte != null) query.append("amount__lte", String(args.amount__lte)) if (args.amount__range != null) query.append("amount__range", args.amount__range.join(',')) if (args.created_at != null) query.append("created_at", String(args.created_at)) if (args.created_at__gt != null) query.append("created_at__gt", String(args.created_at__gt)) if (args.created_at__gte != null) query.append("created_at__gte", String(args.created_at__gte)) if (args.created_at__lt != null) query.append("created_at__lt", String(args.created_at__lt)) if (args.created_at__lte != null) query.append("created_at__lte", String(args.created_at__lte)) if (args.created_at__range != null) query.append("created_at__range", args.created_at__range.join(',')) if (args.customer != null) query.append("customer", String(args.customer)) if (args.customer__in != null) query.append("customer__in", args.customer__in.join(',')) if (args.external_id != null) query.append("external_id", String(args.external_id)) if (args.external_id__in != null) query.append("external_id__in", args.external_id__in.join(',')) if (args.ordering != null) query.append("ordering", String(args.ordering)) if (args.provider != null) query.append("provider", String(args.provider)) if (args.payment_method_type != null) query.append("payment_method_type", String(args.payment_method_type)) if (args.search != null) query.append("search", String(args.search)) if (args.status != null) query.append("status", String(args.status)) if (args.status__in != null) query.append("status__in", args.status__in.join(',')) if (args.updated_at != null) query.append("updated_at", String(args.updated_at)) if (args.updated_at__gt != null) query.append("updated_at__gt", String(args.updated_at__gt)) if (args.updated_at__gte != null) query.append("updated_at__gte", String(args.updated_at__gte)) if (args.updated_at__lt != null) query.append("updated_at__lt", String(args.updated_at__lt)) if (args.updated_at__lte != null) query.append("updated_at__lte", String(args.updated_at__lte)) if (args.updated_at__range != null) query.append("updated_at__range", args.updated_at__range.join(',')) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/payments/br/payment-intents/${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(getApiPaymentsBrPaymentIntentsResponse, await res.json()) };