Developer FAQ

How do I embed secure card fields on my site?

Create a checkout session or setup intent on your server, then mount mountSecureCardFields from @peakgateway/web-sdk using the returned hosted context URL. Card numbers go directly to Peak, not your server. See Embed secure card fields.

Can I embed bank-account fields for ACH?

Not with the web SDK. Use hosted checkout with ACH allowed, or accept bank details through your server using the saved-bank-account API and required mandate authorization. The latter changes your data-handling obligations. See ACH options.

Can I charge a saved card or bank account from my server?

Yes, use the sale API with an authorized saved payment method; card authorization/capture, voids and refunds have their own operations. ACH acceptance is not settlement. See Server-to-server payments.

Can I create recurring donations or installments that stop automatically?

Yes. Set an interval for recurring payments and use maxCycles or endDate to bound them. Twelve USD 50 successful cycles collect USD 600 and complete automatically. These subscriptions require an active saved card; ACH subscriptions are not supported. See Recurring and installment payments.

What is the Create Subscription body?

The complete request table and examples cover the customer, location, saved card, amount, schedule, stopping conditions, items and metadata. A start date of today bills immediately unless a trial defers charging. Create does not accept an idempotency header.

Does Peak retry failed recurring payments?

Yes. Dunning has configurable retry intervals, category schedules, notifications and a final action. The default ordinary delays are 1, 3, 7 and 14 days, maximum four retries. See Retries and card updates.

Is a card account updater available?

No. Use a hosted recovery or card-update link to collect a replacement card; do not assume expiration dates update automatically. See Account updater availability.

Can I email an “update your card” link?

Yes. Issue a setup-intent link with deliveryMode: "EMAIL" to collect a saved card. A standalone replacement changes the saved method/default, not an existing subscription's card reference; the public API has no general-purpose subscription card PATCH. Subscription-bound hosted recovery handles card changes for open dunning cases. See Proactive card updates.

Which subscription webhooks are delivered, and how do I verify them?

Created, billed, payment failed, past due, cancelled, paused, resumed and completed events are available, alongside payment and dunning events. Verify the raw-body HMAC and deduplicate by eventId. See Subscription events.

Where do I get sandbox credentials and test cards?

Ask support for a sandbox organization, location ID and API key. There is no shared public key. See Sandbox and test cards.

Are there public JavaScript and Kotlin SDKs and an OpenAPI download?

See SDKs for npm and Maven Central coordinates and authentication. Download openapi.json for the public merchant, partner and agent API contract.

Where do I get the WooCommerce plugin?

Download the beta ZIP and follow the requirements and setup steps in WooCommerce plugin (beta).

What should I do after a payment timeout?

Keep the original request identity. Read the transaction status and, for a recorded follow-on operation, its exact evidence with GET /api/v1/transactions/{id}/operations?operationId={originalOperationId}. Never submit a new payment simply because the response was lost. See Payment recovery.