Unofficial SDK — generated from Safepay SDK Preview's public OpenAPI specification by the CodeForge platform. Not affiliated with or endorsed by Safepay SDK Preview.

@codeforge-main/safepay-sdk-preview

Version 2.0.0

Install

npm install @codeforge-main/safepay-sdk-preview

yarn add @codeforge-main/safepay-sdk-preview

pnpm add @codeforge-main/safepay-sdk-preview

Usage

This SDK is exposed as a single, fully typed client class. Construct it once with your shared configuration and call any API operation as a method — each returns the deserialized response alongside HTTP metadata.

import { SafepayApiV2Client } from '@codeforge-main/safepay-sdk-preview'

const client = new SafepayApiV2Client({
	baseUrl: 'http://localhost:3000',
	auth: { type: 'bearer', token: 'YOUR_API_TOKEN' },
})

const response = await client.getV2Documents()

console.log(response.status) // HTTP status code
console.log(response.data)   // typed as GetV2DocumentsResponse_200

The client holds the shared configuration (baseUrl, auth, retry, hooks). Each method accepts a per-call context extending HttpClientContext — supply the operation-specific payload / parameters, and override any shared field per call.

Available operations

• postV2Connect
• getV2ConnectReferenceId
• postV2ConnectReferenceIdGuest
• postV2ConnectReferenceIdDelete
• getV2Documents
• postV2Documents
• getV2DocumentsDocumentId
• postV2DocumentsDocumentIdSign
• getV2DocumentsDocumentIdDownload
• postV2DocumentsDocumentIdDelete
• getV2Users
• getV2UsersSafepayAccountId
• getV2UsersSafepayAccountIdBanks
• getV2UsersSafepayAccountIdBankAccounts
• getV2UsersSafepayAccountIdBankAccountsInitialize
• postV2UsersSafepayAccountIdBankAccountsInitialize
• postV2UsersSafepayAccountIdBankAccountsAdd
• postV2UsersSafepayAccountIdBankAccountsSetDefault
• postV2UsersSafepayAccountIdBankAccountsDelete
• getV2Transactions
• postV2TransactionsMarketplace
• postV2TransactionsAuto
• getV2TransactionsTransactionId
• postV2TransactionsTransactionIdDelete
• postV2TransactionsTransactionIdCancel
• postV2TransactionsTransactionIdPayout
• postV2TransactionsTransactionIdUpdate
• postV2TransactionsTransactionIdReimbursePayer
• postV2TransactionsTransactionIdDebtInformation
• getV2TransactionsTransactionIdDebtInformationDownload
• postV2TransactionsTransactionIdBillOfSale
• postV2TransactionsTransactionIdChangeAmount
• postV2TransactionsTransactionIdAddPayee
• postV2TransactionsTransactionIdAddPayer
• postV2Payments
• postV2PaymentsPaymentIdInitialize
• getV2WebhooksExamples

Validation

Every model is plain data — the shape it has on the wire. This SDK carries no schemas and no runtime dependency, so nothing is validated for you: response.data is the parsed body typed as the operation declares it.

Regenerate the SDK with validation schemas turned on to get a zod schema exported beside every model type.

Generated by CodeForge v0.86.0.