Developer Dashboard

Use the Payscribe dashboard to configure the operational parts of an integration: environment-specific credentials, webhook delivery, and your server IP allowlist. Keep those settings separate between sandbox and production.

Engineering flowBuild, verify, then reconcile

Test this flow in sandbox →

1. 01Configure sandboxCreate test credentials and a test webhook endpoint.
2. 02Prove one flowUse the simulator, verify the event, and reconcile the result.
3. 03Prepare productionAdd your server IP and production webhook configuration.
4. 04Operate safelyInspect delivery details and resend only after fixing your handler.

Use a dashboard-issued sandbox API key on your server. Do not enter credentials into this documentation site.

API keys and webhook settings

Open Settings → API Keys & Webhook in the dashboard. Select the environment you are configuring before you create or rotate a credential.

Setting	What to configure	Safety rule
API key	Use a sandbox key for development and a production key only after go-live approval.	Copy a newly generated secret into your server secret manager immediately; do not place it in frontend code or source control.
Webhook URL	A publicly reachable HTTPS endpoint that accepts POST requests.	Point sandbox at a test endpoint and production at a production endpoint.
Callback URL	Optional business callback configuration when your product requires it.	Treat it as environment-specific; do not reuse a test URL in production.
IP whitelist	The outbound IPv4, IPv6, or CIDR range of the server that calls Payscribe.	Add the real production server egress IP before production traffic. A non-allowed IP receives 403.

Coordinate rotations

Rotating a key or webhook secret can interrupt a deployed service. Update the secret manager and deploy the affected service before invalidating the old configuration. If a secret may have been exposed, rotate it immediately and review the related activity.

See Authentication for the key/environment pairing and Going live for the release checklist.

Test a complete sandbox flow

Use the dashboard configuration together with the sandbox simulator—not a successful 200 response alone—to prove your integration.

1. Configure a sandbox API key and HTTPS webhook URL.
2. Create a test customer and virtual account.
3. Trigger Simulate transfer with a unique ref.
4. Verify the signed webhook, store its X-Payscribe-Event-Id once, and reconcile your local state.
5. Record the result in your release test evidence.

Use the Sandbox testing matrix for failure, duplicate-delivery, and recovery cases.

Inspect and recover webhook deliveries

Open Dashboard → Webhooks to find a delivery by status, event type, or event ID. The delivery detail shows the event, destination URL, environment, attempts, payload, response, HTTP status, and timing.

Delivery state	What it means	Your next action
Delivered	Your endpoint returned a successful response.	Confirm your asynchronous worker or database update completed.
Pending / awaiting retry	Payscribe will try delivery again.	Fix endpoint availability or response handling; do not create duplicate business work.
Failed	A delivery attempt did not complete successfully.	Inspect the response and your server logs, then fix the underlying issue.
Permanently failed	Automatic attempts are exhausted.	Reconcile the related operation, then use Resend to queue the same event after the handler is fixed.

Resending repeats delivery of an existing event. Your webhook handler must remain idempotent: a duplicate X-Payscribe-Event-Id should be a successful no-op, not a second fulfilment or credit.

For signature verification and event payloads, use Webhooks & Events. For a recovery checklist, use Troubleshooting.

Production hand-off

Before an application receives real traffic, the engineering owner should confirm:

• production base URL, production key, production webhook secret, and production webhook URL are configured separately from sandbox;
• the deployed server's outbound IP is on the business allowlist;
• webhook verification, deduplication, reconciliation, and alerting have passed in sandbox; and
• the team can inspect delivery details and has access to safely resend a failed delivery.

Complete the go-live checklist before enabling a real-money product flow.