basalt / subscriptions-proxypay/src / ProxyPayOptions
Interface: ProxyPayOptions
Defined in: subscriptions-proxypay/src/index.ts:39
Properties
apiKey
> apiKey: string
Defined in: subscriptions-proxypay/src/index.ts:41
API key — sent as Authorization: Token <apiKey>.
baseUrl?
> optional baseUrl?: string
Defined in: subscriptions-proxypay/src/index.ts:47
Override the base URL entirely.
callbackUrl?
> optional callbackUrl?: string
Defined in: subscriptions-proxypay/src/index.ts:63
Optional callback URL echoed back on the webhook as custom_fields.callback_url. ProxyPay's delivery target is normally set account-wide in the dashboard; this just tags each reference so the payload carries the URL. Per-reference callers can also pass it through PaymentRequest.metadata.
entity
> entity: string
Defined in: subscriptions-proxypay/src/index.ts:43
Your Multicaixa Entity (Entidade), assigned by ProxyPay/EMIS.
expiryDays?
> optional expiryDays?: number
Defined in: subscriptions-proxypay/src/index.ts:69
Days until a reference expires, used when PaymentRequest.expiresAt is not given. ProxyPay requires end_datetime, so the driver always sends one; this is the fallback window. Default 30.
fetch?
> optional fetch?: FetchLike
Defined in: subscriptions-proxypay/src/index.ts:71
Injected fetch. Defaults to the global fetch.
sandbox?
> optional sandbox?: boolean
Defined in: subscriptions-proxypay/src/index.ts:45
Use the sandbox host (api.sandbox.proxypay.co.ao). Default false (production).
webhookSecret?
> optional webhookSecret?: string
Defined in: subscriptions-proxypay/src/index.ts:56
Secret used to verify webhook signatures — HMAC-SHA256 of the raw request body, hex-encoded, delivered in the x-signature header. Defaults to your API key, which is what ProxyPay signs the callback with, so verification is on out of the box. Override only if you configured a different secret. Verification cannot be turned off: an empty or whitespace-only secret makes verifyWebhook throw WebhookSecretMissingError (fail closed).