API SDK type reference
Generated reference for the public server SDK configuration and request types.
Generated from the published @cipay/client-sdk/api declaration during this build.
Import these types from @cipay/client-sdk/api. The API Reference contains the current public transport schemas.
Client configuration
PropType
apiKeystring
Secret merchant credential. Use this entry point only on a trusted server.
Type
stringmode?CipayMode
Type
CipayModebaseUrl?string
Type
stringfetch?typeof globalThis.fetch
Type
typeof globalThis.fetchtimeoutMs?number
Type
numberonResponse?(metadata: ResponseMetadata) => void
Type
(metadata: ResponseMetadata) => voidRequest controls
PropType
requestId?string
Type
stringidempotencyKey?string
Type
stringrevision?number
Current resource revision. Sent as a quoted If-Match value.
Type
numbersignal?AbortSignal
Type
AbortSignalPagination
PropType
pageSize?number
Type
numbercursor?string
Type
stringBuyer handler
PropType
clientimport("./client").CipayClient
Type
import("./client").CipayClientstorefrontReadonly<{ locator: string }>
Type
Readonly<{ locator: string }>resolveCustomer(request: Request) => BuyerIdentity | null | Promise<BuyerIdentity | null>
Type
(request: Request) => BuyerIdentity | null | Promise<BuyerIdentity | null>maxBodyBytes?number
Type
numberWebhook verification
PropType
secretstring
Type
stringrawBodystring | Uint8Array
Type
string | Uint8ArrayheadersHeaders | WebhookHeaders
Type
Headers | WebhookHeadersnow?Date
Type
DatetoleranceSeconds?number
Type
numberCustomer input
PropType
billingAddress
Type
Default
nullemail
Format: email
Type
externalId
Type
Default
nulllocale
Type
Default
enmetadata
Type
Default
{}mobile
Type
name
Type
Checkout input
PropType
locatorstring
Type
stringoriginstring
Type
stringbuyer
Type
customAmountHalalas?
Type
discountCode?
Type
formId?
Format: uuid
Type
offerId
Format: uuid
Type
policyFingerprint?
Type
recurringConsentAccepted?
Type
Webhook endpoint input
PropType
name
Type
scope
Type
selectedEventTypes
Type
url
Format: uri
Type